类 WebXRSessionManager

En

Manages an XRSession to work with the LayaAir engine.

Zh

管理 XRSession 用以与 LayaAir 引擎协同工作。

层级 (查看层级一览)

属性

baseReferenceSpace currentFrame currentTimestamp defaultHeightCompensation session viewerReferenceSpace EVENT_FRAME_LOOP EVENT_MANAGER_END

访问器

currentFrameRate referenceSpace sessionMode supportedFrameRates

方法

destroy endXRRenderLoop event exitXR hasListener initializeAsync initializeSessionAsync initializeXRGL isSessionSupportedAsync off offAll offAllCaller on once resetReferenceSpace runXRRenderLoop setReferenceSpaceTypeAsync updateRenderStateAsync updateTargetFrameRate

属性

baseReferenceSpace

baseReferenceSpace: any

En

The base reference space for the XR session.

Zh

XR 会话的基参考空间。

currentFrame

currentFrame: any

En

The current XR frame in the session.

Zh

会话中的当前 XR 帧。

currentTimestamp

currentTimestamp: number = -1

En

The WebXR timestamp updated every frame.

Zh

每帧更新的 WebXR 时间戳。

defaultHeightCompensation

defaultHeightCompensation: number = 1.7

En

The default height compensation used when initialization fails.

Zh

初始化失败后使用的高度补偿默认值。

session

session: any

En

The underlying XR session being managed.

Zh

被管理的底层 XR 会话。

viewerReferenceSpace

viewerReferenceSpace: any

En

The XRReferenceSpace used for setting up the viewer's reference space.

Zh

用于设置观察者参考空间的 XRReferenceSpace。

静态EVENT_FRAME_LOOP

EVENT_FRAME_LOOP: string = "xrFrameLoop"

静态EVENT_MANAGER_END

EVENT_MANAGER_END: string = "xrManagerDestory"

访问器

currentFrameRate

referenceSpace

sessionMode

supportedFrameRates

方法

destroy

endXRRenderLoop

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

exitXR

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

initializeAsync

initializeSessionAsync

  • initializeSessionAsync(xrSessionMode?: string, xrSessionInit?: {}): Promise<any>

    参数

    • xrSessionMode: string = 'immersive-vr'

      The mode for the XR session.

    • xrSessionInit: {} = {}

      The initialization info for the XR session.

    返回 Promise<any>

    A promise that resolves with the XR session if successful.

    En

    Initializes the XR session with the specified mode and initialization info.

    Zh

    使用指定的模式和初始化信息初始化 XR 会话。

initializeXRGL

  • initializeXRGL(xrSession: any, gl: WebGLRenderingContext): Promise<boolean>

    参数

    • xrSession: any

      The XR session to initialize.

    • gl: WebGLRenderingContext

      The WebGL rendering context.

    返回 Promise<boolean>

    A promise that resolves to true if the XR layer is successfully initialized.

    En

    Initializes the XR layer for the session.

    Zh

    为会话初始化 XR 层。

isSessionSupportedAsync

  • isSessionSupportedAsync(sessionMode: string): Promise<boolean>

    参数

    • sessionMode: string

      The session mode to check, "inline", "immersive-vr", or "immersive-ar".

    返回 Promise<boolean>

    A promise that resolves to true if the session mode is supported, and false if not.

    En

    Checks if the session mode is supported by the browser.

    Zh

    检查会话模式是否得到浏览器支持。

off

offAll

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

resetReferenceSpace

runXRRenderLoop

  • runXRRenderLoop(): void

    返回 void

    En

    Starts the rendering loop for the XR session and binds it to the session's animation frame request.

    Zh

    启动 XR 会话的渲染循环，并将其绑定到会话的动画帧请求。

setReferenceSpaceTypeAsync

  • setReferenceSpaceTypeAsync(referenceSpaceType?: string): Promise<any>

    参数

    • referenceSpaceType: string = "local-floor"

      The type of space to set, defaults to "local-floor".

    返回 Promise<any>

    A promise that resolves once the reference space has been set.

    En

    Sets the reference space on the XR session.

    Zh

    在 XR 会话上设置参考空间。

updateRenderStateAsync

  • updateRenderStateAsync(state: any): any

    参数

    • state: any

      The new render state to be applied.

    返回 any

    A promise that resolves once the render state has been updated.

    En

    Updates the render state of the WebXR session.

    Zh

    更新 WebXR 会话的渲染状态。

updateTargetFrameRate

  • updateTargetFrameRate(rate: number): Promise<void>

    参数

    • rate: number

      The new frame rate to be set, must be within the supportedFrameRates range.

    返回 Promise<void>

    A promise that resolves once the frame rate has been set.

    En

    Sets the frame rate for the WebXR session.

    Zh

    为 WebXR 会话设置帧率。

显示设置

成员可见性

目录

属性
访问器
方法