Class VirtualSession

Virtual session

See the ngx3js docs page for details.

Hierarchy

VirtualSession

Implements

XRSession

Constructors

constructor

new VirtualSession(): VirtualSession

- Defined in lib/control/controls/avr-controls.ts:344
Creates an instance of plane controls.

Returns VirtualSession

Properties

environmentBlendMode

environmentBlendMode: XREnvironmentBlendMode

Environment blend mode of virtual session

inputSources

inputSources: XRInputSource[]

Input sources of virtual session

renderState

renderState: XRRenderState

Render state of virtual session

visibilityState

visibilityState: XRVisibilityState

Visibility state of virtual session

Methods

addEventListener

addEventListener(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Implementation of I3JS.XRSession.addEventListener
- Defined in lib/control/controls/avr-controls.ts:472
Adds event listener

Parameters
- type: string
- callback: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

cancelAnimationFrame

cancelAnimationFrame(id: number): void

Implementation of XRSession.cancelAnimationFrame
- Defined in lib/control/controls/avr-controls.ts:383
Cancels animation frame

Parameters
- id: number
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Implementation of I3JS.XRSession.dispatchEvent
- Defined in lib/control/controls/avr-controls.ts:500
Dispatchs event

Parameters
- event: Event
Returns boolean
true if event

end

end(): Promise<void>

Implementation of XRSession.end
- Defined in lib/control/controls/avr-controls.ts:389
Ends virtual session

Returns Promise<void>
end

Optional eventListeners

eventListeners(eventName?: string): EventListenerOrEventListenerObject[]

- Defined in lib/control/controls/avr-controls.ts:546
Events listeners

Parameters
- Optional eventName: string
Returns EventListenerOrEventListenerObject[]
listeners

hasEventListener

hasEventListener(type: string, listener: any): boolean

- Defined in lib/control/controls/avr-controls.ts:487
Parameters
- type: string
- listener: any
Returns boolean

Optional removeAllListeners

removeAllListeners(eventName?: string): void

- Defined in lib/control/controls/avr-controls.ts:539
Removes all listeners

Parameters
- Optional eventName: string
Returns void

removeEventListener

removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Implementation of I3JS.XRSession.removeEventListener
- Defined in lib/control/controls/avr-controls.ts:519
Removes event listener

Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

requestAnimationFrame

requestAnimationFrame(callback: XRFrameRequestCallback): number

Implementation of XRSession.requestAnimationFrame
- Defined in lib/control/controls/avr-controls.ts:375
Requests animation frame

Parameters
- callback: XRFrameRequestCallback
Returns number
animation frame

requestHitTest

requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>

Implementation of XRSession.requestHitTest
- Defined in lib/control/controls/avr-controls.ts:448
Requests hit test

Parameters
- ray: XRRay
- referenceSpace: XRReferenceSpace
Returns Promise<XRHitResult[]>
hit test

requestHitTestSource

requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>

Implementation of XRSession.requestHitTestSource
- Defined in lib/control/controls/avr-controls.ts:421
Requests hit test source

Parameters
- options: XRHitTestOptionsInit
Returns Promise<XRHitTestSource>
hit test source

requestHitTestSourceForTransientInput

requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>

Implementation of XRSession.requestHitTestSourceForTransientInput
- Defined in lib/control/controls/avr-controls.ts:434
Requests hit test source for transient input

Parameters
- options: XRTransientInputHitTestOptionsInit
Returns Promise<XRTransientInputHitTestSource>
hit test source for transient input

requestReferenceSpace

requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>

Implementation of XRSession.requestReferenceSpace
- Defined in lib/control/controls/avr-controls.ts:351
Requests reference space

Parameters
- type: XRReferenceSpaceType
Returns Promise<XRReferenceSpace>
reference space

updateRenderState

updateRenderState(renderStateInit: XRRenderStateInit): Promise<void>

Implementation of XRSession.updateRenderState
- Defined in lib/control/controls/avr-controls.ts:364
Updates render state

Parameters
- renderStateInit: XRRenderStateInit
Returns Promise<void>
render state

updateWorldTrackingState

updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void

Implementation of XRSession.updateWorldTrackingState
- Defined in lib/control/controls/avr-controls.ts:461
Updates world tracking state

Parameters
- options: { planeDetectionState?: { enabled: boolean } }
  - Optional planeDetectionState?: { enabled: boolean }
    - enabled: boolean
Returns void

Generated using TypeDoc