Struct amethyst_ui::UiMouseSystem

pub struct UiMouseSystem<T: BindingTypes> { /* fields omitted */ }

The system that generates events for Interactable enabled entities. The generic types A and B represent the A and B generic parameter of the InputHandler<A,B>.

Methods

impl<T: BindingTypes> UiMouseSystem<T>

pub fn new() -> Self

Creates a new UiMouseSystem.

Trait Implementations

impl<T: Default + BindingTypes> Default for UiMouseSystem<T>

fn default() -> UiMouseSystem<T>

Returns the "default value" for a type.

impl<T: Debug + BindingTypes> Debug for UiMouseSystem<T>

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

Formats the value using the given formatter.

impl<'a, T: BindingTypes> System<'a> for UiMouseSystem<T>

type SystemData = (Entities<'a>, ReadStorage<'a, UiTransform>, ReadStorage<'a, Interactable>, Read<'a, InputHandler<T>>, ReadExpect<'a, ScreenDimensions>, Write<'a, EventChannel<UiEvent>>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (entities, transform, react, input, screen_dimensions, events): 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.