Class WebXRManager

JavaScript events for custom objects

Example

// Adding events to a custom object
class Car extends EventDispatcher {
  start() {
    this.dispatchEvent( { type: 'start', message: 'vroom vroom!' } );
  }
};
// Using events with the custom object
const car = new Car();
car.addEventListener( 'start', ( event ) => {
  alert( event.message );
} );
car.start();

See

Hierarchy (view full)

Constructors

constructor

Properties

cameraAutoUpdate enabled isPresenting

Methods

addEventListener dispatchEvent dispose getBaseLayer getBinding getCamera getController getControllerGrip getFoveation getFrame getHand getReferenceSpace getSession hasEventListener removeEventListener setAnimationLoop setFoveation setFramebufferScaleFactor setReferenceSpace setReferenceSpaceType setSession updateCamera

Constructors

constructor

Properties

cameraAutoUpdate

cameraAutoUpdate: boolean

Default

true

enabled

enabled: boolean

Default

false

isPresenting

isPresenting: boolean

Default

false

Methods

addEventListener

dispatchEvent

dispose

  • dispose(): void

  • Returns void

getBaseLayer

  • getBaseLayer(): XRWebGLLayer | XRProjectionLayer

  • Returns XRWebGLLayer | XRProjectionLayer

getBinding

  • getBinding(): XRWebGLBinding

  • Returns XRWebGLBinding

getCamera

getController

  • getController(index): XRTargetRaySpace

  • Parameters

    • index: number

    Returns XRTargetRaySpace

getControllerGrip

  • getControllerGrip(index): XRGripSpace

  • Parameters

    • index: number

    Returns XRGripSpace

getFoveation

  • getFoveation(): undefined | number

  • Returns undefined | number

getFrame

  • getFrame(): XRFrame

  • Returns XRFrame

getHand

  • getHand(index): XRHandSpace

  • Parameters

    • index: number

    Returns XRHandSpace

getReferenceSpace

  • getReferenceSpace(): null | XRReferenceSpace

  • Returns null | XRReferenceSpace

getSession

  • getSession(): null | XRSession

  • Returns null | XRSession

hasEventListener

removeEventListener

setAnimationLoop

  • setAnimationLoop(callback): void

  • Parameters

    • callback: null | XRFrameRequestCallback

    Returns void

setFoveation

  • setFoveation(value): void

  • Parameters

    • value: number

    Returns void

setFramebufferScaleFactor

  • setFramebufferScaleFactor(value): void

  • Parameters

    • value: number

    Returns void

setReferenceSpace

  • setReferenceSpace(value): void

  • Parameters

    • value: XRReferenceSpace

    Returns void

setReferenceSpaceType

  • setReferenceSpaceType(value): void

  • Parameters

    • value: XRReferenceSpaceType

    Returns void

setSession

  • setSession(value): Promise<void>

  • Parameters

    • value: null | XRSession

    Returns Promise<void>

updateCamera

  • updateCamera(camera): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

constructorcameraAutoUpdateenabledisPresentingaddEventListenerdispatchEventdisposegetBaseLayergetBindinggetCameragetControllergetControllerGripgetFoveationgetFramegetHandgetReferenceSpacegetSessionhasEventListenerremoveEventListenersetAnimationLoopsetFoveationsetFramebufferScaleFactorsetReferenceSpacesetReferenceSpaceTypesetSessionupdateCamera