Interface EventCallback

Five 事件列表

description: 可以通过 five.on(METHOD_NAME, METHOD) 调用

Hierarchy

EventTypes
- EventCallback

Index

Methods

Methods

cameraDirectionUpdate

cameraDirectionUpdate(coordinates: Pick<Pose, "longitude" | "latitude">, userAction: boolean): void

Inherited from EventTypes.cameraDirectionUpdate
- Defined in lib/five/controllers/events.ts:86
相机姿态中相机方向变化

Parameters
- coordinates: Pick<Pose, "longitude" | "latitude">
  
  相机姿态的俯仰角和偏航角
- userAction: boolean
  
  是否用户触发
Returns void

cameraPositionUpdate

cameraPositionUpdate(offset: Vector3, userAction: boolean): void

Inherited from EventTypes.cameraPositionUpdate
- Defined in lib/five/controllers/events.ts:79
相机姿态中相机位置变化

Parameters
- offset: Vector3
  
  相机位置
- userAction: boolean
  
  是否用户触发
Returns void

cameraUpdate

cameraUpdate(pose: Pose, userAction: boolean): void

Inherited from EventTypes.cameraUpdate
- Defined in lib/five/controllers/events.ts:65
相机姿态变化

Parameters
- pose: Pose
  
  相机姿态
- userAction: boolean
  
  是否用户触发
Returns void

currentStateChange

currentStateChange(state: State, userAction: boolean): void

Inherited from EventTypes.currentStateChange
- Defined in lib/five/application/events.ts:161
当前实时 state 变化时

Parameters
- state: State
  
  当前姿态状态
- userAction: boolean
  
  是否用户触发
Returns void

dispose

dispose(): void

Inherited from EventTypes.dispose
- Defined in lib/five/application/events.ts:227
five 被析构。插件中请监听用于自身析构

Returns void

error

error(error: Error): void

Inherited from EventTypes.error
- Defined in lib/five/application/events.ts:66
内部错误

Parameters
- error: Error
  
  错误对象
Returns void

fps

fps(fps: number): void

Inherited from EventTypes.fps
- Defined in lib/five/application/events.ts:147
当前 fps 变化

Parameters
- fps: number
  
  当前刷新率
Returns void

gesture

gesture(type: GestureTypes, pointers: { delta?: number; x: number; y: number }[], final: boolean): void

Inherited from EventTypes.gesture
- Defined in lib/five/controllers/events.ts:189
手势触发

Parameters
- type: GestureTypes
  
  手势类型
- pointers: { delta?: number; x: number; y: number }[]
  
  手指位置
- final: boolean
  
  是否手势结束
Returns void

helpersVisibleChange

helpersVisibleChange(visible: boolean): void

Inherited from EventTypes.helpersVisibleChange
- Defined in lib/five/application/events.ts:216
帮助元素显应的变换

Parameters
- visible: boolean
  
  帮助元素的是否开启
Returns void

initAnimationEnded

initAnimationEnded(panoIndex: number, pose: Pose, userAction: boolean): void

Inherited from EventTypes.initAnimationEnded
- Defined in lib/five/controllers/events.ts:49
模态间切换动画结束

Parameters
- panoIndex: number
  
  当前点位
- pose: Pose
  
  相机姿态
- userAction: boolean
  
  是否用户触发
Returns void

initAnimationWillStart

initAnimationWillStart(panoIndex: number, pose: Pose, userAction: boolean): void

Inherited from EventTypes.initAnimationWillStart
- Defined in lib/five/controllers/events.ts:41
模态间切换动画开始

Parameters
- panoIndex: number
  
  当前点位
- pose: Pose
  
  相机姿态
- userAction: boolean
  
  是否用户触发
Returns void

interiaPan

interiaPan(pose: Pose, final: boolean): void

Inherited from EventTypes.interiaPan
- Defined in lib/five/controllers/events.ts:219
pan 手势(滑动屏幕) 的惯性运动

Parameters
- pose: Pose
  
  意图的相机姿态
- final: boolean
  
  是否手势结束
Returns void

intersectionHidden

intersectionHidden(): void

Inherited from EventTypes.intersectionHidden
- Defined in lib/five/controllers/events.ts:306
鼠标焦点环被隐藏

Returns void

intersectionOnModelUpdate

intersectionOnModelUpdate(intersection: Intersection, mesh: IntersectMeshInterface): void

Inherited from EventTypes.intersectionOnModelUpdate
- Defined in lib/five/controllers/events.ts:296
鼠标焦点环位置被重新计算

Parameters
- intersection: Intersection
  
  焦点碰撞结果
- mesh: IntersectMeshInterface
  
  焦点环 mesh
Returns void

load

load(input: any, work: Work, state: Omit<State, "offset" | "distance">): void

Inherited from EventTypes.load
- Defined in lib/five/application/events.ts:82
开始加载 Work 数据

Parameters
- input: any
  
  输入的 work
- work: Work
  
  归一化的标准 work
- state: Omit<State, "offset" | "distance">
  
  加载时的姿态
Returns void

loaded

loaded(input: any, work: Work): void

Inherited from EventTypes.loaded
- Defined in lib/five/application/events.ts:89
加载完 Work 数据

Parameters
- input: any
  
  输入的 work
- work: Work
  
  归一化的标准 work
Returns void

modeChange

modeChange(mode: Mode, prevMode: Mode, panoIndex: number, toPose: Pose, userAction: boolean): void

Inherited from EventTypes.modeChange
- Defined in lib/five/application/events.ts:210
模态切换完成

Parameters
- mode: Mode
  
  切换到的模态
- prevMode: Mode
  
  上本质是一个模态
- panoIndex: number
  
  初始化动画结束后的点位下标
- toPose: Pose
  
  初始化动画结束后的状态
- userAction: boolean
  
  是否用户触发
Returns void

modelBvhLoaded

modelBvhLoaded(model: Model): void

Inherited from EventTypes.modelBvhLoaded
- Defined in lib/five/application/events.ts:116
模型 bvh树计算完成

description
bvh 树用于高效的碰撞检测，可以在 model.bvh 属性来设置是否开启。默认开启。 bvh 树计算需要一定事件，可能会暂时影响一些性能。计算完毕后，会对碰撞检测带来质的提升。

Parameters
- model: Model
  
  加载完的 model 本质是一个 PBMGroup
Returns void

modelGeometryLoaded

modelGeometryLoaded(model: Model): void

Inherited from EventTypes.modelGeometryLoaded
- Defined in lib/five/application/events.ts:101
模型三角面片结构加载完成

Parameters
- model: Model
  
  加载完的 model 本质是一个 PBMGroup
Returns void

modelLoadError

modelLoadError(error: Error, model: Model): void

Inherited from EventTypes.modelLoadError
- Defined in lib/five/application/events.ts:123
模型加载错误

Parameters
- error: Error
  
  错误对象
- model: Model
  
  加载完的 model 本质是一个 PBMGroup
Returns void

modelLoaded

modelLoaded(model: Model): void

Inherited from EventTypes.modelLoaded
- Defined in lib/five/application/events.ts:129
模型加载完成

Parameters
- model: Model
  
  加载完的 model 本质是一个 PBMGroup
Returns void

modelMaterialLoaded

modelMaterialLoaded(model: Model): void

Inherited from EventTypes.modelMaterialLoaded
- Defined in lib/five/application/events.ts:107
模型材质结构加载完成

Parameters
- model: Model
  
  加载完的 model 本质是一个 PBMGroup
Returns void

modelShownFloorChange

modelShownFloorChange(shownFloor: number, totalFloorLength: number): void

Inherited from EventTypes.modelShownFloorChange
- Defined in lib/five/application/events.ts:135
模型楼层切换

Parameters
- shownFloor: number
  
  模型楼层
- totalFloorLength: number
Returns void

modelWillLoad

modelWillLoad(workModel: WorkModel): void

Inherited from EventTypes.modelWillLoad
- Defined in lib/five/application/events.ts:95
模型开始加载

Parameters
- workModel: WorkModel
  
  归一化的标准 work 中的 model 值
Returns void

mouseWheel

mouseWheel(delta: number, fov: number, final: boolean): void

Inherited from EventTypes.mouseWheel
- Defined in lib/five/controllers/events.ts:289
鼠标滚轮被触发

Parameters
- delta: number
  
  滚轮数值
- fov: number
- final: boolean
  
  是否手势结束
Returns void

moveToPano

moveToPano(panoIndex: number, userAction: boolean): void

Inherited from EventTypes.moveToPano
- Defined in lib/five/controllers/events.ts:112
开始加载并移动到某个观察点位
description
可 panoWillArrive 相比
- moveToPano 在加载全景图资源前触发
- panoWillArrive 在加载全景图资源后触发
Parameters
- panoIndex: number
  
  移动到的点位下标
- userAction: boolean
  
  是否用户触发
Returns void

moveToPanoCanceled

moveToPanoCanceled(panoIndex: number): void

Inherited from EventTypes.moveToPanoCanceled
- Defined in lib/five/controllers/events.ts:143
移动到某个观察点位被取消
description
这个有一些情况会导致
- 移动过程中切换模态
- 移动过程中 five 被析构
- 移动过程点击切换到另一个点位
Parameters
- panoIndex: number
  
  对应的点位下标
Returns void

movingToPano

movingToPano(panoIndex: number, prevPanoIndex: number, progress: number): void

Inherited from EventTypes.movingToPano
- Defined in lib/five/controllers/events.ts:171
移动中，会告知移动状态（耗时百分比）

Parameters
- panoIndex: number
  
  将要移动到的点位下标
- prevPanoIndex: number
  
  上一个点位下标
- progress: number
  
  整个过程经度 [0-1]
Returns void

network

network(source: string, type: NetworkType, state: NetworkState, detail: string): void

Inherited from EventTypes.network
- Defined in lib/five/application/events.ts:224
网络资源分析

Parameters
- source: string
  
  资源地址
- type: NetworkType
- state: NetworkState
  
  状态
- detail: string
  
  详情
Returns void

panGesture

panGesture(pose: Pose, final: boolean): void

Inherited from EventTypes.panGesture
- Defined in lib/five/controllers/events.ts:204
pan 手势(滑动屏幕) 被触发

Parameters
- pose: Pose
  
  相机姿态
- final: boolean
  
  是否手势结束
Returns void

panoArrived

panoArrived(panoIndex: number, pose: Pose, userAction: boolean): void

Inherited from EventTypes.panoArrived
- Defined in lib/five/controllers/events.ts:163
移动到某个观察点位

Parameters
- panoIndex: number
  
  移动到点位下标
- pose: Pose
  
  相机姿态
- userAction: boolean
  
  是否用户触发
Returns void

panoLoadError

panoLoadError(error: Error, panoIndex: number): void

Inherited from EventTypes.panoLoadError
- Defined in lib/five/controllers/events.ts:132
某个观察点的全景资源加载失败

Parameters
- error: Error
  
  错误对象
- panoIndex: number
  
  对应的点位下标
Returns void

panoLoaded

panoLoaded(panoIndex: number): void

Inherited from EventTypes.panoLoaded
- Defined in lib/five/controllers/events.ts:124
某个观察点的全景资源加载完成

Parameters
- panoIndex: number
  
  对应的点位下标
Returns void

panoSelected

panoSelected(panoIndex: number): void

Inherited from EventTypes.panoSelected
- Defined in lib/five/controllers/events.ts:92
观察点位被选择

Parameters
- panoIndex: number
  
  选择的点位
Returns void

panoWillArrive

panoWillArrive(panoIndex: number, pose: Pose, userAction: boolean): void

Inherited from EventTypes.panoWillArrive
- Defined in lib/five/controllers/events.ts:155
开始移动到某个观察点位
description
和 moveToPano 相比
- moveToPano 在加载全景图资源前触发
- panoWillArrive 在加载全景图资源后触发
Parameters
- panoIndex: number
  
  移动到点位下标
- pose: Pose
  
  相机姿态
- userAction: boolean
  
  是否用户触发
Returns void

panoWillLoad

panoWillLoad(panoIndex: number): void

Inherited from EventTypes.panoWillLoad
- Defined in lib/five/controllers/events.ts:118
开始加载某个观察点的全景资源

Parameters
- panoIndex: number
  
  移动到的点位下标
Returns void

pinchGesture

pinchGesture(scale: number, fov: number, final: boolean): void

Inherited from EventTypes.pinchGesture
- Defined in lib/five/controllers/events.ts:272
pinch 手势(双指缩放) 被触发

Parameters
- scale: number
  
  缩放数值
- fov: number
- final: boolean
  
  是否手势结束
Returns void

pressGesture

pressGesture(raycaster: Raycaster, tapPosition: Vector2, duration: number, isFinal: boolean): void

Inherited from EventTypes.pressGesture
- Defined in lib/five/controllers/events.ts:264
tap 手势(点击屏幕) 被触发

Parameters
- raycaster: Raycaster
  
  点击对应的三维射线
- tapPosition: Vector2
  
  点击对应的屏幕位置
- duration: number
  
  长按持续时间
- isFinal: boolean
Returns void

renderFrame

renderFrame(rendered: boolean): void

Inherited from EventTypes.renderFrame
- Defined in lib/five/application/events.ts:141
渲染循环

Parameters
- rendered: boolean
  
  是否渲染了
Returns void

setState

setState(state: State): void

Inherited from EventTypes.setState
- Defined in lib/five/application/events.ts:167
当 setState 方法被调用

Parameters
- state: State
  
  当前姿态状态
Returns void

stateChange

stateChange(state: State, userAction: boolean): void

Inherited from EventTypes.stateChange
- Defined in lib/five/application/events.ts:154
当目标 state 变化时

Parameters
- state: State
  
  当前姿态状态
- userAction: boolean
  
  是否用户触发
Returns void

stateSynced

stateSynced(state: State): void

Inherited from EventTypes.stateSynced
- Defined in lib/five/application/events.ts:173
当 state 被同步完成时

Parameters
- state: State
  
  当前姿态状态
Returns void

tapGesture

tapGesture(raycaster: Raycaster, tapPosition: Vector2, final: boolean): void

Inherited from EventTypes.tapGesture
- Defined in lib/five/controllers/events.ts:236
tap 手势(点击屏幕) 被触发

Parameters
- raycaster: Raycaster
  
  点击对应的三维射线
- tapPosition: Vector2
  
  点击对应的屏幕位置
- final: boolean
  
  是否手势结束
Returns void

textureAbort

textureAbort(panoIndex: number, observer: WorkObserver): void

Inherited from EventTypes.textureAbort
- Defined in lib/five/controllers/events.ts:331
观察点的全景资源加载被中止

Parameters
- panoIndex: number
  
  加载点位下标
- observer: WorkObserver
  
  对应的 observer 详情
Returns void

textureError

textureError(error: Error, panoIndex: number, observer: WorkObserver): void

Inherited from EventTypes.textureError
- Defined in lib/five/controllers/events.ts:339
观察点的全景资源加载失败

Parameters
- error: Error
  
  错误对象
- panoIndex: number
  
  加载点位下标
- observer: WorkObserver
  
  对应的 observer 详情
Returns void

textureLoaded

textureLoaded(panoIndex: number, observer: WorkObserver, meta: NetWorkMeta[]): void

Inherited from EventTypes.textureLoaded
- Defined in lib/five/controllers/events.ts:346
观察点的全景资源加载完成

Parameters
- panoIndex: number
  
  加载点位下标
- observer: WorkObserver
  
  对应的 observer 详情
- meta: NetWorkMeta[]
Returns void

textureLoading

textureLoading(progress: number, panoIndex: number, observer: WorkObserver): void

Inherited from EventTypes.textureLoading
- Defined in lib/five/controllers/events.ts:324
观察点的全景资源加载中，可获取到进度

Parameters
- progress: number
  
  加载进度 [0-1]
- panoIndex: number
  
  加载点位下标
- observer: WorkObserver
  
  对应的 observer 详情
Returns void

textureStartLoad

textureStartLoad(panoIndex: number, observer: WorkObserver): void

Inherited from EventTypes.textureStartLoad
- Defined in lib/five/controllers/events.ts:316
观察点的全景资源开始加载

Parameters
- panoIndex: number
  
  加载点位下标
- observer: WorkObserver
  
  对应的 observer 详情
Returns void

wantsChangeMode

wantsChangeMode(mode: Mode, prevMode: Mode): false | void

Inherited from EventTypes.wantsChangeMode
- Defined in lib/five/application/events.ts:200
意图要切换到某个模态，可以通过 return false 阻止

Parameters
- mode: Mode
  
  意图要切换到的模态
- prevMode: Mode
  
  当前模态
Returns false | void
可以通过 return false 阻止

wantsGesture

wantsGesture(type: GestureTypes, pointers: { delta?: number; x: number; y: number }[], final: boolean): false | void

Inherited from EventTypes.wantsGesture
- Defined in lib/five/controllers/events.ts:181
意图要触发手势，可以通过 return false 阻止

Parameters
- type: GestureTypes
  
  手势类型
- pointers: { delta?: number; x: number; y: number }[]
  
  手指位置
- final: boolean
  
  是否手势结束
Returns false | void
可以通过 return false 阻止

wantsInteriaPan

wantsInteriaPan(pose: Pose): false | void

Inherited from EventTypes.wantsInteriaPan
- Defined in lib/five/controllers/events.ts:212
意图要触发 pan 手势(滑动屏幕) 的惯性运动, 可以通过 return false 阻止

Parameters
- pose: Pose
  
  意图的相机姿态
Returns false | void
可以通过 return false 阻止

wantsMouseWheel

wantsMouseWheel(delta: number, nextFov: number, final: boolean): false | void

Inherited from EventTypes.wantsMouseWheel
- Defined in lib/five/controllers/events.ts:281
意图要触发鼠标滚轮可以通过 return false 阻止

Parameters
- delta: number
  
  滚轮数值
- nextFov: number
  
  意图的fov变更
- final: boolean
  
  是否手势结束
Returns false | void
可以通过 return false 阻止

wantsMoveToPano

wantsMoveToPano(panoIndex: number, options: MovePanoOptions, userAction: boolean): false | void

Inherited from EventTypes.wantsMoveToPano
- Defined in lib/five/application/events.ts:182
意图要移动到某个点时, 可以通过 return false 阻止

Parameters
- panoIndex: number
  
  意图要移动到点位下标
- options: MovePanoOptions
  
  移动参数
- userAction: boolean
  
  是否用户触发
Returns false | void
可以通过 return false 阻止

wantsPanGesture

wantsPanGesture(pose: Pose, final: boolean): false | void

Inherited from EventTypes.wantsPanGesture
- Defined in lib/five/controllers/events.ts:197
意图要触发 pan 手势(滑动屏幕)，可以通过 return false 阻止

Parameters
- pose: Pose
  
  意图的相机姿态
- final: boolean
  
  是否手势结束
Returns false | void
可以通过 return false 阻止

wantsPinchGesture

wantsPinchGesture(scale: number, nextFov: number, final: boolean): false | void

Inherited from EventTypes.wantsPinchGesture
- Defined in lib/five/controllers/events.ts:245
意图要触发 pinch 手势(双指缩放)，可以通过 return false 阻止

Parameters
- scale: number
  
  缩放数值
- nextFov: number
  
  意图的fov变更
- final: boolean
  
  是否手势结束
Returns false | void
可以通过 return false 阻止

wantsPressGesture

wantsPressGesture(raycaster: Raycaster, tapPosition: Vector2, duration: number, isFinal: boolean): false | void

Inherited from EventTypes.wantsPressGesture
- Defined in lib/five/controllers/events.ts:255
意图要触发 press 手势(长按屏幕)，可以通过 return false 阻止

Parameters
- raycaster: Raycaster
  
  长按对应的三维射线
- tapPosition: Vector2
  
  长按对应的屏幕位置
- duration: number
  
  长按持续时间
- isFinal: boolean
Returns false | void
可以通过 return false 阻止

wantsShowIntersectionOnModel

wantsShowIntersectionOnModel(raycaster: Raycaster): false | void

Inherited from EventTypes.wantsShowIntersectionOnModel
- Defined in lib/five/controllers/events.ts:303
意图要展示鼠标焦点环，可以通过 return false 阻止

Parameters
- raycaster: Raycaster
Returns false | void
可以通过 return false 阻止

wantsTapGesture

wantsTapGesture(raycaster: Raycaster, tapPosition: Vector2, final: boolean): false | void

Inherited from EventTypes.wantsTapGesture
- Defined in lib/five/controllers/events.ts:228
意图要触发 tap 手势(点击屏幕)，可以通过 return false 阻止

Parameters
- raycaster: Raycaster
  
  点击对应的三维射线
- tapPosition: Vector2
  
  点击对应的屏幕位置
- final: boolean
  
  是否手势结束
Returns false | void
可以通过 return false 阻止

wantsToMoveToPano

wantsToMoveToPano(panoIndex: number, options: MovePanoOptions, userAction: boolean): void

Inherited from EventTypes.wantsToMoveToPano
- Defined in lib/five/application/events.ts:192
同 wantsMoveToPano

description
Parameters
- panoIndex: number
  
  意图要移动到点位下标
- options: MovePanoOptions
  
  移动参数
- userAction: boolean
  
  是否用户触发
Returns void
可以通过 return false 阻止

webXRAxesUpdate

webXRAxesUpdate(type: "left" | "right", param: WebXRAxesParams): void

Inherited from EventTypes.webXRAxesUpdate
- Defined in lib/five/controllers/events.ts:371
xr控制器的Axes原始实时数据状态

Parameters
- type: "left" | "right"
- param: WebXRAxesParams
Returns void

webXRControllerEvent

webXRControllerEvent(type: WebXRControllerType, key: WebXRControllerKey, params: WebXRControllerParams): false | void

Inherited from EventTypes.webXRControllerEvent
- Defined in lib/five/controllers/events.ts:367
xr控制器的tap事件和press事件

Parameters
- type: WebXRControllerType
- key: WebXRControllerKey
- params: WebXRControllerParams
Returns false | void

webXRControllerRayUpdate

webXRControllerRayUpdate(raycaster: { leftRay: Raycaster; rightRay: Raycaster }): void

Inherited from EventTypes.webXRControllerRayUpdate
- Defined in lib/five/controllers/events.ts:375
xr控制器的控制器射线更新

Parameters
- raycaster: { leftRay: Raycaster; rightRay: Raycaster }
  - leftRay: Raycaster
  - rightRay: Raycaster
Returns void

webXRMoveToPano

webXRMoveToPano(raycaster: Raycaster): void

Inherited from EventTypes.webXRMoveToPano
- Defined in lib/five/controllers/events.ts:382
触发xr走点

Parameters
- raycaster: Raycaster
Returns void

webXRSessionEnd

webXRSessionEnd(): void

Inherited from EventTypes.webXRSessionEnd
- Defined in lib/five/controllers/events.ts:362
webXR模式结束,webxr session销毁

Returns void

webXRSessionStart

webXRSessionStart(): void

Inherited from EventTypes.webXRSessionStart
- Defined in lib/five/controllers/events.ts:357
webXR模式开始，webxr session完成坐标系矫正

Returns void

willLoad

willLoad(input: any, work: Work, state: Omit<State, "offset" | "distance">): void

Inherited from EventTypes.willLoad
- Defined in lib/five/application/events.ts:74
准备加载 Work 数据

Parameters
- input: any
  
  输入的 work
- work: Work
  
  归一化的标准 work
- state: Omit<State, "offset" | "distance">
  
  加载时的姿态
Returns void