Skip to main content

InteractionEvent

Struct InteractionEvent 

Source
pub struct InteractionEvent {
    pub kind: InteractionEventKind,
    pub pointer_kind: PointerKind,
    pub screen_point: ScreenPoint,
    pub query_coord: Option<GeoCoord>,
    pub projection: Option<CameraProjection>,
    pub button: Option<InteractionButton>,
    pub modifiers: InteractionModifiers,
    pub target: Option<InteractionTarget>,
    pub related_target: Option<InteractionTarget>,
    pub hit: Option<PickHit>,
}
Expand description

Canonical interaction event payload.

Fields§

§kind: InteractionEventKind

Event kind.

§pointer_kind: PointerKind

Input device class that produced the event.

§screen_point: ScreenPoint

Logical screen-space event location.

§query_coord: Option<GeoCoord>

Resolved geographic coordinate, when available.

§projection: Option<CameraProjection>

Camera projection active at dispatch time.

§button: Option<InteractionButton>

Pressed button for button-aware events.

§modifiers: InteractionModifiers

Keyboard-modifier snapshot at dispatch time.

§target: Option<InteractionTarget>

Current target of the interaction, when any.

§related_target: Option<InteractionTarget>

Related target for enter/leave-style transitions, when any.

§hit: Option<PickHit>

Top-priority hit associated with the interaction, when any.

Implementations§

Source§

impl InteractionEvent

Source

pub fn new( kind: InteractionEventKind, pointer_kind: PointerKind, screen_point: ScreenPoint, ) -> Self

Create a new interaction event with no target or resolved hit attached.

Source

pub fn with_query_coord(self, query_coord: GeoCoord) -> Self

Attach a resolved geographic query coordinate.

Source

pub fn with_projection(self, projection: CameraProjection) -> Self

Attach the active camera projection.

Source

pub fn with_button(self, button: InteractionButton) -> Self

Attach button metadata.

Source

pub fn with_modifiers(self, modifiers: InteractionModifiers) -> Self

Attach keyboard modifiers.

Source

pub fn with_hit(self, hit: PickHit) -> Self

Attach a top-priority pick hit and derive the current interaction target.

Attach a related target for enter/leave-style transitions.

Source

pub fn has_target(&self) -> bool

Whether this event currently targets something queryable.

Trait Implementations§

Source§

impl Clone for InteractionEvent

Source§

fn clone(&self) -> InteractionEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InteractionEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.