glok-core/uk.co.nickthecoder.glok.event/MouseEvent

MouseEvent

class MouseEvent(val eventType: EventType<MouseEvent>, val scene: Scene, val sceneX: Float, val sceneY: Float, val buttonIndex: Int, val clickCount: Int, val mods: Int) : MouseEventBase

Used for event types EventType.MOUSE_PRESSED, EventType.MOUSE_RELEASED, EventType.MOUSE_CLICKED, EventType.MOUSE_MOVED, EventType.MOUSE_EXITED, EventType.MOUSE_ENTERED and EventType.MOUSE_DRAGGED.

Constructors

MouseEvent

constructor(eventType: EventType<MouseEvent>, scene: Scene, sceneX: Float, sceneY: Float, buttonIndex: Int, clickCount: Int, mods: Int)

Properties

button

val button: MouseButton

buttonIndex

val buttonIndex: Int

-1 = None, 0 = Left, 1 = Right, 2 = Middle.

buttonNumber

val buttonNumber: Int

0 = None, 1 = Left, 2 = Right, 3 = Middle.

clickCount

val clickCount: Int

eventType

open override val eventType: EventType<MouseEvent>

isAltDown

val isAltDown: Boolean

isControlDown

val isControlDown: Boolean

isMiddle

val isMiddle: Boolean

isPrimary

val isPrimary: Boolean

isSecondary

val isSecondary: Boolean

isShiftDown

val isShiftDown: Boolean

isSuperDown

val isSuperDown: Boolean

mods

val mods: Int

scene

val scene: Scene

sceneX

val sceneX: Float

The X position of the mouse, relative to the left of the scene. For a position relative to a node :

sceneY

val sceneY: Float

The X position of the mouse, relative to the top of the scene. For a position relative to a node :

Functions

capture

fun capture()

Use within EventType.MOUSE_PRESSED events only to indicate that this node wants to recieve EventType.MOUSE_DRAGGED events until the mouse button is released. If called on other event types, it will be ignored.

consume

fun consume()

Prevents further processing of this event.

isConsumed

fun isConsumed(): Boolean

isPopupTrigger

fun isPopupTrigger(): Boolean

On Windows, a popup trigger is when the secondary mouse button is PRESSED, and on all other platforms, it is when the secondary mouse button is RELEASED.

toString

open override fun toString(): String