Struct orbtk_tree::Tree

pub struct Tree {
    pub root: Option<Entity>,
    pub overlay: Option<Entity>,
    pub children: BTreeMap<Entity, Vec<Entity>>,
    pub parent: BTreeMap<Entity, Option<Entity>>,
    // some fields omitted
}

Base data structure to manage the entities of a window in a tree based structure.

Fields

root: Option<Entity>

overlay: Option<Entity>

children: BTreeMap<Entity, Vec<Entity>>

parent: BTreeMap<Entity, Option<Entity>>

Implementations

impl Tree

pub fn new() -> Self

Creates a new tree with default values.

pub fn root(&self) -> Entity

Returns the root of the tree.

pub fn start_node(&self, start_node: impl Into<Entity>) -> &Self

pub fn register_node(&mut self, entity: impl Into<Entity>)

Registers a new entity entity as node.

pub fn set_root(&mut self, root: impl Into<Entity>)

Sets the root.

pub fn set_overlay(&mut self, overlay: impl Into<Entity>)

pub fn append_child(
    &mut self,
    parent: impl Into<Entity>,
    child: impl Into<Entity>
) -> Result<Entity, NotFound>

Appends a child entity to the given parent entity. Raised NotFound error if the parent is not part of the tree.

pub fn len(&self) -> usize

Returns the number of all entities in the tree.

pub fn is_empty(&self) -> bool

Returns true if the tree has no entities.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy 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() -> Tree

Returns the "default value" for a type.

impl EntityStore for Tree

fn register_entity(&mut self, entity: impl Into<Entity>)

Registers the give 'entity'.

fn remove_entity(&mut self, entity: impl Into<Entity>)

Removes the given 'entity'.

impl<'a> IntoIterator for &'a Tree

type Item = Entity

The type of the elements being iterated over.

type IntoIter = TreeIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.