Class WebXRManager

JavaScript events for custom objects

Source

src/core/EventDispatcher.js

Hierarchy

EventDispatcher
- WebXRManager

Constructors

constructor

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

Properties

cameraAutoUpdate

cameraAutoUpdate: boolean

Default

true

enabled

enabled: boolean

Default

false

isPresenting

isPresenting: boolean

Default

false

Methods

addEventListener

addEventListener<T>(type: T, listener: EventListener<Event, T, WebXRManager>): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, 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:30

dispatchEvent

dispatchEvent(event: Event): void
Fire an event type.
Parameters
- event: Event
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:50

dispose

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

getBaseLayer

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

getBinding

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

getCamera

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

getController

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

getControllerGrip

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

getFoveation

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

getFrame

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

getHand

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

getReferenceSpace

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

getSession

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

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Event, T, WebXRManager>): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, 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:37

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Event, T, WebXRManager>): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, 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:44

setAnimationLoop

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

setFoveation

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

setFramebufferScaleFactor

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

setReferenceSpace

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

setReferenceSpaceType

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

setSession

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

updateCamera

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

Generated using TypeDoc