Trait bevy_hierarchy::BuildChildren
source · pub trait BuildChildren {
// Required methods
fn with_children(
&mut self,
f: impl FnOnce(&mut ChildBuilder<'_>)
) -> &mut Self;
fn push_children(&mut self, children: &[Entity]) -> &mut Self;
fn insert_children(
&mut self,
index: usize,
children: &[Entity]
) -> &mut Self;
fn remove_children(&mut self, children: &[Entity]) -> &mut Self;
fn add_child(&mut self, child: Entity) -> &mut Self;
fn clear_children(&mut self) -> &mut Self;
fn replace_children(&mut self, children: &[Entity]) -> &mut Self;
fn set_parent(&mut self, parent: Entity) -> &mut Self;
fn remove_parent(&mut self) -> &mut Self;
}
Expand description
Trait for removing, adding and replacing children and parents of an entity.
Required Methods§
sourcefn with_children(&mut self, f: impl FnOnce(&mut ChildBuilder<'_>)) -> &mut Self
fn with_children(&mut self, f: impl FnOnce(&mut ChildBuilder<'_>)) -> &mut Self
Takes a closure which builds children for this entity using ChildBuilder
.
sourcefn push_children(&mut self, children: &[Entity]) -> &mut Self
fn push_children(&mut self, children: &[Entity]) -> &mut Self
Pushes children to the back of the builder’s children. For any entities that are already a child of this one, this method does nothing.
If the children were previously children of another parent, that parent’s Children
component
will have those children removed from its list. Removing all children from a parent causes its
Children
component to be removed from the entity.
§Panics
Panics if any of the children are the same as the parent.
sourcefn insert_children(&mut self, index: usize, children: &[Entity]) -> &mut Self
fn insert_children(&mut self, index: usize, children: &[Entity]) -> &mut Self
Inserts children at the given index.
If the children were previously children of another parent, that parent’s Children
component
will have those children removed from its list. Removing all children from a parent causes its
Children
component to be removed from the entity.
§Panics
Panics if any of the children are the same as the parent.
sourcefn remove_children(&mut self, children: &[Entity]) -> &mut Self
fn remove_children(&mut self, children: &[Entity]) -> &mut Self
Removes the given children
Removing all children from a parent causes its Children
component to be removed from the entity.
sourcefn add_child(&mut self, child: Entity) -> &mut Self
fn add_child(&mut self, child: Entity) -> &mut Self
Adds a single child.
If the children were previously children of another parent, that parent’s Children
component
will have those children removed from its list. Removing all children from a parent causes its
Children
component to be removed from the entity.
§Panics
Panics if the child is the same as the parent.
sourcefn clear_children(&mut self) -> &mut Self
fn clear_children(&mut self) -> &mut Self
Removes all children from this entity. The Children
component will be removed if it exists, otherwise this does nothing.