Struct specs_hierarchy::Hierarchy
source · pub struct Hierarchy<P> { /* private fields */ }
Expand description
Scene graph type hierarchy.
Will use the given generic type P
as the component type that provides parenting links. The
internal structure is kept in sync with the Tracked
events for that component type.
Will send modification events on the internal EventChannel
. Note that Removed
events
do not indicate that the Parent
component was removed from the component storage, just that
the Entity
will no longer be considered to be a part of the Hierarchy
. This is because the
user may wish to either remove only the component, or the complete Entity, or something
completely different. When an Entity
that is a parent gets removed from the hierarchy, the
full tree of children below it will also be removed from the hierarchy.
Any cycles in the hierarchy will cause Undefined Behavior.
Implementations
sourceimpl<P> Hierarchy<P>
impl<P> Hierarchy<P>
sourcepub fn new(reader_id: ReaderId<ComponentEvent>) -> Selfwhere
P: Component,
P::Storage: Tracked,
pub fn new(reader_id: ReaderId<ComponentEvent>) -> Selfwhere
P: Component,
P::Storage: Tracked,
Create a new hierarchy object.
sourcepub fn all(&self) -> &[Entity]
pub fn all(&self) -> &[Entity]
Get all entities that contain parents, in sorted order, where parents are guaranteed to be before their children.
Note: This does not include entities that are parents.
sourcepub fn children(&self, entity: Entity) -> &[Entity]
pub fn children(&self, entity: Entity) -> &[Entity]
Get the immediate children of a specific entity.
sourcepub fn all_children(&self, entity: Entity) -> BitSet
pub fn all_children(&self, entity: Entity) -> BitSet
Get all children of this entity recursively as a BitSet
This does not include the parent entity you pass in.
sourcepub fn all_children_iter<'a>(
&'a self,
entity: Entity
) -> SubHierarchyIterator<'a, P> ⓘ
pub fn all_children_iter<'a>(
&'a self,
entity: Entity
) -> SubHierarchyIterator<'a, P> ⓘ
Returns an iterator over all of the recursive children of this entity.
This does not include the parent entity you pass in. Parents are guaranteed to be prior to their children.
sourcepub fn track(&mut self) -> ReaderId<HierarchyEvent>
pub fn track(&mut self) -> ReaderId<HierarchyEvent>
Get a token for tracking the modification events from the hierarchy
sourcepub fn changed(&self) -> &EventChannel<HierarchyEvent>
pub fn changed(&self) -> &EventChannel<HierarchyEvent>
Get the EventChannel
for the modification events for reading