Class WebXRGenericTriggerMotionController

A generic trigger-only motion controller for WebXR

Hierarchy (View Summary)

WebXRAbstractMotionController
- WebXRGenericTriggerMotionController

Index

Constructors

constructor

new WebXRGenericTriggerMotionController(
    scene: Scene,
    gamepadObject: IMinimalMotionControllerObject,
    handedness: MotionControllerHandedness,
): WebXRGenericTriggerMotionController
Parameters
- scene: Scene
- gamepadObject: IMinimalMotionControllerObject
- handedness: MotionControllerHandedness
Returns WebXRGenericTriggerMotionController
Overrides WebXRAbstractMotionController.constructor
- Defined in packages/dev/core/src/XR/motionController/webXRGenericMotionController.ts:23

Properties

`Readonly`components

components: { [id: string]: WebXRControllerComponent } = {}

A map of components (WebXRControllerComponent) in this motion controller Components have a ComponentType and can also have both button and axis definitions

disableAnimation

disableAnimation: boolean = false

Disable the model's animation. Can be set at any time.

gamepadObject

gamepadObject: IMinimalMotionControllerObject

The gamepad object correlating to this controller

handedness

handedness: MotionControllerHandedness

handedness (left/right/none) of this controller

onModelLoadedObservable

onModelLoadedObservable: Observable<WebXRAbstractMotionController> = ...

Observers registered here will be triggered when the model of this controller is done loading

profileId

profileId: string = WebXRGenericTriggerMotionController.ProfileId

The profile id of this motion controller

rootMesh

rootMesh: Nullable<AbstractMesh>

The root mesh of the model. It is null if the model was not yet initialized

`Static`ProfileId

ProfileId: string = "generic-trigger"

Static version of the profile id of this controller

Accessors

handness

get handness(): MotionControllerHandedness
Backwards compatibility due to a deeply-integrated typo

Returns MotionControllerHandedness
Inherited from WebXRAbstractMotionController.handness
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:489

Methods

dispose

dispose(): void
Dispose this controller, the model mesh and all its components

Returns void
Inherited from WebXRAbstractMotionController.dispose
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:349

getAllComponentsOfType

getAllComponentsOfType(
type: MotionControllerComponentType,
): WebXRControllerComponent[]
Returns all components of specific type
Parameters
- type: MotionControllerComponentType
  the type to search for
Returns WebXRControllerComponent[]
an array of components with this type
Inherited from WebXRAbstractMotionController.getAllComponentsOfType
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:369

getComponent

getComponent(id: string): WebXRControllerComponent
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
Inherited from WebXRAbstractMotionController.getComponent
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:380

getComponentIds

getComponentIds(): string[]
Get the list of components available in this motion controller

Returns string[]
an array of strings correlating to available components
Inherited from WebXRAbstractMotionController.getComponentIds
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:388

getComponentOfType

getComponentOfType(
type: MotionControllerComponentType,
): Nullable<WebXRControllerComponent>
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
Inherited from WebXRAbstractMotionController.getComponentOfType
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:397

getHapticEffects

getHapticEffects(
hapticActuatorIndex?: number,
): readonly GamepadHapticEffectType[]
Gets the haptic effects reported as supported by an actuator. See https://playground.babylonjs.com/#ULVR1X#0 for an interactive example.
Parameters
- hapticActuatorIndex: number = 0
  index of the actuator (usually 0)
Returns readonly GamepadHapticEffectType[]
the effects reported by the actuator, or an empty array when effect discovery is unavailable

Throws
a RangeError when the actuator index is invalid
Inherited from WebXRAbstractMotionController.getHapticEffects
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:501

getMainComponent

getMainComponent(): WebXRControllerComponent
Get the main (Select) component of this controller as defined in the layout

Returns WebXRControllerComponent
the main component of this controller
Inherited from WebXRAbstractMotionController.getMainComponent
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:405

loadModel

loadModel(): Promise<boolean>
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
Inherited from WebXRAbstractMotionController.loadModel
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:415

playHapticEffectAsync

playHapticEffectAsync(
    effectType: GamepadHapticEffectType,
    parameters?: GamepadEffectParameters,
    hapticActuatorIndex?: number,
): Promise<GamepadHapticsResult>
Plays an advanced haptic effect on this controller.
Parameters
- effectType: GamepadHapticEffectType
  the standard Gamepad haptic effect to play
- Optionalparameters: GamepadEffectParameters
  effect duration, delay, and motor magnitudes
- hapticActuatorIndex: number = 0
  index of the actuator (usually 0)
Returns Promise<GamepadHapticsResult>
the native completion result from the actuator

Throws
an Error when the actuator or requested effect is unsupported, or a RangeError when the actuator index is invalid
Inherited from WebXRAbstractMotionController.playHapticEffectAsync
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:514

pulse

pulse(
    value: number,
    duration: number,
    hapticActuatorIndex?: number,
): Promise<boolean>

Pulse (vibrate) this controller If the controller does not support pulses, this function will fail silently and return Promise directly after called Consecutive calls to this function will cancel the last pulse call

Parameters

value: number
the strength of the pulse in 0.0...1.0 range
duration: number
Duration of the pulse in milliseconds
hapticActuatorIndex: number = 0
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

resetHapticActuatorAsync

resetHapticActuatorAsync(
hapticActuatorIndex?: number,
): Promise<GamepadHapticsResult>
Stops the active haptic effect on an actuator.
Parameters
- hapticActuatorIndex: number = 0
  index of the actuator (usually 0)
Returns Promise<GamepadHapticsResult>
the native completion result from the actuator

Throws
an Error when reset is unsupported, or a RangeError when the actuator index is invalid
Inherited from WebXRAbstractMotionController.resetHapticActuatorAsync
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:536

updateFromXRFrame

updateFromXRFrame(xrFrame: XRFrame): void
Update this model using the current XRFrame
Parameters
- xrFrame: XRFrame
  the current xr frame to use and update the model
Returns void
Inherited from WebXRAbstractMotionController.updateFromXRFrame
- Defined in packages/dev/core/src/XR/motionController/webXRAbstractMotionController.ts:479

Class WebXRGenericTriggerMotionController

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRGenericTriggerMotionController

Properties

Readonlycomponents

disableAnimation

gamepadObject

handedness

onModelLoadedObservable

profileId

rootMesh

StaticProfileId

Accessors

handness

Returns MotionControllerHandedness

Methods

dispose

Returns void

getAllComponentsOfType

Parameters

Returns WebXRControllerComponent[]

getComponent

Parameters

Returns WebXRControllerComponent

getComponentIds

Returns string[]

getComponentOfType

Parameters

Returns Nullable<WebXRControllerComponent>

getHapticEffects

Parameters

Returns readonly GamepadHapticEffectType[]

Throws

getMainComponent

Returns WebXRControllerComponent

loadModel

Returns Promise<boolean>

playHapticEffectAsync

Parameters

Returns Promise<GamepadHapticsResult>

Throws

pulse

Parameters

Returns Promise<boolean>

resetHapticActuatorAsync

Parameters

Returns Promise<GamepadHapticsResult>

Throws

updateFromXRFrame

Parameters

Returns void

Settings

On This Page

`Readonly`components

`Static`ProfileId