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

package/docs_markdown/five/interfaces/EventCallback.md

@@ -1,3374 +0,0 @@
-[**如视 Five SDK**](../../README.md)
-
-***
-
-[如视 Five SDK](../../modules.md) / [five](../README.md) / EventCallback
-
-# Interface: EventCallback
-
-Defined in: lib/five/application/events.ts:126
-
-Five 事件列表
-
-## Description
-
-可以通过 `five.on(METHOD_NAME, METHOD)` 调用
-
-## Extends
-
-- [`EventTypes`](../type-aliases/EventTypes.md)
-
-## Methods
-
-### camera.update()
-
-> **camera.update**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:36
-
-相机改变
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.camera.update`
-
-***
-
-### cameraDirectionUpdate()
-
-> **cameraDirectionUpdate**(`coordinates`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:226
-
-相机姿态中相机方向变化
-
-#### Parameters
-
-##### coordinates
-
-`Pick`\<[`Pose`](Pose.md), `"longitude"` \| `"latitude"`\>
-
-相机姿态的俯仰角和偏航角
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.cameraDirectionUpdate`
-
-***
-
-### cameraFovUpdate()
-
-> **cameraFovUpdate**(`fov`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:212
-
-相机姿态中可视角度变化
-
-#### Parameters
-
-##### fov
-
-`number`
-
-相机的可视角度
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.cameraFovUpdate`
-
-***
-
-### cameraPositionUpdate()
-
-> **cameraPositionUpdate**(`offset`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:219
-
-相机姿态中相机位置变化
-
-#### Parameters
-
-##### offset
-
-`Vector3`
-
-相机位置
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.cameraPositionUpdate`
-
-***
-
-### cameraUpdate()
-
-> **cameraUpdate**(`pose`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:205
-
-相机姿态变化
-
-#### Parameters
-
-##### pose
-
-[`Pose`](Pose.md)
-
-相机姿态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.cameraUpdate`
-
-***
-
-### currentState.change()
-
-> **currentState.change**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:76
-
-当前 state 变化
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.currentState.change`
-
-***
-
-### currentStateChange()
-
-> **currentStateChange**(`state`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:432
-
-当前实时 state 变化时
-
-#### Parameters
-
-##### state
-
-[`State`](State.md)
-
-当前姿态状态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.currentStateChange`
-
-***
-
-### dblTapGesture()
-
-> **dblTapGesture**(`raycaster`, `tapPosition`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:122
-
-dbltap 手势(点击屏幕) 被触发
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-点击对应的三维射线
-
-##### tapPosition
-
-`Vector2`
-
-点击对应的屏幕位置
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.dblTapGesture`
-
-***
-
-### dispose()
-
-> **dispose**(): `void`
-
-Defined in: lib/five/application/events.ts:118
-
-five 被析构。 插件中请监听用于自身析构
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.dispose`
-
-***
-
-### error()
-
-> **error**(`error`): `void`
-
-Defined in: lib/five/application/events.ts:55
-
-内部错误
-
-#### Parameters
-
-##### error
-
-`Error`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.error`
-
-***
-
-### fps()
-
-> **fps**(`fps`): `void`
-
-Defined in: lib/five/application/events.ts:115
-
-当前 fps 变化
-
-#### Parameters
-
-##### fps
-
-`number`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.fps`
-
-***
-
-### gesture()
-
-> **gesture**(`type`, `pointers`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:73
-
-手势 触发
-
-#### Parameters
-
-##### type
-
-[`GestureTypes`](../type-aliases/GestureTypes.md)
-
-手势类型
-
-##### pointers
-
-`object`[]
-
-手指位置
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture`
-
-***
-
-### gesture.dbltap()
-
-> **gesture.dbltap**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:12
-
-手势 双击屏幕
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.dbltap`
-
-***
-
-### gesture.momentum()
-
-> **gesture.momentum**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:27
-
-手势 惯性
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.momentum`
-
-***
-
-### gesture.mousemove()
-
-> **gesture.mousemove**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:24
-
-手势 鼠标移动
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.mousemove`
-
-***
-
-### gesture.mousewheel()
-
-> **gesture.mousewheel**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:21
-
-手势 鼠标滚轮
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.mousewheel`
-
-***
-
-### gesture.pan()
-
-> **gesture.pan**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:6
-
-手势 滑动屏幕
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.pan`
-
-***
-
-### gesture.pinch()
-
-> **gesture.pinch**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:18
-
-手势 双指缩放
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.pinch`
-
-***
-
-### gesture.press()
-
-> **gesture.press**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:15
-
-手势 长按屏幕
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.press`
-
-***
-
-### gesture.tap()
-
-> **gesture.tap**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:9
-
-手势 点击屏幕
-
-#### Parameters
-
-##### event
-
-[`GestureEvent`](GestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.gesture.tap`
-
-***
-
-### helpers.visible()
-
-> **helpers.visible**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:109
-
-改变 helpers 元素可见
-
-#### Parameters
-
-##### event
-
-[`ObjectEvent`](ObjectEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.helpers.visible`
-
-***
-
-### helpersVisibleChange()
-
-> **helpersVisibleChange**(`visible`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:499
-
-帮助元素显应的变换
-
-#### Parameters
-
-##### visible
-
-`boolean`
-
-帮助元素的是否开启
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.helpersVisibleChange`
-
-***
-
-### initAnimation.end()
-
-> **initAnimation.end**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:33
-
-模态切换动画 结束
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.initAnimation.end`
-
-***
-
-### initAnimation.start()
-
-> **initAnimation.start**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:30
-
-模态切换动画 开始
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.initAnimation.start`
-
-***
-
-### initAnimationEnded()
-
-> **initAnimationEnded**(`panoIndex`, `pose`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:56
-
-模态间切换动画结束
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-当前点位
-
-##### pose
-
-[`Pose`](Pose.md)
-
-相机姿态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.initAnimationEnded`
-
-***
-
-### initAnimationWillStart()
-
-> **initAnimationWillStart**(`panoIndex`, `pose`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:48
-
-模态间切换动画开始
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-当前点位
-
-##### pose
-
-[`Pose`](Pose.md)
-
-相机姿态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.initAnimationWillStart`
-
-***
-
-### interiaPan()
-
-> **interiaPan**(`pose`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:189
-
-pan 手势(滑动屏幕) 的惯性运动
-
-#### Parameters
-
-##### pose
-
-[`Pose`](Pose.md)
-
-意图的相机姿态
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.interiaPan`
-
-***
-
-### intersect.update()
-
-> **intersect.update**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:38
-
-#### Parameters
-
-##### event
-
-[`IntersectEvent`](IntersectEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.intersect.update`
-
-***
-
-### intersectionHidden()
-
-> **intersectionHidden**(): `void`
-
-Defined in: lib/five/application/events-legacy.ts:243
-
-鼠标焦点环被隐藏
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.intersectionHidden`
-
-***
-
-### intersectionOnModelUpdate()
-
-> **intersectionOnModelUpdate**(`intersection`, `mesh`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:233
-
-鼠标焦点环位置被重新计算
-
-#### Parameters
-
-##### intersection
-
-[`Intersection`](Intersection.md)
-
-焦点碰撞结果
-
-##### mesh
-
-`Object3D`
-
-焦点环 mesh
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.intersectionOnModelUpdate`
-
-***
-
-### load()
-
-> **load**(`input`, `work`, `state`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:411
-
-开始加载 Work 数据
-
-#### Parameters
-
-##### input
-
-`any`
-
-输入的 work
-
-##### work
-
-[`Work`](../classes/Work.md)
-
-归一化的标准 work
-
-##### state
-
-`Partial`\<[`State`](State.md)\>
-
-加载时的姿态
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.load`
-
-***
-
-### loaded()
-
-> **loaded**(`input`, `work`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:418
-
-加载完 Work 数据
-
-#### Parameters
-
-##### input
-
-`any`
-
-输入的 work
-
-##### work
-
-[`Work`](../classes/Work.md)
-
-归一化的标准 work
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.loaded`
-
-***
-
-### mode.change()
-
-> **mode.change**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:106
-
-改变 mode
-
-#### Parameters
-
-##### event
-
-[`ModeChangeEvent`](ModeChangeEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.mode.change`
-
-***
-
-### mode.change.request()
-
-> **mode.change.request**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:103
-
-请求改变 mode
-
-#### Parameters
-
-##### event
-
-[`ModeChangeEvent`](ModeChangeEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.mode.change.request`
-
-***
-
-### modeChange()
-
-> **modeChange**(`mode`, `prevMode`, `panoIndex`, `toPose`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:493
-
-模态切换完成
-
-#### Parameters
-
-##### mode
-
-[`Mode`](../type-aliases/Mode.md)
-
-切换到的模态
-
-##### prevMode
-
-[`Mode`](../type-aliases/Mode.md)
-
-上本质是一个模态
-
-##### panoIndex
-
-`number`
-
-初始化动画结束后的点位下标
-
-##### toPose
-
-[`Pose`](Pose.md)
-
-初始化动画结束后的状态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.modeChange`
-
-***
-
-### model.changeShownFloor()
-
-> **model.changeShownFloor**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:88
-
-当模型修改楼层
-
-#### Parameters
-
-##### event
-
-[`ModelEvent`](ModelEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.model.changeShownFloor`
-
-***
-
-### model.error()
-
-> **model.error**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:85
-
-当模型错误
-
-#### Parameters
-
-##### event
-
-[`ModelEvent`](ModelEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.model.error`
-
-***
-
-### model.load()
-
-> **model.load**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:82
-
-当模型修改楼层
-
-#### Parameters
-
-##### event
-
-[`ModelEvent`](ModelEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.model.load`
-
-***
-
-### model.request()
-
-> **model.request**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:79
-
-当模型加载
-
-#### Parameters
-
-##### event
-
-[`ModelEvent`](ModelEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.model.request`
-
-***
-
-### modelLoaded()
-
-> **modelLoaded**(`model`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:463
-
-模型加载完成
-
-#### Parameters
-
-##### model
-
-[`Model`](../classes/Model.md)
-
-加载完的 model
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.modelLoaded`
-
-***
-
-### modelLoadError()
-
-> **modelLoadError**(`error`, `model`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:457
-
-模型加载错误
-
-#### Parameters
-
-##### error
-
-`Error`
-
-错误对象
-
-##### model
-
-[`Model`](../classes/Model.md)
-
-加载完的 model
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.modelLoadError`
-
-***
-
-### models.load()
-
-> **models.load**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:91
-
-模型加载完成
-
-#### Parameters
-
-##### event
-
-[`ModelSceneEvent`](ModelSceneEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.models.load`
-
-***
-
-### models.refined()
-
-> **models.refined**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:94
-
-模型细化完成
-
-#### Parameters
-
-##### event
-
-[`ModelSceneEvent`](ModelSceneEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.models.refined`
-
-***
-
-### modelShownFloorChange()
-
-> **modelShownFloorChange**(`shownFloor`, `floorLength`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:469
-
-模型楼层切换
-
-#### Parameters
-
-##### shownFloor
-
-`number`
-
-模型楼层
-
-##### floorLength
-
-`number`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.modelShownFloorChange`
-
-***
-
-### modelWillLoad()
-
-> **modelWillLoad**(`workModel`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:450
-
-模型开始加载
-
-#### Parameters
-
-##### workModel
-
-[`WorkModel`](WorkModel.md)
-
-归一化的标准 work 中的 model 值
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.modelWillLoad`
-
-***
-
-### mouseWheel()
-
-> **mouseWheel**(`delta`, `fov`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:175
-
-鼠标滚轮被触发
-
-#### Parameters
-
-##### delta
-
-`number`
-
-滚轮数值
-
-##### fov
-
-`number`
-
-意图的fov变更
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.mouseWheel`
-
-***
-
-### moveToPano()
-
-> **moveToPano**(`panoIndex`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:279
-
-开始加载并移动到某个观察点位
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-移动到的点位
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Description
-
-可 panoWillArrive 相比
-- moveToPano 在加载全景图资源前触发
-- panoWillArrive 在加载全景图资源后触发
-
-#### Inherited from
-
-`EventTypes.moveToPano`
-
-***
-
-### moveToPanoCanceled()
-
-> **moveToPanoCanceled**(`panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:337
-
-移动到某个观察点位被取消
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-对应的点位
-
-#### Returns
-
-`void`
-
-#### Description
-
-这个有一些情况会导致
-- 移动过程中切换模态
-- 移动过程中 five 被析构
-- 移动过程点击切换到另一个点位
-
-#### Inherited from
-
-`EventTypes.moveToPanoCanceled`
-
-***
-
-### movingToPano()
-
-> **movingToPano**(`panoIndex`, `prevPanoIndex`, `progress`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:287
-
-移动中， 会告知移动状态（耗时百分比）
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-将要移动到的点位下标
-
-##### prevPanoIndex
-
-`number`
-
-上一个点位下标
-
-##### progress
-
-`number`
-
-整个过程经度 [0-1]
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.movingToPano`
-
-***
-
-### network()
-
-> **network**(`source`, `type`, `state`, `detail`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:507
-
-网络资源分析
-
-#### Parameters
-
-##### source
-
-`string`
-
-资源地址
-
-##### type
-
-[`NetworkType`](../type-aliases/NetworkType.md)
-
-##### state
-
-[`NetworkState`](../type-aliases/NetworkState.md)
-
-状态
-
-##### detail
-
-`string`
-
-详情
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.network`
-
-***
-
-### network.resource()
-
-> **network.resource**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:112
-
-网络资源
-
-#### Parameters
-
-##### event
-
-[`NetworkResourceEvent`](NetworkResourceEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.network.resource`
-
-***
-
-### panGesture()
-
-> **panGesture**(`pose`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:88
-
-pan 手势(滑动屏幕) 被触发
-
-#### Parameters
-
-##### pose
-
-[`Pose`](Pose.md)
-
-相机姿态
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.panGesture`
-
-***
-
-### pano.arrived()
-
-> **pano.arrived**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:53
-
-运动到达点位
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.arrived`
-
-***
-
-### pano.cancel()
-
-> **pano.cancel**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:56
-
-取消运动点位
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.cancel`
-
-***
-
-### pano.error()
-
-> **pano.error**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:59
-
-运动点位出错
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.error`
-
-***
-
-### pano.moveTo()
-
-> **pano.moveTo**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:47
-
-运动去点位
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.moveTo`
-
-***
-
-### pano.moving()
-
-> **pano.moving**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:50
-
-运动点位过程
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.moving`
-
-***
-
-### pano.request()
-
-> **pano.request**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:52
-
-请求点位
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.request`
-
-***
-
-### pano.select()
-
-> **pano.select**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:41
-
-选择
-
-#### Parameters
-
-##### event
-
-[`PanoEvent`](PanoEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.select`
-
-***
-
-### pano.texture.abort()
-
-> **pano.texture.abort**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:74
-
-加载全景材质中止
-
-#### Parameters
-
-##### event
-
-[`PanoTextureEvent`](PanoTextureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.texture.abort`
-
-***
-
-### pano.texture.error()
-
-> **pano.texture.error**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:71
-
-加载全景材质失败
-
-#### Parameters
-
-##### event
-
-[`PanoTextureEvent`](PanoTextureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.texture.error`
-
-***
-
-### pano.texture.load()
-
-> **pano.texture.load**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:62
-
-加载全景材质
-
-#### Parameters
-
-##### event
-
-[`PanoTextureEvent`](PanoTextureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.texture.load`
-
-***
-
-### pano.texture.progress()
-
-> **pano.texture.progress**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:65
-
-加载全景材质进度
-
-#### Parameters
-
-##### event
-
-[`PanoTextureEvent`](PanoTextureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.texture.progress`
-
-***
-
-### pano.texture.success()
-
-> **pano.texture.success**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:68
-
-加载全景材质成功
-
-#### Parameters
-
-##### event
-
-[`PanoTextureEvent`](PanoTextureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pano.texture.success`
-
-***
-
-### panoArrived()
-
-> **panoArrived**(`panoIndex`, `pose`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:319
-
-移动到某个观察点位
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-移动到点位
-
-##### pose
-
-[`Pose`](Pose.md)
-
-相机姿态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.panoArrived`
-
-***
-
-### panoLoaded()
-
-> **panoLoaded**(`panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:299
-
-某个观察点的全景资源加载完成
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-对应的点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.panoLoaded`
-
-***
-
-### panoLoadError()
-
-> **panoLoadError**(`error`, `panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:326
-
-某个观察点的全景资源加载失败
-
-#### Parameters
-
-##### error
-
-`Error`
-
-错误对象
-
-##### panoIndex
-
-`number`
-
-对应的点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.panoLoadError`
-
-***
-
-### panoSelected()
-
-> **panoSelected**(`panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:268
-
-观察点位被选择
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-选择的点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.panoSelected`
-
-***
-
-### panoWillArrive()
-
-> **panoWillArrive**(`panoIndex`, `pose`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:311
-
-开始移动到某个观察点位
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-移动到点位
-
-##### pose
-
-[`Pose`](Pose.md)
-
-相机姿态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Description
-
-和 moveToPano 相比
-- moveToPano 在加载全景图资源前触发
-- panoWillArrive 在加载全景图资源后触发
-
-#### Inherited from
-
-`EventTypes.panoWillArrive`
-
-***
-
-### panoWillLoad()
-
-> **panoWillLoad**(`panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:293
-
-开始加载某个观察点的全景资源
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-移动到的点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.panoWillLoad`
-
-***
-
-### pinchGesture()
-
-> **pinchGesture**(`scale`, `fov`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:158
-
-pinch 手势(双指缩放) 被触发
-
-#### Parameters
-
-##### scale
-
-`number`
-
-缩放数值
-
-##### fov
-
-`number`
-
-意图的fov变更
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pinchGesture`
-
-***
-
-### pressGesture()
-
-> **pressGesture**(`raycaster`, `tapPosition`, `duration`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:150
-
-tap 手势(点击屏幕) 被触发
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-点击对应的三维射线
-
-##### tapPosition
-
-`Vector2`
-
-点击对应的屏幕位置
-
-##### duration
-
-`number`
-
-长按持续时间
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.pressGesture`
-
-***
-
-### render()
-
-> **render**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:100
-
-渲染后
-
-#### Parameters
-
-##### event
-
-[`RenderEvent`](RenderEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.render`
-
-***
-
-### render.prepare()
-
-> **render.prepare**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:97
-
-渲染前
-
-#### Parameters
-
-##### event
-
-[`RenderEvent`](RenderEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.render.prepare`
-
-***
-
-### renderFrame()
-
-> **renderFrame**(`rendered`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:475
-
-渲染循环
-
-#### Parameters
-
-##### rendered
-
-`boolean`
-
-是否渲染了
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.renderFrame`
-
-***
-
-### setState()
-
-> **setState**(`state`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:438
-
-当 setState 方法被调用
-
-#### Parameters
-
-##### state
-
-[`State`](State.md)
-
-当前姿态状态
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.setState`
-
-***
-
-### state.change()
-
-> **state.change**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:70
-
-当 state 变化
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.state.change`
-
-***
-
-### state.set()
-
-> **state.set**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:67
-
-设置 state
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.state.set`
-
-***
-
-### state.synced()
-
-> **state.synced**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:73
-
-当 state 同步完成
-
-#### Parameters
-
-##### event
-
-[`StateEvent`](StateEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.state.synced`
-
-***
-
-### stateChange()
-
-> **stateChange**(`state`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:425
-
-当目标 state 变化时
-
-#### Parameters
-
-##### state
-
-[`State`](State.md)
-
-当前姿态状态
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.stateChange`
-
-***
-
-### stateSynced()
-
-> **stateSynced**(`state`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:444
-
-当 state 被同步完成时
-
-#### Parameters
-
-##### state
-
-[`State`](State.md)
-
-当前姿态状态
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.stateSynced`
-
-***
-
-### tapGesture()
-
-> **tapGesture**(`raycaster`, `tapPosition`, `final`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:105
-
-tap 手势(点击屏幕) 被触发
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-点击对应的三维射线
-
-##### tapPosition
-
-`Vector2`
-
-点击对应的屏幕位置
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.tapGesture`
-
-***
-
-### textureAbort()
-
-> **textureAbort**(`panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:356
-
-观察点的全景资源加载被中止
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-加载点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.textureAbort`
-
-***
-
-### textureError()
-
-> **textureError**(`error`, `panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:363
-
-观察点的全景资源加载失败
-
-#### Parameters
-
-##### error
-
-`Error`
-
-错误对象
-
-##### panoIndex
-
-`number`
-
-加载点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.textureError`
-
-***
-
-### textureLoaded()
-
-> **textureLoaded**(`panoIndex`, `meta`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:369
-
-观察点的全景资源加载完成
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-加载点位
-
-##### meta
-
-[`NetWorkMeta`](../type-aliases/NetWorkMeta.md)[]
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.textureLoaded`
-
-***
-
-### textureLoading()
-
-> **textureLoading**(`progress`, `panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:350
-
-观察点的全景资源加载中，可获取到进度
-
-#### Parameters
-
-##### progress
-
-`number`
-
-加载进度 [0-1]
-
-##### panoIndex
-
-`number`
-
-加载点位下标
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.textureLoading`
-
-***
-
-### textureStartLoad()
-
-> **textureStartLoad**(`panoIndex`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:343
-
-观察点的全景资源开始加载
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-加载点位
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.textureStartLoad`
-
-***
-
-### ~~wantsChangeCameraFov()~~
-
-> **wantsChangeCameraFov**(`fov`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:198
-
-意图要变化相机的可视角度 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### fov
-
-`number`
-
-意图要变化相机的可视角度
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Deprecated
-
-建议通过 初始化设置的 `defaultFov`, `maxFov`, `minFov` 来限制
-
-#### Inherited from
-
-`EventTypes.wantsChangeCameraFov`
-
-***
-
-### wantsChangeMode()
-
-> **wantsChangeMode**(`mode`, `prevMode`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:483
-
-意图要切换到某个模态， 可以通过 return false 阻止
-
-#### Parameters
-
-##### mode
-
-[`Mode`](../type-aliases/Mode.md)
-
-意图要切换到的模态
-
-##### prevMode
-
-[`Mode`](../type-aliases/Mode.md)
-
-当前模态
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 return false 阻止
-
-#### Inherited from
-
-`EventTypes.wantsChangeMode`
-
-***
-
-### wantsDblTapGesture()
-
-> **wantsDblTapGesture**(`raycaster`, `tapPosition`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:114
-
-意图要触发 dlbtap 手势(点击屏幕)， 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-点击对应的三维射线
-
-##### tapPosition
-
-`Vector2`
-
-点击对应的屏幕位置
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsDblTapGesture`
-
-***
-
-### wantsGesture()
-
-> **wantsGesture**(`type`, `pointers`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:65
-
-意图要触发手势， 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### type
-
-[`GestureTypes`](../type-aliases/GestureTypes.md)
-
-手势类型
-
-##### pointers
-
-`object`[]
-
-手指位置
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsGesture`
-
-***
-
-### wantsInteriaPan()
-
-> **wantsInteriaPan**(`pose`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:182
-
-意图要触发 pan 手势(滑动屏幕) 的惯性运动, 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### pose
-
-[`Pose`](Pose.md)
-
-意图的相机姿态
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsInteriaPan`
-
-***
-
-### wantsMouseWheel()
-
-> **wantsMouseWheel**(`delta`, `nextFov`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:167
-
-意图要触发 鼠标滚轮 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### delta
-
-`number`
-
-滚轮数值
-
-##### nextFov
-
-`number`
-
-意图的fov变更
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsMouseWheel`
-
-***
-
-### wantsMoveToPano()
-
-> **wantsMoveToPano**(`panoIndex`, `options`, `userAction`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:252
-
-意图要移动到某个点时, 可以通过 return false 阻止
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-意图要移动到点位
-
-##### options
-
-[`MovePanoOptions`](MovePanoOptions.md)
-
-移动参数
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 return false 阻止
-
-#### Inherited from
-
-`EventTypes.wantsMoveToPano`
-
-***
-
-### wantsPanGesture()
-
-> **wantsPanGesture**(`pose`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:81
-
-意图要触发 pan 手势(滑动屏幕)， 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### pose
-
-[`Pose`](Pose.md)
-
-意图的相机姿态
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsPanGesture`
-
-***
-
-### wantsPinchGesture()
-
-> **wantsPinchGesture**(`scale`, `nextFov`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:131
-
-意图要触发 pinch 手势(双指缩放)，可以通过 `return false` 阻止
-
-#### Parameters
-
-##### scale
-
-`number`
-
-缩放数值
-
-##### nextFov
-
-`number`
-
-意图的fov变更
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsPinchGesture`
-
-***
-
-### wantsPressGesture()
-
-> **wantsPressGesture**(`raycaster`, `tapPosition`, `duration`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:141
-
-意图要触发 press 手势(长按屏幕)， 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-长按对应的三维射线
-
-##### tapPosition
-
-`Vector2`
-
-长按对应的屏幕位置
-
-##### duration
-
-`number`
-
-长按持续时间
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsPressGesture`
-
-***
-
-### wantsShowIntersectionOnModel()
-
-> **wantsShowIntersectionOnModel**(`raycaster`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:240
-
-意图要展示鼠标焦点环，可以通过 `return false` 阻止
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-射线
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsShowIntersectionOnModel`
-
-***
-
-### wantsTapGesture()
-
-> **wantsTapGesture**(`raycaster`, `tapPosition`, `final`): `false` \| `void`
-
-Defined in: lib/five/application/events-legacy.ts:97
-
-意图要触发 tap 手势(点击屏幕)， 可以通过 `return false` 阻止
-
-#### Parameters
-
-##### raycaster
-
-`Raycaster`
-
-点击对应的三维射线
-
-##### tapPosition
-
-`Vector2`
-
-点击对应的屏幕位置
-
-##### final
-
-`boolean`
-
-是否手势结束
-
-#### Returns
-
-`false` \| `void`
-
-可以通过 `return false` 阻止
-
-#### Inherited from
-
-`EventTypes.wantsTapGesture`
-
-***
-
-### wantsToMoveToPano()
-
-> **wantsToMoveToPano**(`panoIndex`, `options`, `userAction`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:262
-
-同 wantsMoveToPano
-
-#### Parameters
-
-##### panoIndex
-
-`number`
-
-意图要移动到点位
-
-##### options
-
-[`MovePanoOptions`](MovePanoOptions.md)
-
-移动参数
-
-##### userAction
-
-`boolean`
-
-是否用户触发
-
-#### Returns
-
-`void`
-
-可以通过 return false 阻止
-
-#### Description
-
-#### Inherited from
-
-`EventTypes.wantsToMoveToPano`
-
-***
-
-### webXRAxesUpdate()
-
-> **webXRAxesUpdate**(`type`, `param`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:388
-
-xr控制器的Axes原始实时数据状态
-
-#### Parameters
-
-##### type
-
-`"left"` | `"right"`
-
-##### param
-
-[`WebXRAxesParams`](WebXRAxesParams.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.webXRAxesUpdate`
-
-***
-
-### webXRControllerEvent()
-
-> **webXRControllerEvent**(`type`, `key`, `params`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:384
-
-axes代表控制杆，axes数组的0-1元素分别代表左控制器的左（-1）右（1）,左控制器的上（-1）下（1），axes数组的2-3元素同理
-
-#### Parameters
-
-##### type
-
-[`WebXRControllerType`](../type-aliases/WebXRControllerType.md)
-
-##### key
-
-`"Y"` | `"X"` | `"B"` | `"A"` | `"RightTrigger"` | `"RightPinch"` | `"LeftTrigger"` | `"LeftPinch"` | `"LeftAxesLeft"` | `"LeftAxesRight"` | `"LeftAxesUp"` | `"LeftAxesDown"` | `"RightAxesLeft"` | `"RightAxesRight"` | `"RightAxesUp"` | `"RightAxesDown"`
-
-##### params
-
-[`WebXRControllerParams`](WebXRControllerParams.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.webXRControllerEvent`
-
-***
-
-### webXRControllerRayUpdate()
-
-> **webXRControllerRayUpdate**(`raycaster`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:392
-
-xr控制器的控制器射线更新
-
-#### Parameters
-
-##### raycaster
-
-###### leftRay?
-
-`Raycaster`
-
-###### rightRay?
-
-`Raycaster`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.webXRControllerRayUpdate`
-
-***
-
-### webXRSessionEnd()
-
-> **webXRSessionEnd**(): `void`
-
-Defined in: lib/five/application/events-legacy.ts:379
-
-webXR模式结束,webxr session销毁
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.webXRSessionEnd`
-
-***
-
-### webXRSessionStart()
-
-> **webXRSessionStart**(): `void`
-
-Defined in: lib/five/application/events-legacy.ts:374
-
-webXR模式开始，webxr session完成坐标系矫正
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.webXRSessionStart`
-
-***
-
-### willLoad()
-
-> **willLoad**(`input`, `work`, `state`): `void`
-
-Defined in: lib/five/application/events-legacy.ts:403
-
-准备加载 Work 数据
-
-#### Parameters
-
-##### input
-
-`any`
-
-输入的 work
-
-##### work
-
-[`Work`](../classes/Work.md)
-
-归一化的标准 work
-
-##### state
-
-`Partial`\<[`State`](State.md)\>
-
-加载时的姿态
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.willLoad`
-
-***
-
-### works.load()
-
-> **works.load**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:61
-
-加载 work
-
-#### Parameters
-
-##### event
-
-[`WorksEvent`](WorksEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.works.load`
-
-***
-
-### works.ready()
-
-> **works.ready**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:64
-
-加载 work 并 controller ready
-
-#### Parameters
-
-##### event
-
-[`WorksEvent`](WorksEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.works.ready`
-
-***
-
-### works.request()
-
-> **works.request**(`event`): `void`
-
-Defined in: lib/five/application/events.ts:58
-
-请求 work数据
-
-#### Parameters
-
-##### event
-
-[`WorksEvent`](WorksEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.works.request`
-
-***
-
-### xr.controller.update()
-
-> **xr.controller.update**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:98
-
-XR手柄更新
-
-#### Parameters
-
-##### event
-
-[`XRControllerEvent`](XRControllerEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.controller.update`
-
-***
-
-### xr.gesture.buttonDown()
-
-> **xr.gesture.buttonDown**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:95
-
-XR 手势（按钮）
-
-#### Parameters
-
-##### event
-
-[`XRGestureEvent`](XRGestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.gesture.buttonDown`
-
-***
-
-### xr.gesture.buttonUp()
-
-> **xr.gesture.buttonUp**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:92
-
-XR 手势（按钮）
-
-#### Parameters
-
-##### event
-
-[`XRGestureEvent`](XRGestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.gesture.buttonUp`
-
-***
-
-### xr.gesture.press()
-
-> **xr.gesture.press**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:89
-
-XR 手势（按钮）
-
-#### Parameters
-
-##### event
-
-[`XRGestureEvent`](XRGestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.gesture.press`
-
-***
-
-### xr.gesture.tap()
-
-> **xr.gesture.tap**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:86
-
-XR 手势（按钮）
-
-#### Parameters
-
-##### event
-
-[`XRGestureEvent`](XRGestureEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.gesture.tap`
-
-***
-
-### xr.session.end()
-
-> **xr.session.end**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:80
-
-XR 退出
-
-#### Parameters
-
-##### event
-
-[`XRSessionEvent`](XRSessionEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.session.end`
-
-***
-
-### xr.session.start()
-
-> **xr.session.start**(`event`): `void`
-
-Defined in: lib/five/controllers/events.ts:83
-
-XR 进入
-
-#### Parameters
-
-##### event
-
-[`XRSessionEvent`](XRSessionEvent.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`EventTypes.xr.session.start`