Struct amethyst_ui::SelectionMouseSystem

pub struct SelectionMouseSystem<G, T> where
    T: BindingTypes,  { /* fields omitted */ }

System handling the clicks on ui entities and selecting them, if applicable.

Methods

impl<G, T: BindingTypes> SelectionMouseSystem<G, T> where
    G: Send + Sync + 'static + PartialEq, 

pub fn new(ui_reader_id: ReaderId<UiEvent>) -> Self

Creates a new SelectionMouseSystem.

Trait Implementations

impl<G: Debug, T: Debug> Debug for SelectionMouseSystem<G, T> where
    T: BindingTypes, 

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

Formats the value using the given formatter.

impl<'a, 'b, G, T> SystemDesc<'a, 'b, SelectionMouseSystem<G, T>> for SelectionMouseSystemDesc<G, T> where
    G: Send + Sync + 'static + PartialEq,
    T: BindingTypes, 

fn build(self, world: &mut World) -> SelectionMouseSystem<G, T>

Builds and returns a System.

impl<'a, G, T: BindingTypes> System<'a> for SelectionMouseSystem<G, T> where
    G: Send + Sync + 'static + PartialEq, 

type SystemData = (Write<'a, EventChannel<UiEvent>>, Read<'a, CachedSelectionOrder>, WriteStorage<'a, Selected>, ReadStorage<'a, Selectable<G>>, Read<'a, InputHandler<T>>, Entities<'a>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (ui_events, cached, selecteds, selectables, input_handler, entities): 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.