Struct ambient_api::prelude::ElementTree

pub struct ElementTree { /* private fields */ }

A tree of instantiated Elements.

Implementations

impl ElementTree

pub fn new(world: &mut World, element: Element) -> ElementTree

Creates a new ElementTree from the given Element.

pub fn root_entity(&self) -> Option<EntityId>

Gets the EntityId of the entity at the root of this tree, if available.

pub fn n_instances(&self) -> usize

Get the number of instances in this tree.

pub fn migrate_root(&mut self, world: &mut World, element: Element)

Migrate the root of this tree to another Element.

This can be used to change the root of the tree and/or supply new state at the root level.

pub fn remove_root(&mut self, world: &mut World)

Remove the root of this tree.

pub fn update(&mut self, world: &mut World)

Update the tree and re-render instances as required.

pub fn dump(&self, indent: usize) -> String

Dump the state of this tree to a string.

Trait Implementations

impl Debug for ElementTree

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

Formats the value using the given formatter.

impl Display for ElementTree

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

Formats the value using the given formatter.

impl From<ElementTree> for ShareableElementTree

fn from(tree: ElementTree) -> ShareableElementTree

Converts to this type from the input type.