Struct moonshine_view::ViewBuilder

pub struct ViewBuilder<'a, T: Kind>(/* private fields */);

Used to build a View Entity for a given Instance of Kind T.

See BuildView for more information.

Implementations

impl<'a, T: Kind> ViewBuilder<'a, T>

pub fn instance(&self) -> Instance<View<T>>

Returns the View Instance.

pub fn entity(&self) -> Entity

Returns the View Entity.

pub fn insert(&mut self, bundle: impl Bundle) -> &mut Self

Inserts a new Bundle into the View Entity.

pub fn insert_children<F: FnOnce(&mut ChildBuilder<'_>)>( &mut self, f: F ) -> &mut Self

Adds some children to the View Entity.

pub fn commands(&mut self) -> &mut InstanceCommands<'a, View<T>>

Returns the InstanceCommands for the View Entity.

Usage

This is useful for more advanced operations on the view entity, or for modifying the world beyond the view entity hierarchy.

These types of operations should be avoided as for most cases, building the view should be purely “additive” through adding components (see ViewBuilder::insert) or spawning children (see ViewBuilder::insert_children).