Struct Node

pub struct Node<T> {
    pub value: T,
    /* private fields */
}

A wrapper around the values given to the SceneGraph. This struct includes the data on the relationships to other nodes, in addition to the value placed at the node.

Fields

value: T

The value contained within the node.

Implementations

impl<T> Node<T>

pub fn has_children(&self) -> bool

Returns true if this node has children.

pub fn iter_direct_children<'a>( &'a self, sg: &'a SceneGraph<T>, ) -> SceneGraphChildIter<'a, T>

Iterate directly over only the direct children of parent_index.

For example, given a graph: ROOT: A B C D using iter_direct_children and passing in the parent_index for A will only yield B and C, not D. For that kind of depth first traversal, using iter_on_node.

Note: passing in a SceneGraph of a different kind than this node belongs to (but of the same type) will create logic errors or panics.

pub fn parent(&self) -> NodeIndex

Returns the index of the parent.

Trait Implementations

impl<T: Clone> Clone for Node<T>

fn clone(&self) -> Node<T>

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Node<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Hash> Hash for Node<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Node<T>

fn cmp(&self, other: &Node<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Node<T>

fn eq(&self, other: &Node<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Node<T>

fn partial_cmp(&self, other: &Node<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy> Copy for Node<T>

impl<T: Eq> Eq for Node<T>

impl<T> StructuralPartialEq for Node<T>