WebXRMicrosoftMixedRealityController

The motion controller class for all microsoft mixed reality controllers

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground

Properties

components

Find examples in Playground
components: object

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

Type declaration

gamepadObject

Find examples in Playground

The gamepad object correlating to this controller

handness

Find examples in Playground

handness (left/right/none) of this controller

onModelLoadedObservable

Find examples in Playground
onModelLoadedObservable: Observable<WebXRAbstractMotionController>

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

profileId

Find examples in Playground
profileId: string

rootMesh

Find examples in Playground

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

Static ComponentType

Find examples in Playground
ComponentType: object

Component type map

Type declaration

  • BUTTON: string
  • SQUEEZE: string
  • THUMBSTICK: string
  • TOUCHPAD: string
  • TRIGGER: string

Static MODEL_BASE_URL

Find examples in Playground
MODEL_BASE_URL: string

The base url used to load the left and right controller models

Static MODEL_LEFT_FILENAME

Find examples in Playground
MODEL_LEFT_FILENAME: string

The name of the left controller model file

Static MODEL_RIGHT_FILENAME

Find examples in Playground
MODEL_RIGHT_FILENAME: string

The name of the right controller model file

Methods

dispose

Find examples in Playground
  • dispose(): void

getComponent

Find examples in Playground

getComponentTypes

Find examples in Playground
  • getComponentTypes(): string[]

getMainComponent

Find examples in Playground

loadModel

Find examples in Playground
  • 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

updateFromXRFrame

Find examples in Playground
  • updateFromXRFrame(xrFrame: XRFrame): void

Generated using TypeDoc