@realsee/five 6.0.0-alpha.1 → 6.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/docs/assets/search.js +1 -1
  2. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  3. package/docs/classes/five.BVH.html +1 -1
  4. package/docs/classes/five.BVHIntersect.html +1 -1
  5. package/docs/classes/five.BVHNode.html +1 -1
  6. package/docs/classes/five.BVHVector3.html +1 -1
  7. package/docs/classes/five.BoxBoundingVolume.html +1 -1
  8. package/docs/classes/five.Camera.html +1 -1
  9. package/docs/classes/five.Clipper.html +1 -1
  10. package/docs/classes/five.CullingVolume.html +1 -1
  11. package/docs/classes/five.Five.html +71 -69
  12. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  13. package/docs/classes/five.IntersectMesh.html +1 -1
  14. package/docs/classes/five.Model.html +20 -22
  15. package/docs/classes/five.NetworkSubscribe.html +1 -1
  16. package/docs/classes/five.PBMContainer.html +1 -1
  17. package/docs/classes/five.PBMGroup.html +1 -1
  18. package/docs/classes/five.PBMMaterialReferenceCache.html +1 -1
  19. package/docs/classes/five.PBMMesh.html +1 -1
  20. package/docs/classes/five.PBMMeshMaterial.html +1 -1
  21. package/docs/classes/five.PanoCircleMesh.html +1 -1
  22. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  23. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  24. package/docs/classes/five.RegionBoundingVolume.html +1 -1
  25. package/docs/classes/five.RequestScheduler.html +1 -1
  26. package/docs/classes/five.Scene.html +1 -1
  27. package/docs/classes/five.SphereBoundingVolume.html +1 -1
  28. package/docs/classes/five.Subscribe.html +1 -1
  29. package/docs/classes/five.TextureLoader.html +1 -1
  30. package/docs/classes/five.Tile.html +1 -1
  31. package/docs/classes/five.Tile3DModel.html +1 -1
  32. package/docs/classes/five.TileCubeTextureTarget.html +1 -1
  33. package/docs/classes/five.TileNode.html +1 -1
  34. package/docs/classes/five.Tileset.html +1 -1
  35. package/docs/classes/five.TilesetCache.html +1 -1
  36. package/docs/classes/five.TilesetTraverser.html +1 -1
  37. package/docs/classes/five.Work.html +12 -12
  38. package/docs/classes/five.XRButton.html +1 -1
  39. package/docs/classes/gltf_loader.DDSLoader.html +1 -1
  40. package/docs/classes/gltf_loader.DRACOLoader.html +1 -1
  41. package/docs/classes/gltf_loader.GLTFLoader.html +1 -1
  42. package/docs/classes/gltf_loader.GLTFObject.html +1 -1
  43. package/docs/classes/gltf_loader.GLTFParser.html +1 -1
  44. package/docs/classes/gltf_loader.THREEGLTFLoader.html +1 -1
  45. package/docs/classes/line.Line.html +1 -1
  46. package/docs/classes/line.LineGeometry.html +1 -1
  47. package/docs/classes/line.LineMaterial.html +1 -1
  48. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  49. package/docs/classes/line.THREE_Line2.html +1 -1
  50. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  51. package/docs/classes/react.Store.html +1 -1
  52. package/docs/classes/sticker.Sticker.html +1 -1
  53. package/docs/classes/vfx.Airflow.html +1 -1
  54. package/docs/classes/vfx.Flame.html +1 -1
  55. package/docs/classes/vfx.Particle.html +1 -1
  56. package/docs/classes/vfx.SpotLight.html +1 -1
  57. package/docs/enums/five.PBMPointColorType.html +1 -1
  58. package/docs/enums/five.PBMPointShapeType.html +1 -1
  59. package/docs/enums/five.PBMPointSizeType.html +1 -1
  60. package/docs/enums/five.VolumePlaneIntersect.html +1 -1
  61. package/docs/index.html +1 -1
  62. package/docs/interfaces/five.AddableObject.html +1 -1
  63. package/docs/interfaces/five.AnimationFrame.html +1 -1
  64. package/docs/interfaces/five.BaseEvent.html +1 -0
  65. package/docs/interfaces/five.BoundingVolume.html +1 -1
  66. package/docs/interfaces/five.CameraPose.html +1 -1
  67. package/docs/interfaces/five.ClipperParameter.html +1 -1
  68. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +10 -10
  69. package/docs/interfaces/five.EventCallback.html +186 -94
  70. package/docs/interfaces/five.FiveInitArgs.html +1 -1
  71. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +7 -7
  72. package/docs/interfaces/five.GestureEvent.html +1 -0
  73. package/docs/interfaces/five.ImageOptions.html +1 -1
  74. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  75. package/docs/interfaces/five.ImageURLOptions.html +1 -1
  76. package/docs/interfaces/five.IntersectEvent.html +1 -0
  77. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  78. package/docs/interfaces/five.Intersection.html +1 -1
  79. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +1 -1
  80. package/docs/interfaces/five.ModeChangeEvent.html +1 -0
  81. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +8 -8
  82. package/docs/interfaces/five.ModelEvent.html +1 -0
  83. package/docs/interfaces/five.ModelLodOptions.html +1 -1
  84. package/docs/interfaces/five.ModelsEvent.html +1 -0
  85. package/docs/interfaces/five.MotionKeyframe.html +1 -1
  86. package/docs/interfaces/five.MovePanoOptions.html +9 -7
  87. package/docs/interfaces/five.NetworkOptions.html +1 -1
  88. package/docs/interfaces/five.NetworkResourceEvent.html +1 -0
  89. package/docs/interfaces/five.ObjectEvent.html +1 -0
  90. package/docs/interfaces/five.PBMPanoPicture.html +1 -1
  91. package/docs/interfaces/five.PBMParameters.html +1 -1
  92. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +1 -1
  93. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  94. package/docs/interfaces/five.PanoCircleMeshOptions.html +1 -1
  95. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +1 -1
  96. package/docs/interfaces/five.PanoEvent.html +1 -0
  97. package/docs/interfaces/five.PanoTextureEvent.html +1 -0
  98. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +10 -10
  99. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +8 -8
  100. package/docs/interfaces/five.Pose.html +1 -1
  101. package/docs/interfaces/five.RenderEvent.html +1 -0
  102. package/docs/interfaces/five.Scissor.html +1 -1
  103. package/docs/interfaces/five.State.html +6 -6
  104. package/docs/interfaces/five.StateEvent.html +1 -0
  105. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
  106. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
  107. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
  108. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
  109. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
  110. package/docs/interfaces/five.SubscribeMixinType.waitUnitl.html +1 -1
  111. package/docs/interfaces/five.TextureOptions.html +1 -1
  112. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +1 -1
  113. package/docs/interfaces/five.TileCubeNode.html +1 -1
  114. package/docs/interfaces/five.TileCubeTree.html +1 -1
  115. package/docs/interfaces/five.TileHeader.html +1 -1
  116. package/docs/interfaces/five.TilesetHeader.html +1 -1
  117. package/docs/interfaces/five.TilesetOptions.html +1 -1
  118. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +4 -4
  119. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +8 -8
  120. package/docs/interfaces/five.WebXRControllerParams.html +1 -1
  121. package/docs/interfaces/five.WorkCubeImage.html +6 -6
  122. package/docs/interfaces/five.WorkImage.html +10 -10
  123. package/docs/interfaces/five.WorkInitial.html +9 -9
  124. package/docs/interfaces/five.WorkModel.html +6 -6
  125. package/docs/interfaces/five.WorkObserver.html +24 -16
  126. package/docs/interfaces/five.WorkOptions.html +7 -7
  127. package/docs/interfaces/five.WorkResolvedObserver.html +37 -0
  128. package/docs/interfaces/five.WorkTile.html +1 -1
  129. package/docs/interfaces/five.WorkVideo.html +4 -4
  130. package/docs/interfaces/five.WorksEvent.html +1 -0
  131. package/docs/interfaces/five.XRGestureEvent.html +1 -0
  132. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +8 -8
  133. package/docs/interfaces/five.XRSessionEvent.html +1 -0
  134. package/docs/interfaces/gltf_loader.DDS.html +1 -1
  135. package/docs/interfaces/gltf_loader.GLTF.html +1 -1
  136. package/docs/interfaces/gltf_loader.GLTFReference.html +1 -1
  137. package/docs/interfaces/gltf_loader.THREEGLTF.html +1 -1
  138. package/docs/interfaces/react.FiveActionReactCallbacks.html +3 -5
  139. package/docs/interfaces/react.FiveInjectionTypes.html +10 -15
  140. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
  141. package/docs/interfaces/sticker.IntersectionLike.html +1 -1
  142. package/docs/interfaces/vfx.ParticleArgs.html +1 -1
  143. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +1 -1
  144. package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
  145. package/docs/modules/five.SubscribeMixinType.html +1 -1
  146. package/docs/modules/five.html +62 -283
  147. package/docs/modules/gltf_loader.html +1 -1
  148. package/docs/modules/line.html +1 -1
  149. package/docs/modules/react.html +1 -1
  150. package/docs/modules/sticker.html +1 -1
  151. package/docs/modules/vfx.html +1 -1
  152. package/docs/modules/vue.html +1 -1
  153. package/docs/modules.html +1 -1
  154. package/five/index.d.ts +857 -617
  155. package/five/index.js +6 -6
  156. package/gltf-loader/index.js +3 -3
  157. package/line/index.js +3 -3
  158. package/package.json +1 -1
  159. package/react/index.d.ts +3 -2
  160. package/react/index.js +3 -3
  161. package/sticker/index.js +3 -3
  162. package/umd/five-gltf-loader.js +1 -1
  163. package/umd/five-line.js +1 -1
  164. package/umd/five-react.js +1 -1
  165. package/umd/five-sticker.js +1 -1
  166. package/umd/five-vue.js +1 -1
  167. package/umd/five.js +1 -1
  168. package/vfx/index.js +2 -2
  169. package/vue/index.d.ts +4 -3
  170. package/vue/index.js +3 -3
package/five/index.d.ts CHANGED
@@ -1,3 +1,5 @@
1
+ /// <reference types="webxr" />
2
+
1
3
  import * as THREE_2 from 'three';
2
4
 
3
5
  export declare interface AddableObject extends THREE_2.Object3D {
@@ -46,6 +48,13 @@ export declare class AnimationFrameLoop {
46
48
  disponse(): void;
47
49
  }
48
50
 
51
+ export declare interface BaseEvent {
52
+ type: string;
53
+ timeStamp: number;
54
+ preventDefault(): void;
55
+ defaultPrevented: boolean;
56
+ }
57
+
49
58
  export declare interface BoundingVolume {
50
59
  type: 'box' | 'sphere' | 'regin';
51
60
  applyMatrix4(matrix: THREE_2.Matrix4): this;
@@ -222,297 +231,61 @@ export declare type ControllerCustomInitTypes = {
222
231
  };
223
232
 
224
233
  export declare type ControllerEventTypes = {
225
- /**
226
- * 模态间切换动画开始
227
- * @param panoId - 当前点位
228
- * @param pose - 相机姿态
229
- * @param userAction - 是否用户触发
230
- */
231
- initAnimationWillStart(panoId: WorkPanoId, pose: Pose, userAction: boolean): void;
232
- /**
233
- * 模态间切换动画结束
234
- * @param panoId - 当前点位
235
- * @param pose - 相机姿态
236
- * @param userAction - 是否用户触发
237
- */
238
- initAnimationEnded(panoId: WorkPanoId, pose: Pose, userAction: boolean): void;
239
- /**
240
- * 意图要变化相机的可视角度 可以通过 `return false` 阻止
241
- * @deprecated
242
- * 建议通过 初始化设置的 `defaultFov`, `maxFov`, `minFov` 来限制
243
- * @param fov - 意图要变化相机的可视角度
244
- * @returns 可以通过 `return false` 阻止
245
- */
246
- wantsChangeCameraFov(fov: number): void | false;
247
- /**
248
- * 相机姿态变化
249
- * @param pose - 相机姿态
250
- * @param userAction - 是否用户触发
251
- */
252
- cameraUpdate(pose: Pose, userAction: boolean): void;
253
- /**
254
- * 相机姿态中可视角度变化
255
- * @param fov - 相机的可视角度
256
- * @param userAction - 是否用户触发
257
- */
258
- cameraFovUpdate(fov: Pose["fov"], userAction: boolean): void;
259
- /**
260
- * 相机姿态中相机位置变化
261
- * @param offset - 相机位置
262
- * @param userAction - 是否用户触发
263
- */
264
- cameraPositionUpdate(offset: Pose["offset"], userAction: boolean): void;
265
- /**
266
- * 相机姿态中相机方向变化
267
- * @param coordinates - 相机姿态的俯仰角和偏航角
268
- * @param userAction - 是否用户触发
269
- */
270
- cameraDirectionUpdate(coordinates: Pick<Pose, "longitude" | "latitude">, userAction: boolean): void;
271
- /**
272
- * 观察点位被选择
273
- * @param panoId - 选择的点位
274
- */
275
- panoSelected(panoId: WorkPanoId | null): void;
276
- /**
277
- * 意图要移动到某个点位 可以通过 `return false` 阻止
278
- * @param panoId - 图要移动到的点位
279
- * @param options - 移动参数
280
- * @param userAction - 是否用户触发
281
- * @returns 可以通过 `return false` 阻止
282
- */
283
- wantsMoveToPano(panoId: WorkPanoId, options: MovePanoOptions, userAction: boolean): void | false;
284
- /**
285
- * 开始加载并移动到某个观察点位
286
- * @description
287
- * 可 panoWillArrive 相比
288
- * - moveToPano 在加载全景图资源前触发
289
- * - panoWillArrive 在加载全景图资源后触发
290
- * @param panoId - 移动到的点位
291
- * @param userAction - 是否用户触发
292
- */
293
- moveToPano(panoId: WorkPanoId, userAction: boolean): void;
294
- /**
295
- * 开始加载某个观察点的全景资源
296
- * @param panoId - 移动到的点位
297
- */
298
- panoWillLoad(panoId: WorkPanoId): void;
299
- /**
300
- * 某个观察点的全景资源加载完成
301
- * @param panoId - 对应的点位
302
- */
303
- panoLoaded(panoId: WorkPanoId): void;
304
- /**
305
- * 某个观察点的全景资源加载失败
306
- * @param error - 错误对象
307
- * @param panoId - 对应的点位
308
- */
309
- panoLoadError(error: Error, panoId: WorkPanoId): void;
310
- /**
311
- * 移动到某个观察点位被取消
312
- * @description
313
- * 这个有一些情况会导致
314
- * - 移动过程中切换模态
315
- * - 移动过程中 five 被析构
316
- * - 移动过程点击切换到另一个点位
317
- * @param panoId - 对应的点位
318
- */
319
- moveToPanoCanceled(panoId: WorkPanoId): void;
320
- /**
321
- * 开始移动到某个观察点位
322
- * @description
323
- * 和 moveToPano 相比
324
- * - moveToPano 在加载全景图资源前触发
325
- * - panoWillArrive 在加载全景图资源后触发
326
- * @param panoId - 移动到点位
327
- * @param pose - 相机姿态
328
- * @param userAction - 是否用户触发
329
- */
330
- panoWillArrive(panoId: WorkPanoId, pose: Pose, userAction: boolean): void;
331
- /**
332
- * 移动到某个观察点位
333
- * @param panoIndex - 移动到点位
334
- * @param pose - 相机姿态
335
- * @param userAction - 是否用户触发
336
- */
337
- panoArrived(panoId: WorkPanoId, pose: Pose, userAction: boolean): void;
338
- /**
339
- * 移动中, 会告知移动状态(耗时百分比)
340
- * @param panoId - 将要移动到的点位下标
341
- * @param prevPanoId - 上一个点位下标
342
- * @param progress - 整个过程经度 [0-1]
343
- */
344
- movingToPano(panoId: WorkPanoId, prevPanoId: WorkPanoId, progress: number): void;
345
- /**
346
- * 意图要触发手势, 可以通过 `return false` 阻止
347
- * @param type - 手势类型
348
- * @param pointers - 手指位置
349
- * @param final - 是否手势结束
350
- * @returns 可以通过 `return false` 阻止
351
- */
352
- wantsGesture(type: GestureTypes, pointers: {
353
- x: number;
354
- y: number;
355
- delta?: number;
356
- }[], final: boolean): void | false;
357
- /**
358
- * 手势 触发
359
- * @param type - 手势类型
360
- * @param pointers - 手指位置
361
- * @param final - 是否手势结束
362
- */
363
- gesture(type: GestureTypes, pointers: {
364
- x: number;
365
- y: number;
366
- delta?: number;
367
- }[], final: boolean): void;
368
- /**
369
- * 意图要触发 pan 手势(滑动屏幕), 可以通过 `return false` 阻止
370
- * @param pose - 意图的相机姿态
371
- * @param final - 是否手势结束
372
- * @returns 可以通过 `return false` 阻止
373
- */
374
- wantsPanGesture(pose: Pose, final: boolean): void | false;
375
- /**
376
- * pan 手势(滑动屏幕) 被触发
377
- * @param pose - 相机姿态
378
- * @param final - 是否手势结束
379
- */
380
- panGesture(pose: Pose, final: boolean): void;
381
- /**
382
- * 意图要触发 pan 手势(滑动屏幕) 的惯性运动, 可以通过 `return false` 阻止
383
- * @param pose - 意图的相机姿态
384
- * @param final - 是否手势结束
385
- * @returns 可以通过 `return false` 阻止
386
- */
387
- wantsInteriaPan(pose: Pose): void | false;
388
- /**
389
- * pan 手势(滑动屏幕) 的惯性运动
390
- * @param pose - 意图的相机姿态
391
- * @param final - 是否手势结束
392
- */
393
- interiaPan(pose: Pose, final: boolean): void;
394
- /**
395
- * 意图要触发 tap 手势(点击屏幕), 可以通过 `return false` 阻止
396
- * @param raycaster - 点击对应的三维射线
397
- * @param tapPosition - 点击对应的屏幕位置
398
- * @param final - 是否手势结束
399
- * @returns 可以通过 `return false` 阻止
400
- */
401
- wantsTapGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, final: boolean): void | false;
402
- /**
403
- * tap 手势(点击屏幕) 被触发
404
- * @param raycaster - 点击对应的三维射线
405
- * @param tapPosition - 点击对应的屏幕位置
406
- * @param final - 是否手势结束
407
- */
408
- tapGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, final: boolean): void;
409
- /**
410
- * 意图要触发 pinch 手势(双指缩放),可以通过 `return false` 阻止
411
- * @param scale - 缩放数值
412
- * @param nextFov - 意图的fov变更
413
- * @param final - 是否手势结束
414
- * @returns 可以通过 `return false` 阻止
415
- */
416
- wantsPinchGesture(scale: number, nextFov: number, final: boolean): void | false;
417
- /**
418
- * 意图要触发 press 手势(长按屏幕), 可以通过 `return false` 阻止
419
- * @param raycaster - 长按对应的三维射线
420
- * @param tapPosition - 长按对应的屏幕位置
421
- * @param duration - 长按持续时间
422
- * @param final - 是否手势结束
423
- * @returns 可以通过 `return false` 阻止
424
- */
425
- wantsPressGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, duration: number, isFinal: boolean): void | false;
426
- /**
427
- * tap 手势(点击屏幕) 被触发
428
- * @param raycaster - 点击对应的三维射线
429
- * @param tapPosition - 点击对应的屏幕位置
430
- * @param duration - 长按持续时间
431
- * @param final - 是否手势结束
432
- */
433
- pressGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, duration: number, isFinal: boolean): void;
434
- /**
435
- * pinch 手势(双指缩放) 被触发
436
- * @param scale - 缩放数值
437
- * @param nextFov - 意图的fov变更
438
- * @param final - 是否手势结束
439
- */
440
- pinchGesture(scale: number, fov: number, final: boolean): void;
441
- /**
442
- * 意图要触发 鼠标滚轮 可以通过 `return false` 阻止
443
- * @param delta - 滚轮数值
444
- * @param nextFov - 意图的fov变更
445
- * @param final - 是否手势结束
446
- * @returns 可以通过 `return false` 阻止
447
- */
448
- wantsMouseWheel(delta: number, nextFov: number, final: boolean): void | false;
449
- /**
450
- * 鼠标滚轮被触发
451
- * @param delta - 滚轮数值
452
- * @param nextFov - 意图的fov变更
453
- * @param final - 是否手势结束
454
- */
455
- mouseWheel(delta: number, fov: number, final: boolean): void;
456
- /**
457
- * 鼠标焦点环位置被重新计算
458
- * @param intersection - 焦点碰撞结果
459
- * @param mesh - 焦点环 mesh
460
- */
461
- intersectionOnModelUpdate(intersection: Intersection, mesh: IntersectMeshInterface): void;
462
- /**
463
- * 意图要展示鼠标焦点环,可以通过 `return false` 阻止
464
- * @param intersection - 焦点碰撞结果
465
- * @returns 可以通过 `return false` 阻止
466
- */
467
- wantsShowIntersectionOnModel(raycaster: THREE_2.Raycaster): void | false;
468
- /** 鼠标焦点环被隐藏 */
469
- intersectionHidden(): void;
470
- /** 意图要退出VR眼镜模式 */
471
- vrWantsToExit(): void;
472
- /**
473
- * 观察点的全景资源开始加载
474
- * @param panoId - 加载点位
475
- */
476
- textureStartLoad(panoId: WorkPanoId): void;
477
- /**
478
- * 观察点的全景资源加载中,可获取到进度
479
- * @param progress - 加载进度 [0-1]
480
- * @param panoId - 加载点位下标
481
- */
482
- textureLoading(progress: number, panoId: WorkPanoId): void;
483
- /**
484
- * 观察点的全景资源加载被中止
485
- * @param panoId - 加载点位
486
- */
487
- textureAbort(panoId: WorkPanoId): void;
488
- /**
489
- * 观察点的全景资源加载失败
490
- * @param error - 错误对象
491
- * @param panoId - 加载点位
492
- */
493
- textureError(error: Error, panoId: WorkPanoId): void;
494
- /**
495
- * 观察点的全景资源加载完成
496
- * @param panoId - 加载点位
497
- */
498
- textureLoaded(panoId: WorkPanoId, meta: (NetWorkMeta | null)[]): void;
499
- /**
500
- * 抛出错误
501
- * @param error - 抛出错误
502
- */
503
- error(error: Error): void;
504
- /**
505
- * webXR模式开始,webxr session完成坐标系矫正
506
- */
507
- webXRSessionStart(): void;
508
- /**
509
- * webXR模式结束,webxr session销毁
510
- */
511
- webXRSessionEnd(): void;
512
- /**
513
- * axes代表控制杆,axes数组的0-1元素分别代表左控制器的左(-1)右(1),左控制器的上(-1)下(1),axes数组的2-3元素同理
514
- */
515
- webXRControllerEvent(type: WebXRControllerType, key: WebXRControllerKey, params: WebXRControllerParams): void;
234
+ /** 手势 滑动屏幕 */
235
+ "gesture.pan"(event: GestureEvent): void;
236
+ /** 手势 点击屏幕 */
237
+ "gesture.tap"(event: GestureEvent): void;
238
+ /** 手势 长按屏幕 */
239
+ "gesture.press"(event: GestureEvent): void;
240
+ /** 手势 双指缩放 */
241
+ "gesture.pinch"(event: GestureEvent): void;
242
+ /** 手势 鼠标滚轮 */
243
+ "gesture.mousewheel"(event: GestureEvent): void;
244
+ /** 手势 鼠标移动 */
245
+ "gesture.mousemove"(event: GestureEvent): void;
246
+ /** 手势 惯性 */
247
+ "gesture.momentum"(event: GestureEvent): void;
248
+ /** 模态切换动画 开始 */
249
+ "initAnimation.start"(event: StateEvent): void;
250
+ /** 模态切换动画 结束 */
251
+ "initAnimation.end"(event: StateEvent): void;
252
+ /** 相机改变 */
253
+ "camera.update"(event: StateEvent): void;
254
+ "intersect.update"(event: IntersectEvent): void;
255
+ /** 选择 */
256
+ "pano.select"(event: PanoEvent): void;
257
+ /** 请求点位 */
258
+ "pano.request"(event: PanoEvent): void;
259
+ /** 运动去点位 */
260
+ "pano.moveTo"(event: PanoEvent): void;
261
+ /** 运动点位过程 */
262
+ "pano.moving"(event: PanoEvent): void;
263
+ /** 运动到达点位 */
264
+ "pano.arrived"(event: PanoEvent): void;
265
+ /** 取消运动点位 */
266
+ "pano.cancel"(event: PanoEvent): void;
267
+ /** 运动点位出错 */
268
+ "pano.error"(event: PanoEvent): void;
269
+ /** 加载全景材质 */
270
+ "pano.texture.load"(event: PanoTextureEvent): void;
271
+ /** 加载全景材质进度 */
272
+ "pano.texture.progress"(event: PanoTextureEvent): void;
273
+ /** 加载全景材质成功 */
274
+ "pano.texture.success"(event: PanoTextureEvent): void;
275
+ /** 加载全景材质失败 */
276
+ "pano.texture.error"(event: PanoTextureEvent): void;
277
+ /** 加载全景材质中止 */
278
+ "pano.texture.abort"(event: PanoTextureEvent): void;
279
+ /** VRPanorama 请求退出 */
280
+ "vr.requestExit"(event: BaseEvent): void;
281
+ /** XR 退出 */
282
+ "xr.session.end"(event: XRSessionEvent_2): void;
283
+ /** XR 进入 */
284
+ "xr.session.start"(event: XRSessionEvent_2): void;
285
+ /** XR 手势(按钮) */
286
+ "xr.gesture.tap"(event: XRGestureEvent): void;
287
+ /** 抛出错误 */
288
+ "error"(error: Error): void;
516
289
  };
517
290
 
518
291
  export declare class CullingVolume {
@@ -545,7 +318,7 @@ export declare interface DepthPanoramaControllerCustomInitArgs extends PanoramaL
545
318
  */
546
319
  panoTapTriggerRadius?: number;
547
320
  /** 地面观察点标识自定义创建器 */
548
- panoCircleMeshCreator?: (panoId: WorkPanoId) => PanoCircleMeshInterface;
321
+ panoCircleMeshCreator?: (pano: Pano) => PanoCircleMeshInterface;
549
322
  }
550
323
 
551
324
  /**
@@ -561,132 +334,49 @@ export declare interface EventCallback extends EventTypes {
561
334
  * @description
562
335
  * 具体事件列表 请查看 {@link EventCallback}
563
336
  */
564
- export declare type EventTypes = Pick<ControllerEventTypes, typeof PROXY_CONTROLLER_EVENT_NAMES[number]> & {
565
- /**
566
- * 内部错误
567
- * @param error - 错误对象
568
- */
569
- error(error: Error): void;
570
- /**
571
- * 准备加载 Work 数据
572
- * @param input - 输入的 work
573
- * @param works - 归一化的标准 work
574
- * @param state - 加载时的姿态
575
- */
576
- willLoad(input: any, works: Works, state: Partial<State>): void;
577
- /**
578
- * 开始加载 Work 数据
579
- * @param input - 输入的 work
580
- * @param works - 归一化的标准 work
581
- * @param state - 加载时的姿态
582
- */
583
- load(input: any, works: Works, state: Partial<State>): void;
584
- /**
585
- * 加载完 Work 数据
586
- * @param input - 输入的 work
587
- * @param works - 归一化的标准 work
588
- */
589
- loaded(input: any, works: Works): void;
590
- /**
591
- * 模型开始加载
592
- * @param workModel - 归一化的标准 work 中的 model 值
593
- */
594
- modelWillLoad(workModel: WorkModel): void;
595
- /**
596
- * 模型加载错误
597
- * @param error - 错误对象
598
- * @param model - 加载完的 model
599
- */
600
- modelLoadError(error: Error, model: Model): void;
601
- /**
602
- * 模型加载完成
603
- * @param models - 加载完的 model
604
- */
605
- modelLoaded(models: Models): void;
606
- /**
607
- * 模型楼层切换
608
- * @param shownFloor - 模型楼层
609
- */
610
- modelShownFloorChange(shownFloor: number | null): void;
611
- /**
612
- * 渲染循环
613
- * @param rendered - 是否渲染了
614
- */
615
- renderFrame(rendered: boolean): void;
616
- /**
617
- * 当前 fps 变化
618
- * @param fps - 当前刷新率
619
- */
620
- fps(fps: number): void;
621
- /**
622
- * 当目标 state 变化时
623
- * @param state - 当前姿态状态
624
- * @param userAction - 是否用户触发
625
- */
626
- stateChange(state: State, userAction: boolean): void;
627
- /**
628
- * 当前实时 state 变化时
629
- * @param state - 当前姿态状态
630
- * @param userAction - 是否用户触发
631
- */
632
- currentStateChange(state: State, userAction: boolean): void;
633
- /**
634
- * 当 setState 方法被调用
635
- * @param state - 当前姿态状态
636
- */
637
- setState(state: State): void;
638
- /**
639
- * 当 state 被同步完成时
640
- * @param state - 当前姿态状态
641
- */
642
- stateSynced(state: State): void;
643
- /**
644
- * 意图要移动到某个点时, 可以通过 return false 阻止
645
- * @param panoId - 意图要移动到点位
646
- * @param options - 移动参数
647
- * @param userAction - 是否用户触发
648
- * @returns 可以通过 return false 阻止
649
- */
650
- wantsMoveToPano(panoId: WorkPanoId, options: MovePanoOptions, userAction: boolean): void | false;
651
- /**
652
- * 同 wantsMoveToPano
653
- * @description
654
- * @param panoId - 意图要移动到点位
655
- * @param options - 移动参数
656
- * @param userAction - 是否用户触发
657
- * @returns 可以通过 return false 阻止
658
- */
659
- wantsToMoveToPano(panoId: WorkPanoId, options: MovePanoOptions, userAction: boolean): void;
660
- /**
661
- * 意图要切换到某个模态, 可以通过 return false 阻止
662
- * @param mode - 意图要切换到的模态
663
- * @param prevMode - 当前模态
664
- * @returns 可以通过 return false 阻止
665
- */
666
- wantsChangeMode(mode: Mode, prevMode: Mode): void | false;
667
- /**
668
- * 模态切换完成
669
- * @param mode - 切换到的模态
670
- * @param prevMode - 上本质是一个模态
671
- * @param panoIndex - 初始化动画结束后的点位下标
672
- * @param toPose - 初始化动画结束后的状态
673
- * @param userAction - 是否用户触发
674
- */
675
- modeChange(mode: Mode, prevMode: Mode, panoId: WorkPanoId, toPose: Pose, userAction: boolean): void;
676
- /**
677
- * 帮助元素显应的变换
678
- * @param visible - 帮助元素的是否开启
679
- */
680
- helpersVisibleChange(visible: boolean): void;
681
- /**
682
- * 网络资源分析
683
- * @param source - 资源地址
684
- * @param state - 状态
685
- * @param detail - 详情
686
- */
687
- network(source: string, type: NetworkType, state: NetworkState, detail: string): void;
337
+ export declare type EventTypes = Pick<ControllerEventTypes, typeof PROXY_CONTROLLER_EVENT_NAMES[number]> & legacyEventType & {
338
+ /** 请求点位 */
339
+ "pano.request"(event: PanoEvent): void;
340
+ /** 内部错误 */
341
+ "error"(error: Error): void;
342
+ /** 请求 work数据 */
343
+ "works.request"(event: WorksEvent): void;
344
+ /** 加载 work */
345
+ "works.load"(event: WorksEvent): void;
346
+ /** 设置 state */
347
+ "state.set"(event: StateEvent): void;
348
+ /** 当 state 变化 */
349
+ "state.change"(event: StateEvent): void;
350
+ /** 当 state 同步完成 */
351
+ "state.synced"(event: StateEvent): void;
352
+ /** 当前 state 变化 */
353
+ "currentState.change"(event: StateEvent): void;
354
+ /** 当模型加载 */
355
+ "model.request"(event: ModelEvent): void;
356
+ /** 当模型修改楼层 */
357
+ "model.load"(event: ModelEvent): void;
358
+ /** 当模型错误 */
359
+ "model.error"(event: ModelEvent): void;
360
+ /** 当模型修改楼层 */
361
+ "model.changeShownFloor"(event: ModelEvent): void;
362
+ /** 模型加载完成 */
363
+ "models.load"(event: ModelsEvent): void;
364
+ /** 渲染前 */
365
+ "render.prepare"(event: RenderEvent): void;
366
+ /** 渲染后 */
367
+ "render"(event: RenderEvent): void;
368
+ /** 请求改变 mode */
369
+ "mode.change.request"(event: ModeChangeEvent): void;
370
+ /** 改变 mode */
371
+ "mode.change"(event: ModeChangeEvent): void;
372
+ /** 改变 helpers 元素可见 */
373
+ "helpers.visible"(event: ObjectEvent): void;
374
+ /** 网络资源 */
375
+ "network.resource"(event: NetworkResourceEvent): void;
376
+ /** 当前 fps 变化 */
377
+ "fps"(fps: number): void;
688
378
  /** five 被析构。 插件中请监听用于自身析构 */
689
- dispose(): void;
379
+ "dispose"(): void;
690
380
  };
691
381
 
692
382
  /**
@@ -732,7 +422,7 @@ export declare class Five extends Subscribe<EventTypes> {
732
422
  */
733
423
  paused: boolean;
734
424
  /** 当前点位序号 */
735
- panoId: WorkPanoId;
425
+ pano: Pano;
736
426
  /** 当前展示的模式 */
737
427
  currentMode: Mode;
738
428
  /** 内部使用的 `THREE.Scene` */
@@ -760,6 +450,7 @@ export declare class Five extends Subscribe<EventTypes> {
760
450
  renderer?: THREE_2.WebGLRenderer;
761
451
  /** 当前加载的模型 */
762
452
  models: Models;
453
+ private lastModels;
763
454
  /**
764
455
  * 是否需要渲染
765
456
  * @description
@@ -813,6 +504,19 @@ export declare class Five extends Subscribe<EventTypes> {
813
504
  * ```
814
505
  */
815
506
  state: State;
507
+ info: null | {
508
+ memory: {
509
+ geometries: number;
510
+ textures: number;
511
+ };
512
+ render: {
513
+ calls: number;
514
+ frame: number;
515
+ lines: number;
516
+ points: number;
517
+ triangles: number;
518
+ };
519
+ };
816
520
  /** 插件暴露的方法 */
817
521
  plugins: {
818
522
  [key: string]: FivePluginInstance<any>;
@@ -834,7 +538,6 @@ export declare class Five extends Subscribe<EventTypes> {
834
538
  private extraElements;
835
539
  private getPixelsRenderTarget;
836
540
  private readyCallbacks;
837
- private modelPending;
838
541
  private syncingState;
839
542
  /**
840
543
  * 是否开启 IOS EDR 模式
@@ -1031,7 +734,7 @@ export declare class Five extends Subscribe<EventTypes> {
1031
734
  /**
1032
735
  * 获取观测点
1033
736
  */
1034
- get observers(): WorkObserver[];
737
+ get observers(): WorkResolvedObserver[];
1035
738
  /**
1036
739
  * 强制渲染
1037
740
  * @description
@@ -1056,16 +759,14 @@ export declare class Five extends Subscribe<EventTypes> {
1056
759
  * @param options - 移动点位参数
1057
760
  * @param userAction - 是否用户触犯
1058
761
  */
1059
- moveToPano(panoId: WorkPanoId, options?: MovePanoOptions, userAction?: boolean): Promise<void>;
1060
- moveToPano(panoIndex: number, options?: MovePanoOptions, userAction?: boolean): Promise<void>;
762
+ moveToPano(pano: Pano | PanoId | number, options?: MovePanoOptions, userAction?: boolean): Promise<void>;
1061
763
  /**
1062
764
  * 预加载点位图片资源
1063
- * @param panoIndex - 观察点序号
765
+ * @param pano - 观察点序号
1064
766
  * @param callback - 加载完成回调, 并传递加载用时。
1065
767
  * @returns 加载完成的 Promise 参数同 callback
1066
768
  */
1067
- preloadPano(panoId: WorkPanoId, callback?: (costs: number) => void): Promise<number>;
1068
- preloadPano(panoIndex: number, callback?: (costs: number) => void): Promise<number>;
769
+ preloadPano(pano: Pano | PanoId | number, callback?: (costs: number) => void): Promise<number>;
1069
770
  /**
1070
771
  * 计算三维坐标对应到屏幕的二维坐标
1071
772
  * @description
@@ -1125,8 +826,7 @@ export declare class Five extends Subscribe<EventTypes> {
1125
826
  private applyController;
1126
827
  /** 移除事件绑定 */
1127
828
  private removeEventListeners;
1128
- /** 销毁GPU Picking 所用的材质 */
1129
- private diposeGPUPickingMaterial;
829
+ initlegacyEvent(): void;
1130
830
  }
1131
831
 
1132
832
  /** Five 初始化参数 */
@@ -1258,176 +958,610 @@ export declare interface FiveInitArgs {
1258
958
  * 单位毫秒
1259
959
  * @default `800`
1260
960
  */
1261
- modeChangeDuration?: number;
961
+ modeChangeDuration?: number;
962
+ /**
963
+ * 插件定义
964
+ * @description
965
+ * 详见插件部分。
966
+ */
967
+ plugins?: (FivePlugin<void> | FivePluginInit<FivePlugin<any, any>> | FivePluginInit<FivePlugin<void, any>>)[];
968
+ /**
969
+ * 是否展示 powered by 如视
970
+ */
971
+ poweredByRealsee?: boolean;
972
+ /**
973
+ * 是否使用webgl2渲染执行环境, 默认值 false
974
+ */
975
+ webgl2?: boolean;
976
+ /**
977
+ * 是否开启模型裁切
978
+ */
979
+ localClippingEnabled?: boolean;
980
+ /**
981
+ * 请求代理
982
+ * @param url - 发起的请求
983
+ * @returns 返回的请求
984
+ */
985
+ requestProxy?(url: string): string | Promise<string>;
986
+ /**
987
+ * 模型lod相关的配置,maxDepth为加载的最大深度
988
+ */
989
+ modelLod?: {
990
+ maxDepth?: number;
991
+ };
992
+ }
993
+
994
+ /**
995
+ * Five 插件
996
+ * [[include:plugins.md]]
997
+ * @template Parameters - 插件参数, 没有参数则为 void
998
+ * @template Returns - 如果有参数则插件暴露的 api,没有参数则不传
999
+ */
1000
+ export declare type FivePlugin<Parameters = void, Returns = void> = Parameters extends void ? ((five: Five) => Returns) : ((five: Five, parameters: Parameters) => Returns);
1001
+
1002
+ /**
1003
+ * 获取插件在Five中的初始化结构
1004
+ * @template T - Five 插件
1005
+ */
1006
+ export declare type FivePluginInit<T extends FivePlugin<any, any>> = Parameters<T>[1] extends undefined ? [
1007
+ Plugin: T,
1008
+ instanceName: null | string
1009
+ ] : [
1010
+ Plugin: T,
1011
+ instanceName: null | string,
1012
+ parameters: Parameters<T>[1]
1013
+ ];
1014
+
1015
+ /**
1016
+ * 获取插件暴露的 api
1017
+ * @template T - Five 插件
1018
+ */
1019
+ export declare type FivePluginInstance<T extends FivePlugin<any, any>> = ReturnType<T>;
1020
+
1021
+ export declare interface FloorplanControllerCustomInitArgs {
1022
+ /** 默认俯仰角 */
1023
+ defaultLatitude?: number;
1024
+ /** 最大俯仰角 */
1025
+ maxLatitude?: number;
1026
+ /** 最小俯仰角 */
1027
+ minLatitude?: number;
1028
+ /** 默认相机可视角度(垂直),可作为 `zoom` */
1029
+ defaultFov?: number;
1030
+ /** 最大相机可视角度 */
1031
+ maxFov?: number;
1032
+ /** 最小相机可视角度 */
1033
+ minFov?: number;
1034
+ /** 鼠标焦点环自定义创建器 */
1035
+ intersectMeshCreator?: () => IntersectMeshInterface;
1036
+ }
1037
+
1038
+ export declare interface GestureEvent extends StateEvent {
1039
+ target: EventTarget | null;
1040
+ pointerType: 'touch' | 'pen' | 'mouse' | 'kinect';
1041
+ srcEvent: MouseEvent | TouchEvent | PointerEvent;
1042
+ pointers: {
1043
+ x: number;
1044
+ y: number;
1045
+ delta: number;
1046
+ buttons: number;
1047
+ coords: THREE_2.Vector2;
1048
+ raycaster: THREE_2.Raycaster;
1049
+ }[];
1050
+ isFirst: boolean;
1051
+ isFinal: boolean;
1052
+ scale: number;
1053
+ center: {
1054
+ x: number;
1055
+ y: number;
1056
+ delta: number;
1057
+ buttons: number;
1058
+ coords: THREE_2.Vector2;
1059
+ raycaster: THREE_2.Raycaster;
1060
+ };
1061
+ velocityX: number;
1062
+ velocityY: number;
1063
+ overallVelocityX: number;
1064
+ overallVelocityY: number;
1065
+ }
1066
+
1067
+ export declare type GestureTypes = "pan" | "tap" | "pinch" | "press" | "mouseWheel" | "mouseMove";
1068
+
1069
+ export declare function getViewportScale(): number;
1070
+
1071
+ /**
1072
+ * 图片参数
1073
+ */
1074
+ export declare interface ImageOptions {
1075
+ /**
1076
+ * url 地址转化
1077
+ * @param url - 原始地址
1078
+ * @param options - 当前地址参数
1079
+ * @returns 转化后地址
1080
+ */
1081
+ transform?: (url: string, options: ImageURLOptions) => string;
1082
+ /** 图片尺寸参数 尽量使用 2 的幂次 如 512 1024 2048 */
1083
+ size?: number;
1084
+ /** 图片质量参数(0-100) */
1085
+ quality?: number;
1086
+ /** 图片格式参数 */
1087
+ format?: "jpg" | "png" | "heif" | "webp" | "avif";
1088
+ /** 锐化参数 海外不支持 */
1089
+ sharpen?: number;
1090
+ mappings?: ImageURLMappings;
1091
+ }
1092
+
1093
+ export declare function imageSupport(): Promise<{
1094
+ avif: boolean;
1095
+ webp: boolean;
1096
+ }>;
1097
+
1098
+ export declare interface ImageURLMappings {
1099
+ [publicDomain: string]: {
1100
+ "type"?: string;
1101
+ "pano": [string, string];
1102
+ "tile": [string, string];
1103
+ "model": [string, string];
1104
+ "texture": [string];
1105
+ "default": [string];
1106
+ };
1107
+ }
1108
+
1109
+ export declare interface ImageURLOptions {
1110
+ /** 图片类型标识 */
1111
+ key: string;
1112
+ /** 图片尺寸参数 尽量使用 2 的幂次 如 256 512 1024 */
1113
+ size?: number;
1114
+ /** 图片质量参数(0-100) */
1115
+ quality?: number;
1116
+ /** 图片格式参数 */
1117
+ format?: "jpg" | "png" | "heif" | "webp" | "avif";
1118
+ /** 图片裁切 */
1119
+ cut?: [x: number, y: number, width: number, height: number];
1120
+ /** 锐化参数 海外不支持 */
1121
+ sharpen?: number;
1122
+ /** url匹配规则 */
1123
+ mappings?: ImageURLMappings;
1124
+ }
1125
+
1126
+ export declare class InternalWebGLRenderer extends THREE_2.WebGLRenderer {
1127
+ constructor({ preserveDrawingBuffer, backgroundColor, backgroundAlpha, pixelRatio, antialias, webgl2, }: {
1128
+ preserveDrawingBuffer?: boolean;
1129
+ backgroundColor?: number | THREE_2.Color;
1130
+ backgroundAlpha?: number;
1131
+ pixelRatio?: number;
1132
+ antialias?: boolean;
1133
+ webgl2?: boolean;
1134
+ });
1135
+ }
1136
+
1137
+ export declare interface IntersectEvent extends BaseEvent {
1138
+ object: THREE_2.Object3D;
1139
+ raycaster: THREE_2.Raycaster;
1140
+ intersection: Intersection | null;
1141
+ }
1142
+
1143
+ export declare interface Intersection {
1144
+ /** 焦点坐标 */
1145
+ point: THREE.Vector3;
1146
+ /** 焦点面片 */
1147
+ face?: {
1148
+ normal: THREE.Vector3;
1149
+ } | null;
1150
+ /** 焦点距离 */
1151
+ distance: number;
1152
+ }
1153
+
1154
+ export declare class IntersectMesh extends THREE_2.Object3D implements IntersectMeshInterface {
1155
+ private ringMesh;
1156
+ constructor();
1157
+ dispose(): void;
1158
+ }
1159
+
1160
+ /**
1161
+ * 地面提示点位接口
1162
+ */
1163
+ export declare interface IntersectMeshInterface extends THREE_2.Object3D {
1164
+ dispose(): void;
1165
+ }
1166
+
1167
+ export declare function isPanoId(id: any): id is PanoId;
1168
+
1169
+ /**
1170
+ * 过时的事件列表
1171
+ */
1172
+ declare type legacyEventType = {
1173
+ /**
1174
+ * 模态间切换动画开始
1175
+ * @param panoIndex - 当前点位
1176
+ * @param pose - 相机姿态
1177
+ * @param userAction - 是否用户触发
1178
+ */
1179
+ initAnimationWillStart(panoIndex: number, pose: Pose, userAction: boolean): void;
1180
+ /**
1181
+ * 模态间切换动画结束
1182
+ * @deprecated
1183
+ * @param panoIndex - 当前点位
1184
+ * @param pose - 相机姿态
1185
+ * @param userAction - 是否用户触发
1186
+ */
1187
+ initAnimationEnded(panoIndex: number, pose: Pose, userAction: boolean): void;
1188
+ /**
1189
+ * 意图要触发手势, 可以通过 `return false` 阻止
1190
+ * @deprecated
1191
+ * @param type - 手势类型
1192
+ * @param pointers - 手指位置
1193
+ * @param final - 是否手势结束
1194
+ * @returns 可以通过 `return false` 阻止
1195
+ */
1196
+ wantsGesture(type: GestureTypes, pointers: {
1197
+ x: number;
1198
+ y: number;
1199
+ delta?: number;
1200
+ }[], final: boolean): void | false;
1201
+ /**
1202
+ * 手势 触发
1203
+ * @param type - 手势类型
1204
+ * @param pointers - 手指位置
1205
+ * @param final - 是否手势结束
1206
+ */
1207
+ gesture(type: GestureTypes, pointers: {
1208
+ x: number;
1209
+ y: number;
1210
+ delta?: number;
1211
+ }[], final: boolean): void;
1212
+ /**
1213
+ * 意图要触发 pan 手势(滑动屏幕), 可以通过 `return false` 阻止
1214
+ * @param pose - 意图的相机姿态
1215
+ * @param final - 是否手势结束
1216
+ * @returns 可以通过 `return false` 阻止
1217
+ */
1218
+ wantsPanGesture(pose: Pose, final: boolean): void | false;
1219
+ /**
1220
+ * pan 手势(滑动屏幕) 被触发
1221
+ * @param pose - 相机姿态
1222
+ * @param final - 是否手势结束
1223
+ */
1224
+ panGesture(pose: Pose, final: boolean): void;
1225
+ /**
1226
+ * 意图要触发 tap 手势(点击屏幕), 可以通过 `return false` 阻止
1227
+ * @param raycaster - 点击对应的三维射线
1228
+ * @param tapPosition - 点击对应的屏幕位置
1229
+ * @param final - 是否手势结束
1230
+ * @returns 可以通过 `return false` 阻止
1231
+ */
1232
+ wantsTapGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, final: boolean): void | false;
1233
+ /**
1234
+ * tap 手势(点击屏幕) 被触发
1235
+ * @param raycaster - 点击对应的三维射线
1236
+ * @param tapPosition - 点击对应的屏幕位置
1237
+ * @param final - 是否手势结束
1238
+ */
1239
+ tapGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, final: boolean): void;
1240
+ /**
1241
+ * 意图要触发 pinch 手势(双指缩放),可以通过 `return false` 阻止
1242
+ * @param scale - 缩放数值
1243
+ * @param nextFov - 意图的fov变更
1244
+ * @param final - 是否手势结束
1245
+ * @returns 可以通过 `return false` 阻止
1246
+ */
1247
+ wantsPinchGesture(scale: number, nextFov: number, final: boolean): void | false;
1248
+ /**
1249
+ * 意图要触发 press 手势(长按屏幕), 可以通过 `return false` 阻止
1250
+ * @param raycaster - 长按对应的三维射线
1251
+ * @param tapPosition - 长按对应的屏幕位置
1252
+ * @param duration - 长按持续时间
1253
+ * @param final - 是否手势结束
1254
+ * @returns 可以通过 `return false` 阻止
1255
+ */
1256
+ wantsPressGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, duration: number, isFinal: boolean): void | false;
1257
+ /**
1258
+ * tap 手势(点击屏幕) 被触发
1259
+ * @param raycaster - 点击对应的三维射线
1260
+ * @param tapPosition - 点击对应的屏幕位置
1261
+ * @param duration - 长按持续时间
1262
+ * @param final - 是否手势结束
1263
+ */
1264
+ pressGesture(raycaster: THREE_2.Raycaster, tapPosition: THREE_2.Vector2, duration: number, isFinal: boolean): void;
1265
+ /**
1266
+ * pinch 手势(双指缩放) 被触发
1267
+ * @param scale - 缩放数值
1268
+ * @param nextFov - 意图的fov变更
1269
+ * @param final - 是否手势结束
1270
+ */
1271
+ pinchGesture(scale: number, fov: number, final: boolean): void;
1272
+ /**
1273
+ * 意图要触发 鼠标滚轮 可以通过 `return false` 阻止
1274
+ * @param delta - 滚轮数值
1275
+ * @param nextFov - 意图的fov变更
1276
+ * @param final - 是否手势结束
1277
+ * @returns 可以通过 `return false` 阻止
1278
+ */
1279
+ wantsMouseWheel(delta: number, nextFov: number, final: boolean): void | false;
1280
+ /**
1281
+ * 鼠标滚轮被触发
1282
+ * @param delta - 滚轮数值
1283
+ * @param nextFov - 意图的fov变更
1284
+ * @param final - 是否手势结束
1285
+ */
1286
+ mouseWheel(delta: number, fov: number, final: boolean): void;
1287
+ /**
1288
+ * 意图要触发 pan 手势(滑动屏幕) 的惯性运动, 可以通过 `return false` 阻止
1289
+ * @param pose - 意图的相机姿态
1290
+ * @param final - 是否手势结束
1291
+ * @returns 可以通过 `return false` 阻止
1292
+ */
1293
+ wantsInteriaPan(pose: Pose): void | false;
1294
+ /**
1295
+ * pan 手势(滑动屏幕) 的惯性运动
1296
+ * @param pose - 意图的相机姿态
1297
+ * @param final - 是否手势结束
1298
+ */
1299
+ interiaPan(pose: Pose, final: boolean): void;
1300
+ /**
1301
+ * 意图要变化相机的可视角度 可以通过 `return false` 阻止
1302
+ * @deprecated
1303
+ * 建议通过 初始化设置的 `defaultFov`, `maxFov`, `minFov` 来限制
1304
+ * @param fov - 意图要变化相机的可视角度
1305
+ * @returns 可以通过 `return false` 阻止
1306
+ */
1307
+ wantsChangeCameraFov(fov: number): void | false;
1308
+ /**
1309
+ * 相机姿态变化
1310
+ * @param pose - 相机姿态
1311
+ * @param userAction - 是否用户触发
1312
+ */
1313
+ cameraUpdate(pose: Pose, userAction: boolean): void;
1314
+ /**
1315
+ * 相机姿态中可视角度变化
1316
+ * @param fov - 相机的可视角度
1317
+ * @param userAction - 是否用户触发
1318
+ */
1319
+ cameraFovUpdate(fov: Pose["fov"], userAction: boolean): void;
1320
+ /**
1321
+ * 相机姿态中相机位置变化
1322
+ * @param offset - 相机位置
1323
+ * @param userAction - 是否用户触发
1324
+ */
1325
+ cameraPositionUpdate(offset: Pose["offset"], userAction: boolean): void;
1326
+ /**
1327
+ * 相机姿态中相机方向变化
1328
+ * @param coordinates - 相机姿态的俯仰角和偏航角
1329
+ * @param userAction - 是否用户触发
1330
+ */
1331
+ cameraDirectionUpdate(coordinates: Pick<Pose, "longitude" | "latitude">, userAction: boolean): void;
1332
+ /**
1333
+ * 鼠标焦点环位置被重新计算
1334
+ * @param intersection - 焦点碰撞结果
1335
+ * @param mesh - 焦点环 mesh
1336
+ */
1337
+ intersectionOnModelUpdate(intersection: Intersection, mesh: THREE_2.Object3D): void;
1338
+ /**
1339
+ * 意图要展示鼠标焦点环,可以通过 `return false` 阻止
1340
+ * @param intersection - 焦点碰撞结果
1341
+ * @returns 可以通过 `return false` 阻止
1342
+ */
1343
+ wantsShowIntersectionOnModel(raycaster: THREE_2.Raycaster): void | false;
1344
+ /** 鼠标焦点环被隐藏 */
1345
+ intersectionHidden(): void;
1346
+ /**
1347
+ * 意图要移动到某个点时, 可以通过 return false 阻止
1348
+ * @param panoIndex - 意图要移动到点位
1349
+ * @param options - 移动参数
1350
+ * @param userAction - 是否用户触发
1351
+ * @returns 可以通过 return false 阻止
1352
+ */
1353
+ wantsMoveToPano(panoIndex: number, options: MovePanoOptions, userAction: boolean): void | false;
1354
+ /**
1355
+ * 同 wantsMoveToPano
1356
+ * @description
1357
+ * @param panoIndex - 意图要移动到点位
1358
+ * @param options - 移动参数
1359
+ * @param userAction - 是否用户触发
1360
+ * @returns 可以通过 return false 阻止
1361
+ */
1362
+ wantsToMoveToPano(panoIndex: number, options: MovePanoOptions, userAction: boolean): void;
1363
+ /**
1364
+ * 观察点位被选择
1365
+ * @param panoIndex - 选择的点位
1366
+ */
1367
+ panoSelected(panoIndex: number | null): void;
1368
+ /**
1369
+ * 开始加载并移动到某个观察点位
1370
+ * @description
1371
+ * 可 panoWillArrive 相比
1372
+ * - moveToPano 在加载全景图资源前触发
1373
+ * - panoWillArrive 在加载全景图资源后触发
1374
+ * @param panoIndex - 移动到的点位
1375
+ * @param userAction - 是否用户触发
1376
+ */
1377
+ moveToPano(panoIndex: number, userAction: boolean): void;
1378
+ /**
1379
+ * 移动中, 会告知移动状态(耗时百分比)
1380
+ * @param panoIndex - 将要移动到的点位下标
1381
+ * @param prevPanoIndex - 上一个点位下标
1382
+ * @param progress - 整个过程经度 [0-1]
1383
+ */
1384
+ movingToPano(panoIndex: number, prevPanoIndex: number, progress: number): void;
1385
+ /**
1386
+ * 开始加载某个观察点的全景资源
1387
+ * @param pano - 移动到的点位
1388
+ */
1389
+ panoWillLoad(panoIndex: number): void;
1390
+ /**
1391
+ * 某个观察点的全景资源加载完成
1392
+ * @param panoIndex - 对应的点位
1393
+ */
1394
+ panoLoaded(panoIndex: number): void;
1395
+ /**
1396
+ * 开始移动到某个观察点位
1397
+ * @description
1398
+ * 和 moveToPano 相比
1399
+ * - moveToPano 在加载全景图资源前触发
1400
+ * - panoWillArrive 在加载全景图资源后触发
1401
+ * @param panoIndex - 移动到点位
1402
+ * @param pose - 相机姿态
1403
+ * @param userAction - 是否用户触发
1404
+ */
1405
+ panoWillArrive(panoIndex: number, pose: Pose, userAction: boolean): void;
1406
+ /**
1407
+ * 移动到某个观察点位
1408
+ * @param panoIndex - 移动到点位
1409
+ * @param pose - 相机姿态
1410
+ * @param userAction - 是否用户触发
1411
+ */
1412
+ panoArrived(panoIndex: number, pose: Pose, userAction: boolean): void;
1413
+ /**
1414
+ * 某个观察点的全景资源加载失败
1415
+ * @param error - 错误对象
1416
+ * @param panoIndex - 对应的点位
1417
+ */
1418
+ panoLoadError(error: Error, panoIndex: number): void;
1419
+ /**
1420
+ * 移动到某个观察点位被取消
1421
+ * @description
1422
+ * 这个有一些情况会导致
1423
+ * - 移动过程中切换模态
1424
+ * - 移动过程中 five 被析构
1425
+ * - 移动过程点击切换到另一个点位
1426
+ * @param panoIndex - 对应的点位
1427
+ */
1428
+ moveToPanoCanceled(panoIndex: number): void;
1429
+ /**
1430
+ * 观察点的全景资源开始加载
1431
+ * @param panoIndex - 加载点位
1432
+ */
1433
+ textureStartLoad(panoIndex: number): void;
1434
+ /**
1435
+ * 观察点的全景资源加载中,可获取到进度
1436
+ * @param progress - 加载进度 [0-1]
1437
+ * @param panoIndex - 加载点位下标
1438
+ */
1439
+ textureLoading(progress: number, panoIndex: number): void;
1440
+ /**
1441
+ * 观察点的全景资源加载被中止
1442
+ * @param panoIndex - 加载点位
1443
+ */
1444
+ textureAbort(panoIndex: number): void;
1445
+ /**
1446
+ * 观察点的全景资源加载失败
1447
+ * @param error - 错误对象
1448
+ * @param panoIndex - 加载点位
1449
+ */
1450
+ textureError(error: Error, panoIndex: number): void;
1451
+ /**
1452
+ * 观察点的全景资源加载完成
1453
+ * @param panoIndex - 加载点位
1454
+ */
1455
+ textureLoaded(panoIndex: number, meta: (NetWorkMeta | null)[]): void;
1456
+ /**
1457
+ * webXR模式开始,webxr session完成坐标系矫正
1458
+ */
1459
+ webXRSessionStart(): void;
1460
+ /**
1461
+ * webXR模式结束,webxr session销毁
1462
+ */
1463
+ webXRSessionEnd(): void;
1464
+ /**
1465
+ * axes代表控制杆,axes数组的0-1元素分别代表左控制器的左(-1)右(1),左控制器的上(-1)下(1),axes数组的2-3元素同理
1466
+ */
1467
+ webXRControllerEvent(type: WebXRControllerType, key: WebXRControllerKey, params: WebXRControllerParams): void;
1468
+ /**
1469
+ * 准备加载 Work 数据
1470
+ * @param input - 输入的 work
1471
+ * @param work - 归一化的标准 work
1472
+ * @param state - 加载时的姿态
1473
+ */
1474
+ willLoad(input: any, work: Work, state: Partial<State>): void;
1475
+ /**
1476
+ * 开始加载 Work 数据
1477
+ * @param input - 输入的 work
1478
+ * @param work - 归一化的标准 work
1479
+ * @param state - 加载时的姿态
1480
+ */
1481
+ load(input: any, work: Work, state: Partial<State>): void;
1482
+ /**
1483
+ * 加载完 Work 数据
1484
+ * @param input - 输入的 work
1485
+ * @param work - 归一化的标准 work
1486
+ */
1487
+ loaded(input: any, work: Work): void;
1488
+ /**
1489
+ * 当目标 state 变化时
1490
+ * @param state - 当前姿态状态
1491
+ * @param userAction - 是否用户触发
1492
+ */
1493
+ stateChange(state: State, userAction: boolean): void;
1494
+ /**
1495
+ * 当前实时 state 变化时
1496
+ * @param state - 当前姿态状态
1497
+ * @param userAction - 是否用户触发
1498
+ */
1499
+ currentStateChange(state: State, userAction: boolean): void;
1500
+ /**
1501
+ * 当 setState 方法被调用
1502
+ * @param state - 当前姿态状态
1503
+ */
1504
+ setState(state: State): void;
1505
+ /**
1506
+ * 当 state 被同步完成时
1507
+ * @param state - 当前姿态状态
1508
+ */
1509
+ stateSynced(state: State): void;
1510
+ /**
1511
+ * 模型开始加载
1512
+ * @param workModel - 归一化的标准 work 中的 model 值
1513
+ */
1514
+ modelWillLoad(workModel: WorkModel): void;
1515
+ /**
1516
+ * 模型加载错误
1517
+ * @param error - 错误对象
1518
+ * @param model - 加载完的 model
1519
+ */
1520
+ modelLoadError(error: Error, model: Model): void;
1262
1521
  /**
1263
- * 插件定义
1264
- * @description
1265
- * 详见插件部分。
1522
+ * 模型加载完成
1523
+ * @param models - 加载完的 model
1266
1524
  */
1267
- plugins?: (FivePlugin<void> | FivePluginInit<FivePlugin<any, any>> | FivePluginInit<FivePlugin<void, any>>)[];
1525
+ modelLoaded(model: Model): void;
1268
1526
  /**
1269
- * 是否展示 powered by 如视
1527
+ * 模型楼层切换
1528
+ * @param shownFloor - 模型楼层
1270
1529
  */
1271
- poweredByRealsee?: boolean;
1530
+ modelShownFloorChange(shownFloor: number | null, floorLength: number): void;
1272
1531
  /**
1273
- * 是否使用webgl2渲染执行环境, 默认值 false
1532
+ * 渲染循环
1533
+ * @param rendered - 是否渲染了
1274
1534
  */
1275
- webgl2?: boolean;
1535
+ renderFrame(rendered: boolean): void;
1276
1536
  /**
1277
- * 是否开启模型裁切
1537
+ * 意图要切换到某个模态, 可以通过 return false 阻止
1538
+ * @param mode - 意图要切换到的模态
1539
+ * @param prevMode - 当前模态
1540
+ * @returns 可以通过 return false 阻止
1278
1541
  */
1279
- localClippingEnabled?: boolean;
1542
+ wantsChangeMode(mode: Mode, prevMode: Mode): void | false;
1280
1543
  /**
1281
- * 请求代理
1282
- * @param url - 发起的请求
1283
- * @returns 返回的请求
1544
+ * 模态切换完成
1545
+ * @param mode - 切换到的模态
1546
+ * @param prevMode - 上本质是一个模态
1547
+ * @param panoIndex - 初始化动画结束后的点位下标
1548
+ * @param toPose - 初始化动画结束后的状态
1549
+ * @param userAction - 是否用户触发
1284
1550
  */
1285
- requestProxy?(url: string): string | Promise<string>;
1551
+ modeChange(mode: Mode, prevMode: Mode, panoIndex: number, toPose: Pose, userAction: boolean): void;
1286
1552
  /**
1287
- * 模型lod相关的配置,maxDepth为加载的最大深度
1553
+ * 帮助元素显应的变换
1554
+ * @param visible - 帮助元素的是否开启
1288
1555
  */
1289
- modelLod?: {
1290
- maxDepth?: number;
1291
- };
1292
- }
1293
-
1294
- /**
1295
- * Five 插件
1296
- * [[include:plugins.md]]
1297
- * @template Parameters - 插件参数, 没有参数则为 void
1298
- * @template Returns - 如果有参数则插件暴露的 api,没有参数则不传
1299
- */
1300
- export declare type FivePlugin<Parameters = void, Returns = void> = Parameters extends void ? ((five: Five) => Returns) : ((five: Five, parameters: Parameters) => Returns);
1301
-
1302
- /**
1303
- * 获取插件在Five中的初始化结构
1304
- * @template T - Five 插件
1305
- */
1306
- export declare type FivePluginInit<T extends FivePlugin<any, any>> = Parameters<T>[1] extends undefined ? [
1307
- Plugin: T,
1308
- instanceName: null | string
1309
- ] : [
1310
- Plugin: T,
1311
- instanceName: null | string,
1312
- parameters: Parameters<T>[1]
1313
- ];
1314
-
1315
- /**
1316
- * 获取插件暴露的 api
1317
- * @template T - Five 插件
1318
- */
1319
- export declare type FivePluginInstance<T extends FivePlugin<any, any>> = ReturnType<T>;
1320
-
1321
- export declare interface FloorplanControllerCustomInitArgs {
1322
- /** 默认俯仰角 */
1323
- defaultLatitude?: number;
1324
- /** 最大俯仰角 */
1325
- maxLatitude?: number;
1326
- /** 最小俯仰角 */
1327
- minLatitude?: number;
1328
- /** 默认相机可视角度(垂直),可作为 `zoom` */
1329
- defaultFov?: number;
1330
- /** 最大相机可视角度 */
1331
- maxFov?: number;
1332
- /** 最小相机可视角度 */
1333
- minFov?: number;
1334
- /** 鼠标焦点环自定义创建器 */
1335
- intersectMeshCreator?: () => IntersectMeshInterface;
1336
- }
1337
-
1338
- export declare type GestureTypes = "pan" | "tap" | "pinch" | "press" | "mouseWheel";
1339
-
1340
- export declare function getViewportScale(): number;
1341
-
1342
- /**
1343
- * 图片参数
1344
- */
1345
- export declare interface ImageOptions {
1556
+ helpersVisibleChange(visible: boolean): void;
1346
1557
  /**
1347
- * url 地址转化
1348
- * @param url - 原始地址
1349
- * @param options - 当前地址参数
1350
- * @returns 转化后地址
1558
+ * 网络资源分析
1559
+ * @param source - 资源地址
1560
+ * @param state - 状态
1561
+ * @param detail - 详情
1351
1562
  */
1352
- transform?: (url: string, options: ImageURLOptions) => string;
1353
- /** 图片尺寸参数 尽量使用 2 的幂次 如 512 1024 2048 */
1354
- size?: number;
1355
- /** 图片质量参数(0-100) */
1356
- quality?: number;
1357
- /** 图片格式参数 */
1358
- format?: "jpg" | "png" | "heif" | "webp" | "avif";
1359
- /** 锐化参数 海外不支持 */
1360
- sharpen?: number;
1361
- mappings?: ImageURLMappings;
1362
- }
1363
-
1364
- export declare function imageSupport(): Promise<{
1365
- avif: boolean;
1366
- webp: boolean;
1367
- }>;
1368
-
1369
- export declare interface ImageURLMappings {
1370
- [publicDomain: string]: {
1371
- "type"?: string;
1372
- "pano": [string, string];
1373
- "tile": [string, string];
1374
- "model": [string, string];
1375
- "texture": [string];
1376
- "default": [string];
1377
- };
1378
- }
1379
-
1380
- export declare interface ImageURLOptions {
1381
- /** 图片类型标识 */
1382
- key: string;
1383
- /** 图片尺寸参数 尽量使用 2 的幂次 如 256 512 1024 */
1384
- size?: number;
1385
- /** 图片质量参数(0-100) */
1386
- quality?: number;
1387
- /** 图片格式参数 */
1388
- format?: "jpg" | "png" | "heif" | "webp" | "avif";
1389
- /** 图片裁切 */
1390
- cut?: [x: number, y: number, width: number, height: number];
1391
- /** 锐化参数 海外不支持 */
1392
- sharpen?: number;
1393
- /** url匹配规则 */
1394
- mappings?: ImageURLMappings;
1395
- }
1396
-
1397
- export declare class InternalWebGLRenderer extends THREE_2.WebGLRenderer {
1398
- constructor({ preserveDrawingBuffer, backgroundColor, backgroundAlpha, pixelRatio, antialias, webgl2, }: {
1399
- preserveDrawingBuffer?: boolean;
1400
- backgroundColor?: number | THREE_2.Color;
1401
- backgroundAlpha?: number;
1402
- pixelRatio?: number;
1403
- antialias?: boolean;
1404
- webgl2?: boolean;
1405
- });
1406
- }
1407
-
1408
- export declare interface Intersection {
1409
- /** 焦点坐标 */
1410
- point: THREE.Vector3;
1411
- /** 焦点面片 */
1412
- face?: {
1413
- normal: THREE.Vector3;
1414
- } | null;
1415
- /** 焦点距离 */
1416
- distance: number;
1417
- }
1418
-
1419
- export declare class IntersectMesh extends THREE_2.Object3D implements IntersectMeshInterface {
1420
- private ringMesh;
1421
- constructor();
1422
- dispose(): void;
1423
- }
1424
-
1425
- /**
1426
- * 地面提示点位接口
1427
- */
1428
- export declare interface IntersectMeshInterface extends THREE_2.Object3D {
1429
- dispose(): void;
1430
- }
1563
+ network(source: string, type: NetworkType, state: NetworkState, detail: string): void;
1564
+ };
1431
1565
 
1432
1566
  export declare type LooseWork = {
1433
1567
  work_code?: string;
@@ -1579,6 +1713,11 @@ export declare type Mode =
1579
1713
  /** XR眼镜模式*/
1580
1714
  "XRPanorama";
1581
1715
 
1716
+ export declare interface ModeChangeEvent extends StateEvent {
1717
+ prevMode: Mode;
1718
+ mode: Mode;
1719
+ }
1720
+
1582
1721
  /**
1583
1722
  * Five 模型
1584
1723
  * @description
@@ -1600,11 +1739,10 @@ export declare class Model extends THREE_2.Object3D {
1600
1739
  }[];
1601
1740
  onError: (error: Error) => void;
1602
1741
  onShownFloorChange: (floorIndex: number | null) => void;
1742
+ onLoad: () => void;
1603
1743
  /** 外接盒子的大小 */
1604
1744
  bounding: THREE_2.Box3;
1605
- /** 当前显示的楼层 */
1606
- shownFloor: number | null;
1607
- /** 楼层的数量 */
1745
+ /** 所有楼层 */
1608
1746
  floorLength: number;
1609
1747
  /** 材质贴图参数 */
1610
1748
  textureOptions: TextureOptions;
@@ -1625,6 +1763,7 @@ export declare class Model extends THREE_2.Object3D {
1625
1763
  constructor(options?: {
1626
1764
  onError?: (error: Error) => void;
1627
1765
  onShownFloorChange?: (floorIndex: number | null) => void;
1766
+ onLoad?: () => void;
1628
1767
  });
1629
1768
  get empty(): boolean;
1630
1769
  /** 获取材质参数 */
@@ -1634,13 +1773,10 @@ export declare class Model extends THREE_2.Object3D {
1634
1773
  /**
1635
1774
  * 当前显示的楼层
1636
1775
  */
1776
+ get shownFloor(): PBMParameters['floorIndex'] | null;
1777
+ set shownFloor(floorIndex: PBMParameters['floorIndex'] | null);
1637
1778
  get shownfloor(): PBMParameters['floorIndex'] | null;
1638
1779
  set shownfloor(floorIndex: PBMParameters['floorIndex'] | null);
1639
- /**
1640
- * 裁切
1641
- */
1642
- get clippers(): PBMParameters['clippers'];
1643
- set clippers(clippers: PBMParameters['clippers']);
1644
1780
  /**
1645
1781
  * 显示某楼层
1646
1782
  * @example
@@ -1649,7 +1785,12 @@ export declare class Model extends THREE_2.Object3D {
1649
1785
  * model.show(1) //显示第一楼层
1650
1786
  * ```
1651
1787
  */
1652
- show(floorIndex?: number | null): void;
1788
+ show(floorIndex?: PBMParameters['floorIndex'] | null): void;
1789
+ /**
1790
+ * 裁切
1791
+ */
1792
+ get clippers(): PBMParameters['clippers'];
1793
+ set clippers(clippers: PBMParameters['clippers']);
1653
1794
  /**
1654
1795
  * 获取模型边界线
1655
1796
  * @param sphere - 获取区域
@@ -1686,6 +1827,12 @@ export declare class Model extends THREE_2.Object3D {
1686
1827
  export declare interface ModelControllerCustomInitArgs extends PanoramaLikeControllerCustomInitArgs {
1687
1828
  }
1688
1829
 
1830
+ export declare interface ModelEvent extends BaseEvent {
1831
+ model: Model;
1832
+ work: Work;
1833
+ error: Error | null;
1834
+ }
1835
+
1689
1836
  export declare interface ModelLodOptions {
1690
1837
  maxDepth?: number;
1691
1838
  }
@@ -1697,12 +1844,17 @@ export declare type Models = Model[] & {
1697
1844
  bounding: THREE_2.Box3;
1698
1845
  loaded: boolean;
1699
1846
  refined: boolean;
1847
+ materialVersion: string;
1700
1848
  intersectRaycaster(raycaster: THREE_2.Raycaster): Intersection[];
1701
1849
  setMaterial(values: Partial<ModelMaterialValues>): void;
1702
1850
  getMaterial(): ModelMaterialValues;
1703
1851
  update(renderer: THREE_2.WebGLRenderer, camera: Camera, mode: Mode): void;
1704
1852
  };
1705
1853
 
1854
+ export declare interface ModelsEvent extends BaseEvent {
1855
+ models: Models;
1856
+ }
1857
+
1706
1858
  export declare interface MotionKeyframe<K extends string> {
1707
1859
  progress: number;
1708
1860
  value: MotionValue<K>;
@@ -1714,7 +1866,7 @@ export declare type MotionValue<K extends string> = Record<K, number>;
1714
1866
  /**
1715
1867
  * 点位移动参数
1716
1868
  */
1717
- export declare interface MovePanoOptions extends Partial<Omit<Pose, "offset">> {
1869
+ export declare interface MovePanoOptions extends Partial<Omit<State, "offset" | 'distance' | 'mode'>> {
1718
1870
  /** 是否通过初始化参数限制 fov, latitude */
1719
1871
  limit?: boolean;
1720
1872
  /**
@@ -1737,9 +1889,9 @@ export declare interface MovePanoOptions extends Partial<Omit<Pose, "offset">> {
1737
1889
  /** 运动曲线函数 */
1738
1890
  easing?: (k: number) => number;
1739
1891
  /** 运动开始回调 */
1740
- moveStartCallback?: (panoId: WorkPanoId, toPose: Pose) => void;
1892
+ moveStartCallback?: (toState: State) => void;
1741
1893
  /** 运动结束回调 */
1742
- moveEndCallback?: (panoId: WorkPanoId, pose: Pose) => void;
1894
+ moveEndCallback?: (state: State) => void;
1743
1895
  /**
1744
1896
  * 运动被取消回调
1745
1897
  * @description
@@ -1774,6 +1926,13 @@ export declare interface NetworkOptions {
1774
1926
  allowHosts?: string[];
1775
1927
  }
1776
1928
 
1929
+ export declare interface NetworkResourceEvent extends BaseEvent {
1930
+ source: string;
1931
+ requestType: NetworkType;
1932
+ requestState: NetworkState;
1933
+ detail: string;
1934
+ }
1935
+
1777
1936
  export declare type NetworkResponse<T = any, E extends NetWorkMeta | NetWorkMeta[] = NetWorkMeta> = {
1778
1937
  body: T;
1779
1938
  meta: E;
@@ -1788,6 +1947,15 @@ export declare class NetworkSubscribe extends Subscribe<{
1788
1947
 
1789
1948
  export declare type NetworkType = "XMLHttpRequest" | "Script" | "Image" | "Link";
1790
1949
 
1950
+ export declare interface ObjectEvent extends BaseEvent {
1951
+ object: THREE_2.Object3D;
1952
+ }
1953
+
1954
+ export declare type Pano = {
1955
+ workCode: string;
1956
+ panoIndex: number;
1957
+ };
1958
+
1791
1959
  export declare class PanoCircleMesh extends THREE_2.Object3D implements PanoCircleMeshInterface {
1792
1960
  needsRender: boolean;
1793
1961
  private currentStartTime;
@@ -1924,6 +2092,19 @@ export declare interface PanoCircleMeshSolidOptions {
1924
2092
  color?: number;
1925
2093
  }
1926
2094
 
2095
+ export declare function panoEqual(a: Pano, b: Pano): boolean;
2096
+
2097
+ export declare interface PanoEvent extends StateEvent {
2098
+ prevPano: Pano;
2099
+ progress: number;
2100
+ options: MovePanoOptions;
2101
+ error: Error | null;
2102
+ }
2103
+
2104
+ export declare type PanoId = `${Pano['workCode']}[${number}]`;
2105
+
2106
+ export declare function panoParse(panoId: PanoId): Pano;
2107
+
1927
2108
  export declare interface PanoramaControllerCustomInitArgs extends PanoramaLikeControllerCustomInitArgs {
1928
2109
  /** 最远可移动观察点距离 */
1929
2110
  maxAccessibleDistance?: number;
@@ -1935,7 +2116,7 @@ export declare interface PanoramaControllerCustomInitArgs extends PanoramaLikeCo
1935
2116
  */
1936
2117
  panoTapTriggerRadius?: number;
1937
2118
  /** 地面观察点标识自定义创建器 */
1938
- panoCircleMeshCreator?: (panoId: WorkPanoId) => PanoCircleMeshInterface;
2119
+ panoCircleMeshCreator?: (pano: Pano) => PanoCircleMeshInterface;
1939
2120
  /**
1940
2121
  * 全景瓦片登记
1941
2122
  * @param fov - 当前 fov
@@ -1970,6 +2151,15 @@ export declare interface PanoramaLikeControllerCustomInitArgs {
1970
2151
  intersectMeshCreator?: () => IntersectMeshInterface;
1971
2152
  }
1972
2153
 
2154
+ export declare function panoStringify(pano: Pano): PanoId;
2155
+
2156
+ export declare interface PanoTextureEvent extends BaseEvent {
2157
+ pano: Pano;
2158
+ progress: number;
2159
+ meta: NetWorkMeta[] | null;
2160
+ error: Error | null;
2161
+ }
2162
+
1973
2163
  /**
1974
2164
  * 解析 Work 数据
1975
2165
  * @param obj - work 数据,从如数开发者平台获取
@@ -1979,6 +2169,8 @@ export declare interface PanoramaLikeControllerCustomInitArgs {
1979
2169
  export declare function parseWork(obj: Work | LooseWork | string | any, options?: ParseWorkOptions): Work;
1980
2170
 
1981
2171
  export declare type ParseWorkOptions = {
2172
+ /** 重置 WorkCode */
2173
+ workCode?: string | ((input: any) => string);
1982
2174
  /** 重写资源前缀 */
1983
2175
  baseURL?: string;
1984
2176
  /** 资源地址使用短地址 */
@@ -2168,7 +2360,7 @@ export declare interface Pose {
2168
2360
  distance: number;
2169
2361
  }
2170
2362
 
2171
- export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["cameraDirectionUpdate", "cameraUpdate", "cameraPositionUpdate", "panoSelected", "moveToPano", "moveToPanoCanceled", "panoWillArrive", "movingToPano", "panoArrived", "panoWillLoad", "panoLoaded", "panoLoadError", "initAnimationEnded", "initAnimationWillStart", "wantsGesture", "gesture", "wantsTapGesture", "tapGesture", "wantsPressGesture", "pressGesture", "wantsPanGesture", "wantsInteriaPan", "panGesture", "interiaPan", "wantsPinchGesture", "pinchGesture", "wantsMouseWheel", "mouseWheel", "wantsShowIntersectionOnModel", "intersectionOnModelUpdate", "intersectionHidden", "textureStartLoad", "textureLoading", "textureAbort", "textureLoaded", "textureError", "webXRSessionStart", "webXRSessionEnd", "webXRControllerEvent"];
2363
+ export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["gesture.pan", "gesture.tap", "gesture.press", "gesture.pinch", "gesture.mousewheel", "gesture.mousemove", "gesture.momentum", "initAnimation.start", "initAnimation.end", "camera.update", "intersect.update", "pano.select", "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.start", "xr.session.end", "xr.gesture.tap"];
2172
2364
 
2173
2365
  export declare class RegionBoundingVolume implements BoundingVolume {
2174
2366
  type: "regin";
@@ -2197,6 +2389,23 @@ export declare type RegionBoundingVolumeJson = {
2197
2389
  region: number[];
2198
2390
  };
2199
2391
 
2392
+ export declare interface RenderEvent extends BaseEvent {
2393
+ needsRender: boolean;
2394
+ info: null | {
2395
+ memory: {
2396
+ geometries: number;
2397
+ textures: number;
2398
+ };
2399
+ render: {
2400
+ calls: number;
2401
+ frame: number;
2402
+ lines: number;
2403
+ points: number;
2404
+ triangles: number;
2405
+ };
2406
+ };
2407
+ }
2408
+
2200
2409
  export declare type RequestResult = null | {
2201
2410
  done: () => void;
2202
2411
  };
@@ -2297,10 +2506,15 @@ export declare type SphereBoundingVolumeJson = {
2297
2506
  export declare interface State extends Pose {
2298
2507
  /** 模态 */
2299
2508
  mode: Mode;
2509
+ /** workCode */
2510
+ workCode: string;
2300
2511
  /** 观察点序号 */
2301
2512
  panoIndex: number;
2302
- /** 观察点id */
2303
- panoId: string;
2513
+ }
2514
+
2515
+ export declare interface StateEvent extends BaseEvent {
2516
+ state: State;
2517
+ userAction: boolean;
2304
2518
  }
2305
2519
 
2306
2520
  /**
@@ -2787,18 +3001,11 @@ export declare interface WebXRControllerParams {
2787
3001
 
2788
3002
  export declare type WebXRControllerType = 'tap' | 'press' | 'axes';
2789
3003
 
2790
- export declare type WebXREventTypes = {
2791
- /** WebXR模式开始,session完成坐标系设置*/
2792
- webXRSessionStart(): void;
2793
- /** WebXR模式结束,销毁session*/
2794
- webXRSessionEnd(): void;
2795
- };
2796
-
2797
3004
  export declare class Work {
2798
3005
  /** 名称 */
2799
3006
  name: string;
2800
3007
  /** 编号 */
2801
- workCode: WorkCode;
3008
+ workCode: string;
2802
3009
  /** 允许访问的安全域名 */
2803
3010
  allowHosts: string[];
2804
3011
  /** 过期时间 */
@@ -2829,8 +3036,6 @@ export declare class Work {
2829
3036
  toJSON(): any;
2830
3037
  }
2831
3038
 
2832
- export declare type WorkCode = string;
2833
-
2834
3039
  export declare interface WorkCubeImage {
2835
3040
  /** 全景图 up */
2836
3041
  up: string;
@@ -2858,10 +3063,11 @@ export declare interface WorkImage extends WorkCubeImage {
2858
3063
 
2859
3064
  /** 初始化位姿参数 */
2860
3065
  export declare interface WorkInitial {
3066
+ work: Work;
2861
3067
  /** 模态 */
2862
3068
  mode?: Mode;
2863
3069
  /** 点位序号 */
2864
- panoId?: string;
3070
+ panoIndex?: number;
2865
3071
  /** 相机水平角 */
2866
3072
  longitude?: number;
2867
3073
  /** 相机俯仰角 */
@@ -2899,8 +3105,12 @@ export declare interface WorkObserver {
2899
3105
  work: Work;
2900
3106
  /** 序号 */
2901
3107
  index: number;
3108
+ /** 序号 */
3109
+ panoIndex: number;
3110
+ /** 点位序号 */
3111
+ panoId: PanoId;
2902
3112
  /** 点位序号 */
2903
- panoId: WorkPanoId;
3113
+ pano: Pano;
2904
3114
  /** 点位所在楼层 */
2905
3115
  floorIndex: number;
2906
3116
  /** 点位 derived_id */
@@ -2914,9 +3124,13 @@ export declare interface WorkObserver {
2914
3124
  /** 点位视频 */
2915
3125
  video?: WorkVideo;
2916
3126
  /** 可以看到的相关点位序号 */
2917
- visibleIds: string[];
3127
+ visibleNodes: number[];
3128
+ /** 可以看到的相关点位序号 */
3129
+ visibleIds: PanoId[];
2918
3130
  /** 可以连通的相关点位序号 */
2919
- accessibleIds: string[];
3131
+ accessibleNodes: number[];
3132
+ /** 可以看到的相关点位序号 */
3133
+ accessibleIds: PanoId[];
2920
3134
  /** 点位和模型的地面坐标 */
2921
3135
  standingPosition: THREE_2.Vector3;
2922
3136
  /** 点位和模型的观察点坐标 */
@@ -2942,16 +3156,25 @@ export declare interface WorkOptions {
2942
3156
  modelMaxScreenSpaceError?: number;
2943
3157
  }
2944
3158
 
2945
- export declare type WorkPanoId = string;
3159
+ export declare interface WorkResolvedObserver extends WorkObserver {
3160
+ isResolved: true;
3161
+ }
2946
3162
 
2947
3163
  export declare type Works = ReadonlyArray<Work> & {
2948
- resolvedObservers: WorkObserver[];
3164
+ resolvedObservers: WorkResolvedObserver[];
2949
3165
  initial: WorkInitial;
2950
- getWork(workCode: WorkCode): Work | undefined;
2951
- getResolvedObserver(panoId: WorkPanoId): WorkObserver | undefined;
3166
+ getWork(workCode: string): Work | undefined;
3167
+ getResolvedObserver(pano: PanoId | Pano | number): WorkResolvedObserver | undefined;
2952
3168
  update(): void;
2953
3169
  };
2954
3170
 
3171
+ export declare interface WorksEvent extends BaseEvent {
3172
+ input: any;
3173
+ works: Works;
3174
+ state: Partial<State>;
3175
+ userAction: boolean;
3176
+ }
3177
+
2955
3178
  export declare interface WorkTile {
2956
3179
  level: number;
2957
3180
  size: number;
@@ -2977,7 +3200,24 @@ export declare class XRButton {
2977
3200
  static createButton(onClickHook: () => void): HTMLAnchorElement | HTMLButtonElement;
2978
3201
  }
2979
3202
 
3203
+ export declare interface XRGestureEvent extends BaseEvent {
3204
+ session: XRSession | null;
3205
+ buttons: null | 'A' | 'B' | 'X' | 'Y' | 'RightTrigger' | 'RightPinch' | 'LeftTrigger' | 'LeftPinch' | 'LeftAxesLeft' | 'LeftAxesRight' | 'LeftAxesUp' | 'LeftAxesDown' | 'RightAxesLeft' | 'RightAxesRight' | 'RightAxesUp' | 'RightAxesDown';
3206
+ machineType: 'Pico' | 'Oculus';
3207
+ isFirst: boolean;
3208
+ isFinal: boolean;
3209
+ controllers: {
3210
+ raycaster: THREE_2.Raycaster;
3211
+ }[];
3212
+ }
3213
+
2980
3214
  export declare interface XRPanoramaControllerCustomInitArgs extends Omit<PanoramaControllerCustomInitArgs, "maxLatitude" | "minLatitude"> {
2981
3215
  }
2982
3216
 
3217
+ declare interface XRSessionEvent_2 extends BaseEvent {
3218
+ session: XRSession | null;
3219
+ machineType: 'Pico' | 'Oculus';
3220
+ }
3221
+ export { XRSessionEvent_2 as XRSessionEvent }
3222
+
2983
3223
  export { }