MouseWheelInputEvent

class Event.MouseWheelInputEvent()

Accessors

viewKey

Methods

altDown()
commandDown()
controlDown()
getButtons()
getDate()
getEventType()
getHandled()
getModifiers()
getPosition()
getWheelDelta()
setHandled()
shiftDown()

Accessors

Event.viewKey()

Get the ViewKey this event is associated with.

Return type: ViewKey

Methods

altDown

MouseWheelInputEvent.altDown()

gets the state of the alt key

Returns: whether the alt key was down when this event was generated
Return type: boolean

commandDown

MouseWheelInputEvent.commandDown()

gets the state of the command key

Returns: whether the command key was down when this event was generated
Return type: boolean

controlDown

MouseWheelInputEvent.controlDown()

gets the state of the control key

Returns: whether the control key was down when this event was generated
Return type: boolean

getButtons

MouseWheelInputEvent.getButtons()

gets the mouse buttons currently pressed with this event

Returns: the mouse buttons currently pressed for this event
Return type: Buttons

getDate

MouseWheelInputEvent.getDate()

Gets the Date this event occurred

Returns: the event Date
Return type: Date

getEventType

MouseWheelInputEvent.getEventType()

gets the event type

Returns: the type of mouse event
Return type: MouseInputType

getHandled

MouseWheelInputEvent.getHandled()

Gets the handled state of the event

Returns: whether the event has been handled
Return type: boolean

getModifiers

MouseWheelInputEvent.getModifiers()

gets the event modifiers

Returns: bitwise combination of KeyModifiers
Return type: KeyModifiers

getPosition

MouseWheelInputEvent.getPosition()

gets the window position of the mouse pointer for this event

Returns: the mouse position for this event
Return type: Point2

getWheelDelta

MouseWheelInputEvent.getWheelDelta()

Gets the wheel delta for this event. A positive value indicates that the wheel was scrolled Up, while a negative value indicated the wheel was scrolled down.

Returns: Wheel dela value
Return type: number

setHandled

MouseWheelInputEvent.setHandled(handled)

Arguments

handled (boolean()) – Indicates whether this event has been handled.

Sets the handled state of the event. When an event has been handled it will not propagate any further

Return type: void

shiftDown

MouseWheelInputEvent.shiftDown()

gets the state of the shift key

Returns: whether the shift key was down when this event was generated
Return type: boolean