XRManagerAgent | g.frame

Hierarchy

XRManager
- XRManagerAgent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new XRManagerAgent(instances: Array<XRManager>): XRManagerAgent

Overrides XRManager.constructor
- Defined in packages/g.frame.common.xr_manager/src/XRManagerAgent.ts:4
Parameters
- instances: Array<XRManager>
Returns XRManagerAgent

Properties

__agentConstructor

__agentConstructor: Function

Protected controllerModel

controllerModel: IXRControllerModel

Protected currentXRControllerView

currentXRControllerView: IXRControllerView

Protected defaultXRControllerView

defaultXRControllerView: IXRControllerView

Protected renderer

renderer: WebGLRenderer

Methods

Protected createButton

createButton(): void

Inherited from XRManager.createButton
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:69
Creates "Enter VR" button

Returns void

fire

fire(eventName: XREvent, event?: ParentEvent<XREvent>): this

- Defined in packages/g.frame.common.xr_manager/src/XRManagerAgent.ts:9
Parameters
- eventName: XREvent
- Optional event: ParentEvent<XREvent>
Returns this

getCurrentView

getCurrentView(): IXRControllerView

Inherited from XRManager.getCurrentView
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:27
Returns current XR view

Returns IXRControllerView

getDefaultView

getDefaultView(): IXRControllerView

Inherited from XRManager.getDefaultView
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:34
Returns default XR view

Returns IXRControllerView

Protected goFromVR

goFromVR(): void

Inherited from XRManager.goFromVR
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:96
Function to add some business logic when exit XR

Returns void

Protected goToVR

goToVR(): void

Inherited from XRManager.goToVR
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:91
Function to add some business logic when enter XR

Returns void

Protected initEvents

initEvents(): void

Inherited from XRManager.initEvents
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:51
Adds event listeners for tracking XR session

Returns void

off

off(eventName?: XREvent, callback?: Function): this

- Defined in packages/g.frame.common.xr_manager/src/XRManagerAgent.ts:16
Parameters
- Optional eventName: XREvent
- Optional callback: Function
Returns this

on

on(eventName: XREvent, callback1?: Function, callback2?: Function): this

- Defined in packages/g.frame.common.xr_manager/src/XRManagerAgent.ts:23
Parameters
- eventName: XREvent
- Optional callback1: Function
- Optional callback2: Function
Returns this

once

once(eventName: XREvent, callback1?: Function, callback2?: Function): this

- Defined in packages/g.frame.common.xr_manager/src/XRManagerAgent.ts:30
Parameters
- eventName: XREvent
- Optional callback1: Function
- Optional callback2: Function
Returns this

Protected processInputSources

processInputSources(): void

Inherited from XRManager.processInputSources
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:77
Adds event listener on input source changing

Returns void

Protected resetInputSources

resetInputSources(): void

Inherited from XRManager.resetInputSources
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:106
Function to nullify input sources when they don't exist

Returns void

Protected setInputSources

setInputSources(inputSources: Array<XRInputSource>): void

Inherited from XRManager.setInputSources
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:101
Function to update input sources when changed

Parameters
- inputSources: Array<XRInputSource>
Returns void

setXRControllerView

setXRControllerView(newXRControllerView?: IXRControllerView): void

Inherited from XRManager.setXRControllerView
- Defined in packages/g.frame.common.xr_manager/src/XRManager.ts:43
Replaces current XR view by another. If the view doesn't exist, default view will be setted. Each default view is different for every type of a device!

Parameters
- Optional newXRControllerView: IXRControllerView
Returns void

Generated using TypeDoc