MouseEvent

data class MouseEvent( val position: Vector2, val rotation: Vector2, val dragDisplacement: Vector2, val type: MouseEventType, val button: MouseButton, val modifiers: Set<KeyModifier>)(source)

Represents a mouse event in a 2D GUI or application.

Constructors

constructor( position: Vector2, rotation: Vector2, dragDisplacement: Vector2, type: MouseEventType, button: MouseButton, modifiers: Set<KeyModifier>)

The mouse button involved in the event, represented by MouseButton.

The displacement vector caused by dragging, represented as a Vector2.

The set of key modifiers (such as Shift, Ctrl, or Alt) active during the mouse event, represented by KeyModifier.

The position of the mouse event in 2D space, represented as a Vector2.

specifies if the propagation of this event is cancelled

The rotational change of the mouse event, typically used for scroll or gesture detection, represented as a Vector2.

The type of the mouse event, represented by MouseEventType, such as click, drag, or scroll.

cancel propagation of this MouseEvent message