Skip to content

@tmrw-realityos/world


@tmrw-realityos/world / Input

Class: Input

Defined in: input.ts:6

Input handing

Constructors

Constructor

new Input(): Input

Returns

Input

Properties

boundOnContext()?

optional boundOnContext: (e) => void

Defined in: input.ts:19

Parameters

e

Event

Returns

void


boundOnKey()?

optional boundOnKey: (e) => void

Defined in: input.ts:18

Parameters

e

KeyboardEvent

Returns

void


boundOnMouse()?

optional boundOnMouse: (e) => boolean

Defined in: input.ts:16

Parameters

e

PointerEvent

Returns

boolean


boundOnWheel()?

optional boundOnWheel: (e) => void

Defined in: input.ts:17

Parameters

e

WheelEvent

Returns

void


boundTarget?

optional boundTarget: HTMLElement

Defined in: input.ts:14


deltaPosition

deltaPosition: number[]

Defined in: input.ts:8


deltaWheel

deltaWheel: number = 0

Defined in: input.ts:11


mouseDownPosition

mouseDownPosition: number[]

Defined in: input.ts:9


mousePosition

mousePosition: number[]

Defined in: input.ts:7


mouseState

mouseState: number = 0

Defined in: input.ts:10


onKey()?

optional onKey: (e) => boolean

Defined in: input.ts:24

Parameters

e

KeyboardEvent

Returns

boolean


onMouse()?

optional onMouse: (e) => boolean

Defined in: input.ts:22

Parameters

e

PointerEvent

Returns

boolean


onWheel()?

optional onWheel: (e) => boolean

Defined in: input.ts:23

Parameters

e

WheelEvent

Returns

boolean

Methods

bindEvents()

bindEvents(target): void

Defined in: input.ts:31

Attaches input events to DOM. Keydown and keyup will be attached to document.body.

Parameters

target

HTMLElement

element to attach pointer events

Returns

void


isKeyPressed()

isKeyPressed(code): boolean

Defined in: input.ts:126

Parameters

code

string

Returns

boolean


processKey()

processKey(e): void

Defined in: input.ts:121

Parameters

e

KeyboardEvent

Returns

void


processMouse()

processMouse(e): boolean

Defined in: input.ts:97

Parameters

e

PointerEvent

Returns

boolean


processWheel()

processWheel(e): void

Defined in: input.ts:115

Parameters

e

WheelEvent

Returns

void


unbindEvents()

unbindEvents(): void

Defined in: input.ts:57

Removes event listeners from the target element

Returns

void


update()

update(): void

Defined in: input.ts:90

Returns

void