Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebXRSystem

Hierarchy

  • WebXRSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Properties

Private Optional __basePath

__basePath?: string

Private __canvasHeightForVR

__canvasHeightForVR: number = 0

Private __canvasWidthForVR

__canvasWidthForVR: number = 0

Private __controllerEntities

__controllerEntities: ISceneGraphEntity[] = []

Private __defaultPositionInLocalSpaceMode

__defaultPositionInLocalSpaceMode: Vector3 = defaultUserPositionInVR

Private Optional __glw

__glw?: WebGLContextWrapper

Private __isReadyForWebXR

__isReadyForWebXR: boolean = false

Private __isWebXRMode

__isWebXRMode: boolean = false

Private __leftCameraEntity

__leftCameraEntity: ICameraEntity

Private __requestedToEnterWebXR

__requestedToEnterWebXR: boolean = false

Private __rightCameraEntity

__rightCameraEntity: ICameraEntity

Private __spaceType

__spaceType: XRReferenceSpaceType = 'local'

Private __viewerAzimuthAngle

__viewerAzimuthAngle: MutableScalar = ...

Private __viewerEntity

__viewerEntity: ISceneGraphEntity

Private __viewerOrientation

__viewerOrientation: MutableQuaternion = ...

Private __viewerScale

__viewerScale: MutableVector3 = ...

Private __viewerTranslate

__viewerTranslate: MutableVector3 = ...

Private Optional __webglLayer

__webglLayer?: XRWebGLLayer

Private __xrInputSources

__xrInputSources: XRInputSource[] = []

Private Optional __xrReferenceSpace

__xrReferenceSpace?: XRReferenceSpace

Private Optional __xrSession

__xrSession?: XRSession

Private Optional __xrViewerPose

__xrViewerPose?: null | XRViewerPose

Static Private __instance

__instance: WebXRSystem

Accessors

framebuffer

  • get framebuffer(): undefined | WebGLFramebuffer

isReadyForWebXR

  • get isReadyForWebXR(): boolean

isWebXRMode

  • get isWebXRMode(): boolean

leftProjectionMatrix

leftViewMatrix

requestedToEnterWebVR

  • get requestedToEnterWebVR(): boolean

requestedToEnterWebXR

  • get requestedToEnterWebXR(): boolean

rightProjectionMatrix

rightViewMatrix

xrSession

  • get xrSession(): undefined | XRSession

Methods

Private __onInputSourcesChange

  • __onInputSourcesChange(event: XRInputSourceChangeEvent, resolve: ((entities: ISceneGraphEntity[]) => void), profilePriorities: string[]): Promise<void>

Private __setCameraInfoFromXRViews

  • __setCameraInfoFromXRViews(xrViewerPose: XRViewerPose): void

Private __setupWebGLLayer

  • __setupWebGLLayer(xrSession: XRSession, callbackOnXrSessionStart: Function): Promise<void>

  • Parameters

    • xrSession: XRSession
    • callbackOnXrSessionStart: Function

    Returns Promise<void>

Private __updateInputSources

  • __updateInputSources(xrFrame: XRFrame): void

Private __updateView

  • __updateView(xrFrame: XRFrame): void

_getCameraComponentSIDAt

  • _getCameraComponentSIDAt(index: number): number

  • Getter of the CameraComponent SID of left/right eye

    internal

    Parameters

    • index: number

      (0: left, 1: right)

    Returns number

    the SID of the CameraComponent of left/right eye

_getCameraWorldPositionAt

  • _getCameraWorldPositionAt(displayIdx: number): Vector3

  • Getter of the position of the VR camera in world space

    internal

    Parameters

    • displayIdx: number

      (0: left, 1: right)

    Returns Vector3

    The position of the VR camera in world space

_getLeftViewport

_getProjectMatrixAt

  • Getter of the project matrix of right eye

    internal

    Parameters

    • index: number

      (0: left, 1: right)

    Returns MutableMatrix44

    The project matrix of right eye

_getRightViewport

_getViewMatrixAt

  • _getViewMatrixAt(index: number): Matrix44

  • Getter of the view matrix of right eye

    internal

    Parameters

    • index: number

      (0: left, 1: right)

    Returns Matrix44

    The view matrix vector of right eye

_getViewportAt

  • _getViewportAt(index: number): Vector4

  • Getter of the viewport vector

    internal

    Parameters

    • index: number

      (0: left, 1: right)

    Returns Vector4

    the viewport vector

_postRender

  • _postRender(): void

_preRender

  • _preRender(time: number, xrFrame: XRFrame): void

  • Pre process for rendering

    internal

    Parameters

    • time: number
    • xrFrame: XRFrame

      XRFrame object

    Returns void

_setValuesToGlobalDataRepository

  • _setValuesToGlobalDataRepository(): void

enterWebXR

  • enterWebXR(__namedParameters: { callbackOnXrSessionEnd: Function; callbackOnXrSessionStart: Function; initialUserPosition?: Vector3; profilePriorities: string[] }): Promise<undefined | IEntity[]>

  • Enter to WebXR (VR mode)

    Parameters

    • __namedParameters: { callbackOnXrSessionEnd: Function; callbackOnXrSessionStart: Function; initialUserPosition?: Vector3; profilePriorities: string[] }
      • callbackOnXrSessionEnd: Function
      • callbackOnXrSessionStart: Function
      • Optional initialUserPosition?: Vector3
      • profilePriorities: string[]

    Returns Promise<undefined | IEntity[]>

    boolean value about succeeded or not

exitWebXR

  • exitWebXR(): Promise<void>

getCanvasHeightForVr

  • getCanvasHeightForVr(): number

getCanvasWidthForVr

  • getCanvasWidthForVr(): number

getControllerEntities

readyForWebXR

  • readyForWebXR(requestButtonDom: HTMLElement, basePath: string): Promise<never[]>

  • Ready for WebXR

    Parameters

    • requestButtonDom: HTMLElement
    • basePath: string

    Returns Promise<never[]>

    true: prepared properly, false: failed to prepare

Static getInstance

Generated using TypeDoc