Skip to main content

Stage

Struct Stage 

Source
pub struct Stage {
    nodes: SlotMap<NodeId, Node>,
    root: NodeId,
}
Expand description

Scene graph root.

Owns all nodes via a SlotMap keyed by NodeId. The tree is rooted at a Container returned by Stage::root. Child relationships are tracked inside each Container.

Fields§

§nodes: SlotMap<NodeId, Node>§root: NodeId

Implementations§

Source§

impl Stage

Source

pub fn new() -> Self

Construct a new stage with an empty root container.

Source

pub fn root(&self) -> NodeId

The root node ID. Always a Container.

Source

pub fn len(&self) -> usize

Total node count across the whole graph (including the root).

Source

pub fn is_empty(&self) -> bool

true iff only the root exists.

Source

pub fn get(&self, id: NodeId) -> Option<&Node>

Borrow a node by ID.

Source

pub fn get_mut(&mut self, id: NodeId) -> Option<&mut Node>

Mutably borrow a node by ID.

Source

pub fn add_child( &mut self, parent: NodeId, child: impl Into<Node>, ) -> Option<NodeId>

Insert child as a child of parent. Returns the new node ID.

child’s parent field is set; parent’s children list is appended.

Returns None if parent doesn’t exist.

Source

pub fn detach(&mut self, child: NodeId) -> bool

Detach child from its parent without destroying it.

After this call the child is an orphan still reachable via Stage::get but no longer in any container’s children list. Returns true if the child was attached.

Source

pub fn destroy(&mut self, id: NodeId) -> bool

Destroy a node and (recursively) all its descendants. Detaches from parent first.

Returns true if the node existed.

Source

pub fn traverse_pre_order( &self, start: NodeId, visit: impl FnMut(NodeId, &Node), )

Pre-order traversal from a starting node. Visits the start first, then each child’s subtree in insertion order.

Source

fn collect_descendants(&self, id: NodeId) -> Vec<NodeId>

Trait Implementations§

Source§

impl Default for Stage

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Stage

§

impl !RefUnwindSafe for Stage

§

impl Send for Stage

§

impl Sync for Stage

§

impl Unpin for Stage

§

impl UnsafeUnpin for Stage

§

impl !UnwindSafe for Stage

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,