Skip to main content

Class: Input

Defined in: src/input/Input.ts:41

Holds physical input sources and samples their current state each frame.

Constructors​

Constructor​

new Input(): Input

Returns​

Input

Properties​

activeControllers​

activeControllers: ActiveControllers

Defined in: src/input/Input.ts:60

controllerGrips​

controllerGrips: Group<Object3DEventMap>[] = []

Defined in: src/input/Input.ts:44

controllers​

controllers: Controller[] = []

Defined in: src/input/Input.ts:43

controllersEnabled​

controllersEnabled: boolean = true

Defined in: src/input/Input.ts:52

gamepadController​

gamepadController: GamepadController

Defined in: src/input/Input.ts:51

gazeController​

gazeController: GazeController

Defined in: src/input/Input.ts:49

hands​

hands: XRHandSpace[] = []

Defined in: src/input/Input.ts:45

headGestures?​

optional headGestures: HeadGestureRecognition

Defined in: src/input/Input.ts:47

Completed head gestures, when enabled before initialization.

leftController?​

optional leftController: Controller

Defined in: src/input/Input.ts:61

listeners​

listeners: Map<any, any>

Defined in: src/input/Input.ts:53

mouseController​

mouseController: MouseController

Defined in: src/input/Input.ts:50

options​

options: Options

Defined in: src/input/Input.ts:42

pivotsEnabled​

pivotsEnabled: boolean = false

Defined in: src/input/Input.ts:48

reticles​

reticles: Reticles

Defined in: src/input/Input.ts:63

rightController?​

optional rightController: Controller

Defined in: src/input/Input.ts:62

Methods​

addObject()​

addObject(obj): void

Defined in: src/input/Input.ts:191

Adds an object to both controllers by creating a new group and cloning it.

Parameters​

obj​

Object3D

The object to add to each controller.

Returns​

void

addReticles()​

addReticles(): void

Defined in: src/input/Input.ts:217

Adds reticles to the controllers and scene, with initial visibility set to false.

Returns​

void

bindKeyDown()​

bindKeyDown(event): void

Defined in: src/input/Input.ts:397

Parameters​

event​

(event) => void

Returns​

void

bindKeyUp()​

bindKeyUp(event): void

Defined in: src/input/Input.ts:403

Parameters​

event​

(event) => void

Returns​

void

bindListener()​

bindListener(listenerName, listener): void

Defined in: src/input/Input.ts:309

Binds a listener to both controllers.

Parameters​

listenerName​

keyof ControllerEventMap

Event name

listener​

(event) => void

Function to call

Returns​

void

bindSelect()​

bindSelect(event): void

Defined in: src/input/Input.ts:372

Binds an event listener to handle 'select' events for both controllers.

Parameters​

event​

(event) => void

The event listener function.

Returns​

void

bindSelectEnd()​

bindSelectEnd(event): void

Defined in: src/input/Input.ts:364

Binds an event listener to handle 'selectend' events for both controllers.

Parameters​

event​

(event) => void

The event listener function.

Returns​

void

bindSelectStart()​

bindSelectStart(event): void

Defined in: src/input/Input.ts:356

Binds an event listener to handle 'selectstart' events for both controllers.

Parameters​

event​

(event) => void

The event listener function.

Returns​

void

bindSqueeze()​

bindSqueeze(event): void

Defined in: src/input/Input.ts:393

Parameters​

event​

(event) => void

Returns​

void

bindSqueezeEnd()​

bindSqueezeEnd(event): void

Defined in: src/input/Input.ts:389

Binds an event listener to handle 'squeezeend' events for both controllers.

Parameters​

event​

(event) => void

The event listener function.

Returns​

void

bindSqueezeStart()​

bindSqueezeStart(event): void

Defined in: src/input/Input.ts:381

Binds an event listener to handle 'squeezestart' events for both controllers.

Parameters​

event​

(event) => void

The event listener function.

Returns​

void

defaultOnConnected()​

defaultOnConnected(event): void

Defined in: src/input/Input.ts:262

Parameters​

event​

ControllerEvent

Returns​

void

defaultOnDisconnected()​

defaultOnDisconnected(event): void

Defined in: src/input/Input.ts:277

Parameters​

event​

ControllerEvent

Returns​

void

defaultOnSelectEnd()​

defaultOnSelectEnd(event): void

Defined in: src/input/Input.ts:244

Default action to handle the end of a selection, setting the selecting state to false.

Parameters​

event​

ControllerEvent

Returns​

void

defaultOnSelectStart()​

defaultOnSelectStart(event): void

Defined in: src/input/Input.ts:235

Default action to handle the start of a selection, setting the selecting state to true.

Parameters​

event​

ControllerEvent

Returns​

void

defaultOnSqueezeEnd()​

defaultOnSqueezeEnd(event): void

Defined in: src/input/Input.ts:256

Parameters​

event​

ControllerEvent

Returns​

void

defaultOnSqueezeStart()​

defaultOnSqueezeStart(event): void

Defined in: src/input/Input.ts:250

Parameters​

event​

ControllerEvent

Returns​

void

disableController()​

disableController(controller): void

Defined in: src/input/Input.ts:530

Parameters​

controller​

Controller

Returns​

void

disableControllers()​

disableControllers(): void

Defined in: src/input/Input.ts:535

Returns​

void

disableGazeController()​

disableGazeController(): void

Defined in: src/input/Input.ts:507

Returns​

void

dispatchEvent()​

dispatchEvent(event): void

Defined in: src/input/Input.ts:340

Parameters​

event​

ControllerEvent

Returns​

void

dispose()​

dispose(): void

Defined in: src/input/Input.ts:551

Returns​

void

enableController()​

enableController(controller): void

Defined in: src/input/Input.ts:524

Parameters​

controller​

Controller

Returns​

void

enableControllers()​

enableControllers(): void

Defined in: src/input/Input.ts:547

Returns​

void

enableGazeController()​

enableGazeController(): void

Defined in: src/input/Input.ts:502

Returns​

void

enablePivots()​

enablePivots(): void

Defined in: src/input/Input.ts:204

Creates a pivot point for each hand, primarily used as a reference point.

Returns​

void

get()​

get(id): Object3D

Defined in: src/input/Input.ts:183

Retrieves the controller object by its ID.

Parameters​

id​

number

The ID of the controller.

Returns​

Object3D

The controller with the specified ID.

getFrame()​

getFrame(): InteractionFrameInput

Defined in: src/input/Input.ts:432

Returns the complete physical source state sampled this frame.

Returns​

InteractionFrameInput

init()​

init(__namedParameters): void

Defined in: src/input/Input.ts:78

Initializes physical input sources. Only called by Core.

Parameters​

__namedParameters​
options​

Options

renderer​

WebGLRenderer

systemsGroup​

XRSystems

Returns​

void

sampleSources()​

sampleSources(): void

Defined in: src/input/Input.ts:420

Samples current controller, button, and direct-touch state.

Returns​

void

unbindKeyDown()​

unbindKeyDown(event): void

Defined in: src/input/Input.ts:409

Parameters​

event​

(event) => void

Returns​

void

unbindKeyUp()​

unbindKeyUp(event): void

Defined in: src/input/Input.ts:414

Parameters​

event​

(event) => void

Returns​

void

unbindListener()​

unbindListener(listenerName, listener): void

Defined in: src/input/Input.ts:322

Parameters​

listenerName​

keyof ControllerEventMap

listener​

(event) => void

Returns​

void