Struct Tree 

pub struct Tree { /* private fields */ }

Available on crate feature tree only.

FBX data tree.

Tree manipulation methods

You can use the methods below to access and/or modify the tree.

• Access
  • root
• Create nodes / modify tree
  • create_node
  • append_new
  • prepend_new
  • insert_new_after
  • insert_new_before
  • append
  • prepend
  • insert_after
  • insert_before
  • detach
• Modify node
  • append_attribute
  • get_attribute_mut
  • take_attributes_vec
  • set_attributes_vec

Implementations

impl Tree

pub fn root(&self) -> NodeHandle<'_>

Returns the root node.

pub fn create_node(&mut self, name: &str) -> NodeId

Creates an orphan node in the arena.

The created node can be inserted nearby some other nodes (in the same arena) later.

pub fn append(&mut self, new_last_child: NodeId, parent: NodeId)

Detaches the node and appends it to the given parent node.

Panics

Panics if:

• any of the given node IDs are not used in the tree,
• the new_last_child is parent, or
• the new_last_child is an ancestor of parent.

pub fn prepend(&mut self, new_first_child: NodeId, parent: NodeId)

Detaches the node and prepends it to the given parent node.

Panics

Panics if:

• any of the given node IDs are not used in the tree,
• the new_first_child is parent, or
• the new_first_child is an ancestor of parent.

pub fn insert_after(&mut self, new_next_sibling: NodeId, prev_sibling: NodeId)

Detaches the node and inserts it after the given base node.

Panics

Panics if:

• any of the given node IDs are not used in the tree,
• the new_next_sibling is prev_sibling.

pub fn insert_before(&mut self, new_prev_sibling: NodeId, next_sibling: NodeId)

Detaches the node and inserts it after the given base node.

Panics

Panics if:

• any of the given node IDs are not used in the tree,
• the new_prev_sibling is next_sibling.

pub fn append_new(&mut self, parent: NodeId, name: &str) -> NodeId

Creates a new node and appends to the given parent node.

Panics

Panics if the given node ID is not used in the tree.

pub fn prepend_new(&mut self, parent: NodeId, name: &str) -> NodeId

Creates a new node and prepends to the given parent node.

Panics

Panics if the given node ID is not used in the tree.

pub fn insert_new_after(&mut self, sibling: NodeId, name: &str) -> NodeId

Creates a new node and inserts after the given sibling node.

Panics

Panics if the given node ID is invalid (i.e. not used or root node).

pub fn insert_new_before(&mut self, sibling: NodeId, name: &str) -> NodeId

Creates a new node and inserts before the given sibling node.

Panics

Panics if the given node ID is invalid (i.e. not used or root node).

pub fn detach(&mut self, subtree_root: NodeId)

Detaches the subtree from the tree.

If the subtree is the root node, does nothing.

The detached node and its descendants are kept in the arena, so they can be inserted nearby some other nodes (in the same arena) later.

pub fn append_attribute( &mut self, node_id: NodeId, v: impl Into<AttributeValue>, )

Creates a new node and inserts before the given sibling node.

Panics

Panics if the given node ID is invalid (i.e. not used or root node).

pub fn get_attribute_mut( &mut self, node_id: NodeId, i: usize, ) -> Option<&mut AttributeValue>

Returns a mutable reference to the node attribute at the given index.

Panics

Panics if the given node ID is invalid (i.e. not used or root node).

pub fn take_attributes_vec(&mut self, node_id: NodeId) -> Vec<AttributeValue>

Takes all attributes as a Vec.

After calling this, the node will have no attributes (until other values are set).

Panics

Panics if the given node ID is invalid (i.e. not used or root node).

pub fn set_attributes_vec(&mut self, node_id: NodeId, new: Vec<AttributeValue>)

Sets the given Vec of attribute values as the node attributes.

After calling this, the node will have only the given attributes.

Panics

Panics if the given node ID is invalid (i.e. not used or root node).

pub fn strict_eq(&self, other: &Self) -> bool

Compares trees strictly.

Returns true if the two trees are same.

Note that f32 and f64 values are compared bitwise.

Note that this method compares tree data, not internal states of the objects.

pub fn debug_tree(&self) -> impl Debug + '_

Pretty-print the tree for debugging purpose.

Be careful, this output format may change in future.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl Default for Tree

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Tree

fn eq(&self, other: &Tree) -> bool

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

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 StructuralPartialEq for Tree