Enum PointerEvent

#[non_exhaustive]
pub enum PointerEvent {
    Moved {
        pos: Point,
        modifiers: Modifiers,
    },
    Button {
        pos: Point,
        button: PointerButton,
        pressed: bool,
        modifiers: Modifiers,
    },
    Cancelled {
        pos: Point,
        modifiers: Modifiers,
    },
    Wheel {
        pos: Point,
        delta: WheelDelta,
        modifiers: Modifiers,
        precise: bool,
    },
}

Pointer move, button, cancellation, or wheel event.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent}, Point};
let event = PointerEvent::moved(Point::new(1.0, 2.0), Modifiers::default());
assert_eq!(event.position(), Point::new(1.0, 2.0));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Moved

Cursor moved to pos.

Fields

pos: Point

Current logical window position.

modifiers: Modifiers

Modifier snapshot at the time of motion.

Button

Button pressed or released at pos.

Fields

pos: Point

Logical window position of the transition.

button: PointerButton

Button whose state changed.

pressed: bool

true for press and false for release.

modifiers: Modifiers

Modifier snapshot at the time of transition.

Cancelled

The active gesture was cancelled by the host or input provider.

Cancellation never represents a click release. Runtimes must clear press/capture state for the corresponding PointerId.

Fields

pos: Point

Last known logical window position.

modifiers: Modifiers

Modifier snapshot at cancellation time.

Wheel

Scroll wheel at pos.

Fields

pos: Point

Logical window position associated with the wheel input.

delta: WheelDelta

Provider wheel displacement before widget-specific normalization.

modifiers: Modifiers

Modifier snapshot at wheel time.

precise: bool

High-resolution trackpad scroll when supported.

Implementations

impl PointerEvent

pub const fn moved(pos: Point, modifiers: Modifiers) -> Self

Creates a pointer movement event in logical coordinates.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent}, Point};
assert_eq!(PointerEvent::moved(Point::new(1.0, 2.0), Modifiers::default()).position(), Point::new(1.0, 2.0));

pub const fn button( pos: Point, button: PointerButton, pressed: bool, modifiers: Modifiers, ) -> Self

Creates a pointer-button transition in logical coordinates.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerButton, PointerEvent}, Point};
let event = PointerEvent::button(Point::default(), PointerButton::Left, true, Modifiers::default());
assert_eq!(event.button_transition(), Some((PointerButton::Left, true)));

pub const fn cancelled(pos: Point, modifiers: Modifiers) -> Self

Creates a pointer cancellation event.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent}, Point};
assert!(PointerEvent::cancelled(Point::default(), Modifiers::default()).is_cancelled());

pub const fn wheel( pos: Point, delta: WheelDelta, modifiers: Modifiers, precise: bool, ) -> Self

Creates a pointer-wheel event in logical coordinates.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent, WheelDelta}, Point};
let event = PointerEvent::wheel(Point::default(), WheelDelta::LineDelta { x: 0.0, y: 1.0 }, Modifiers::default(), false);
assert!(event.wheel_delta().is_some());

pub const fn position(&self) -> Point

Logical position associated with this event.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent}, Point};
let event = PointerEvent::moved(Point::new(2.0, 3.0), Modifiers::default());
assert_eq!(event.position(), Point::new(2.0, 3.0));

pub const fn modifiers(&self) -> Modifiers

Keyboard modifiers observed with this event.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent}, Point};
let modifiers = Modifiers { shift: true, ..Modifiers::default() };
assert!(PointerEvent::moved(Point::default(), modifiers).modifiers().shift);

pub const fn button_transition(&self) -> Option<(PointerButton, bool)>

Returns the button and transition state for a button event.

The boolean is true for press and false for release; all other event variants return None.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerButton, PointerEvent}, Point};
let event = PointerEvent::button(Point::default(), PointerButton::Right, false, Modifiers::default());
assert_eq!(event.button_transition(), Some((PointerButton::Right, false)));

pub const fn wheel_delta(&self) -> Option<(WheelDelta, bool)>

Returns wheel displacement and the high-resolution flag for a wheel event.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent, WheelDelta}, Point};
let event = PointerEvent::wheel(Point::default(), WheelDelta::PixelDelta { x: 0.0, y: 2.0 }, Modifiers::default(), true);
assert_eq!(event.wheel_delta(), Some((WheelDelta::PixelDelta { x: 0.0, y: 2.0 }, true)));

pub const fn is_cancelled(&self) -> bool

Returns whether the provider cancelled the active gesture.

Examples

use ailloli_ui_core::{event::{Modifiers, PointerEvent}, Point};
assert!(!PointerEvent::moved(Point::default(), Modifiers::default()).is_cancelled());

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 PartialEq for PointerEvent

fn eq(&self, other: &PointerEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PointerEvent