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

enabled isPresenting cameraAutoUpdate

Methods

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

Constructors

constructor

Properties

enabled

enabled: boolean

Default

false

isPresenting

isPresenting: boolean

Default

false

cameraAutoUpdate

cameraAutoUpdate: boolean

Default

true

Methods

getController

getControllerGrip

getHand

setFramebufferScaleFactor

  • setFramebufferScaleFactor(value): void

  • Parameters

    • value: number

    Returns void

setReferenceSpaceType

  • setReferenceSpaceType(value): void

  • Parameters

    • value: XRReferenceSpaceType

    Returns void

getReferenceSpace

  • getReferenceSpace(): XRReferenceSpace

  • Returns XRReferenceSpace

setReferenceSpace

  • setReferenceSpace(value): void

  • Parameters

    • value: XRReferenceSpace

    Returns void

getBaseLayer

  • getBaseLayer(): XRWebGLLayer | XRProjectionLayer

  • Returns XRWebGLLayer | XRProjectionLayer

getBinding

  • getBinding(): XRWebGLBinding

  • Returns XRWebGLBinding

getFrame

  • getFrame(): XRFrame

  • Returns XRFrame

getSession

  • getSession(): XRSession

  • Returns XRSession

setSession

  • setSession(value): Promise<void>

  • Parameters

    • value: XRSession

    Returns Promise<void>

getCamera

updateCamera

setAnimationLoop

  • setAnimationLoop(callback): void

  • Parameters

    • callback: XRFrameRequestCallback

    Returns void

getFoveation

  • getFoveation(): number

  • Returns number

setFoveation

  • setFoveation(value): void

  • Parameters

    • value: number

    Returns void

dispose

  • dispose(): void

  • Returns void

addEventListener

hasEventListener

removeEventListener

dispatchEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods