Class Input

The input system is responsible for handling all input events like pointer events (mouse, touch, xr controllers) and keyboard events.

Implements

IInput

Accessors

mouseClick

get mouseClick(): boolean
Returns boolean

mouseDoubleClick

get mouseDoubleClick(): boolean
Returns boolean

mouseDown

get mouseDown(): boolean
Returns boolean

mousePosition

get mousePosition(): Vector2
Returns Vector2

mousePositionRC

get mousePositionRC(): Vector2
Returns Vector2

mousePressed

get mousePressed(): boolean
Returns boolean

mouseUp

get mouseUp(): boolean
Returns boolean

mouseWheelChanged

get mouseWheelChanged(): boolean
Returns boolean

Methods

addEventListener

addEventListener(type, callback, options?): void
Adds an event listener for the specified event type. The callback will be called when the event is triggered.
Parameters
- type: InputEvents | InputEventNames
  The event type to listen for
- callback: InputEventListener
  The callback to call when the event is triggered
- Optionaloptions: EventListenerOptions
  The options for adding the event listener
Returns void

bindEvents

bindEvents(): void
Returns void

convertScreenspaceToRaycastSpace

convertScreenspaceToRaycastSpace<T>(vec2): T
Type Parameters
- T extends Vec2 | Vector2
Parameters
- vec2: T
Returns T
Implementation of IInput.convertScreenspaceToRaycastSpace

createInputEvent

createInputEvent(args): void
Parameters
- args: NEPointerEvent
Returns void

dispose

dispose(): void
Returns void

foreachPointerId

foreachPointerId(pointerType?): Generator<number, any, unknown>
Parameters
- OptionalpointerType: string | string[] | PointerType[]
Returns Generator<number, any, unknown>

foreachTouchId

foreachTouchId(): Generator<number, any, unknown>
Returns Generator<number, any, unknown>

getFirstPressedButtonForPointer

getFirstPressedButtonForPointer(pointerId): undefined | number
the first button that was down and is currently pressed
Parameters
- pointerId: number
Returns undefined | number

getIsMouse

getIsMouse(i): boolean
Parameters
- i: number
Returns boolean

getIsPointerIdInUse

getIsPointerIdInUse(pointerId): boolean
Check if a pointer id is currently used.
Parameters
- pointerId: number
Returns boolean

getIsTouch

getIsTouch(i): boolean
Parameters
- i: number
Returns boolean

getKeyDown

getKeyDown(): null | string
Returns null | string

getKeyPressed

getKeyPressed(): null | string
Returns null | string

getLatestPressedButtonForPointer

getLatestPressedButtonForPointer(pointerId): undefined | number
the last (most recent) button that was down and is currently pressed
Parameters
- pointerId: number
Returns undefined | number

getMouseWheelChanged

getMouseWheelChanged(i?): boolean
Parameters
- i: number = 0
Returns boolean

getMouseWheelDeltaY

getMouseWheelDeltaY(i?): number
Parameters
- i: number = 0
Returns number

getPointerClicked

getPointerClicked(i): boolean
Parameters
- i: number
Returns boolean

getPointerDoubleClicked

getPointerDoubleClicked(i): boolean
Parameters
- i: number
Returns boolean

getPointerDown

getPointerDown(i): boolean
Parameters
- i: number
Returns boolean

getPointerDownTime

getPointerDownTime(i): number
Parameters
- i: number
Returns number

getPointerEvent

getPointerEvent(i): undefined | Event
Parameters
- i: number
Returns undefined | Event

getPointerLongPress

getPointerLongPress(i): boolean
Parameters
- i: number
Returns boolean

getPointerPosition

getPointerPosition(i): null | Vector2
Gets the position of the given pointer index in pixel
Parameters
- i: number
  The pointer index
Returns null | Vector2
The position of the pointer in pixel

Implementation of IInput.getPointerPosition

getPointerPositionDelta

getPointerPositionDelta(i): null | Vector2
Parameters
- i: number
Returns null | Vector2

getPointerPositionLastFrame

getPointerPositionLastFrame(i): null | Vector2
Parameters
- i: number
Returns null | Vector2

getPointerPositionRC

getPointerPositionRC(i): null | Vector2
Parameters
- i: number
Returns null | Vector2

getPointerPressed

getPointerPressed(i): boolean
Parameters
- i: number
Returns boolean

getPointerPressedCount

getPointerPressedCount(): number
how many pointers are currently pressed

Returns number

getPointerUp

getPointerUp(i): boolean
Parameters
- i: number
Returns boolean

getPointerUpTime

getPointerUpTime(i): number
Parameters
- i: number
Returns number

getTouchesPressedCount

getTouchesPressedCount(): number
Returns number

isKeyDown

isKeyDown(keyCode): boolean
Parameters
- keyCode: string
Returns boolean

isKeyPressed

isKeyPressed(keyCode): boolean
Parameters
- keyCode: string
Returns boolean

isKeyUp

isKeyUp(keyCode): boolean
Parameters
- keyCode: string
Returns boolean

removeEventListener

removeEventListener(type, callback, options?): void
Removes the event listener from the specified event type. If no queue is specified the listener will be removed from all queues.
Parameters
- type: InputEvents | InputEventNames
  The event type to remove the listener from
- callback: InputEventListener
  The callback to remove
- Optionaloptions: EventListenerOptions
  The options for removing the event listener
Returns void

setCursorNormal

setCursorNormal(): void
Returns void

setCursorPointer

setCursorPointer(): void
Returns void

unbindEvents

unbindEvents(): void
Returns void