Class WebXRAbstractMotionController
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
constructs a new abstract motion controller
Parameters
-
scene: Scene
the scene to which the model of the controller will be added
-
layout: IMotionControllerLayout
The profile layout to load
-
gamepadObject: IMinimalMotionControllerObject
The gamepad object correlating to this controller
-
handedness: MotionControllerHandedness
handedness (left/right/none) of this controller
-
Optional _doNotLoadControllerMesh: boolean
set this flag to ignore the mesh loading
-
Optional _controllerCache: { filename: string; meshes: AbstractMesh[]; path: string }[] | undefined
a cache holding controller models already loaded in this session
Returns WebXRAbstractMotionController
-
Properties
Readonly componentsSearch playground for components
A map of components (WebXRControllerComponent) in this motion controller Components have a ComponentType and can also have both button and axis definitions
Type declaration
-
[id: string]: WebXRControllerComponent
disable
Disable the model's animation. Can be set at any time.
gamepad
The gamepad object correlating to this controller
handednessSearch playground for handedness
handedness (left/right/none) of this controller
on
Observers registered here will be triggered when the model of this controller is done loading
Abstract profile
The profile id of this motion controller
root
The root mesh of the model. It is null if the model was not yet initialized
Accessors
handness
-
Backwards compatibility due to a deeply-integrated typo
Returns MotionControllerHandedness
Methods
disposeSearch playground for dispose
-
Dispose this controller, the model mesh and all its components
Returns void
get
-
Returns all components of specific type
Parameters
-
type: MotionControllerComponentType
the type to search for
Returns WebXRControllerComponent[]
an array of components with this type
-
get
-
get a component based an its component id as defined in layout.components
Parameters
-
id: string
the id of the component
Returns WebXRControllerComponent
the component correlates to the id or undefined if not found
-
get
-
Get the list of components available in this motion controller
Returns string[]
an array of strings correlating to available components
get
-
Get the first component of specific type
Parameters
-
type: MotionControllerComponentType
type of component to find
Returns Nullable<WebXRControllerComponent>
a controller component or null if not found
-
get
-
Get the main (Select) component of this controller as defined in the layout
Returns WebXRControllerComponent
the main component of this controller
load
-
Loads the model correlating to this controller When the mesh is loaded, the onModelLoadedObservable will be triggered
Returns Promise<boolean>
A promise fulfilled with the result of the model loading
pulse
Parameters
-
value: number
the strength of the pulse in 0.0...1.0 range
-
duration: number
Duration of the pulse in milliseconds
-
Optional hapticActuatorIndex: number
optional index of actuator (will usually be 0)
Returns Promise<boolean>
a promise that will send true when the pulse has ended and false if the device doesn't support pulse or an error accrued
update
-
Update this model using the current XRFrame
Parameters
-
xrFrame: XRFrame
the current xr frame to use and update the model
Returns void
-
An Abstract Motion controller This class receives an xrInput and a profile layout and uses those to initialize the components Each component has an observable to check for changes in value and state