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)

EventDispatcher<WebXRManagerEventMap>
- WebXRManager

Constructors

constructor

new WebXRManager(renderer, gl): WebXRManager
Parameters
- renderer: WebGLRenderer
- gl: WebGLRenderingContext
Returns WebXRManager
Overrides EventDispatcher.constructor
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:25

Properties

enabled

enabled: boolean

Default

false

isPresenting

isPresenting: boolean

Default

false

cameraAutoUpdate

cameraAutoUpdate: boolean

Default

true

Methods

getController

getController(index): XRTargetRaySpace
Parameters
- index: number
Returns XRTargetRaySpace
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:42

getControllerGrip

getControllerGrip(index): XRGripSpace
Parameters
- index: number
Returns XRGripSpace
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:44

getHand

getHand(index): XRHandSpace
Parameters
- index: number
Returns XRHandSpace
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:46

setFramebufferScaleFactor

setFramebufferScaleFactor(value): void
Parameters
- value: number
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:48

setReferenceSpaceType

setReferenceSpaceType(value): void
Parameters
- value: XRReferenceSpaceType
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:50

getReferenceSpace

getReferenceSpace(): null | XRReferenceSpace
Returns null | XRReferenceSpace
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:52

setReferenceSpace

setReferenceSpace(value): void
Parameters
- value: XRReferenceSpace
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:54

getBaseLayer

getBaseLayer(): XRWebGLLayer | XRProjectionLayer
Returns XRWebGLLayer | XRProjectionLayer
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:56

getBinding

getBinding(): XRWebGLBinding
Returns XRWebGLBinding
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:58

getFrame

getFrame(): XRFrame
Returns XRFrame
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:60

getSession

getSession(): null | XRSession
Returns null | XRSession
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:62

setSession

setSession(value): Promise<void>
Parameters
- value: null | XRSession
Returns Promise<void>
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:64

getCamera

getCamera(): WebXRArrayCamera
Returns WebXRArrayCamera
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:66

updateCamera

updateCamera(camera): void
Parameters
- camera: PerspectiveCamera
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:68

setAnimationLoop

setAnimationLoop(callback): void
Parameters
- callback: null | XRFrameRequestCallback
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:70

getFoveation

getFoveation(): undefined | number
Returns undefined | number
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:72

setFoveation

setFoveation(value): void
Parameters
- value: number
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:74

dispose

dispose(): void
Returns void
- Defined in node_modules/@types/three/src/renderers/webxr/WebXRManager.d.ts:76

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof WebXRManagerEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<WebXRManagerEventMap[T], T, WebXRManager>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebXRManager>
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:56

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof WebXRManagerEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<WebXRManagerEventMap[T], T, WebXRManager>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebXRManager>
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:67

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof WebXRManagerEventMap
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<WebXRManagerEventMap[T], T, WebXRManager>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, WebXRManager>
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:78

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof WebXRManagerEventMap
Parameters
- event: BaseEvent<T> & WebXRManagerEventMap[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:84

Class WebXRManager

Example

See

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WebXRManager

Properties

enabled

Default

isPresenting

Default

cameraAutoUpdate

Default

Methods

getController

Parameters

Returns XRTargetRaySpace

getControllerGrip

Parameters

Returns XRGripSpace

getHand

Parameters

Returns XRHandSpace

setFramebufferScaleFactor

Parameters

Returns void

setReferenceSpaceType

Parameters

Returns void

getReferenceSpace

Returns null | XRReferenceSpace

setReferenceSpace

Parameters

Returns void

getBaseLayer

Returns XRWebGLLayer | XRProjectionLayer

getBinding

Returns XRWebGLBinding

getFrame

Returns XRFrame

getSession

Returns null | XRSession

setSession

Parameters

Returns Promise<void>

getCamera

Returns WebXRArrayCamera

updateCamera

Parameters

Returns void

setAnimationLoop

Parameters

Returns void

getFoveation

Returns undefined | number

setFoveation

Parameters

Returns void

dispose

Returns void

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean