Struct dx::engine::d2::input::PointerEvent

pub struct PointerEvent {
    pub view_x: f32,
    pub view_y: f32,
    pub hit: Option<Sprite>,
    pub source: Option<EventSource>,
    pub id: i32,
    pub stopped: bool,
}

Represents an event coming from a pointing device, such as a mouse or finger.

NOTE: For performance reasons, PointerEvent instances are reused. Use clone() to retain a reference to an event.

Fields

view_x: f32

The X position of the pointing device, in view (stage) coordinates.

view_y: f32

The Y position of the pointing device, in view (stage) coordinates.

hit: Option<Sprite>

The deepest sprite lying under the pointer that caused the event, if any. The hit sprite does not necessarily have a pointer event listener connected to it. This event starts at the hit sprite, and propagates upwards to its parents.

source: Option<EventSource>

The source that this event originated from. This can be used to determine if the event came from a mouse or a touch.

id: i32

An incrementing ID unique to every dispatched pointer event.

stopped: bool

Implementations

impl PointerEvent

pub fn new() -> Self

pub fn stop_propagation(&mut self)

Prevents this PointerEvent from propagating up to parent sprites and the top-level Pointer signal. Other listeners for this event on the current sprite will still fire.

pub fn init(
    &mut self,
    id: i32,
    view_x: f32,
    view_y: f32,
    hit: Option<Sprite>,
    source: Option<EventSource>
)

Trait Implementations

impl Clone for PointerEvent

fn clone(&self) -> PointerEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PointerEvent

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

Formats the value using the given formatter.

impl Default for PointerEvent

fn default() -> PointerEvent

Returns the “default value” for a type.