@realsee/five 6.7.2 → 6.8.0-alpha.1

package/docs_markdown/five/classes/Five.md

@@ -0,0 +1,2231 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / Five
+
+# Class: Five
+
+Defined in: lib/five/application/five.ts:97
+
+如视 VR Web展示器
+
+## Example
+
+```
+// 初始化构造函数
+const five = new Five();
+// 将绘制区域添加到页面上
+five.appendTo(document.body);
+// 加载 Work 数据
+five.load({...});
+```
+
+## Extends
+
+- [`Subscribe`](Subscribe.md)\<[`EventTypes`](../type-aliases/EventTypes.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new Five**(`initArgs`): `Five`
+
+Defined in: lib/five/application/five.ts:293
+
+#### Parameters
+
+##### initArgs
+
+[`FiveInitArgs`](../interfaces/FiveInitArgs.md) = `{}`
+
+#### Returns
+
+`Five`
+
+#### Overrides
+
+[`Subscribe`](Subscribe.md).[`constructor`](Subscribe.md#constructor)
+
+## Properties
+
+### backgroundAlpha
+
+> **backgroundAlpha**: `number`
+
+Defined in: lib/five/application/five.ts:215
+
+背景透明度
+
+***
+
+### backgroundColor
+
+> **backgroundColor**: `Color`
+
+Defined in: lib/five/application/five.ts:212
+
+背景颜色
+
+***
+
+### camera
+
+> **camera**: [`Camera`](Camera.md)
+
+Defined in: lib/five/application/five.ts:172
+
+内部使用的 `Camera`
+
+***
+
+### currentMode
+
+> **currentMode**: [`Mode`](../type-aliases/Mode.md)
+
+Defined in: lib/five/application/five.ts:161
+
+当前展示的模式
+
+***
+
+### fiveId
+
+> `readonly` **fiveId**: `string`
+
+Defined in: lib/five/application/five.ts:264
+
+***
+
+### imageOptions
+
+> **imageOptions**: [`ImageOptions`](../interfaces/ImageOptions.md)
+
+Defined in: lib/five/application/five.ts:223
+
+全景图的配置参数
+
+#### Description
+
+可以动态对配置在 `work` 数据中的全景图片在 runtime 做 url 调整。
+平衡加载时间和图片质量
+
+***
+
+### modelScene
+
+> **modelScene**: [`ModelScene`](ModelScene.md)
+
+Defined in: lib/five/application/five.ts:166
+
+内部模型部分使用的 `THREE.Scene`
+
+***
+
+### needsRender
+
+> **needsRender**: `boolean`
+
+Defined in: lib/five/application/five.ts:201
+
+是否需要渲染
+
+#### Description
+
+如果初始化设置了 `onlyRenderIfNeeds: true`, 则会激活按需渲染
+可以通过设置 `five.needsRender = true` 来告知，five 会在下一帧渲染画面。
+
+***
+
+### onlyRenderIfNeeds
+
+> **onlyRenderIfNeeds**: `boolean`
+
+Defined in: lib/five/application/five.ts:206
+
+是否按需渲染
+
+***
+
+### pano
+
+> **pano**: [`Pano`](../type-aliases/Pano.md)
+
+Defined in: lib/five/application/five.ts:158
+
+当前点位序号
+
+***
+
+### paused
+
+> **paused**: `boolean`
+
+Defined in: lib/five/application/five.ts:155
+
+自动播放状态是否暂停
+
+#### Description
+
+可以通过 `five.play` `five.pause` 方法播放或暂停
+
+***
+
+### plugins
+
+> **plugins**: `object`
+
+Defined in: lib/five/application/five.ts:262
+
+插件暴露的方法
+
+#### Index Signature
+
+\[`key`: `string`\]: `any`
+
+***
+
+### poweredByRealsee
+
+> **poweredByRealsee**: `boolean`
+
+Defined in: lib/five/application/five.ts:209
+
+是否显示 Powered By Realsee
+
+***
+
+### renderer?
+
+> `optional` **renderer**: `WebGLRenderer`
+
+Defined in: lib/five/application/five.ts:193
+
+当前使用的 THREE.WebGLRenderer。
+
+#### Description
+
+如果初始化时传入了 `renderer` 则直接时该值
+否则会通过 `preserveDrawingBuffer` `backgroundColor` `backgroundAlpha` `antialias` 创建一个 `THREE.WebGLRenderer`
+
+***
+
+### scene
+
+> **scene**: [`Scene`](Scene.md)
+
+Defined in: lib/five/application/five.ts:164
+
+非模型部分使用的 `THREE.Scene`
+
+***
+
+### state
+
+> **state**: [`State`](../interfaces/State.md)
+
+Defined in: lib/five/application/five.ts:259
+
+当前状态
+
+#### Description
+
+```text
+five 设置了以下状态
+
+- mode: Mode
+- panoIndex: number
+- longitude: number
+- latitude: number
+- fov: number
+- offset: THREE.Vector3
+
+可以通过 five.state 和 five.setState 来获取和设置。
+通过 state 设置后，five 会通过合适的动画运动来达到设置的位置。
+来迎合一些通过数据驱动的场景。
+```
+
+***
+
+### textureOptions
+
+> **textureOptions**: [`TextureOptions`](../interfaces/TextureOptions.md)
+
+Defined in: lib/five/application/five.ts:231
+
+模型贴图的配置参数
+
+#### Description
+
+可以动态对配置在 `work` 数据中的模型贴图在 runtime 做 url 调整。
+平衡加载时间和图片质量
+
+***
+
+### videoTexture
+
+> **videoTexture**: `VideoTexture`
+
+Defined in: lib/five/application/five.ts:239
+
+模型贴图的配置参数
+
+#### Description
+
+可以动态对配置在 `work` 数据中的模型贴图在 runtime 做 url 调整。
+平衡加载时间和图片质量
+
+***
+
+### viewport
+
+> **viewport**: [`Viewport`](../interfaces/Viewport.md)
+
+Defined in: lib/five/application/five.ts:185
+
+当前设置的 `viewport`
+
+#### Description
+
+可通过初始化，或者 setScissor 方式设置
+`viewport` 是将屏幕中的内容渲染到 `renderer` 的指定区域。
+页面整体长宽均为 `1`。通过类似 css 的 `left` `bottom` `width` `height` 来确定区域。
+
+#### Example
+
+```
+viewport: { left: 0.75, bottom: 0, width: 0.25, height: 1 }
+```
+
+***
+
+### xrCustomObjectsScene
+
+> **xrCustomObjectsScene**: `Scene`
+
+Defined in: lib/five/application/five.ts:169
+
+供外部放置需要在xr场景下产生遮挡的物体们
+
+***
+
+### Mode
+
+> `static` **Mode**: `object`
+
+Defined in: lib/five/application/five.ts:140
+
+Five 的显示模式，可以通过 `five.changeMode` `five.setState` 来切换
+
+#### Floorplan
+
+> `readonly` **Floorplan**: `"Floorplan"` = `"Floorplan"`
+
+#### Mapview
+
+> `readonly` **Mapview**: `"Mapview"` = `"Mapview"`
+
+#### Model
+
+> `readonly` **Model**: `"Model"` = `"Model"`
+
+#### Panorama
+
+> `readonly` **Panorama**: `"Panorama"` = `"Panorama"`
+
+#### Topview
+
+> `readonly` **Topview**: `"Topview"` = `"Topview"`
+
+#### VRPanorama
+
+> `readonly` **VRPanorama**: `"VRPanorama"` = `"VRPanorama"`
+
+#### XRPanorama
+
+> `readonly` **XRPanorama**: `"XRPanorama"` = `"XRPanorama"`
+
+#### Description
+
+```text
+Panorama 全景图游走模式
+Model 模型游走模式
+Floorplan 模型查看模式
+Topview 户型图模式
+VRPanorama VR眼镜模式
+XRPanorama VR硬件模式
+```
+
+## Accessors
+
+### boundingMesh
+
+#### Get Signature
+
+> **get** **boundingMesh**(): [`BoundingMesh`](BoundingMesh.md)
+
+Defined in: lib/five/application/five.ts:594
+
+获取 boundingMesh
+
+##### Returns
+
+[`BoundingMesh`](BoundingMesh.md)
+
+***
+
+### enableAdaptiveLuminance
+
+#### Get Signature
+
+> **get** **enableAdaptiveLuminance**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2845
+
+开启 AdaptiveLuminance
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **enableAdaptiveLuminance**(`enable`): `void`
+
+Defined in: lib/five/application/five.ts:2848
+
+##### Parameters
+
+###### enable
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### enableEDL
+
+#### Get Signature
+
+> **get** **enableEDL**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2836
+
+开启 edl
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **enableEDL**(`enable`): `void`
+
+Defined in: lib/five/application/five.ts:2839
+
+##### Parameters
+
+###### enable
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### enableHQ
+
+#### Get Signature
+
+> **get** **enableHQ**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2827
+
+开启 HQ
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **enableHQ**(`enable`): `void`
+
+Defined in: lib/five/application/five.ts:2830
+
+##### Parameters
+
+###### enable
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### enableIOSEDR
+
+#### Get Signature
+
+> **get** **enableIOSEDR**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2857
+
+##### Deprecated
+
+不可用
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **enableIOSEDR**(`enable`): `void`
+
+Defined in: lib/five/application/five.ts:2860
+
+##### Parameters
+
+###### enable
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### enablePostProcessing
+
+#### Get Signature
+
+> **get** **enablePostProcessing**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2867
+
+##### Deprecated
+
+不可用
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **enablePostProcessing**(`enable`): `void`
+
+Defined in: lib/five/application/five.ts:2870
+
+##### Parameters
+
+###### enable
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### helperVisible
+
+#### Get Signature
+
+> **get** **helperVisible**(): `boolean`
+
+Defined in: lib/five/application/five.ts:601
+
+帮助元素显示/隐藏
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **helperVisible**(`visible`): `void`
+
+Defined in: lib/five/application/five.ts:604
+
+##### Parameters
+
+###### visible
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### ident
+
+#### Get Signature
+
+> **get** **ident**(): `string`
+
+Defined in: lib/five/application/five.ts:507
+
+##### Returns
+
+`string`
+
+***
+
+### internalLightsEnabled
+
+#### Get Signature
+
+> **get** **internalLightsEnabled**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2676
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **internalLightsEnabled**(`value`): `void`
+
+Defined in: lib/five/application/five.ts:2685
+
+##### Parameters
+
+###### value
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### model
+
+#### Get Signature
+
+> **get** **model**(): [`Model`](Model.md)
+
+Defined in: lib/five/application/five.ts:846
+
+##### Returns
+
+[`Model`](Model.md)
+
+***
+
+### models
+
+#### Get Signature
+
+> **get** **models**(): [`Models`](../type-aliases/Models.md)
+
+Defined in: lib/five/application/five.ts:842
+
+##### Returns
+
+[`Models`](../type-aliases/Models.md)
+
+***
+
+### modelSceneNeedsRender
+
+#### Get Signature
+
+> **get** **modelSceneNeedsRender**(): `boolean`
+
+Defined in: lib/five/application/five.ts:2877
+
+##### Deprecated
+
+use five.modelScene.needsRender instead
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **modelSceneNeedsRender**(`needsRender`): `void`
+
+Defined in: lib/five/application/five.ts:2880
+
+##### Parameters
+
+###### needsRender
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### observers
+
+#### Get Signature
+
+> **get** **observers**(): readonly [`WorkObserver`](../interfaces/WorkObserver.md)[]
+
+Defined in: lib/five/application/five.ts:838
+
+##### Returns
+
+readonly [`WorkObserver`](../interfaces/WorkObserver.md)[]
+
+***
+
+### panoIndex
+
+#### Get Signature
+
+> **get** **panoIndex**(): `number`
+
+Defined in: lib/five/application/five.ts:511
+
+##### Returns
+
+`number`
+
+***
+
+### renderMode
+
+#### Get Signature
+
+> **get** **renderMode**(): `"default"` \| `"ssaa"` \| `"point-cloud-high-quality"`
+
+Defined in: lib/five/application/five.ts:2819
+
+设置渲染模式
+
+##### Returns
+
+`"default"` \| `"ssaa"` \| `"point-cloud-high-quality"`
+
+#### Set Signature
+
+> **set** **renderMode**(`value`): `void`
+
+Defined in: lib/five/application/five.ts:2822
+
+##### Parameters
+
+###### value
+
+`"default"` | `"ssaa"` | `"point-cloud-high-quality"`
+
+##### Returns
+
+`void`
+
+***
+
+### scissor
+
+#### Get Signature
+
+> **get** **scissor**(): [`Viewport`](../interfaces/Viewport.md)
+
+Defined in: lib/five/application/five.ts:2702
+
+##### Deprecated
+
+use Viewport instead.
+
+##### Returns
+
+[`Viewport`](../interfaces/Viewport.md)
+
+***
+
+### work
+
+#### Get Signature
+
+> **get** **work**(): [`Work`](Work.md)
+
+Defined in: lib/five/application/five.ts:834
+
+##### Returns
+
+[`Work`](Work.md)
+
+***
+
+### works
+
+#### Get Signature
+
+> **get** **works**(): [`Works`](../type-aliases/Works.md)
+
+Defined in: lib/five/application/five.ts:826
+
+当前加载的 work 数据
+
+##### Returns
+
+[`Works`](../type-aliases/Works.md)
+
+***
+
+### dracoPath
+
+#### Get Signature
+
+> **get** `static` **dracoPath**(): `string`
+
+Defined in: lib/five/application/five.ts:104
+
+##### Returns
+
+`string`
+
+#### Set Signature
+
+> **set** `static` **dracoPath**(`path`): `void`
+
+Defined in: lib/five/application/five.ts:108
+
+##### Parameters
+
+###### path
+
+`string`
+
+##### Returns
+
+`void`
+
+***
+
+### ktx2Path
+
+#### Get Signature
+
+> **get** `static` **ktx2Path**(): `string`
+
+Defined in: lib/five/application/five.ts:112
+
+##### Returns
+
+`string`
+
+#### Set Signature
+
+> **set** `static` **ktx2Path**(`path`): `void`
+
+Defined in: lib/five/application/five.ts:116
+
+##### Parameters
+
+###### path
+
+`string`
+
+##### Returns
+
+`void`
+
+***
+
+### useNativeImageBitmap
+
+#### Get Signature
+
+> **get** `static` **useNativeImageBitmap**(): `boolean`
+
+Defined in: lib/five/application/five.ts:120
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** `static` **useNativeImageBitmap**(`enable`): `void`
+
+Defined in: lib/five/application/five.ts:124
+
+##### Parameters
+
+###### enable
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### version
+
+#### Get Signature
+
+> **get** `static` **version**(): `string`
+
+Defined in: lib/five/application/five.ts:99
+
+##### Returns
+
+`string`
+
+## Methods
+
+### addExtraElement()
+
+> **addExtraElement**(`element`): () => `void`
+
+Defined in: lib/five/application/five.ts:749
+
+绑定一个额外 DOM 区域，接受触控/鼠标事件
+
+#### Parameters
+
+##### element
+
+`HTMLElement`
+
+#### Returns
+
+解除该绑定
+
+> (): `void`
+
+##### Returns
+
+`void`
+
+***
+
+### addPass()
+
+> **addPass**(`pass`): `void`
+
+Defined in: lib/five/application/five.ts:2774
+
+增加后处理PASS
+
+#### Parameters
+
+##### pass
+
+[`Pass`](../interfaces/Pass.md)
+
+要添加的Pass实例
+
+#### Returns
+
+`void`
+
+***
+
+### appendTo()
+
+> **appendTo**(`element`, `size`): `void`
+
+Defined in: lib/five/application/five.ts:680
+
+将显示区域加载到页面 DOM 中
+
+#### Parameters
+
+##### element
+
+`HTMLElement`
+
+加载到页面的 DOM 元素
+
+##### size
+
+显示区域尺寸 默认铺满这个 DOM 元素
+
+###### height?
+
+`number`
+
+###### width?
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Description
+
+如果你是传入的 `renderer`. 则你需要自行来方式显示区域该方法并不生效
+
+***
+
+### changeMode()
+
+> **changeMode**\<`T`\>(`mode`, `state`, `options?`, `userAction?`, `force?`): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:1272
+
+切换模态
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`Mode`](../type-aliases/Mode.md)
+
+#### Parameters
+
+##### mode
+
+`T`
+
+切换到的模态
+
+##### state
+
+`Partial`\<`Omit`\<[`State`](../interfaces/State.md), `"mode"`\>\> = `{}`
+
+切换完成时的姿态
+
+##### options?
+
+模态切换动画用时
+
+`number` | \{ `duration?`: `number`; `effect?`: [`MovePanoEffect`](../type-aliases/MovePanoEffect.md); \}
+
+##### userAction?
+
+`boolean` = `true`
+
+是否时用户动作触发 默认 true
+
+##### force?
+
+`boolean` = `false`
+
+必须重新初始化 controller
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/application/five.ts:521
+
+析构 five 对象。
+
+#### Returns
+
+`void`
+
+#### Description
+
+一旦调用了析构方法，则不能再使用当前 five 对象了。
+你可以新建一个新的。
+
+***
+
+### 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`](../type-aliases/EventTypes.md)\[`K`\]\>
+
+触发事件的数据
+
+#### Returns
+
+`boolean`
+
+canceled 是否被触发取消
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`emit`](Subscribe.md#emit)
+
+***
+
+### exitFullscreen()
+
+> **exitFullscreen**(): `void`
+
+Defined in: lib/five/application/five.ts:2428
+
+退出全屏
+
+#### Returns
+
+`void`
+
+***
+
+### ~~getCameraLocal()~~
+
+> **getCameraLocal**(): `object`
+
+Defined in: lib/five/application/five.ts:2744
+
+获取当前相机的姿态（用于内部的 python 脚本截图）
+
+#### Returns
+
+`object`
+
+##### ~~lookAtVector~~
+
+> **lookAtVector**: `Vector3`
+
+##### ~~phi~~
+
+> **phi**: `number`
+
+##### ~~theta~~
+
+> **theta**: `number`
+
+#### Deprecated
+
+这是用于内部的 python 脚本截图
+
+***
+
+### getCurrentState()
+
+> **getCurrentState**(): [`State`](../interfaces/State.md)
+
+Defined in: lib/five/application/five.ts:2034
+
+#### Returns
+
+[`State`](../interfaces/State.md)
+
+***
+
+### getDrawingBufferSize()
+
+> **getDrawingBufferSize**(`target`): `Vector2`
+
+Defined in: lib/five/application/five.ts:781
+
+#### Parameters
+
+##### target
+
+`Vector2`
+
+#### Returns
+
+`Vector2`
+
+***
+
+### getElement()
+
+> **getElement**(): `HTMLCanvasElement`
+
+Defined in: lib/five/application/five.ts:1656
+
+获取显示用的画布（Canvas DOM节点）
+
+#### Returns
+
+`HTMLCanvasElement`
+
+***
+
+### ~~getLongitudeAndLatitude()~~
+
+> **getLongitudeAndLatitude**(): `Pick`\<[`Pose`](../interfaces/Pose.md), `"longitude"` \| `"latitude"`\>
+
+Defined in: lib/five/application/five.ts:2727
+
+获取当前相机经纬度
+
+#### Returns
+
+`Pick`\<[`Pose`](../interfaces/Pose.md), `"longitude"` \| `"latitude"`\>
+
+#### Deprecated
+
+请使用使用 getPose
+
+***
+
+### getMaxShDegree()
+
+> **getMaxShDegree**(): `number`
+
+Defined in: lib/five/application/five.ts:2812
+
+获取当前球谐阶数
+
+#### Returns
+
+`number`
+
+当前球谐阶数，如果没有 pbmGSRenderMesh 则返回 0
+
+***
+
+### ~~getOffset()~~
+
+> **getOffset**(): `Vector3`
+
+Defined in: lib/five/application/five.ts:2736
+
+获取当前相机位置
+
+#### Returns
+
+`Vector3`
+
+#### Deprecated
+
+请使用使用 getPose
+
+***
+
+### getPixels()
+
+#### Call Signature
+
+> **getPixels**\<`T`\>(`x`, `y`, `width`, `height`, `pixelRatio?`, `flipY?`, `buffer?`): `T`
+
+Defined in: lib/five/application/five.ts:1452
+
+获取画面中的像素颜色
+
+##### 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
+
+> **getPixels**\<`T`\>(`options`): `T`
+
+Defined in: lib/five/application/five.ts:1466
+
+获取画面中的像素颜色
+
+##### 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`
+
+***
+
+### ~~getPose()~~
+
+> **getPose**(): [`Pose`](../interfaces/Pose.md)
+
+Defined in: lib/five/application/five.ts:2718
+
+#### Returns
+
+[`Pose`](../interfaces/Pose.md)
+
+#### Deprecated
+
+获取当前相机姿态, 可以使用 getCurrentState 代替
+
+***
+
+### getSize()
+
+> **getSize**(`target`): `Vector2`
+
+Defined in: lib/five/application/five.ts:771
+
+#### Parameters
+
+##### target
+
+`Vector2`
+
+#### Returns
+
+`Vector2`
+
+***
+
+### 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`](Subscribe.md).[`hasListener`](Subscribe.md#haslistener)
+
+***
+
+### insertPass()
+
+> **insertPass**(`pass`, `index`): `void`
+
+Defined in: lib/five/application/five.ts:2794
+
+在指定位置插入后处理Pass
+
+#### Parameters
+
+##### pass
+
+[`Pass`](../interfaces/Pass.md)
+
+要插入的Pass实例
+
+##### index
+
+`number`
+
+插入位置的索引
+
+#### Returns
+
+`void`
+
+***
+
+### load()
+
+> **load**(`inputWork`, `state?`, `options?`, `userAction?`): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:859
+
+加载 Work 数据
+
+#### Parameters
+
+##### inputWork
+
+Work 数据
+
+`string` | `string`[] | [`LooseWork`](../interfaces/LooseWork.md) | [`Work`](Work.md) | [`Work`](Work.md)[] | [`LooseWork`](../interfaces/LooseWork.md)[] | [`LooseWorkWithExtrinsics`](../interfaces/LooseWorkWithExtrinsics.md)[] | `Promise`\<[`LooseWork`](../interfaces/LooseWork.md) \| [`Work`](Work.md) \| [`Work`](Work.md)[] \| [`LooseWork`](../interfaces/LooseWork.md)[] \| [`LooseWorkWithExtrinsics`](../interfaces/LooseWorkWithExtrinsics.md)[]\>
+
+##### state?
+
+初始化姿态
+ - "inherit" 使用当前姿态
+ - "initial" 使用 Work 数据中的 initial 姿态
+ - State 自定义姿态
+
+`"initial"` | `"inherit"` | `Partial`\<[`State`](../interfaces/State.md)\>
+
+##### options?
+
+切换时间, 切换效果
+
+`number` | [`FiveLoadOptions`](../interfaces/FiveLoadOptions.md)
+
+##### userAction?
+
+`boolean` = `true`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### moveToPano()
+
+> **moveToPano**(`pano`, `options`, `userAction`): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:1925
+
+转化到 Panorama 模态，并移动到对应序号的观察点。
+
+#### Parameters
+
+##### pano
+
+观察点序号
+
+`number` | [`Pano`](../type-aliases/Pano.md) | `` `${string}[${number}]` ``
+
+##### options
+
+[`MovePanoOptions`](../interfaces/MovePanoOptions.md) = `{}`
+
+移动点位参数
+
+##### userAction
+
+`boolean` = `true`
+
+是否用户触犯
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### 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`](../type-aliases/EventTypes.md)\[`K`\]\>
+
+事件回调函数
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`off`](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`](../type-aliases/EventTypes.md)\[`K`\]\>
+
+事件回调函数
+
+##### once?
+
+`boolean`
+
+是否只执行一次
+
+#### Returns
+
+解除事件
+
+> (): `void`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`on`](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`](../type-aliases/EventTypes.md)\[`K`\]\>
+
+事件回调函数
+
+#### Returns
+
+解除事件
+
+> (): `void`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`once`](Subscribe.md#once)
+
+***
+
+### pause()
+
+> **pause**(): `void`
+
+Defined in: lib/five/application/five.ts:1907
+
+暂停自动播放
+
+#### Returns
+
+`void`
+
+***
+
+### play()
+
+> **play**(): `void`
+
+Defined in: lib/five/application/five.ts:1914
+
+#### Returns
+
+`void`
+
+***
+
+### preloadPano()
+
+> **preloadPano**(`pano`, `callback`): `Promise`\<`number`\>
+
+Defined in: lib/five/application/five.ts:1978
+
+预加载点位图片资源
+
+#### Parameters
+
+##### pano
+
+观察点序号
+
+`number` | [`Pano`](../type-aliases/Pano.md) | `` `${string}[${number}]` ``
+
+##### callback
+
+(`costs`) => `void`
+
+加载完成回调, 并传递加载用时。
+
+#### Returns
+
+`Promise`\<`number`\>
+
+加载完成的 Promise 参数同 callback
+
+***
+
+### project2d()
+
+> **project2d**(`vector`, `testModel`): `Vector2`
+
+Defined in: lib/five/application/five.ts:2013
+
+计算三维坐标对应到屏幕的二维坐标
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+三维坐标
+
+##### testModel
+
+`boolean` = `false`
+
+是否计算模型遮挡
+
+#### Returns
+
+`Vector2`
+
+二维坐标 或者 null
+
+#### Description
+
+如果三维坐标不在屏幕中，则返回 null
+
+***
+
+### ready()
+
+> **ready**(`args`): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:2401
+
+当前页面静态
+
+#### Parameters
+
+##### args
+
+###### tile?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### refresh()
+
+> **refresh**(`size`, `pixelRatio?`): `void`
+
+Defined in: lib/five/application/five.ts:709
+
+设置显示区域尺寸
+
+#### Parameters
+
+##### size
+
+显示区域尺寸 默认铺满这个 DOM 元素
+
+###### height?
+
+`number`
+
+###### width?
+
+`number`
+
+##### pixelRatio?
+
+`number`
+
+像素比 默认继承之前的设置
+
+#### Returns
+
+`void`
+
+#### Description
+
+如果你是传入的 `renderer`. 则你需要自行来设置显示区域尺寸，该方法并不生效
+
+***
+
+### removeExtraElement()
+
+> **removeExtraElement**(`element`): `void`
+
+Defined in: lib/five/application/five.ts:762
+
+解除绑定的一个额外 DOM 区域
+
+#### Parameters
+
+##### element
+
+`HTMLElement`
+
+#### Returns
+
+`void`
+
+***
+
+### removePass()
+
+> **removePass**(`pass`): `void`
+
+Defined in: lib/five/application/five.ts:2782
+
+移除后处理Pass
+
+#### Parameters
+
+##### pass
+
+[`Pass`](../interfaces/Pass.md)
+
+要移除的Pass实例
+
+#### Returns
+
+`void`
+
+***
+
+### render()
+
+> **render**(`callback?`): `void`
+
+Defined in: lib/five/application/five.ts:1671
+
+强制渲染
+
+#### Parameters
+
+##### callback?
+
+() => `void`
+
+渲染完成回调
+
+#### Returns
+
+`void`
+
+#### Description
+
+调用 `five.render()` 和设置 `five.needsRender = true` 均可在按需渲染时，使得画面渲染一次
+区别在于：
+- `five.needsRender = true` 为在下帧渲染画面
+- `five.render()` 在当前帧渲染画面
+推荐使用 `five.needsRender = true`, 可以更加流畅。但是如果需要截图等同步操作，可以使用 `five.render()`
+
+***
+
+### requestFullscreen()
+
+> **requestFullscreen**(): `void`
+
+Defined in: lib/five/application/five.ts:2417
+
+请求全屏
+
+#### Returns
+
+`void`
+
+***
+
+### reset()
+
+> **reset**(): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:1204
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### reset\_()
+
+> **reset\_**(): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:1214
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### setMaxShDegree()
+
+> **setMaxShDegree**(`degree`): `void`
+
+Defined in: lib/five/application/five.ts:2802
+
+设置球谐阶数
+
+#### Parameters
+
+##### degree
+
+`number`
+
+球谐阶数
+
+#### Returns
+
+`void`
+
+***
+
+### ~~setScissor()~~
+
+> **setScissor**(`scissor`): `void`
+
+Defined in: lib/five/application/five.ts:2710
+
+#### Parameters
+
+##### scissor
+
+[`Viewport`](../interfaces/Viewport.md)
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+use setViewport instead.
+
+***
+
+### setState()
+
+> **setState**(`state`, `immediately`, `userAction`): `void`
+
+Defined in: lib/five/application/five.ts:2065
+
+设置 State
+
+#### Parameters
+
+##### state
+
+`Partial`\<[`State`](../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 会通过合适的动画运动来达到设置的位置。
+来迎合一些通过数据驱动的场景。
+```
+
+***
+
+### setViewport()
+
+> **setViewport**(`viewport`): `void`
+
+Defined in: lib/five/application/five.ts:586
+
+设置 `viewport`
+
+#### Parameters
+
+##### viewport
+
+[`Viewport`](../interfaces/Viewport.md)
+
+指定区域
+`scissor` 是将屏幕中的内容渲染到 `renderer` 的指定区域。
+请确保在 five 初始化时传入 `renderer` 对象
+页面整体长宽均为 `1`。通过类似 css 的 `left` `bottom` `width` `height` 来确定区域。
+
+#### Returns
+
+`void`
+
+#### Example
+
+```
+five.setViewport({ left: 0.75, bottom: 0, width: 0.25, height: 1 })
+```
+
+***
+
+### updateCamera()
+
+> **updateCamera**(`pose`, `duration`, `userAction`): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:801
+
+移动相机。（不触发点位移动）
+
+#### Parameters
+
+##### pose
+
+`Partial`\<[`Pose`](../interfaces/Pose.md)\>
+
+相机目标位置
+
+##### duration
+
+`number`
+
+动画触发的时常
+
+##### userAction
+
+`boolean` = `true`
+
+是否用户触发
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise 是否移动成功
+
+#### Description
+
+如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
+会 Promise.reject。运动完成则 Promise.resolve
+
+***
+
+### updateCameraWithKeyframes()
+
+> **updateCameraWithKeyframes**(`keyframes`, `duration`, `userAction`): `Promise`\<`void`\>
+
+Defined in: lib/five/application/five.ts:818
+
+通过帧动画移动相机。（不触发点位移动）
+
+#### Parameters
+
+##### keyframes
+
+`object`[]
+
+动画帧
+
+##### duration
+
+`number`
+
+动画触发的时常
+
+##### userAction
+
+`boolean` = `true`
+
+是否用户触发
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise 是否移动成功
+
+#### Description
+
+如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
+会 Promise.reject。运动完成则 Promise.resolve
+
+***
+
+### updateConfiguration()
+
+> **updateConfiguration**(`args`, `refresh`): `void`
+
+Defined in: lib/five/application/five.ts:615
+
+#### Parameters
+
+##### args
+
+`Pick`\<[`FiveInitArgs`](../interfaces/FiveInitArgs.md), `"panorama"` \| `"model"` \| `"floorplan"` \| `"topview"` \| `"mapview"` \| `"vrPanorama"` \| `"imageOptions"` \| `"textureOptions"`\>
+
+##### refresh
+
+`boolean` = `true`
+
+#### Returns
+
+`void`
+
+***
+
+### updateTime()
+
+> **updateTime**(`time`, `deltaTime`, ...`args`): `void`
+
+Defined in: lib/five/application/five.ts:1738
+
+#### Parameters
+
+##### time
+
+`number`
+
+##### deltaTime
+
+`number`
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`void`
+
+***
+
+### waitUntil()
+
+> **waitUntil**\<`K`\>(`name`, `filter?`): `Promise`\<`Parameters`\<[`EventTypes`](../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`](../type-aliases/EventTypes.md)\[`K`\]\>\>
+
+触发事件的数据
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`waitUntil`](Subscribe.md#waituntil)