Struct hecs_hierarchy::DeferredTreeBuilder

pub struct DeferredTreeBuilder<T> { /* fields omitted */ }

Ergonomically construct trees without knowledge of world.

This struct builds the world using EntityBuilderClone

Example

use hecs_hierarchy::*;
use hecs::*;

struct Tree;
let mut world = World::default();
let mut builder = DeferredTreeBuilder::<Tree>::from_bundle(("root",));
builder.attach_bundle(("child 1",));
builder.attach({
    let mut builder = DeferredTreeBuilder::new();
    builder.add("child 2");
    builder
});
let root = builder.build(&mut world);
assert_eq!(*world.get::<&'static str>(root).unwrap(), "root");
for (a, b) in world
    .descendants_depth_first::<Tree>(root)
    .zip(["child 1", "child 2"])
{
    assert_eq!(*world.get::<&str>(a).unwrap(), b)
}

Implementations

impl<T: Component> DeferredTreeBuilder<T>

pub fn new() -> Self

pub fn from_builder(builder: EntityBuilderClone) -> Self

pub fn from_bundle(bundle: impl DynamicBundleClone) -> Self

pub fn build(&self, world: &mut World) -> Entity

pub fn build_cmd(
    &self,
    world: &impl GenericWorld,
    cmd: &mut CommandBuffer
) -> Entity

pub fn add(&mut self, component: impl Component + Clone) -> &mut Self

Add a component to the root

pub fn add_bundle(&mut self, bundle: impl DynamicBundleClone) -> &mut Self

Add a bundle to the root

pub fn attach(&mut self, child: DeferredTreeBuilder<T>) -> &mut Self

Atttach a new subtree

pub fn attach_new(&mut self, child: EntityBuilderClone) -> &mut Self

Attach a new leaf as an entity builder

pub fn attach_bundle(&mut self, child: impl DynamicBundleClone) -> &mut Self

Attach a new leaf as a bundle

pub fn builder(&self) -> &EntityBuilderClone

Get a reference to the deferred tree builder’s builder.

pub fn children(&self) -> &[DeferredTreeBuilder<T>]

Get a reference to the deferred tree builder’s children.

Trait Implementations

impl<T: Clone> Clone for DeferredTreeBuilder<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Component> From<EntityBuilderClone> for DeferredTreeBuilder<T>

fn from(builder: EntityBuilderClone) -> Self

Performs the conversion.