Class XRManager

XR管理器

Export

Date

2023.2.24

Author

lyx

Hierarchy

XRManagerBase
- XRManager

Index

Constructors

constructor

new XRManager(engine): XRManager
Parameters
- engine: Engine
Returns XRManager

Overrides XRManagerBase.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

camera

get camera(): WebXRArrayCamera
获取WebXR相机

Returns WebXRArrayCamera

Memberof
XRManager

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from XRManagerBase.engine

originalReferenceSpace

get originalReferenceSpace(): XRReferenceSpace
获取原始关联空间

Returns XRReferenceSpace

Memberof
XRManager

referenceSpace

get referenceSpace(): XRReferenceSpace
获取关联空间

Returns XRReferenceSpace

Memberof
XRManager

Methods

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  }
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from XRManagerBase.addEventListener

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from XRManagerBase.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
XRManager

Overrides XRManagerBase.dispose

enterAR

enterAR(parameters?): Promise<void>
进入AR模式
Parameters
- Optional parameters: WebXRParameters = {}
Returns Promise<void>

Memberof
XRManager

enterVR

enterVR(parameters?): Promise<void>
进入VR模式
Parameters
- Optional parameters: WebXRParameters = {}
Returns Promise<void>

Memberof
XRManager

exit

exit(): Promise<void>
退出AR/VR模式

Returns Promise<void>

Memberof
XRManager

getGripInput

getGripInput(index): XRGripInput
获取Grip类型输入
Parameters
- index: number
  
  输入索引（注：通常0对应左手，1对应右手）
Returns XRGripInput

Memberof
XRManager

getHandInput

getHandInput(index): XRHandInput
获取Hand类型输入
Parameters
- index: number
  
  输入索引（注：通常0对应左手，1对应右手）
Returns XRHandInput

Memberof
XRManager

getTargetRayInput

getTargetRayInput(index): XRTargetRayInput
获取TargetRay类型输入
Parameters
- index: number
  
  输入索引（注：通常0对应左手，1对应右手）
Returns XRTargetRayInput

Memberof
XRManager

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from XRManagerBase.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from XRManagerBase.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from XRManagerBase.removeEventListenerByEventId

render

render(timeSinceLastFrame, timeStamp, frame): void
XR渲染接口
Parameters
- timeSinceLastFrame: number
  
  距离上一帧的更新时长（单位：毫秒）
- timeStamp: number
  
  时间戳
- frame: XRFrame
Returns void

Memberof
XRManager

Overrides XRManagerBase.render

requestHitTest

requestHitTest(referenceSpaceType?): Promise<HitTest>
请求HitTest
Parameters
- Optional referenceSpaceType: XRReferenceSpaceType = 'viewer'
Returns Promise<HitTest>

Memberof
XRManager

requestTransientHitTest

requestTransientHitTest(profile): HitTest
请求Transient类型HitTest
Parameters
- profile: string
Returns HitTest

Memberof
XRManager

`Static` isARAvailable

isARAvailable(): Promise<boolean>
判断是否支持AR

Returns Promise<boolean>

Static

Memberof
XRManager

`Static` isVRAvailable

isVRAvailable(): Promise<boolean>
判断是否支持VR

Returns Promise<boolean>

Static

Memberof
XRManager