@realsee/five 6.8.0-alpha.1 → 6.8.0-alpha.11

package/docs_markdown/react/interfaces/FiveInjectionTypes.md

@@ -1,1075 +0,0 @@
-[**如视 Five SDK**](../../README.md)
-
-***
-
-[如视 Five SDK](../../modules.md) / [react](../README.md) / FiveInjectionTypes
-
-# Interface: FiveInjectionTypes
-
-Defined in: lib/react/withFive.ts:328
-
-监听者模式
-
-## Example
-
-```
-new Subscribe<{
-"foo": [arg1: number, arg2: string],
-"bar": [arg: boolean],
-}>()
-```
-
-## Extends
-
-- [`Subscribe`](../../five/classes/Subscribe.md)\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\>
-
-## Properties
-
-### cameraDirection
-
-> **cameraDirection**: `Vector3`
-
-Defined in: lib/react/withFive.ts:386
-
-Five React Inject: Five cameraDirection
-
-***
-
-### cameraRaycaster
-
-> **cameraRaycaster**: `Raycaster`
-
-Defined in: lib/react/withFive.ts:391
-
-Five React Inject: Five cameraRaycaster
-
-***
-
-### currentObserver
-
-> **currentObserver**: [`WorkObserver`](../../five/interfaces/WorkObserver.md)
-
-Defined in: lib/react/withFive.ts:381
-
-Five React Inject: Five currentState
-
-***
-
-### currentState
-
-> **currentState**: [`State`](../../five/interfaces/State.md)
-
-Defined in: lib/react/withFive.ts:376
-
-Five React Inject: Five 的当前状态
-
-#### Description
-
-```text
-five 设置了以下状态
-
-- mode: Mode
-- panoId: string
-- panoIndex: number
-- longitude: number
-- latitude: number
-- fov: number
-- offset: THREE.Vector3
-
-可以通过 state, currentState 和 setState 来获取和设置。
-通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
-来迎合一些通过数据驱动的场景。
-```
-
-***
-
-### getPixels()
-
-> **getPixels**: \{\<`T`\>(`x`, `y`, `width`, `height`, `pixelRatio?`, `flipY?`, `buffer?`): `T`; \<`T`\>(`options`): `T`; \}
-
-Defined in: lib/react/withFive.ts:506
-
-获取画面中的像素颜色
-
-#### Call Signature
-
-> \<`T`\>(`x`, `y`, `width`, `height`, `pixelRatio?`, `flipY?`, `buffer?`): `T`
-
-获取画面中的像素颜色
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `Uint8Array`\<`ArrayBufferLike`\> \| `Uint8ClampedArray`\<`ArrayBufferLike`\> = `Uint8Array`\<`ArrayBufferLike`\>
-
-##### Parameters
-
-###### x
-
-`number`
-
-获取像素区域的起始坐标 x
-
-###### y
-
-`number`
-
-获取像素区域的起始坐标 y
-
-###### width
-
-`number`
-
-获取像素区域的宽度
-
-###### height
-
-`number`
-
-获取像素区域的高度
-
-###### pixelRatio?
-
-`number`
-
-获取区域的像素比
-
-###### flipY?
-
-`boolean`
-
-是否Y轴翻转
-
-###### buffer?
-
-`T`
-
-存储数组
-
-##### Returns
-
-`T`
-
-rgba颜色平铺的 Uint8Array
-
-#### Call Signature
-
-> \<`T`\>(`options`): `T`
-
-获取画面中的像素颜色
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* `Uint8Array`\<`ArrayBufferLike`\> \| `Uint8ClampedArray`\<`ArrayBufferLike`\> = `Uint8Array`\<`ArrayBufferLike`\>
-
-##### Parameters
-
-###### options
-
-参数
-
-###### buffer?
-
-`T`
-
-存储数组
-
-###### flipY?
-
-`boolean`
-
-是否Y轴翻转
-
-###### height
-
-`number`
-
-获取像素区域的高度
-
-###### helperVisible?
-
-`boolean`
-
-###### pixelRatio?
-
-`number`
-
-获取区域的像素比
-
-###### skipPanorama?
-
-`boolean`
-
-###### width
-
-`number`
-
-获取像素区域的宽度
-
-###### x
-
-`number`
-
-获取像素区域的起始坐标 x
-
-###### y
-
-`number`
-
-获取像素区域的起始坐标 y
-
-##### Returns
-
-`T`
-
-#### Param
-
-获取像素区域的起始坐标 x
-
-#### Param
-
-获取像素区域的起始坐标 y
-
-#### Param
-
-获取像素区域的宽度
-
-#### Param
-
-获取像素区域的高度
-
-#### Param
-
-获取区域的像素比
-
-#### Returns
-
-rgba颜色平铺的 Uint8Array
-
-***
-
-### helperVisible
-
-> **helperVisible**: `boolean`
-
-Defined in: lib/react/withFive.ts:432
-
-Five React Inject: Five helperVisible
-
-***
-
-### intersectRaycaster()
-
-> **intersectRaycaster**: (`raycaster`, `target?`) => [`Intersection`](../../five/interfaces/Intersection.md)[]
-
-Defined in: lib/react/withFive.ts:474
-
-计算模型射线碰撞检测
-
-计算模型射线碰撞检测
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-THREE 射线对象
-
-##### target?
-
-[`Intersection`](../../five/interfaces/Intersection.md)[]
-
-返回碰撞
-
-#### Returns
-
-[`Intersection`](../../five/interfaces/Intersection.md)[]
-
-返回碰撞
-
-#### Param
-
-THREE 射线对象
-
-#### Param
-
-和某一楼层做碰撞检测， 不传为和所有楼层做碰撞检测
-
-#### Returns
-
-返回碰撞
-
-***
-
-### loadWork()
-
-> **loadWork**: (`inputWork`, `state?`, `options?`, `userAction`) => `Promise`\<`void`\>
-
-Defined in: lib/react/withFive.ts:466
-
-加载 Work 数据
-
-加载 Work 数据
-
-#### Parameters
-
-##### inputWork
-
-Work 数据
-
-`string` | `string`[] | [`LooseWork`](../../five/interfaces/LooseWork.md) | [`Work`](../../five/classes/Work.md) | [`Work`](../../five/classes/Work.md)[] | [`LooseWork`](../../five/interfaces/LooseWork.md)[] | [`LooseWorkWithExtrinsics`](../../five/interfaces/LooseWorkWithExtrinsics.md)[] | `Promise`\<[`LooseWork`](../../five/interfaces/LooseWork.md) \| [`Work`](../../five/classes/Work.md) \| [`Work`](../../five/classes/Work.md)[] \| [`LooseWork`](../../five/interfaces/LooseWork.md)[] \| [`LooseWorkWithExtrinsics`](../../five/interfaces/LooseWorkWithExtrinsics.md)[]\>
-
-##### state?
-
-初始化姿态
- - "inherit" 使用当前姿态
- - "initial" 使用 Work 数据中的 initial 姿态
- - State 自定义姿态
-
-`"initial"` | `"inherit"` | `Partial`\<[`State`](../../five/interfaces/State.md)\>
-
-##### options?
-
-切换时间, 切换效果
-
-`number` | [`FiveLoadOptions`](../../five/interfaces/FiveLoadOptions.md)
-
-##### userAction?
-
-`boolean` = `true`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Param
-
-Work 数据
-
-#### Param
-
-初始化姿态
- - "inherit" 使用当前姿态
- - "initial" 使用 Work 数据中的 initial 姿态
- - State 自定义姿态
-
-#### Param
-
-切换时间
-
-***
-
-### model
-
-> **model**: [`Model`](../../five/classes/Model.md)
-
-Defined in: lib/react/withFive.ts:406
-
-Five React Inject: Five model
-
-***
-
-### modelReadyState
-
-> **modelReadyState**: `"Empty"` \| `"Loaded"`
-
-Defined in: lib/react/withFive.ts:421
-
-Five React Inject: Five modelReadyState
-
-***
-
-### models
-
-> **models**: [`Models`](../../five/type-aliases/Models.md)
-
-Defined in: lib/react/withFive.ts:411
-
-Five React Inject: Five models
-
-***
-
-### needsRender()
-
-> **needsRender**: () => `void`
-
-Defined in: lib/react/withFive.ts:531
-
-下一帧渲染
-
-#### Returns
-
-`void`
-
-#### Description
-
-调用 `render()` 和设置 `needsRender()` 均可在按需渲染时，使得画面渲染一次
-区别在于：
-- `needsRender()` 为在下帧渲染画面
-- `render()` 在当前帧渲染画面
-推荐使用 `needsRender()`, 可以更加流畅。但是如果需要截图等同步操作，可以使用 `render()`
-
-***
-
-### preloadPano()
-
-> **preloadPano**: (`pano`, `callback`) => `Promise`\<`number`\>
-
-Defined in: lib/react/withFive.ts:539
-
-预加载点位图片资源
-
-预加载点位图片资源
-
-#### Parameters
-
-##### pano
-
-观察点序号
-
-`number` | [`Pano`](../../five/type-aliases/Pano.md) | `` `${string}[${number}]` ``
-
-##### callback
-
-(`costs`) => `void`
-
-加载完成回调, 并传递加载用时。
-
-#### Returns
-
-`Promise`\<`number`\>
-
-加载完成的 Promise 参数同 callback
-
-#### Param
-
-观察点
-
-#### Param
-
-加载完成回调, 并传递加载用时。
-
-#### Returns
-
-加载完成的 Promise 参数同 callback
-
-***
-
-### project2d()
-
-> **project2d**: (`vector`, `testModel`) => `Vector2`
-
-Defined in: lib/react/withFive.ts:484
-
-计算三维坐标对应到屏幕的二维坐标
-
-计算三维坐标对应到屏幕的二维坐标
-
-#### Parameters
-
-##### vector
-
-`Vector3`
-
-三维坐标
-
-##### testModel
-
-`boolean` = `false`
-
-是否计算模型遮挡
-
-#### Returns
-
-`Vector2`
-
-二维坐标 或者 null
-
-#### Description
-
-如果三维坐标不在屏幕中，则返回 null
-
-#### Description
-
-如果三维坐标不在屏幕中，则返回 null
-
-#### Param
-
-三维坐标
-
-#### Param
-
-是否计算模型遮挡
-
-#### Returns
-
-二维坐标 或者 null
-
-***
-
-### render()
-
-> **render**: (`callback?`) => `void`
-
-Defined in: lib/react/withFive.ts:519
-
-强制渲染
-
-强制渲染
-
-#### Parameters
-
-##### callback?
-
-() => `void`
-
-渲染完成回调
-
-#### Returns
-
-`void`
-
-#### Description
-
-调用 `five.render()` 和设置 `five.needsRender = true` 均可在按需渲染时，使得画面渲染一次
-区别在于：
-- `five.needsRender = true` 为在下帧渲染画面
-- `five.render()` 在当前帧渲染画面
-推荐使用 `five.needsRender = true`, 可以更加流畅。但是如果需要截图等同步操作，可以使用 `five.render()`
-
-#### Description
-
-调用 `render()` 和设置 `needsRender()` 均可在按需渲染时，使得画面渲染一次
-区别在于：
-- `needsRender()` 为在下帧渲染画面
-- `render()` 在当前帧渲染画面
-推荐使用 `needsRender()`, 可以更加流畅。但是如果需要截图等同步操作，可以使用 `render()`
-
-#### Param
-
-渲染完成回调
-
-***
-
-### scene
-
-> **scene**: [`Scene`](../../five/classes/Scene.md)
-
-Defined in: lib/react/withFive.ts:416
-
-Five React Inject: Five models
-
-***
-
-### setState()
-
-> **setState**: (`state`, `immediately`, `userAction`) => `void`
-
-Defined in: lib/react/withFive.ts:455
-
-设置 State
-
-设置 State
-
-#### Parameters
-
-##### state
-
-`Partial`\<[`State`](../../five/interfaces/State.md)\>
-
-目标状态
-
-##### immediately
-
-`boolean` = `false`
-
-是否马上转换，马上转换会尽快达到目标状态，尽量减少中间状态，更少动画。
-
-##### userAction
-
-`boolean` = `true`
-
-是否是用户触发的动作
-
-#### Returns
-
-`void`
-
-#### Description
-
-```text
-five 设置了以下状态
-
-- mode: Mode
-- panoIndex: number
-- longitude: number
-- latitude: number
-- distance: number
-- fov: number
-- offset: THREE.Vector3
-
-可以通过 five.state 和 five.setState 来获取和设置。
-通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
-来迎合一些通过数据驱动的场景。
-```
-
-#### Description
-
-```text
-five 设置了以下状态
-
-- mode: Mode
-- panoId: string
-- panoIndex: number
-- longitude: number
-- latitude: number
-- fov: number
-- offset: THREE.Vector3
-
-可以通过 state, currentState 和 setState 来获取和设置。
-通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
-来迎合一些通过数据驱动的场景。
-```
-
-#### Param
-
-目标状态
-
-#### Param
-
-是否马上转换，马上转换会尽快达到目标状态，尽量减少中间状态，更少动画。
-
-***
-
-### showFloor()
-
-> **showFloor**: (`floorIndex?`) => `void`
-
-Defined in: lib/react/withFive.ts:545
-
-显示楼层
-
-#### Parameters
-
-##### floorIndex?
-
-`number`
-
-楼层，如果不传则都显示
-
-#### Returns
-
-`void`
-
-***
-
-### shownFloor
-
-> **shownFloor**: `number`
-
-Defined in: lib/react/withFive.ts:427
-
-Five React Inject: Five shownFloor
-
-***
-
-### state
-
-> **state**: [`State`](../../five/interfaces/State.md)
-
-Defined in: lib/react/withFive.ts:355
-
-Five React Inject: Five 的目标状态
-
-#### Description
-
-```text
-five 设置了以下状态
-
-- mode: Mode
-- panoId: string
-- panoIndex: number
-- longitude: number
-- latitude: number
-- fov: number
-- offset: THREE.Vector3
-
-可以通过 state, currentState 和 setState 来获取和设置。
-通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
-来迎合一些通过数据驱动的场景。
-```
-
-***
-
-### toggleHelperVisible()
-
-> **toggleHelperVisible**: (`visible`) => `void`
-
-Defined in: lib/react/withFive.ts:551
-
-帮助元素的隐藏/显示
-
-#### Parameters
-
-##### visible
-
-`boolean`
-
-隐藏/显示
-
-#### Returns
-
-`void`
-
-***
-
-### ~~unsafe\_\_fiveInstance~~
-
-> **unsafe\_\_fiveInstance**: [`Five`](../../five/classes/Five.md)
-
-Defined in: lib/react/withFive.ts:334
-
-Five React Inject: 获取 five 实例
-
-#### Description
-
-不到万不得已，并不推荐直接使用。
-
-#### Deprecated
-
-不到万不得已，并不推荐直接使用。
-
-***
-
-### updateCamera()
-
-> **updateCamera**: (`pose`, `duration`, `userAction`) => `Promise`\<`void`\>
-
-Defined in: lib/react/withFive.ts:495
-
-移动相机。（不触发点位移动）
-
-移动相机。（不触发点位移动）
-
-#### Parameters
-
-##### pose
-
-`Partial`\<[`Pose`](../../five/interfaces/Pose.md)\>
-
-相机目标位置
-
-##### duration
-
-`number`
-
-动画触发的时常
-
-##### userAction
-
-`boolean` = `true`
-
-是否用户触发
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Promise 是否移动成功
-
-#### Description
-
-如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
-会 Promise.reject。运动完成则 Promise.resolve
-
-#### Description
-
-如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
-会 Promise.reject。运动完成则 Promise.resolve
-
-#### Param
-
-相机目标位置
-
-#### Param
-
-动画触发的时常
-
-#### Returns
-
-Promise 是否移动成功
-
-***
-
-### work
-
-> **work**: [`Work`](../../five/classes/Work.md)
-
-Defined in: lib/react/withFive.ts:396
-
-Five React Inject: Five Work
-
-***
-
-### works
-
-> **works**: [`Works`](../../five/type-aliases/Works.md)
-
-Defined in: lib/react/withFive.ts:401
-
-Five React Inject: Five Work
-
-## Methods
-
-### emit()
-
-> **emit**\<`K`\>(`name`, ...`data`): `boolean`
-
-Defined in: lib/five/utils/subscribe.ts:131
-
-触发事件
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* `"dispose"` \| `"error"` \| `"render"` \| `"gesture.pan"` \| `"gesture.tap"` \| `"gesture.dbltap"` \| `"gesture.press"` \| `"gesture.pinch"` \| `"gesture.mousewheel"` \| `"gesture.mousemove"` \| `"gesture.momentum"` \| `"initAnimation.start"` \| `"initAnimation.end"` \| `"camera.update"` \| `"intersect.update"` \| `"pano.select"` \| `"pano.request"` \| `"pano.moveTo"` \| `"pano.moving"` \| `"pano.arrived"` \| `"pano.cancel"` \| `"pano.error"` \| `"pano.texture.load"` \| `"pano.texture.progress"` \| `"pano.texture.success"` \| `"pano.texture.error"` \| `"pano.texture.abort"` \| `"xr.session.end"` \| `"xr.session.start"` \| `"xr.gesture.tap"` \| `"xr.gesture.press"` \| `"xr.gesture.buttonUp"` \| `"xr.gesture.buttonDown"` \| `"xr.controller.update"` \| keyof LegacyEventType \| `"works.request"` \| `"works.load"` \| `"works.ready"` \| `"state.set"` \| `"state.change"` \| `"state.synced"` \| `"currentState.change"` \| `"model.request"` \| `"model.load"` \| `"model.error"` \| `"model.changeShownFloor"` \| `"models.load"` \| `"models.refined"` \| `"render.prepare"` \| `"mode.change.request"` \| `"mode.change"` \| `"helpers.visible"` \| `"network.resource"` \| `"fps"`
-
-预设的监听事件名称
-
-#### Parameters
-
-##### name
-
-`K`
-
-事件类型
-
-##### data
-
-...`Parameters`\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\[`K`\]\>
-
-触发事件的数据
-
-#### Returns
-
-`boolean`
-
-canceled 是否被触发取消
-
-#### Inherited from
-
-[`Subscribe`](../../five/classes/Subscribe.md).[`emit`](../../five/classes/Subscribe.md#emit)
-
-***
-
-### hasListener()
-
-> **hasListener**(`name`): `boolean`
-
-Defined in: lib/five/utils/subscribe.ts:44
-
-判断是否注册了事件
-
-#### Parameters
-
-##### name
-
-事件类型
-
-`"dispose"` | `"error"` | `"render"` | `"gesture.pan"` | `"gesture.tap"` | `"gesture.dbltap"` | `"gesture.press"` | `"gesture.pinch"` | `"gesture.mousewheel"` | `"gesture.mousemove"` | `"gesture.momentum"` | `"initAnimation.start"` | `"initAnimation.end"` | `"camera.update"` | `"intersect.update"` | `"pano.select"` | `"pano.request"` | `"pano.moveTo"` | `"pano.moving"` | `"pano.arrived"` | `"pano.cancel"` | `"pano.error"` | `"pano.texture.load"` | `"pano.texture.progress"` | `"pano.texture.success"` | `"pano.texture.error"` | `"pano.texture.abort"` | `"xr.session.end"` | `"xr.session.start"` | `"xr.gesture.tap"` | `"xr.gesture.press"` | `"xr.gesture.buttonUp"` | `"xr.gesture.buttonDown"` | `"xr.controller.update"` | keyof LegacyEventType | `"works.request"` | `"works.load"` | `"works.ready"` | `"state.set"` | `"state.change"` | `"state.synced"` | `"currentState.change"` | `"model.request"` | `"model.load"` | `"model.error"` | `"model.changeShownFloor"` | `"models.load"` | `"models.refined"` | `"render.prepare"` | `"mode.change.request"` | `"mode.change"` | `"helpers.visible"` | `"network.resource"` | `"fps"`
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-[`Subscribe`](../../five/classes/Subscribe.md).[`hasListener`](../../five/classes/Subscribe.md#haslistener)
-
-***
-
-### off()
-
-> **off**\<`K`\>(`name?`, `callback?`): `void`
-
-Defined in: lib/five/utils/subscribe.ts:97
-
-解除事件
-
-如果 name 不传的话解除对应所有事件
-如果 name, callback 不传的话解除所有name的所有事件
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* `"dispose"` \| `"error"` \| `"render"` \| `"gesture.pan"` \| `"gesture.tap"` \| `"gesture.dbltap"` \| `"gesture.press"` \| `"gesture.pinch"` \| `"gesture.mousewheel"` \| `"gesture.mousemove"` \| `"gesture.momentum"` \| `"initAnimation.start"` \| `"initAnimation.end"` \| `"camera.update"` \| `"intersect.update"` \| `"pano.select"` \| `"pano.request"` \| `"pano.moveTo"` \| `"pano.moving"` \| `"pano.arrived"` \| `"pano.cancel"` \| `"pano.error"` \| `"pano.texture.load"` \| `"pano.texture.progress"` \| `"pano.texture.success"` \| `"pano.texture.error"` \| `"pano.texture.abort"` \| `"xr.session.end"` \| `"xr.session.start"` \| `"xr.gesture.tap"` \| `"xr.gesture.press"` \| `"xr.gesture.buttonUp"` \| `"xr.gesture.buttonDown"` \| `"xr.controller.update"` \| keyof LegacyEventType \| `"works.request"` \| `"works.load"` \| `"works.ready"` \| `"state.set"` \| `"state.change"` \| `"state.synced"` \| `"currentState.change"` \| `"model.request"` \| `"model.load"` \| `"model.error"` \| `"model.changeShownFloor"` \| `"models.load"` \| `"models.refined"` \| `"render.prepare"` \| `"mode.change.request"` \| `"mode.change"` \| `"helpers.visible"` \| `"network.resource"` \| `"fps"`
-
-预设的监听事件名称
-
-#### Parameters
-
-##### name?
-
-`K`
-
-事件类型
-
-##### callback?
-
-(...`args`) => `ReturnType`\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\[`K`\]\>
-
-事件回调函数
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`Subscribe`](../../five/classes/Subscribe.md).[`off`](../../five/classes/Subscribe.md#off)
-
-***
-
-### on()
-
-> **on**\<`K`\>(`name`, `callback`, `once?`): () => `void`
-
-Defined in: lib/five/utils/subscribe.ts:58
-
-注册事件
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* `"dispose"` \| `"error"` \| `"render"` \| `"gesture.pan"` \| `"gesture.tap"` \| `"gesture.dbltap"` \| `"gesture.press"` \| `"gesture.pinch"` \| `"gesture.mousewheel"` \| `"gesture.mousemove"` \| `"gesture.momentum"` \| `"initAnimation.start"` \| `"initAnimation.end"` \| `"camera.update"` \| `"intersect.update"` \| `"pano.select"` \| `"pano.request"` \| `"pano.moveTo"` \| `"pano.moving"` \| `"pano.arrived"` \| `"pano.cancel"` \| `"pano.error"` \| `"pano.texture.load"` \| `"pano.texture.progress"` \| `"pano.texture.success"` \| `"pano.texture.error"` \| `"pano.texture.abort"` \| `"xr.session.end"` \| `"xr.session.start"` \| `"xr.gesture.tap"` \| `"xr.gesture.press"` \| `"xr.gesture.buttonUp"` \| `"xr.gesture.buttonDown"` \| `"xr.controller.update"` \| keyof LegacyEventType \| `"works.request"` \| `"works.load"` \| `"works.ready"` \| `"state.set"` \| `"state.change"` \| `"state.synced"` \| `"currentState.change"` \| `"model.request"` \| `"model.load"` \| `"model.error"` \| `"model.changeShownFloor"` \| `"models.load"` \| `"models.refined"` \| `"render.prepare"` \| `"mode.change.request"` \| `"mode.change"` \| `"helpers.visible"` \| `"network.resource"` \| `"fps"`
-
-预设的监听事件名称
-
-#### Parameters
-
-##### name
-
-`K`
-
-事件类型
-
-##### callback
-
-(...`args`) => `ReturnType`\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\[`K`\]\>
-
-事件回调函数
-
-##### once?
-
-`boolean`
-
-是否只执行一次
-
-#### Returns
-
-解除事件
-
-> (): `void`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`Subscribe`](../../five/classes/Subscribe.md).[`on`](../../five/classes/Subscribe.md#on)
-
-***
-
-### once()
-
-> **once**\<`K`\>(`name`, `callback`): () => `void`
-
-Defined in: lib/five/utils/subscribe.ts:81
-
-注册事件(是否只执行一次)
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* `"dispose"` \| `"error"` \| `"render"` \| `"gesture.pan"` \| `"gesture.tap"` \| `"gesture.dbltap"` \| `"gesture.press"` \| `"gesture.pinch"` \| `"gesture.mousewheel"` \| `"gesture.mousemove"` \| `"gesture.momentum"` \| `"initAnimation.start"` \| `"initAnimation.end"` \| `"camera.update"` \| `"intersect.update"` \| `"pano.select"` \| `"pano.request"` \| `"pano.moveTo"` \| `"pano.moving"` \| `"pano.arrived"` \| `"pano.cancel"` \| `"pano.error"` \| `"pano.texture.load"` \| `"pano.texture.progress"` \| `"pano.texture.success"` \| `"pano.texture.error"` \| `"pano.texture.abort"` \| `"xr.session.end"` \| `"xr.session.start"` \| `"xr.gesture.tap"` \| `"xr.gesture.press"` \| `"xr.gesture.buttonUp"` \| `"xr.gesture.buttonDown"` \| `"xr.controller.update"` \| keyof LegacyEventType \| `"works.request"` \| `"works.load"` \| `"works.ready"` \| `"state.set"` \| `"state.change"` \| `"state.synced"` \| `"currentState.change"` \| `"model.request"` \| `"model.load"` \| `"model.error"` \| `"model.changeShownFloor"` \| `"models.load"` \| `"models.refined"` \| `"render.prepare"` \| `"mode.change.request"` \| `"mode.change"` \| `"helpers.visible"` \| `"network.resource"` \| `"fps"`
-
-预设的监听事件名称
-
-#### Parameters
-
-##### name
-
-`K`
-
-事件类型
-
-##### callback
-
-(...`args`) => `ReturnType`\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\[`K`\]\>
-
-事件回调函数
-
-#### Returns
-
-解除事件
-
-> (): `void`
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`Subscribe`](../../five/classes/Subscribe.md).[`once`](../../five/classes/Subscribe.md#once)
-
-***
-
-### waitUntil()
-
-> **waitUntil**\<`K`\>(`name`, `filter?`): `Promise`\<`Parameters`\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\[`K`\]\>\>
-
-Defined in: lib/five/utils/subscribe.ts:155
-
-等待事件
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* `"dispose"` \| `"error"` \| `"render"` \| `"gesture.pan"` \| `"gesture.tap"` \| `"gesture.dbltap"` \| `"gesture.press"` \| `"gesture.pinch"` \| `"gesture.mousewheel"` \| `"gesture.mousemove"` \| `"gesture.momentum"` \| `"initAnimation.start"` \| `"initAnimation.end"` \| `"camera.update"` \| `"intersect.update"` \| `"pano.select"` \| `"pano.request"` \| `"pano.moveTo"` \| `"pano.moving"` \| `"pano.arrived"` \| `"pano.cancel"` \| `"pano.error"` \| `"pano.texture.load"` \| `"pano.texture.progress"` \| `"pano.texture.success"` \| `"pano.texture.error"` \| `"pano.texture.abort"` \| `"xr.session.end"` \| `"xr.session.start"` \| `"xr.gesture.tap"` \| `"xr.gesture.press"` \| `"xr.gesture.buttonUp"` \| `"xr.gesture.buttonDown"` \| `"xr.controller.update"` \| keyof LegacyEventType \| `"works.request"` \| `"works.load"` \| `"works.ready"` \| `"state.set"` \| `"state.change"` \| `"state.synced"` \| `"currentState.change"` \| `"model.request"` \| `"model.load"` \| `"model.error"` \| `"model.changeShownFloor"` \| `"models.load"` \| `"models.refined"` \| `"render.prepare"` \| `"mode.change.request"` \| `"mode.change"` \| `"helpers.visible"` \| `"network.resource"` \| `"fps"`
-
-预设的监听事件名称
-
-#### Parameters
-
-##### name
-
-`K`
-
-事件类型
-
-##### filter?
-
-(...`args`) => `boolean` \| `void`
-
-事件类型
-
-#### Returns
-
-`Promise`\<`Parameters`\<[`EventTypes`](../../five/type-aliases/EventTypes.md)\[`K`\]\>\>
-
-触发事件的数据
-
-#### Inherited from
-
-[`Subscribe`](../../five/classes/Subscribe.md).[`waitUntil`](../../five/classes/Subscribe.md#waituntil)