Struct MouseEvent

pub struct MouseEvent {
    pub location: MouseLocation,
    pub wheel_delta_v: Option<WheelDelta>,
    pub wheel_delta_h: Option<WheelDelta>,
    pub is_precision_scroll: Option<PrecisionScroll>,
    pub phase: MousePhase,
    pub affected_buttons: HashSet<MouseButton>,
    pub pressed_buttons: HashSet<MouseButton>,
}

A MouseEvent represents a pointer event with a specified phase, and the buttons involved in said phase. The supported phases for mice include Up, Down, and Move.

Example

The following MouseEvent represents a relative movement of 40 units in the x axis and 20 units in the y axis while holding the primary button (1) down.

let mouse_device_event = input_device::InputDeviceEvent::Mouse(MouseEvent::new(
    MouseLocation::Relative(RelativePosition {
      millimeters: Position { x: 4.0, y: 2.0 },
    }),
    Some(1),
    Some(1),
    MousePhase::Move,
    HashSet::from_iter(vec![1]).into_iter()),
    HashSet::from_iter(vec![1]).into_iter()),,
));

Fields

location: MouseLocation

The mouse location.

wheel_delta_v: Option<WheelDelta>

The mouse wheel rotated delta in vertical.

wheel_delta_h: Option<WheelDelta>

The mouse wheel rotated delta in horizontal.

is_precision_scroll: Option<PrecisionScroll>

The mouse device reports precision scroll delta.

phase: MousePhase

The phase of the [buttons] associated with this input event.

affected_buttons: HashSet<MouseButton>

The buttons relevant to this event.

pressed_buttons: HashSet<MouseButton>

The complete button state including this event.

Implementations

impl MouseEvent

pub fn new( location: MouseLocation, wheel_delta_v: Option<WheelDelta>, wheel_delta_h: Option<WheelDelta>, phase: MousePhase, affected_buttons: HashSet<MouseButton>, pressed_buttons: HashSet<MouseButton>, is_precision_scroll: Option<PrecisionScroll>, ) -> MouseEvent

Creates a new MouseEvent.

Parameters

• location: The mouse location.
• phase: The phase of the [buttons] associated with this input event.
• buttons: The buttons relevant to this event.

pub fn record_inspect(&self, node: &Node)

Trait Implementations

impl Clone for MouseEvent

fn clone(&self) -> MouseEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEvent

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

Formats the value using the given formatter.

impl PartialEq for MouseEvent

fn eq(&self, other: &MouseEvent) -> 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 MouseEvent