Struct amethyst_ui::SelectionKeyboardSystem

pub struct SelectionKeyboardSystem<G> where
    G: Send + Sync + 'static + PartialEq,  { /* fields omitted */ }

System managing the selection of entities. Reacts to UiEvent. Reacts to Tab and Shift+Tab.

Methods

impl<G> SelectionKeyboardSystem<G> where
    G: Send + Sync + 'static + PartialEq, 

pub fn new(window_reader_id: ReaderId<Event>) -> Self

Creates a new SelectionKeyboardSystem.

Trait Implementations

impl<G: Debug> Debug for SelectionKeyboardSystem<G> where
    G: Send + Sync + 'static + PartialEq, 

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

Formats the value using the given formatter.

impl<'system_desc_a, 'system_desc_b, G> SystemDesc<'system_desc_a, 'system_desc_b, SelectionKeyboardSystem<G>> for SelectionKeyboardSystemDesc<G> where
    G: Send + Sync + 'static + PartialEq, 

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

Builds and returns a System.

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

type SystemData = (Read<'a, EventChannel<Event>>, Read<'a, CachedSelectionOrder>, WriteStorage<'a, Selected>, Write<'a, EventChannel<UiEvent>>, Entities<'a>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (window_events, cached, selecteds, ui_events, 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.