Struct amethyst_core::HideHierarchySystem

pub struct HideHierarchySystem { /* fields omitted */ }

This system adds a HiddenPropagate-component to all children.

Using this system will result in every child being hidden. Depends on the resource "ParentHierarchy", which is set up by the TransformBundle

Based on the UiTransformSystem.

Implementations

impl HideHierarchySystem

pub fn new(
    hidden_events_id: ReaderId<ComponentEvent>,
    parent_events_id: ReaderId<HierarchyEvent>
) -> Self

Creates a new HideHierarchySystem.

Trait Implementations

impl Debug for HideHierarchySystem

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

Formats the value using the given formatter.

impl<'a> System<'a> for HideHierarchySystem

type SystemData = (WriteStorage<'a, HiddenPropagate>, ReadStorage<'a, Parent>, ReadExpect<'a, ParentHierarchy>)

The resource bundle required to execute this system.

fn run(&mut self, (hidden, parents, hierarchy): Self::SystemData)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.

impl<'a, 'b> SystemDesc<'a, 'b, HideHierarchySystem> for HideHierarchySystemDesc

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

Builds and returns a System.