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 dispose enabled getBaseLayer getBinding getCamera getController getControllerGrip getDepthSensingMesh getDepthTexture getEnvironmentBlendMode getFoveation getFrame getHand getReferenceSpace getSession hasDepthSensing isPresenting setAnimationLoop setFoveation setFramebufferScaleFactor setReferenceSpace setReferenceSpaceType setSession updateCamera

Methods

addEventListener dispatchEvent hasEventListener removeEventListener

Constructors

constructor

Properties

cameraAutoUpdate

cameraAutoUpdate: boolean

Default

true

dispose

dispose: (() => void)

enabled

enabled: boolean

Default

false

getBaseLayer

getBaseLayer: (() => XRWebGLLayer | XRProjectionLayer)

getBinding

getBinding: (() => XRWebGLBinding)

getCamera

getCamera: (() => WebXRArrayCamera)

getController

getController: ((index: number) => XRTargetRaySpace)

getControllerGrip

getControllerGrip: ((index: number) => XRGripSpace)

getDepthSensingMesh

getDepthSensingMesh: (() => null | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>)

getDepthTexture

getDepthTexture: (() => null | Texture)

getEnvironmentBlendMode

getEnvironmentBlendMode: (() => undefined | XREnvironmentBlendMode)

getFoveation

getFoveation: (() => undefined | number)

getFrame

getFrame: (() => XRFrame)

getHand

getHand: ((index: number) => XRHandSpace)

getReferenceSpace

getReferenceSpace: (() => null | XRReferenceSpace)

getSession

getSession: (() => null | XRSession)

hasDepthSensing

hasDepthSensing: (() => boolean)

isPresenting

isPresenting: boolean

Default

false

setAnimationLoop

setAnimationLoop: ((callback: null | XRFrameRequestCallback) => void)

setFoveation

setFoveation: ((value: number) => void)

setFramebufferScaleFactor

setFramebufferScaleFactor: ((value: number) => void)

setReferenceSpace

setReferenceSpace: ((value: XRReferenceSpace) => void)

setReferenceSpaceType

setReferenceSpaceType: ((value: XRReferenceSpaceType) => void)

setSession

setSession: ((value: null | XRSession) => Promise<void>)

updateCamera

updateCamera: ((camera: PerspectiveCamera) => void)

Methods

addEventListener

dispatchEvent

hasEventListener

removeEventListener

Settings

Member Visibility

On This Page

Constructors
Properties
Methods