API reference @voxolith/engine/inputInterfaces

Gestures

A running recogniser, from recogniseGestures.

Defined in: engine/src/input/gestures.ts:137

Methods

dispose()

dispose(): void;

Defined in: engine/src/input/gestures.ts:145

Stop listening to the input.

Returns

void

dragging()

dragging(): boolean;

Defined in: engine/src/input/gestures.ts:139

This recogniser is dragging at least one pointer.

Returns

boolean

pinching()

pinching(): boolean;

Defined in: engine/src/input/gestures.ts:141

A two-finger pinch is under way.

Returns

boolean

setEnabled()

setEnabled(on: boolean): void;

Defined in: engine/src/input/gestures.ts:143

Disabling ends any drag (as cancelled) and pinch, and ignores input until re-enabled.

Parameters

Parameter	Type
`on`	`boolean`

Returns

void

GestureOptions

Tuning for recogniseGestures. Distances in CSS pixels, times in milliseconds.

Input

The input for one surface, made by createInput. It owns every listener; gestures, actions, touch controls and camera controllers read from it rather than adding their own.

On this page

Methods dispose()Returns dragging()Returns pinching()Returns setEnabled()Parameters Returns