MouseWheelInputEvent

class Event.MouseWheelInputEvent()

Accessors

Event.MouseWheelInputEvent.viewKey()

inherited

get viewKey(): ViewKey

Get the ViewKey this event is associated with.

Returns: ViewKey

Methods

Event.MouseWheelInputEvent.altDown()

inherited

altDown(): boolean

gets the state of the alt key

Returns: boolean

whether the alt key was down when this event was generated
Event.MouseWheelInputEvent.commandDown()

inherited

commandDown(): boolean

gets the state of the command key

Returns: boolean

whether the command key was down when this event was generated
Event.MouseWheelInputEvent.controlDown()

inherited

controlDown(): boolean

gets the state of the control key

Returns: boolean

whether the control key was down when this event was generated
Event.MouseWheelInputEvent.getButtons()
getButtons(): Buttons

gets the mouse buttons currently pressed with this event

Returns: Buttons

the mouse buttons currently pressed for this event
Event.MouseWheelInputEvent.getDate()

inherited

getDate(): Date

Gets the Date this event occurred

Returns: Date

the event Date
Event.MouseWheelInputEvent.getEventType()

inherited

getEventType(): MouseInputType

gets the event type

Returns: MouseInputType

the type of mouse event
Event.MouseWheelInputEvent.getHandled()

inherited

getHandled(): boolean

Gets the handled state of the event

Returns: boolean

whether the event has been handled
Event.MouseWheelInputEvent.getModifiers()

inherited

getModifiers(): KeyModifiers

gets the event modifiers

Returns: KeyModifiers

bitwise combination of KeyModifiers
Event.MouseWheelInputEvent.getPosition()

inherited

getPosition(): Point2

gets the window position of the mouse pointer for this event

Returns: Point2

the mouse position for this event
Event.MouseWheelInputEvent.getWheelDelta()
getWheelDelta(): number

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: number

Wheel dela value
Event.MouseWheelInputEvent.setHandled()

inherited

setHandled(handled: boolean): void

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

Parameters

handled: boolean

Indicates whether this event has been handled.

Returns: void

Event.MouseWheelInputEvent.shiftDown()

inherited

shiftDown(): boolean

gets the state of the shift key

Returns: boolean

whether the shift key was down when this event was generated