Class: Input
Defined in: src/input/Input.ts:53
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:87
controllerGrips
controllerGrips:
Group<Object3DEventMap>[] =[]
Defined in: src/input/Input.ts:56
controllers
controllers:
Controller[] =[]
Defined in: src/input/Input.ts:55
controllersEnabled
controllersEnabled:
boolean=true
Defined in: src/input/Input.ts:74
gamepadController
gamepadController:
GamepadController
Defined in: src/input/Input.ts:65
gazeController
gazeController:
GazeController
Defined in: src/input/Input.ts:63
hands
hands:
XRHandSpace[] =[]
Defined in: src/input/Input.ts:57
headGestures?
optionalheadGestures:HeadGestureRecognition
Defined in: src/input/Input.ts:61
Completed head gestures, when enabled before initialization.
leftController?
optionalleftController:Controller
Defined in: src/input/Input.ts:88
listeners
listeners:
Map<any,any>
Defined in: src/input/Input.ts:75
mouseController
mouseController:
MouseController
Defined in: src/input/Input.ts:64
options
options:
Options
Defined in: src/input/Input.ts:54
pivotsEnabled
pivotsEnabled:
boolean=false
Defined in: src/input/Input.ts:62
reticles
reticles:
Reticles
Defined in: src/input/Input.ts:90
rightController?
optionalrightController:Controller
Defined in: src/input/Input.ts:89
Methods
addObject()
addObject(
obj):void
Defined in: src/input/Input.ts:239
Adds an object to both controllers by creating a new group and cloning it.
Parameters
obj
The object to add to each controller.
Returns
void
addReticles()
addReticles():
void
Defined in: src/input/Input.ts:265
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:569
Parameters
event
(event) => void
Returns
void
bindKeyUp()
bindKeyUp(
event):void
Defined in: src/input/Input.ts:577
Parameters
event
(event) => void
Returns
void
bindListener()
bindListener(
listenerName,listener):void
Defined in: src/input/Input.ts:472
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:544
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:536
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:528
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:565
Parameters
event
(event) => void
Returns
void
bindSqueezeEnd()
bindSqueezeEnd(
event):void
Defined in: src/input/Input.ts:561
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:553
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:332
Parameters
event
ControllerEvent
Returns
void
defaultOnDisconnected()
defaultOnDisconnected(
event):void
Defined in: src/input/Input.ts:364
Parameters
event
ControllerEvent
Returns
void
defaultOnSelectEnd()
defaultOnSelectEnd(
event):void
Defined in: src/input/Input.ts:314
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:305
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:326
Parameters
event
ControllerEvent
Returns
void
defaultOnSqueezeStart()
defaultOnSqueezeStart(
event):void
Defined in: src/input/Input.ts:320
Parameters
event
ControllerEvent
Returns
void
disableController()
disableController(
controller):void
Defined in: src/input/Input.ts:840
Parameters
controller
Returns
void
disableControllers()
disableControllers():
void
Defined in: src/input/Input.ts:923
Returns
void
disableGazeController()
disableGazeController():
void
Defined in: src/input/Input.ts:744
Returns
void
dispatchEvent()
dispatchEvent(
event):void
Defined in: src/input/Input.ts:504
Parameters
event
ControllerEvent
Returns
void
dispose()
dispose():
void
Defined in: src/input/Input.ts:941
Returns
void
enableController()
enableController(
controller):void
Defined in: src/input/Input.ts:833
Parameters
controller
Returns
void
enableControllers()
enableControllers():
void
Defined in: src/input/Input.ts:937
Returns
void
enableGazeController()
enableGazeController():
void
Defined in: src/input/Input.ts:739
Returns
void
enablePivots()
enablePivots():
void
Defined in: src/input/Input.ts:252
Creates a pivot point for each hand, primarily used as a reference point.
Returns
void
get()
get(
id):Controller|undefined
Defined in: src/input/Input.ts:231
Retrieves the controller object by its ID.
Parameters
id
number
The ID of the controller.
Returns
Controller | undefined
The controller with the specified ID, or undefined after removal.
getFrame()
getFrame():
InteractionFrameInput
Defined in: src/input/Input.ts:622
Returns the complete physical source state sampled this frame.
Returns
InteractionFrameInput
init()
init(
__namedParameters):void
Defined in: src/input/Input.ts:106
Initializes physical input sources. Only called by Core.
Parameters
__namedParameters
options
renderer
systemsGroup
XRSystems
Returns
void
removeController()
removeController(
controller):void
Defined in: src/input/Input.ts:850
Permanently unregisters a source added through enableController. Built-ins and already-removed sources are ignored. Capture is cancelled as source-lost next frame; terminal selectend/disconnected notifications are sent once.
Parameters
controller
Returns
void
sampleSources()
sampleSources():
void
Defined in: src/input/Input.ts:600
Samples current controller, button, and direct-touch state.
Returns
void
setReticleConfigurer()
setReticleConfigurer(
configurer):void
Defined in: src/input/Input.ts:286
Sets a configuration callback for reticles (such as upgrading to WebGPU materials) and immediately applies it to all existing reticles.
Parameters
configurer
(reticle) => void
Returns
void
unbindKeyDown()
unbindKeyDown(
event):void
Defined in: src/input/Input.ts:585
Parameters
event
(event) => void
Returns
void
unbindKeyUp()
unbindKeyUp(
event):void
Defined in: src/input/Input.ts:592
Parameters
event
(event) => void
Returns
void
unbindListener()
unbindListener(
listenerName,listener):void
Defined in: src/input/Input.ts:486
Parameters
listenerName
keyof ControllerEventMap
listener
(event) => void
Returns
void