Class WebXRInputSource
Hierarchy
- WebXRInputSource
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates the input source object
Parameters
-
_scene: Scene
the scene which the controller should be associated to
-
inputSource: XRInputSource
the underlying input source for the controller
-
Optional _options: IWebXRControllerOptions
options for this controller creation
Returns WebXRInputSource
-
Properties
Optional gripSearch playground for grip
Represents the part of the controller that is held. This may not exist if the controller is the head mounted display itself, if that's the case only the pointer from the head will be available
input
The underlying input source for the controller
Optional motion
If available, this is the gamepad object related to this controller. Using this object it is possible to get click events and trackpad changes of the webxr controller that is currently being used.
on
Event that fires when the controller is removed/disposed. The object provided as event data is this controller, after associated assets were disposed. uniqueId is still available.
on
Will be triggered when the mesh associated with the motion controller is done loading. It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh A shortened version of controller -> motion controller -> on mesh loaded.
on
Observers registered here will trigger when a motion controller profile was assigned to this xr controller
pointerSearch playground for pointer
Pointer which can be used to select objects or attach a visible laser to
Accessors
unique
-
Get this controllers unique id
Returns string
Methods
disposeSearch playground for dispose
-
Disposes of the object
Returns void
get
-
Gets a world space ray coming from the pointer or grip
Parameters
-
result: Ray
the resulting ray
-
Optional gripIfAvailable: boolean
use the grip mesh instead of the pointer, if available
Returns void
-
update
-
Updates the controller pose based on the given XRFrame
Parameters
-
xrFrame: XRFrame
xr frame to update the pose with
-
referenceSpace: XRReferenceSpace
reference space to use
-
xrCamera: WebXRCamera
the xr camera, used for parenting
Returns void
-
Represents an XR controller