@realsee/five 6.8.0-alpha.3 → 6.8.0-alpha.31

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 (764) hide show
  1. package/AGENTS_READ_ME.md +6 -1
  2. package/AI_CONTEXT.md +6 -1
  3. package/README.md +10 -6
  4. package/ai_guides/README.md +40 -2
  5. package/ai_guides/ai-doc-guidelines.md +31 -1
  6. package/ai_guides/api.md +107 -13
  7. package/ai_guides/features/3dtile.md +49 -141
  8. package/ai_guides/features/camera-animation.md +42 -4
  9. package/ai_guides/features/clipper.md +4 -2
  10. package/ai_guides/features/{coordnate-system.md → coordinate-system.md} +22 -2
  11. package/ai_guides/features/event.md +108 -10
  12. package/ai_guides/features/five.md +20 -16
  13. package/ai_guides/features/flowing-light-2d-pass.md +442 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +425 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/ai_guides/features/gesture.md +4 -1
  17. package/ai_guides/features/get-screen-pixels.md +4 -2
  18. package/ai_guides/features/image-options.md +5 -2
  19. package/ai_guides/features/load-external-model.md +27 -2
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +159 -0
  22. package/ai_guides/features/mode.md +5 -1
  23. package/ai_guides/features/model.md +5 -2
  24. package/ai_guides/features/move-pano-effect.md +3 -1
  25. package/ai_guides/features/multi-work.md +3 -1
  26. package/ai_guides/features/pano-filter.md +149 -0
  27. package/ai_guides/features/pano-tile.md +8 -15
  28. package/ai_guides/features/pano-uv.md +131 -0
  29. package/ai_guides/features/parameter.md +117 -118
  30. package/ai_guides/features/plugin.md +210 -0
  31. package/ai_guides/features/postprocessing.md +40 -5
  32. package/ai_guides/features/raycast.md +16 -2
  33. package/ai_guides/features/request-proxy.md +3 -1
  34. package/ai_guides/features/screen-project.md +4 -1
  35. package/ai_guides/features/state.md +25 -3
  36. package/ai_guides/features/view-layer.md +187 -0
  37. package/ai_guides/features/work.md +64 -3
  38. package/ai_guides/glossary.md +28 -7
  39. package/ai_guides/intro.md +1 -1
  40. package/ai_guides/quick-start.md +1 -0
  41. package/ai_guides/release_notes/6.8.md +222 -0
  42. package/ai_guides/template.md +28 -3
  43. package/docs/00_FOR_AI_AGENTS.md +3 -2
  44. package/docs/README.md +3 -2
  45. package/docs/assets/hierarchy.js +1 -1
  46. package/docs/assets/main.js +1 -1
  47. package/docs/assets/navigation.js +1 -1
  48. package/docs/assets/search.js +1 -1
  49. package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
  50. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  51. package/docs/classes/five.BoundingMesh.html +2 -2
  52. package/docs/classes/five.Camera.html +3 -3
  53. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  54. package/docs/classes/five.Five.html +77 -76
  55. package/docs/classes/five.FivePass.html +1 -1
  56. package/docs/classes/five.Histogram.html +19 -0
  57. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  58. package/docs/classes/five.Model.html +32 -32
  59. package/docs/classes/five.ModelScene.html +1 -1
  60. package/docs/classes/five.NetworkSubscribe.html +5 -5
  61. package/docs/classes/five.PBMContainer.html +1 -1
  62. package/docs/classes/five.PBMCustomShader.html +42 -3
  63. package/docs/classes/five.PBMGSObject.html +5 -3
  64. package/docs/classes/five.PBMGroup.html +1 -1
  65. package/docs/classes/five.PBMMesh.html +1 -1
  66. package/docs/classes/five.PBMMeshMaterial.html +16 -7
  67. package/docs/classes/five.PBMPanoFilter.html +61 -0
  68. package/docs/classes/five.PBMPointCloud.html +1 -1
  69. package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
  70. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  71. package/docs/classes/five.PBMUpdateable.html +41 -0
  72. package/docs/classes/five.PanoCircleMesh.html +1 -1
  73. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  74. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  75. package/docs/classes/five.Parameter.html +59 -55
  76. package/docs/classes/five.Scene.html +1 -1
  77. package/docs/classes/five.Subscribe.html +5 -5
  78. package/docs/classes/five.Tile.html +1 -1
  79. package/docs/classes/five.Tile3D.html +30 -26
  80. package/docs/classes/five.TileNode.html +1 -1
  81. package/docs/classes/five.Tileset.html +3 -2
  82. package/docs/classes/five.Trajectory.html +1 -1
  83. package/docs/classes/five.TrajectoryNode.html +1 -1
  84. package/docs/classes/five.Work.html +16 -16
  85. package/docs/classes/five.WorkResolvedObserver.html +41 -16
  86. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  87. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  88. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  89. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  90. package/docs/classes/gltf-loader.GLTFParser.html +1 -1
  91. package/docs/classes/gltf-loader.THREEGLTFLoader.html +2 -2
  92. package/docs/classes/line.Line.html +1 -1
  93. package/docs/classes/line.LineGeometry.html +1 -1
  94. package/docs/classes/line.LineMaterial.html +1 -1
  95. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  96. package/docs/classes/line.THREE_Line2.html +1 -1
  97. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  98. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  99. package/docs/classes/plugins.CSS3DObject.html +9 -0
  100. package/docs/classes/plugins.CSS3DRenderer.html +4 -2
  101. package/docs/classes/plugins.CSS3DSprite.html +11 -0
  102. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  103. package/docs/classes/sticker.Sticker.html +1 -1
  104. package/docs/classes/vfx.Airflow.html +1 -1
  105. package/docs/classes/vfx.Flame.html +1 -1
  106. package/docs/classes/vfx.Particle.html +6 -6
  107. package/docs/classes/vfx.ParticleGPU.html +3 -3
  108. package/docs/classes/vfx.SpotLight.html +1 -1
  109. package/docs/documents/README.html +132 -3
  110. package/docs/documents/ai-doc-guidelines.html +48 -3
  111. package/docs/documents/api.html +179 -26
  112. package/docs/documents/features_3dtile.html +143 -46
  113. package/docs/documents/features_camera-animation.html +79 -6
  114. package/docs/documents/features_clipper.html +5 -2
  115. package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +56 -4
  116. package/docs/documents/features_event.html +47 -8
  117. package/docs/documents/features_five.html +20 -16
  118. package/docs/documents/features_flowing-light-2d-pass.html +259 -0
  119. package/docs/documents/features_flowing-light-3d-pass.html +249 -0
  120. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  121. package/docs/documents/features_gesture.html +5 -1
  122. package/docs/documents/features_get-screen-pixels.html +5 -2
  123. package/docs/documents/features_image-options.html +5 -2
  124. package/docs/documents/features_load-external-model.html +31 -4
  125. package/docs/documents/features_load-progress.html +110 -0
  126. package/docs/documents/features_material.html +341 -0
  127. package/docs/documents/features_mode.html +6 -1
  128. package/docs/documents/features_model.html +6 -2
  129. package/docs/documents/features_move-pano-effect.html +4 -1
  130. package/docs/documents/features_multi-work.html +4 -1
  131. package/docs/documents/features_pano-filter.html +123 -0
  132. package/docs/documents/features_pano-tile.html +35 -20
  133. package/docs/documents/features_pano-uv.html +82 -0
  134. package/docs/documents/features_parameter.html +84 -56
  135. package/docs/documents/features_plugin.html +105 -0
  136. package/docs/documents/features_postprocessing.html +23 -6
  137. package/docs/documents/features_raycast.html +9 -3
  138. package/docs/documents/features_request-proxy.html +4 -1
  139. package/docs/documents/features_screen-project.html +5 -1
  140. package/docs/documents/features_state.html +12 -2
  141. package/docs/documents/features_view-layer.html +158 -0
  142. package/docs/documents/features_work.html +64 -3
  143. package/docs/documents/glossary.html +33 -8
  144. package/docs/documents/intro.html +1 -1
  145. package/docs/documents/quick-start.html +1 -0
  146. package/docs/documents/release_notes_6.8.html +203 -0
  147. package/docs/documents/template.html +54 -4
  148. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  149. package/docs/functions/five.loadAt3d.html +1 -1
  150. package/docs/functions/five.loadB3dm.html +1 -1
  151. package/docs/functions/five.loadDome.html +1 -1
  152. package/docs/functions/five.loadDomez.html +1 -1
  153. package/docs/functions/five.loadFbx.html +1 -1
  154. package/docs/functions/five.loadGltf.html +1 -1
  155. package/docs/functions/five.loadPbm.html +1 -1
  156. package/docs/functions/five.loadPly.html +1 -1
  157. package/docs/functions/five.loadPnts.html +1 -1
  158. package/docs/functions/five.loadSplat.html +1 -1
  159. package/docs/functions/five.loadSpz.html +1 -1
  160. package/docs/functions/five.loadX3p.html +1 -1
  161. package/docs/functions/five.parseWork.html +1 -1
  162. package/docs/functions/plugins.CSS3DPlugin.html +1 -0
  163. package/docs/functions/plugins.GaussianSplattingEntranceAnimationPlugin.html +1 -0
  164. package/docs/functions/react.useFiveCurrentObserver.html +2 -2
  165. package/docs/functions/react.useFiveFloor.html +2 -2
  166. package/docs/functions/react.useFiveProject2d.html +2 -2
  167. package/docs/functions/vue.useFiveCurrentObserver.html +2 -2
  168. package/docs/functions/vue.useFiveFloor.html +2 -2
  169. package/docs/functions/vue.useFiveWorks.html +2 -2
  170. package/docs/hierarchy.html +1 -1
  171. package/docs/index.html +132 -3
  172. package/docs/interfaces/five.AddableObject.html +1 -1
  173. package/docs/interfaces/five.AjaxOptions.html +1 -1
  174. package/docs/interfaces/five.BaseEvent.html +7 -2
  175. package/docs/interfaces/five.BaseExtendableEvent.html +11 -0
  176. package/docs/interfaces/five.EventCallback.html +60 -52
  177. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  178. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
  179. package/docs/interfaces/five.GestureEvent.html +21 -2
  180. package/docs/interfaces/five.GesturePointer.html +20 -0
  181. package/docs/interfaces/five.ImageOptions.html +1 -1
  182. package/docs/interfaces/five.IntersectEvent.html +10 -2
  183. package/docs/interfaces/five.IntersectMesh.html +1 -1
  184. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  185. package/docs/interfaces/five.Intersection.html +4 -3
  186. package/docs/interfaces/five.LooseWorkObserver.html +2 -2
  187. package/docs/interfaces/five.LooseWorkPanorama.html +2 -2
  188. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  189. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +10 -10
  190. package/docs/interfaces/five.ModeChangeEvent.html +9 -2
  191. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  192. package/docs/interfaces/five.ModelEvent.html +7 -2
  193. package/docs/interfaces/five.ModelSceneEvent.html +7 -2
  194. package/docs/interfaces/five.ModelTileEvent.html +13 -0
  195. package/docs/interfaces/five.MovePanoOptions.html +8 -8
  196. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  197. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  198. package/docs/interfaces/five.NetworkOptions.html +1 -1
  199. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  200. package/docs/interfaces/five.NetworkResourceEvent.html +7 -2
  201. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  202. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  203. package/docs/interfaces/five.ObjectEvent.html +7 -2
  204. package/docs/interfaces/five.PBMClipperParameter.html +2 -2
  205. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
  206. package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
  207. package/docs/interfaces/five.PBMMaterial.html +1 -1
  208. package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
  209. package/docs/interfaces/five.PBMPanoDepth.html +5 -5
  210. package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
  211. package/docs/interfaces/five.PBMPanoPicture.html +8 -6
  212. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
  213. package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
  214. package/docs/interfaces/five.PanoCircleMeshInterface.html +2 -2
  215. package/docs/interfaces/five.PanoEvent.html +15 -2
  216. package/docs/interfaces/five.PanoPrepareEvent.html +15 -0
  217. package/docs/interfaces/five.PanoTextureEvent.html +11 -2
  218. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  219. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  220. package/docs/interfaces/five.ParameterMaterialValue.html +42 -38
  221. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  222. package/docs/interfaces/five.ParameterValue.html +56 -52
  223. package/docs/interfaces/five.Pose.html +1 -1
  224. package/docs/interfaces/five.RenderEvent.html +7 -2
  225. package/docs/interfaces/five.ResolvedParameterValue.html +57 -54
  226. package/docs/interfaces/five.RgbaData.html +7 -0
  227. package/docs/interfaces/five.SplatData.html +2 -2
  228. package/docs/interfaces/five.State.html +1 -1
  229. package/docs/interfaces/five.StateEvent.html +9 -2
  230. package/docs/interfaces/five.TextureOptions.html +1 -1
  231. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  232. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
  233. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  234. package/docs/interfaces/five.ViewLayer.html +30 -26
  235. package/docs/interfaces/five.WorkCubeImage.html +3 -2
  236. package/docs/interfaces/five.WorkImage.html +6 -5
  237. package/docs/interfaces/five.WorkInitial.html +8 -8
  238. package/docs/interfaces/five.WorkModel.html +8 -8
  239. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  240. package/docs/interfaces/five.WorkObserver.html +42 -17
  241. package/docs/interfaces/five.WorkObserverJson.html +2 -2
  242. package/docs/interfaces/five.WorkObserverProto.html +26 -0
  243. package/docs/interfaces/five.WorkPanoramaJson.html +2 -2
  244. package/docs/interfaces/five.WorkTile.html +6 -5
  245. package/docs/interfaces/five.WorkVideo.html +4 -4
  246. package/docs/interfaces/five.WorksEvent.html +7 -2
  247. package/docs/interfaces/five.XRControllerEvent.html +10 -2
  248. package/docs/interfaces/five.XRControllerState.html +8 -0
  249. package/docs/interfaces/five.XRGestureEvent.html +13 -2
  250. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  251. package/docs/interfaces/five.XRSessionEvent.html +9 -2
  252. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  253. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  254. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  255. package/docs/interfaces/plugins.CSS3DPluginController.html +52 -0
  256. package/docs/interfaces/plugins.CSS3DPluginType.Config.html +2 -0
  257. package/docs/interfaces/plugins.CSS3DPluginType.CreateCSS3DObjectType.html +10 -0
  258. package/docs/interfaces/plugins.CSS3DPluginType.EventMap.html +10 -0
  259. package/docs/interfaces/plugins.CSS3DPluginType.Params.html +4 -0
  260. package/docs/interfaces/plugins.CSS3DPluginType.State.html +8 -0
  261. package/docs/interfaces/plugins.CSS3DRendererParameters.html +2 -0
  262. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +3 -3
  263. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  264. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  265. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationController.html +44 -0
  266. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.BoundingAABB2D.html +3 -0
  267. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Config.html +8 -0
  268. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.EventMap.html +10 -0
  269. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Keyframe.html +3 -0
  270. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.State.html +8 -0
  271. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  272. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  273. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +2 -2
  274. package/docs/interfaces/plugins.OrientationPluginController.html +6 -6
  275. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  276. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  277. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  278. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  279. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  280. package/docs/interfaces/plugins.PlayingState.html +2 -2
  281. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  282. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  283. package/docs/interfaces/plugins.TrajectoryController.html +8 -8
  284. package/docs/interfaces/react.FiveInjectionTypes.html +21 -21
  285. package/docs/interfaces/sticker.IntersectionLike.html +2 -2
  286. package/docs/interfaces/vfx.ParticleArgs.html +4 -4
  287. package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
  288. package/docs/modules/five.html +1 -1
  289. package/docs/modules/plugins.CSS3DPluginType.html +1 -0
  290. package/docs/modules/plugins.GaussianSplattingEntranceAnimationPluginType.html +1 -0
  291. package/docs/modules/plugins.html +1 -1
  292. package/docs/modules.html +1 -1
  293. package/docs/types/five.ControllerEventTypes.html +30 -26
  294. package/docs/types/five.EasingFunction.html +1 -0
  295. package/docs/types/five.EventTypes.html +27 -25
  296. package/docs/types/five.LegacyEventType.html +7 -7
  297. package/docs/types/five.NetworkProgressCallback.html +1 -1
  298. package/docs/types/five.PBMAlphaMode.html +1 -1
  299. package/docs/types/five.PBMColorStyle.html +1 -1
  300. package/docs/types/five.PBMFloorStyle.html +1 -1
  301. package/docs/types/five.PBMMeshShaderType.html +1 -1
  302. package/docs/types/five.PBMPointBack.html +1 -1
  303. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  304. package/docs/types/five.PBMPointShape.html +1 -1
  305. package/docs/types/five.PBMPointSize.html +1 -1
  306. package/docs/types/five.PBMTransition.html +1 -1
  307. package/docs/types/five.ParseOptions.html +6 -6
  308. package/docs/types/five.Works.html +1 -1
  309. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  310. package/docs/types/plugins.CSS3DPluginType.PluginData.html +1 -0
  311. package/docs/types/plugins.CSS3DPluginType.ServerData.html +1 -0
  312. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  313. package/five/application/analysis.d.ts +40 -0
  314. package/five/application/controllers.d.ts +41 -0
  315. package/five/application/events-legacy.d.ts +454 -0
  316. package/five/application/events.d.ts +69 -0
  317. package/five/application/five.d.ts +519 -0
  318. package/five/application/fiveInitArgs.d.ts +176 -0
  319. package/five/application/fiveLoadOptions.d.ts +21 -0
  320. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  321. package/five/application/getViewportScale.d.ts +2 -0
  322. package/five/application/initLights.d.ts +3 -0
  323. package/five/application/mode.d.ts +28 -0
  324. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  325. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  326. package/five/assets/gradient-png-data-url.d.ts +2 -0
  327. package/five/assets/loading-png-data-url.d.ts +2 -0
  328. package/five/assets/phone-png-data-url.d.ts +2 -0
  329. package/five/assets/realsee-png-data-url.d.ts +2 -0
  330. package/five/bvh/bvhMath.d.ts +33 -0
  331. package/five/bvh/bvhMesh.d.ts +7 -0
  332. package/five/bvh/bvhNode.d.ts +29 -0
  333. package/five/bvh/bvhObject.d.ts +18 -0
  334. package/five/bvh/bvhPoints.d.ts +6 -0
  335. package/five/bvh/index.d.ts +10 -0
  336. package/five/bvh/worker.d.ts +35 -0
  337. package/five/cardboard/helper.d.ts +2 -0
  338. package/five/cardboard/index.d.ts +13 -0
  339. package/five/cardboard/sensor.d.ts +158 -0
  340. package/five/certificates/hardware.d.ts +1 -0
  341. package/five/controllers/base.d.ts +167 -0
  342. package/five/controllers/events.d.ts +73 -0
  343. package/five/controllers/floorplan.d.ts +119 -0
  344. package/five/controllers/mapview.d.ts +139 -0
  345. package/five/controllers/model.d.ts +57 -0
  346. package/five/controllers/panorama.d.ts +144 -0
  347. package/five/controllers/panoramaLike.d.ts +87 -0
  348. package/five/controllers/topview.d.ts +42 -0
  349. package/five/controllers/vrPanorama.d.ts +56 -0
  350. package/five/controllers/xrPanorama.d.ts +81 -0
  351. package/five/core/camera.d.ts +65 -0
  352. package/five/core/internalWebGLRenderer.d.ts +14 -0
  353. package/five/core/panoVideo.d.ts +18 -0
  354. package/five/core/scene.d.ts +10 -0
  355. package/five/core/tiling.d.ts +43 -0
  356. package/five/declare.d.ts +2 -1
  357. package/five/gaussian-splatting/util/renderData.d.ts +66 -0
  358. package/five/gaussian-splatting/wasm/data.d.ts +20 -0
  359. package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
  360. package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
  361. package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
  362. package/five/index.d.ts +60 -4636
  363. package/five/index.js +272 -392
  364. package/five/index.mjs +26894 -31013
  365. package/five/meshes/boundingMesh.d.ts +13 -0
  366. package/five/meshes/intersectMesh.d.ts +8 -0
  367. package/five/meshes/panoCircleMesh.d.ts +35 -0
  368. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  369. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  370. package/five/meshes/panoSphereMesh.d.ts +27 -0
  371. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  372. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  373. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  374. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  375. package/five/model/index.d.ts +70 -0
  376. package/five/model/intersection.d.ts +18 -0
  377. package/five/model/loaders/at3d.d.ts +12 -0
  378. package/five/model/loaders/b3dm.d.ts +9 -0
  379. package/five/model/loaders/dome.d.ts +22 -0
  380. package/five/model/loaders/domez.d.ts +11 -0
  381. package/five/model/loaders/fbx.d.ts +8 -0
  382. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  383. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  384. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  385. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  386. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  387. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  388. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +26 -0
  389. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +11 -0
  390. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
  391. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  392. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  393. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  394. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  395. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  396. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  397. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  398. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  399. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  400. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  401. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +25 -0
  402. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  403. package/five/model/loaders/glTF-helpers/index.d.ts +51 -0
  404. package/five/model/loaders/glTF-helpers/parser.d.ts +115 -0
  405. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  406. package/five/model/loaders/gltf.d.ts +10 -0
  407. package/five/model/loaders/obj.d.ts +9 -0
  408. package/five/model/loaders/pbm.d.ts +26 -0
  409. package/five/model/loaders/ply.d.ts +24 -0
  410. package/five/model/loaders/pnts.d.ts +8 -0
  411. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  412. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  413. package/five/model/loaders/shared.d.ts +16 -0
  414. package/five/model/loaders/splat.d.ts +8 -0
  415. package/five/model/loaders/spz.d.ts +14 -0
  416. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  417. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  418. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  419. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  420. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  421. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  422. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  423. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  424. package/five/model/loaders/x3p.d.ts +22 -0
  425. package/five/model/materials/pbmMaterial.d.ts +137 -0
  426. package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
  427. package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -0
  428. package/five/model/model-scene.d.ts +172 -0
  429. package/five/model/model.d.ts +209 -0
  430. package/five/model/objects/pbmContainer.d.ts +28 -0
  431. package/five/model/objects/pbmGaussianSplattingObject.d.ts +43 -0
  432. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +59 -0
  433. package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
  434. package/five/model/objects/pbmGroup.d.ts +8 -0
  435. package/five/model/objects/pbmMesh.d.ts +10 -0
  436. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  437. package/five/model/parameter.d.ts +141 -0
  438. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  439. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  440. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  441. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  442. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  443. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  444. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  445. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  446. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  447. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  448. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  449. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  450. package/five/model/tile3d/header.d.ts +88 -0
  451. package/five/model/tile3d/index.d.ts +216 -0
  452. package/five/model/tile3d/tile-cache.d.ts +18 -0
  453. package/five/model/tile3d/tile-content.d.ts +10 -0
  454. package/five/model/tile3d/tile-node.d.ts +24 -0
  455. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  456. package/five/model/tile3d/tile.d.ts +79 -0
  457. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  458. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  459. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  460. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  461. package/five/model/tile3d/tileset.d.ts +70 -0
  462. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  463. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  464. package/five/model/tile3d/trajectory.d.ts +30 -0
  465. package/five/model/tile3d/types.d.ts +33 -0
  466. package/five/model/view-layer.d.ts +20 -0
  467. package/five/renderer/five-renderer.d.ts +17 -0
  468. package/five/renderer/index.d.ts +3 -0
  469. package/five/renderer/postprocessing/composer.d.ts +37 -0
  470. package/five/renderer/postprocessing/index.d.ts +7 -0
  471. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +17 -0
  472. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  473. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  474. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  475. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  476. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  477. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  478. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  479. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  480. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  481. package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
  482. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  483. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  484. package/five/texture/histogram.d.ts +54 -0
  485. package/five/texture/imageBitmap.d.ts +13 -0
  486. package/five/texture/initTexture.d.ts +3 -0
  487. package/five/texture/loader.d.ts +39 -0
  488. package/five/texture/textureData.d.ts +11 -0
  489. package/five/thirdparty/fflate.d.ts +1407 -0
  490. package/five/thirdparty/hammer.d.ts +375 -0
  491. package/five/thirdparty/jsrsasign.d.ts +753 -0
  492. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  493. package/five/three-version-check.d.ts +1 -0
  494. package/five/types/addableObject.d.ts +12 -0
  495. package/five/types/cube.d.ts +1 -0
  496. package/five/types/gestureInput.d.ts +24 -0
  497. package/five/types/imageOptions.d.ts +20 -0
  498. package/five/types/intersectMeshInterface.d.ts +8 -0
  499. package/five/types/movePanoEffect.d.ts +13 -0
  500. package/five/types/movePanoOptions.d.ts +36 -0
  501. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  502. package/five/types/plugin.d.ts +25 -0
  503. package/five/types/pose.d.ts +17 -0
  504. package/five/types/state.d.ts +20 -0
  505. package/five/types/viewport.d.ts +22 -0
  506. package/five/utils/ajax.d.ts +66 -0
  507. package/five/utils/animationFrameLoop.d.ts +45 -0
  508. package/five/utils/array.d.ts +31 -0
  509. package/five/utils/asyncTaskQueue.d.ts +8 -0
  510. package/five/utils/bufferGeometry.d.ts +33 -0
  511. package/five/utils/calculateProgress.d.ts +39 -0
  512. package/five/utils/calculateThreeMouse.d.ts +13 -0
  513. package/five/utils/canplayVideo.d.ts +2 -0
  514. package/five/utils/clamp.d.ts +2 -0
  515. package/five/utils/clock.d.ts +17 -0
  516. package/five/utils/createSymbol.d.ts +5 -0
  517. package/five/utils/decodeText.d.ts +2 -0
  518. package/five/utils/deepEqual.d.ts +2 -0
  519. package/five/utils/deepFreeze.d.ts +2 -0
  520. package/five/utils/defineProperty.d.ts +9 -0
  521. package/five/utils/detector.d.ts +14 -0
  522. package/five/utils/distance.d.ts +10 -0
  523. package/five/utils/draco.d.ts +26 -0
  524. package/five/utils/easing.d.ts +63 -0
  525. package/five/utils/error.d.ts +1 -0
  526. package/five/utils/event.d.ts +210 -0
  527. package/five/utils/formatRad.d.ts +7 -0
  528. package/five/utils/imageSupport.d.ts +6 -0
  529. package/five/utils/imageURL.d.ts +42 -0
  530. package/five/utils/isEmptyObject.d.ts +2 -0
  531. package/five/utils/isNil.d.ts +6 -0
  532. package/five/utils/isNumber.d.ts +2 -0
  533. package/five/utils/isPowerOfTwo.d.ts +2 -0
  534. package/five/utils/isPromise.d.ts +2 -0
  535. package/five/utils/isSimilar.d.ts +6 -0
  536. package/five/utils/json.d.ts +7 -0
  537. package/five/utils/ktx2.d.ts +30 -0
  538. package/five/utils/lzma/index.d.ts +2 -0
  539. package/five/utils/lzma/lzma.d.ts +3 -0
  540. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  541. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  542. package/five/utils/memoryUsage.d.ts +29 -0
  543. package/five/utils/motion.d.ts +38 -0
  544. package/five/utils/noop.d.ts +6 -0
  545. package/five/utils/now.d.ts +7 -0
  546. package/five/utils/pano.d.ts +9 -0
  547. package/five/utils/pick.d.ts +3 -0
  548. package/five/utils/poseUtils.d.ts +5 -0
  549. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  550. package/five/utils/renderDepth.d.ts +2 -0
  551. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  552. package/five/utils/requestPermission.d.ts +3 -0
  553. package/five/utils/shaderContentFix.d.ts +7 -0
  554. package/five/utils/shaderMaterial.d.ts +20 -0
  555. package/five/utils/stateUtils.d.ts +5 -0
  556. package/five/utils/string-pattern.d.ts +8 -0
  557. package/five/utils/subscribe.d.ts +67 -0
  558. package/five/utils/tileCube.d.ts +19 -0
  559. package/five/utils/toFastProperties.d.ts +1 -0
  560. package/five/utils/typedCache.d.ts +10 -0
  561. package/five/utils/uniform.d.ts +15 -0
  562. package/five/utils/url.d.ts +35 -0
  563. package/five/utils/uuid.d.ts +5 -0
  564. package/five/utils/values.d.ts +2 -0
  565. package/five/utils/vectorCoordinates.d.ts +29 -0
  566. package/five/utils/volume.d.ts +111 -0
  567. package/five/utils/webglError.d.ts +7 -0
  568. package/five/utils/worker.d.ts +26 -0
  569. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  570. package/five/webxr/motionHelper.d.ts +68 -0
  571. package/five/webxr/xrButton.d.ts +4 -0
  572. package/five/webxr/xrController.d.ts +24 -0
  573. package/five/webxr/xrManager.d.ts +84 -0
  574. package/five/work/_ALLOW_HOST.d.ts +2 -0
  575. package/five/work/index.d.ts +7 -0
  576. package/five/work/keychain.d.ts +5 -0
  577. package/five/work/looseWorkType.d.ts +121 -0
  578. package/five/work/verify.d.ts +7 -0
  579. package/five/work/work.d.ts +206 -0
  580. package/five/work/workFetcher.d.ts +4 -0
  581. package/five/work/workJson.d.ts +3 -0
  582. package/five/work/workJsonType.d.ts +73 -0
  583. package/five/work/workObserverProto.d.ts +39 -0
  584. package/five/work/workParser.d.ts +6 -0
  585. package/five/work/workResolvedObserver.d.ts +12 -0
  586. package/five/work/workVerify.d.ts +2 -0
  587. package/five/work/works.d.ts +10 -0
  588. package/gltf-loader/gltf-object.d.ts +17 -0
  589. package/gltf-loader/index.d.ts +60 -160
  590. package/gltf-loader/index.js +9 -9
  591. package/gltf-loader/index.mjs +1351 -1451
  592. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  593. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  594. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  595. package/line/circle_png.d.ts +1 -0
  596. package/line/index.d.ts +19 -69
  597. package/line/index.js +4 -4
  598. package/line/index.mjs +334 -513
  599. package/line/utils/Line2.d.ts +7 -0
  600. package/line/utils/LineGeometry.d.ts +10 -0
  601. package/line/utils/LineMaterial.d.ts +20 -0
  602. package/line/utils/LineSegments2.d.ts +11 -0
  603. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  604. package/llms.txt +48 -3
  605. package/package.json +4 -4
  606. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  607. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  608. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  609. package/plugins/BasePlugin/index.d.ts +119 -0
  610. package/plugins/CSS3DPlugin/Controller.d.ts +64 -0
  611. package/plugins/CSS3DPlugin/index.d.ts +5 -0
  612. package/plugins/CSS3DPlugin/typing.d.ts +32 -0
  613. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  614. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  615. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  616. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  617. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  618. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  619. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  620. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  621. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  622. package/plugins/GaussianSplattingEntranceAnimationPlugin/Controller.d.ts +30 -0
  623. package/plugins/GaussianSplattingEntranceAnimationPlugin/index.d.ts +5 -0
  624. package/plugins/GaussianSplattingEntranceAnimationPlugin/typing.d.ts +28 -0
  625. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  626. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  627. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  628. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  629. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  630. package/plugins/OrientationPlugin/index.d.ts +6 -0
  631. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  632. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  633. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  634. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  635. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  636. package/plugins/PluginTemplate/index.d.ts +5 -0
  637. package/plugins/PluginTemplate/typing.d.ts +21 -0
  638. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  639. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  640. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  641. package/plugins/index.d.ts +11 -1102
  642. package/plugins/index.js +35 -21
  643. package/plugins/index.mjs +3668 -4247
  644. package/plugins/thirdParty/CSS3DRenderer.d.ts +45 -0
  645. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  646. package/plugins/utils/absoluteUrl.d.ts +5 -0
  647. package/plugins/utils/clamp.d.ts +2 -0
  648. package/plugins/utils/loadImage.d.ts +1 -0
  649. package/plugins/utils/motion.d.ts +38 -0
  650. package/plugins/utils/now.d.ts +6 -0
  651. package/plugins/utils/uuid.d.ts +2 -0
  652. package/react/canvas.d.ts +19 -0
  653. package/react/context.d.ts +12 -0
  654. package/react/createProvider.d.ts +95 -0
  655. package/react/createStore.d.ts +144 -0
  656. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  657. package/react/hooks/useFiveAction.d.ts +147 -0
  658. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  659. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  660. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  661. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  662. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  663. package/react/hooks/useFiveFloor.d.ts +15 -0
  664. package/react/hooks/useFiveHelper.d.ts +14 -0
  665. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  666. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  667. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  668. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  669. package/react/hooks/useFiveProject2d.d.ts +20 -0
  670. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  671. package/react/hooks/useFiveState.d.ts +6 -0
  672. package/react/hooks/useFiveWork.d.ts +29 -0
  673. package/react/index.d.ts +24 -830
  674. package/react/index.js +3 -3
  675. package/react/index.mjs +572 -783
  676. package/react/rendererPool.d.ts +7 -0
  677. package/react/withFive.d.ts +213 -0
  678. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  679. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  680. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  681. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  682. package/shader-lib/ShineModel/index.d.ts +7 -0
  683. package/shader-lib/SweepModel/index.d.ts +7 -0
  684. package/shader-lib/index.d.ts +5 -86
  685. package/shader-lib/index.js +13 -14
  686. package/shader-lib/index.mjs +424 -824
  687. package/sticker/geometry.d.ts +3 -0
  688. package/sticker/index.d.ts +68 -71
  689. package/sticker/index.js +3 -3
  690. package/sticker/index.mjs +102 -142
  691. package/umd/five-gltf-loader.js +9 -9
  692. package/umd/five-line.js +4 -4
  693. package/umd/five-plugins.js +35 -21
  694. package/umd/five-react.js +3 -3
  695. package/umd/five-shader-lib.js +13 -14
  696. package/umd/five-sticker.js +3 -3
  697. package/umd/five-vfx.js +21 -21
  698. package/umd/five-vue.js +3 -3
  699. package/umd/five.js +267 -387
  700. package/vfx/airflow/airflow.d.ts +18 -0
  701. package/vfx/airflow/fragment-shader.d.ts +2 -0
  702. package/vfx/airflow/vertex-shader.d.ts +2 -0
  703. package/vfx/common/scale-shader.d.ts +2 -0
  704. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  705. package/vfx/frame/fragment-shader.d.ts +2 -0
  706. package/vfx/frame/frame.d.ts +22 -0
  707. package/vfx/frame/vertex-shader.d.ts +2 -0
  708. package/vfx/index.d.ts +7 -363
  709. package/vfx/index.js +21 -21
  710. package/vfx/index.mjs +454 -910
  711. package/vfx/particle/fragment-shader.d.ts +2 -0
  712. package/vfx/particle/instance.d.ts +36 -0
  713. package/vfx/particle/particle.d.ts +205 -0
  714. package/vfx/particle/utils.d.ts +11 -0
  715. package/vfx/particle/vertex-shader.d.ts +2 -0
  716. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  717. package/vfx/particle-gpu/instance.d.ts +36 -0
  718. package/vfx/particle-gpu/particle.d.ts +95 -0
  719. package/vfx/particle-gpu/utils.d.ts +11 -0
  720. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  721. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  722. package/vfx/spotLight/spotLight.d.ts +15 -0
  723. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  724. package/vue/context.d.ts +7 -0
  725. package/vue/hooks/FiveCanvas.d.ts +36 -0
  726. package/vue/hooks/FiveProvider.d.ts +35 -0
  727. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  728. package/vue/hooks/useFiveAction.d.ts +178 -0
  729. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  730. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  731. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  732. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  733. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  734. package/vue/hooks/useFiveFloor.d.ts +16 -0
  735. package/vue/hooks/useFiveHelper.d.ts +15 -0
  736. package/vue/hooks/useFiveModel.d.ts +7 -0
  737. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  738. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  739. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  740. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  741. package/vue/hooks/useFiveScene.d.ts +6 -0
  742. package/vue/hooks/useFiveState.d.ts +16 -0
  743. package/vue/hooks/useFiveWork.d.ts +30 -0
  744. package/vue/index.d.ts +23 -467
  745. package/vue/index.js +3 -3
  746. package/vue/index.mjs +309 -301
  747. package/vue/rendererPool.d.ts +10 -0
  748. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  749. package/work-downloader/components/model.d.ts +3 -0
  750. package/work-downloader/components/observer.d.ts +7 -0
  751. package/work-downloader/download.d.ts +16 -0
  752. package/work-downloader/index.d.ts +2 -33
  753. package/work-downloader/index.js +3 -3
  754. package/work-downloader/index.mjs +339 -556
  755. package/work-downloader/type.d.ts +28 -0
  756. package/work-downloader/utils/download-to-file.d.ts +1 -0
  757. package/work-downloader/utils/image-processing.d.ts +7 -0
  758. package/work-downloader/utils/join-url.d.ts +2 -0
  759. package/work-downloader/utils/log.d.ts +1 -0
  760. package/work-downloader/utils/relative-url.d.ts +1 -0
  761. package/ai_guides/plugin.md +0 -206
  762. package/docs/documents/plugin.html +0 -60
  763. package/docs/media/five.ts +0 -2881
  764. package/docs/media/pass.ts +0 -64
package/docs/documents/ai-doc-guidelines.html CHANGED
@@ -17,11 +17,55 @@
17
17
  <li><strong>结构规范</strong>: 严格使用二级标题 (<code>##</code>) 作为主要段落分割（如 <code>## Schema</code>, <code>## Concepts</code>），避免使用中文标题（如 <code>## 格式说明</code>）。</li>
18
18
  <li><strong>代码缩进</strong>: 强制使用 <strong>两个空格</strong> 缩进。</li>
19
19
  <li><strong>相对路径</strong>: 内部文档链接必须使用 <strong>相对路径</strong>（如 <code>./state.md</code>）。</li>
20
- <li><strong>Schema</strong>: 必须提供 TypeScript Interface 定义，并保留关键字段的注释（JSDoc）。</li>
20
+ <li><strong>Schema</strong>: 必须提供 TypeScript Interface 定义，并保留关键字段的注释（JSDoc）。
21
+ <ul>
22
+ <li><strong>精简原则</strong>: 仅展示核心与常用字段，避免列出所有内部或废弃字段。</li>
23
+ </ul>
24
+ </li>
25
+ <li><strong>Configuration</strong>: 对于参数较多的配置项，建议按 <strong>“常用 (Common)”</strong>、<strong>“进阶 (Advanced)”</strong>、<strong>“内部 (Internal)”</strong> 进行分类表格展示，并在内部参数处添加“不建议修改”的警告。</li>
26
+ <li><strong>Source Link</strong>: 引用源码文件时，请在 <code>## Schema</code> 章节中使用 <code>&gt; **Definition**: [InterfaceName](../../path/to/source.ts)</code> 的格式。<strong>支持多个链接</strong>（如 <code>[Five](...), [EventTypes](...)</code>），以便完整覆盖相关类型。<strong>必须</strong> 指向 <code>lib/</code> 目录下的 <code>.ts</code> 文件。构建脚本会自动将其转换为发布包中的 <code>.d.ts</code> 链接。</li>
27
+ <li><strong>Related</strong>: 文档末尾建议包含 <code>## Related</code> 章节，提供相关文档的<strong>相对路径链接</strong>。
28
+ <ul>
29
+ <li><strong>语义化</strong>: 链接文字应准确反映目标文档的主题（如 <code>[Coordinate System](./coordinate.md)</code>）。</li>
30
+ </ul>
31
+ </li>
21
32
  <li><strong>Metadata</strong>: 结尾必须包含 YAML 格式的 <code>tags</code>。</li>
33
+ <li><strong>文档拆分与审查</strong>: 单个文档应保持精简。若内容过多需拆分为新专题，<strong>必须</strong>在创建新文件前向用户确认并获得批准，严禁擅自创建新文件。</li>
34
+ </ul>
35
+ <h2 id="最佳实践-best-practices" class="tsd-anchor-link">最佳实践 (Best Practices)<a href="#最佳实践-best-practices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
36
+ <h3 id="1-变量命名语义化-semantic-variable-naming" class="tsd-anchor-link">1. 变量命名语义化 (Semantic Variable Naming)<a href="#1-变量命名语义化-semantic-variable-naming" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
37
+ <p>在示例代码中，变量名应准确反映其通用性或特定上下文。</p>
38
+ <ul>
39
+ <li><strong>Good</strong>: <code>parentParameter</code> (暗示可用于 Model, ViewLayer 等多种父级)</li>
40
+ <li><strong>Bad</strong>: <code>modelParam</code> (若该逻辑同样适用于 ViewLayer，则会误导用户)</li>
41
+ </ul>
42
+ <h3 id="2-区分属性与方法-property-vs-method" class="tsd-anchor-link">2. 区分属性与方法 (Property vs Method)<a href="#2-区分属性与方法-property-vs-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
43
+ <p>明确区分“直接访问属性”与“调用方法计算”。</p>
44
+ <ul>
45
+ <li>若 API 设计为 Getter (如 <code>parameter.opacity</code>)，文档应引导用户直接访问属性，避免混淆使用 <code>get()</code> 方法。</li>
46
+ <li>对于涉及计算或继承的逻辑 (如 <code>resolveValue()</code>)，应显式说明其与直接访问的区别。</li>
47
+ </ul>
48
+ <h3 id="3-显式说明默认行为-explicit-default-behavior" class="tsd-anchor-link">3. 显式说明默认行为 (Explicit Default Behavior)<a href="#3-显式说明默认行为-explicit-default-behavior" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
49
+ <p>对于有默认值或继承逻辑的方法，务必说明“不传参”时的行为。</p>
50
+ <ul>
51
+ <li>例如：<code>resolveValue()</code> 不传参时仅计算默认值；传入 <code>upstream</code> 时会包含继承逻辑。</li>
22
52
  </ul>
23
53
  <h2 id="标准模板结构-standard-template-structure" class="tsd-anchor-link">标准模板结构 (Standard Template Structure)<a href="#标准模板结构-standard-template-structure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
24
- <p>新建文档时，请参考独立模板文件：<a href="template.html">template.md</a>。</p>
54
+ <p>无论是<strong>新建文档</strong>还是<strong>维护现有文档</strong>，都请参考独立模板文件：<a href="template.html">template.md</a>。</p>
55
+ <ul>
56
+ <li><strong>新建文档</strong>: 直接复制模板内容开始编写。</li>
57
+ <li><strong>维护文档</strong>: 在修改现有文档时，请检查其结构是否符合模板要求（如 Schema 的 Definition 引用、Configuration 的分类等）。如果发现结构过时，请顺手将其标准化。</li>
58
+ <li><strong>特殊说明 (Special Notes)</strong>:
59
+ <ul>
60
+ <li><strong>模板链接格式 (Template Link Format)</strong>:
61
+ <ul>
62
+ <li>模板(<code>template.md</code>)中所有的占位符链接（如 <code>Definition</code> 处的 <code>[InterfaceName](...)</code> 或 <code>Related</code> 处的 <code>[RelatedConcept](...)</code>）均使用了<strong>代码块</strong>包裹，以避免构建时因路径不存在而报错。</li>
63
+ <li><strong>AI 操作</strong>: 在编写正式文档时，<strong>必须将其还原为可点击的标准 Markdown 链接</strong>（即去掉反引号），并确保路径指向真实存在的文件。</li>
64
+ </ul>
65
+ </li>
66
+ </ul>
67
+ </li>
68
+ </ul>
25
69
  <p>请严格遵循该模板的结构，以保证文档风格一致性。</p>
26
70
  <hr>
27
71
  <h1 id="part-2-maintenance-guide-维护指南" class="tsd-anchor-link">Part 2: Maintenance Guide (维护指南)<a href="#part-2-maintenance-guide-维护指南" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
@@ -52,6 +96,7 @@
52
96
  </ul>
53
97
  </li>
54
98
  <li><strong>更新索引</strong>: 如果是新功能，确保将其添加到 <code>ai_guides/README.md</code> 的合适章节中。</li>
99
+ <li><strong>同步 llms.txt</strong>: 若新增了文档或修改了文档路径，<strong>必须</strong>同步更新项目根目录下的 <code>llms.txt</code>，确保外部索引与 <code>ai_guides/</code> 保持一致。</li>
55
100
  </ol>
56
101
  <h3 id="场景-b：api-文档同步-sync-api-doc" class="tsd-anchor-link">场景 B：API 文档同步 (Sync API Doc)<a href="#场景-b：api-文档同步-sync-api-doc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
57
102
  <p>定期检查 <code>ai_guides/api.md</code> 的完整性：</p>
@@ -69,4 +114,4 @@
69
114
  <li><code>ai_guides/README.md</code>: 文档总索引。</li>
70
115
  <li><code>package/five/index.d.ts</code>: <strong>API 签名的真理来源</strong>。</li>
71
116
  </ul>
72
- </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ai-文档与维护指南-ai-documentation-maintenance-guide"><span>AI 文档与维护指南 (<wbr/>AI <wbr/>Documentation &amp; <wbr/>Maintenance <wbr/>Guide)</span></a><ul><li><a href="#summary"><span>Summary</span></a></li></ul><a href="#part-1-writing-guide-编写指南"><span>Part 1: <wbr/>Writing <wbr/>Guide (编写指南)</span></a><ul><li><a href="#目的"><span>目的</span></a></li><li><a href="#建议风格"><span>建议风格</span></a></li><li><a href="#标准模板结构-standard-template-structure"><span>标准模板结构 (<wbr/>Standard <wbr/>Template <wbr/>Structure)</span></a></li></ul><a href="#part-2-maintenance-guide-维护指南"><span>Part 2: <wbr/>Maintenance <wbr/>Guide (维护指南)</span></a><ul><li><a href="#核心原则-core-principles"><span>核心原则 (<wbr/>Core <wbr/>Principles)</span></a></li><li><a href="#1-语义化检索-semantic-retrieval"><span>1. 语义化检索 (<wbr/>Semantic <wbr/>Retrieval)</span></a></li><li><a href="#2-单一事实来源-single-source-of-truth"><span>2. 单一事实来源 (<wbr/>Single <wbr/>Source of <wbr/>Truth)</span></a></li><li><a href="#3-维护工作流-maintenance-workflow"><span>3. 维护工作流 (<wbr/>Maintenance <wbr/>Workflow)</span></a></li><li><ul><li><a href="#场景-a：代码功能迭代后-post-coding"><span>场景 <wbr/>A：代码功能迭代后 (<wbr/>Post-<wbr/>Coding)</span></a></li><li><a href="#场景-b：api-文档同步-sync-api-doc"><span>场景 <wbr/>B：<wbr/>API 文档同步 (<wbr/>Sync <wbr/>API <wbr/>Doc)</span></a></li></ul></li><li><a href="#目录结构说明"><span>目录结构说明</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
117
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ai-文档与维护指南-ai-documentation-maintenance-guide"><span>AI 文档与维护指南 (<wbr/>AI <wbr/>Documentation &amp; <wbr/>Maintenance <wbr/>Guide)</span></a><ul><li><a href="#summary"><span>Summary</span></a></li></ul><a href="#part-1-writing-guide-编写指南"><span>Part 1: <wbr/>Writing <wbr/>Guide (编写指南)</span></a><ul><li><a href="#目的"><span>目的</span></a></li><li><a href="#建议风格"><span>建议风格</span></a></li><li><a href="#最佳实践-best-practices"><span>最佳实践 (<wbr/>Best <wbr/>Practices)</span></a></li><li><ul><li><a href="#1-变量命名语义化-semantic-variable-naming"><span>1. 变量命名语义化 (<wbr/>Semantic <wbr/>Variable <wbr/>Naming)</span></a></li><li><a href="#2-区分属性与方法-property-vs-method"><span>2. 区分属性与方法 (<wbr/>Property vs <wbr/>Method)</span></a></li><li><a href="#3-显式说明默认行为-explicit-default-behavior"><span>3. 显式说明默认行为 (<wbr/>Explicit <wbr/>Default <wbr/>Behavior)</span></a></li></ul></li><li><a href="#标准模板结构-standard-template-structure"><span>标准模板结构 (<wbr/>Standard <wbr/>Template <wbr/>Structure)</span></a></li></ul><a href="#part-2-maintenance-guide-维护指南"><span>Part 2: <wbr/>Maintenance <wbr/>Guide (维护指南)</span></a><ul><li><a href="#核心原则-core-principles"><span>核心原则 (<wbr/>Core <wbr/>Principles)</span></a></li><li><a href="#1-语义化检索-semantic-retrieval"><span>1. 语义化检索 (<wbr/>Semantic <wbr/>Retrieval)</span></a></li><li><a href="#2-单一事实来源-single-source-of-truth"><span>2. 单一事实来源 (<wbr/>Single <wbr/>Source of <wbr/>Truth)</span></a></li><li><a href="#3-维护工作流-maintenance-workflow"><span>3. 维护工作流 (<wbr/>Maintenance <wbr/>Workflow)</span></a></li><li><ul><li><a href="#场景-a：代码功能迭代后-post-coding"><span>场景 <wbr/>A：代码功能迭代后 (<wbr/>Post-<wbr/>Coding)</span></a></li><li><a href="#场景-b：api-文档同步-sync-api-doc"><span>场景 <wbr/>B：<wbr/>API 文档同步 (<wbr/>Sync <wbr/>API <wbr/>Doc)</span></a></li></ul></li><li><a href="#目录结构说明"><span>目录结构说明</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/documents/api.html CHANGED
@@ -92,68 +92,122 @@
92
92
  </table>
93
93
  <h2 id="initialization-configuration-" class="tsd-anchor-link">Initialization Configuration (<code>FiveInitArgs</code>)<a href="#initialization-configuration-" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
94
94
  <p>Configuration object passed to the <code>Five</code> constructor.</p>
95
- <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">FiveInitArgs</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** External WebGLRenderer. If provided, internal renderer creation is skipped. */</span><br/><span class="hl-1"> </span><span class="hl-6">renderer</span><span class="hl-1">?: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">WebGLRenderer</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Width/Height of the viewport relative to container (0-1). */</span><br/><span class="hl-1"> </span><span class="hl-6">viewport</span><span class="hl-1">?: { </span><span class="hl-6">left</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">bottom</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background color. Default: 0x181A1C */</span><br/><span class="hl-1"> </span><span class="hl-6">backgroundColor</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Color</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background alpha (0-1). Default: 1 */</span><br/><span class="hl-1"> </span><span class="hl-6">backgroundAlpha</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable antialiasing. Default: false */</span><br/><span class="hl-1"> </span><span class="hl-6">antialias</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Auto-play rendering loop. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">play</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable on-demand rendering to save battery. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">onlyRenderIfNeeds</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Max FPS limit. false = unlimited. Default: false */</span><br/><span class="hl-1"> </span><span class="hl-6">maxFps</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">false</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Mode transition duration in ms. Default: 800 */</span><br/><span class="hl-1"> </span><span class="hl-6">modeChangeDuration</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Initial plugins to load. */</span><br/><span class="hl-1"> </span><span class="hl-6">plugins</span><span class="hl-1">?: </span><span class="hl-7">FivePlugin</span><span class="hl-1">[];</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Dynamic image configuration for optimization. */</span><br/><span class="hl-1"> </span><span class="hl-6">imageOptions</span><span class="hl-1">?: </span><span class="hl-7">ImageOptions</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Dynamic texture configuration for optimization. */</span><br/><span class="hl-1"> </span><span class="hl-6">textureOptions</span><span class="hl-1">?: </span><span class="hl-7">TextureOptions</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
95
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">FiveInitArgs</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** External WebGLRenderer. If provided, internal renderer creation is skipped. */</span><br/><span class="hl-1"> </span><span class="hl-6">renderer</span><span class="hl-1">?: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">WebGLRenderer</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Width/Height of the viewport relative to container (0-1). */</span><br/><span class="hl-1"> </span><span class="hl-6">viewport</span><span class="hl-1">?: { </span><span class="hl-6">left</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">bottom</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background color. Default: 0x181A1C */</span><br/><span class="hl-1"> </span><span class="hl-6">backgroundColor</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Color</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background alpha (0-1). Default: 1 */</span><br/><span class="hl-1"> </span><span class="hl-6">backgroundAlpha</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable antialiasing. Default: false */</span><br/><span class="hl-1"> </span><span class="hl-6">antialias</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Auto-play rendering loop. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">play</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable on-demand rendering to save battery. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">onlyRenderIfNeeds</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Max FPS limit. false = unlimited. Default: false */</span><br/><span class="hl-1"> </span><span class="hl-6">maxFps</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">false</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Mode transition duration in ms. Default: 1000 */</span><br/><span class="hl-1"> </span><span class="hl-6">modeChangeDuration</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable mouse wheel zoom. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">enableWheel</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Initial plugins to load. */</span><br/><span class="hl-1"> </span><span class="hl-6">plugins</span><span class="hl-1">?: </span><span class="hl-7">FivePlugin</span><span class="hl-1">[];</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Dynamic image configuration for optimization. */</span><br/><span class="hl-1"> </span><span class="hl-6">imageOptions</span><span class="hl-1">?: </span><span class="hl-7">ImageOptions</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Dynamic texture configuration for optimization. */</span><br/><span class="hl-1"> </span><span class="hl-6">textureOptions</span><span class="hl-1">?: </span><span class="hl-7">TextureOptions</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Request URL interceptor for auth/CDN. */</span><br/><span class="hl-1"> </span><span class="hl-5">requestProxy</span><span class="hl-1">?: (</span><span class="hl-6">url</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">string</span><span class="hl-1"> | </span><span class="hl-7">Promise</span><span class="hl-1">&lt;</span><span class="hl-7">string</span><span class="hl-1">&gt;;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Per-mode configuration (panorama, mapview, floorplan, topview, model). */</span><br/><span class="hl-1"> </span><span class="hl-6">panorama</span><span class="hl-1">?: </span><span class="hl-7">PanoramaConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">mapview</span><span class="hl-1">?: </span><span class="hl-7">MapviewConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">floorplan</span><span class="hl-1">?: </span><span class="hl-7">FloorplanConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">topview</span><span class="hl-1">?: </span><span class="hl-7">TopviewConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">model</span><span class="hl-1">?: </span><span class="hl-7">ModelConfig</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
96
96
  </code><button type="button">Copy</button></pre>
97
97
 
98
+ <blockquote>
99
+ <p>详细的模式配置参数见 <a href="../../ai_guides/features/mode.md#configuration">Mode</a>。
100
+ 图片加载策略见 <a href="features_image-options.html">ImageOptions</a>。
101
+ 请求代理见 <a href="features_request-proxy.html">Request Proxy</a>。
102
+ 完整初始化参数见 <a href="features_five.html">Five</a> 和 <a href="features_parameter.html">Parameter</a>。</p>
103
+ </blockquote>
98
104
  <h2 id="core-methods" class="tsd-anchor-link">Core Methods<a href="#core-methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
99
- <h3 id="" class="tsd-anchor-link"><code>load(work, state?, options?)</code></h3>
105
+ <h3 id="_" class="tsd-anchor-link"><code>load(work, state?, options?)</code><a href="#_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
100
106
  <p>Loads a &quot;Work&quot; (dataset) into the Five instance.</p>
101
107
  <ul>
102
- <li><strong>work</strong>: The data object containing scene information (panorama, model, etc.).</li>
108
+ <li><strong>work</strong>: The data object (<code>LooseWork</code> or <code>Work</code>) containing scene information.</li>
103
109
  <li><strong>state</strong>: Initial state overrides. <code>&quot;inherit&quot;</code>, <code>&quot;initial&quot;</code>, or a <code>State</code> object.</li>
104
- <li><strong>options</strong>: Loading options (e.g., transition duration).</li>
110
+ <li><strong>options</strong>: Loading options (e.g., transition duration, <code>mode: &quot;add&quot; | &quot;replace&quot;</code>).</li>
105
111
  </ul>
106
- <h3 id="-1" class="tsd-anchor-link"><code>appendTo(element, size?)</code><a href="#-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
112
+ <blockquote>
113
+ <p>详见 <a href="features_work.html">Work</a> 和 <a href="features_multi-work.html">Multi-Work</a>。</p>
114
+ </blockquote>
115
+ <h3 id="_-1" class="tsd-anchor-link"><code>appendTo(element, size?)</code><a href="#_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
107
116
  <p>Mounts the Five canvas to a DOM element.</p>
108
117
  <ul>
109
118
  <li><strong>element</strong>: HTMLElement to append to.</li>
110
119
  <li><strong>size</strong>: Optional <code>{ width, height }</code>. Defaults to element size.</li>
111
120
  </ul>
112
- <h3 id="-2" class="tsd-anchor-link"><code>setState(state, immediately?, userAction?)</code><a href="#-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
121
+ <h3 id="_-2" class="tsd-anchor-link"><code>setState(state, immediately?, userAction?)</code><a href="#_-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
113
122
  <p>Updates the current state (position, mode, etc.).</p>
114
123
  <ul>
115
124
  <li><strong>state</strong>: Partial <code>State</code> object to merge.</li>
116
125
  <li><strong>immediately</strong>: If <code>true</code>, skips animation.</li>
117
126
  <li><strong>userAction</strong>: Marks the change as triggered by user interaction.</li>
118
127
  </ul>
119
- <h3 id="-3" class="tsd-anchor-link"><code>changeMode(mode, state?, options?)</code><a href="#-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
128
+ <blockquote>
129
+ <p>详见 <a href="features_state.html">State</a>。</p>
130
+ </blockquote>
131
+ <h3 id="_-3" class="tsd-anchor-link"><code>changeMode(mode, state?, options?)</code><a href="#_-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
120
132
  <p>Switches the viewing mode (e.g., from <code>Panorama</code> to <code>Model</code>).</p>
121
133
  <ul>
122
134
  <li><strong>mode</strong>: Target <code>Five.Mode</code>.</li>
123
135
  <li><strong>state</strong>: Target state after mode change.</li>
124
136
  <li><strong>options</strong>: Animation duration and effect.</li>
125
137
  </ul>
126
- <h3 id="-4" class="tsd-anchor-link"><code>moveToPano(panoIndex, options?)</code><a href="#-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
138
+ <blockquote>
139
+ <p>详见 <a href="features_mode.html">Mode</a>。</p>
140
+ </blockquote>
141
+ <h3 id="_-4" class="tsd-anchor-link"><code>moveToPano(panoIndex, options?)</code><a href="#_-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
127
142
  <p>Moves to a specific panorama spot.</p>
128
143
  <ul>
129
144
  <li><strong>panoIndex</strong>: Index of the panorama.</li>
130
- <li><strong>options</strong>: <code>{ effect?: MovePanoEffect, duration?: number }</code>.</li>
145
+ <li><strong>options</strong>: <code>{ effect?: MovePanoEffect, duration?: number, effectEasing?: Function }</code>.</li>
131
146
  </ul>
132
- <h3 id="-5" class="tsd-anchor-link"><code>refresh(size?)</code><a href="#-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
147
+ <blockquote>
148
+ <p>详见 <a href="features_move-pano-effect.html">Move Pano Effect</a> 和 <a href="features_camera-animation.html">Camera Animation</a>。</p>
149
+ </blockquote>
150
+ <h3 id="_-5" class="tsd-anchor-link"><code>updateCamera(pose, duration, userAction?)</code><a href="#_-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
151
+ <p>Animates the camera to a target pose without changing pano index.</p>
152
+ <ul>
153
+ <li><strong>pose</strong>: Partial <code>Pose</code> object (longitude, latitude, fov, etc.).</li>
154
+ <li><strong>duration</strong>: Animation duration in ms.</li>
155
+ <li><strong>returns</strong>: <code>Promise&lt;void&gt;</code> (rejects if interrupted).</li>
156
+ </ul>
157
+ <blockquote>
158
+ <p>详见 <a href="features_camera-animation.html">Camera Animation</a>。</p>
159
+ </blockquote>
160
+ <h3 id="_-6" class="tsd-anchor-link"><code>ready(args?)</code><a href="#_-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
161
+ <p>Returns a Promise that resolves when Five is stable (state synced, model loaded, optionally tiles loaded).</p>
162
+ <ul>
163
+ <li><strong>args</strong>: <code>{ tile?: boolean }</code> — if <code>tile: true</code> in Panorama mode, waits for tile loading.</li>
164
+ </ul>
165
+ <h3 id="_-7" class="tsd-anchor-link"><code>refresh(size?)</code><a href="#_-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
133
166
  <p>Resizes the renderer to fit the container or specified size.</p>
134
- <h3 id="-6" class="tsd-anchor-link"><code>getElement()</code><a href="#-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
167
+ <h3 id="_-8" class="tsd-anchor-link"><code>getElement()</code><a href="#_-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
135
168
  <p>Returns the <code>&lt;canvas&gt;</code> element used by Five.</p>
136
- <h3 id="-7" class="tsd-anchor-link"><code>project2d(vector, testModel?)</code><a href="#-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
169
+ <h3 id="_-9" class="tsd-anchor-link"><code>project2d(vector, testModel?)</code><a href="#_-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
137
170
  <p>Projects a 3D point to 2D screen coordinates.</p>
138
171
  <ul>
139
172
  <li><strong>vector</strong>: <code>THREE.Vector3</code> (World Space).</li>
140
173
  <li><strong>testModel</strong>: <code>boolean</code> (default <code>false</code>). If <code>true</code>, checks for occlusion.</li>
141
174
  <li><strong>returns</strong>: <code>THREE.Vector2</code> (Screen Space, px) or <code>null</code>.</li>
142
175
  </ul>
143
- <h3 id="-8" class="tsd-anchor-link"><code>getPixels(x, y, width, height)</code><a href="#-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
176
+ <blockquote>
177
+ <p>详见 <a href="features_screen-project.html">Screen &amp; Space Projection</a>。</p>
178
+ </blockquote>
179
+ <h3 id="_-10" class="tsd-anchor-link"><code>getPixels(options)</code><a href="#_-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
144
180
  <p>Get pixel data from the renderer (e.g. for color picking or magnifier).</p>
145
181
  <ul>
146
- <li><strong>x, y</strong>: Coordinate of the lower-left corner (Screen Space).</li>
147
- <li><strong>width, height</strong>: Size of the rectangle.</li>
182
+ <li><strong>options</strong>: <code>{ x, y, width, height, pixelRatio?, flipY?, buffer?, skipPanorama?, helperVisible? }</code></li>
148
183
  <li><strong>returns</strong>: <code>Uint8Array</code> (RGBA data).</li>
149
184
  </ul>
150
- <h3 id="-9" class="tsd-anchor-link"><code>intersectRaycaster(raycaster)</code><a href="#-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
185
+ <blockquote>
186
+ <p>详见 <a href="features_get-screen-pixels.html">Get Screen Pixels</a>。</p>
187
+ </blockquote>
188
+ <h3 id="_-11" class="tsd-anchor-link"><code>intersectRaycaster(raycaster)</code><a href="#_-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
151
189
  <p>(On <code>five.model</code>) Performs raycasting against the scene models.</p>
152
190
  <ul>
153
- <li><strong>raycaster</strong>: <code>THREE.Raycaster</code>.</li>
154
- <li><strong>returns</strong>: <code>THREE.Intersection[]</code>.</li>
191
+ <li><strong>raycaster</strong>: <code>THREE.Raycaster</code> (supports extended props: <code>firstHitOnly</code>, <code>hitFilter</code>, <code>sortByDistance</code>, <code>floorIndex</code>).</li>
192
+ <li><strong>returns</strong>: <code>THREE.Intersection[]</code> (extended with <code>tile</code>, <code>viewLayer</code>, <code>model</code> fields).</li>
193
+ </ul>
194
+ <blockquote>
195
+ <p>详见 <a href="features_raycast.html">Raycast</a>。</p>
196
+ </blockquote>
197
+ <h3 id="_-12" class="tsd-anchor-link"><code>addPass(pass)</code> / <code>removePass(pass)</code><a href="#_-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
198
+ <p>Add or remove a post-processing pass to/from the rendering chain.</p>
199
+ <ul>
200
+ <li><strong>pass</strong>: <code>FivePass</code> instance (e.g. <code>GaussianBlurPass</code>, <code>FlowingLight2DPass</code>).</li>
155
201
  </ul>
156
- <h3 id="-10" class="tsd-anchor-link"><code>dispose()</code><a href="#-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
202
+ <blockquote>
203
+ <p>详见 <a href="features_postprocessing.html">Postprocessing</a>。</p>
204
+ </blockquote>
205
+ <h3 id="_-13" class="tsd-anchor-link"><code>updateConfiguration(config)</code><a href="#_-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
206
+ <p>Dynamically update mode configurations after initialization (e.g., panorama, mapview settings).</p>
207
+ <blockquote>
208
+ <p>详见 <a href="../../ai_guides/features/mode.md#%E5%8A%A8%E6%80%81%E4%BF%AE%E6%94%B9%E9%85%8D%E7%BD%AE-update-configuration">Mode</a>。</p>
209
+ </blockquote>
210
+ <h3 id="_-14" class="tsd-anchor-link"><code>dispose()</code><a href="#_-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
157
211
  <p>Destroys the Five instance and releases resources.</p>
158
212
  <h2 id="state-management" class="tsd-anchor-link">State Management<a href="#state-management" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
159
213
  <p>The <code>State</code> interface defines the complete status of the Five instance at any moment.</p>
@@ -161,14 +215,17 @@
161
215
  </code><button type="button">Copy</button></pre>
162
216
 
163
217
  <h2 id="data-structures" class="tsd-anchor-link">Data Structures<a href="#data-structures" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
164
- <h3 id="-11" class="tsd-anchor-link"><code>Work</code><a href="#-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
218
+ <blockquote>
219
+ <p>以下为核心数据结构摘要。完整定义见 <a href="features_work.html">Work</a>、<a href="features_state.html">State</a>、<a href="features_model.html">Model</a>。</p>
220
+ </blockquote>
221
+ <h3 id="_-15" class="tsd-anchor-link"><code>Work</code><a href="#_-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
165
222
  <p>The main data object containing the scene description.</p>
166
223
  <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">Work</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">workCode</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">; </span><span class="hl-8">// Unique identifier</span><br/><span class="hl-1"> </span><span class="hl-6">name</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">; </span><span class="hl-8">// Project name</span><br/><span class="hl-1"> </span><span class="hl-6">observers</span><span class="hl-1">: </span><span class="hl-7">WorkObserver</span><span class="hl-1">[]; </span><span class="hl-8">// List of panorama points</span><br/><span class="hl-1"> </span><span class="hl-6">model</span><span class="hl-1">: </span><span class="hl-7">WorkModel</span><span class="hl-1">; </span><span class="hl-8">// 3D model data</span><br/><span class="hl-1"> </span><span class="hl-6">initial</span><span class="hl-1">: </span><span class="hl-7">WorkInitial</span><span class="hl-1">; </span><span class="hl-8">// Initial view state</span><br/><span class="hl-1"> </span><span class="hl-6">transform</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Matrix4</span><span class="hl-1">; </span><span class="hl-8">// World transform matrix</span><br/><span class="hl-1">}</span>
167
224
  </code><button type="button">Copy</button></pre>
168
225
 
169
226
  <h3 id="panorama-point" class="tsd-anchor-link"><code>WorkObserver</code> (Panorama Point)<a href="#panorama-point" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
170
227
  <p>Represents a single panorama spot.</p>
171
- <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">WorkObserver</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">index</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-8">// Index in the list</span><br/><span class="hl-1"> </span><span class="hl-6">floorIndex</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-8">// Floor number</span><br/><span class="hl-1"> </span><span class="hl-6">position</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">; </span><span class="hl-8">// Position in 3D space</span><br/><span class="hl-1"> </span><span class="hl-6">quaternion</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Quaternion</span><span class="hl-1">; </span><span class="hl-8">// Rotation relative to model</span><br/><span class="hl-1"> </span><span class="hl-6">accessibleNodes</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">[]; </span><span class="hl-8">// Indices of reachable points</span><br/><span class="hl-1"> </span><span class="hl-6">images</span><span class="hl-1">: </span><span class="hl-7">WorkImage</span><span class="hl-1">; </span><span class="hl-8">// Panorama image URLs</span><br/><span class="hl-1"> </span><span class="hl-6">active</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">; </span><span class="hl-8">// Whether the point is enabled</span><br/><span class="hl-1">}</span>
228
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">WorkObserver</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">index</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-8">// Index in the list</span><br/><span class="hl-1"> </span><span class="hl-6">floorIndex</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-8">// Floor number</span><br/><span class="hl-1"> </span><span class="hl-6">position</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">; </span><span class="hl-8">// Position in 3D space</span><br/><span class="hl-1"> </span><span class="hl-6">quaternion</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Quaternion</span><span class="hl-1">; </span><span class="hl-8">// Rotation relative to model</span><br/><span class="hl-1"> </span><span class="hl-6">accessibleNodes</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">[]; </span><span class="hl-8">// Indices of reachable points</span><br/><span class="hl-1"> </span><span class="hl-6">images</span><span class="hl-1">: </span><span class="hl-7">WorkImage</span><span class="hl-1">; </span><span class="hl-8">// Panorama image URLs</span><br/><span class="hl-1"> </span><span class="hl-6">active</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">; </span><span class="hl-8">// Whether the point is enabled</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// Coordinate Methods</span><br/><span class="hl-1"> </span><span class="hl-5">getWorldPosition</span><span class="hl-1">(): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">getWorldStandingPosition</span><span class="hl-1">(): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// UV Conversion Methods</span><br/><span class="hl-1"> </span><span class="hl-5">vectorToEquirectangularUv</span><span class="hl-1">(</span><span class="hl-6">vector</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">equirectangularUvToVector</span><span class="hl-1">(</span><span class="hl-6">uv</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">vectorToCubemapUv</span><span class="hl-1">(</span><span class="hl-6">vector</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): [</span><span class="hl-7">CubeFace</span><span class="hl-1">, </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-5">cubemapUvToVector</span><span class="hl-1">(</span><span class="hl-6">cubeFace</span><span class="hl-1">: </span><span class="hl-7">CubeFace</span><span class="hl-1">, </span><span class="hl-6">uv</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
172
229
  </code><button type="button">Copy</button></pre>
173
230
 
174
231
  <h2 id="events" class="tsd-anchor-link">Events<a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
@@ -189,25 +246,53 @@
189
246
  <tr>
190
247
  <td style="text-align:left"><code>gesture.tap</code></td>
191
248
  <td style="text-align:left">Triggered on tap/click. Replaces <code>wantsTapGesture</code>.</td>
192
- <td style="text-align:left"><code>{ pointers, event, ... }</code></td>
249
+ <td style="text-align:left"><code>GestureEvent</code></td>
250
+ </tr>
251
+ <tr>
252
+ <td style="text-align:left"><code>gesture.dbltap</code></td>
253
+ <td style="text-align:left">Triggered on double tap/click.</td>
254
+ <td style="text-align:left"><code>GestureEvent</code></td>
193
255
  </tr>
194
256
  <tr>
195
257
  <td style="text-align:left"><code>gesture.pan</code></td>
196
258
  <td style="text-align:left">Triggered on pan/drag.</td>
197
- <td style="text-align:left"><code>{ pointers, ... }</code></td>
259
+ <td style="text-align:left"><code>GestureEvent</code></td>
198
260
  </tr>
199
261
  <tr>
200
262
  <td style="text-align:left"><code>gesture.pinch</code></td>
201
263
  <td style="text-align:left">Triggered on pinch/zoom.</td>
202
- <td style="text-align:left"><code>{ scale, ... }</code></td>
264
+ <td style="text-align:left"><code>GestureEvent</code></td>
203
265
  </tr>
204
266
  <tr>
205
267
  <td style="text-align:left"><code>gesture.press</code></td>
206
268
  <td style="text-align:left">Triggered on long press.</td>
207
- <td style="text-align:left"><code>{ pointers, ... }</code></td>
269
+ <td style="text-align:left"><code>GestureEvent</code></td>
270
+ </tr>
271
+ <tr>
272
+ <td style="text-align:left"><code>gesture.mousewheel</code></td>
273
+ <td style="text-align:left">Triggered on mouse wheel scroll.</td>
274
+ <td style="text-align:left"><code>GestureEvent</code></td>
275
+ </tr>
276
+ <tr>
277
+ <td style="text-align:left"><code>gesture.mousemove</code></td>
278
+ <td style="text-align:left">Triggered on mouse move.</td>
279
+ <td style="text-align:left"><code>GestureEvent</code></td>
280
+ </tr>
281
+ <tr>
282
+ <td style="text-align:left"><code>gesture.momentum</code></td>
283
+ <td style="text-align:left">Triggered on inertia movement after pan.</td>
284
+ <td style="text-align:left"><code>GestureEvent</code></td>
285
+ </tr>
286
+ <tr>
287
+ <td style="text-align:left"><code>gesture.fire</code></td>
288
+ <td style="text-align:left">Triggered when any gesture event fires.</td>
289
+ <td style="text-align:left"><code>GestureEvent</code></td>
208
290
  </tr>
209
291
  </tbody>
210
292
  </table>
293
+ <blockquote>
294
+ <p>手势事件详解及不同 Mode 下的默认行为见 <a href="features_gesture.html">Gesture</a>。</p>
295
+ </blockquote>
211
296
  <h4 id="state-mode" class="tsd-anchor-link">State &amp; Mode<a href="#state-mode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
212
297
  <table>
213
298
  <thead>
@@ -235,6 +320,9 @@
235
320
  </tr>
236
321
  </tbody>
237
322
  </table>
323
+ <blockquote>
324
+ <p>状态管理详见 <a href="features_state.html">State</a>，模式切换详见 <a href="features_mode.html">Mode</a>。</p>
325
+ </blockquote>
238
326
  <h4 id="lifecycle-resources" class="tsd-anchor-link">Lifecycle &amp; Resources<a href="#lifecycle-resources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
239
327
  <table>
240
328
  <thead>
@@ -251,27 +339,92 @@
251
339
  <td style="text-align:left"><code>WorksEvent</code></td>
252
340
  </tr>
253
341
  <tr>
342
+ <td style="text-align:left"><code>works.ready</code></td>
343
+ <td style="text-align:left">Triggered when work data is loaded and controller is ready.</td>
344
+ <td style="text-align:left"><code>WorksEvent</code></td>
345
+ </tr>
346
+ <tr>
254
347
  <td style="text-align:left"><code>models.load</code></td>
255
348
  <td style="text-align:left">Triggered when models are loaded.</td>
256
349
  <td style="text-align:left"><code>ModelSceneEvent</code></td>
257
350
  </tr>
258
351
  <tr>
352
+ <td style="text-align:left"><code>models.refined</code></td>
353
+ <td style="text-align:left">Triggered when all models finish texture refinement.</td>
354
+ <td style="text-align:left"><code>ModelSceneEvent</code></td>
355
+ </tr>
356
+ <tr>
357
+ <td style="text-align:left"><code>model.load</code></td>
358
+ <td style="text-align:left">Triggered when a single model geometry is loaded.</td>
359
+ <td style="text-align:left"><code>ModelEvent</code></td>
360
+ </tr>
361
+ <tr>
362
+ <td style="text-align:left"><code>model.tileLoad</code></td>
363
+ <td style="text-align:left">Triggered when a 3D tile is loaded.</td>
364
+ <td style="text-align:left"><code>ModelTileEvent</code></td>
365
+ </tr>
366
+ <tr>
367
+ <td style="text-align:left"><code>model.tileUnload</code></td>
368
+ <td style="text-align:left">Triggered when a 3D tile is unloaded.</td>
369
+ <td style="text-align:left"><code>ModelTileEvent</code></td>
370
+ </tr>
371
+ <tr>
372
+ <td style="text-align:left"><code>model.changeShownFloor</code></td>
373
+ <td style="text-align:left">Triggered when floor visibility changes.</td>
374
+ <td style="text-align:left"><code>ModelEvent</code></td>
375
+ </tr>
376
+ <tr>
377
+ <td style="text-align:left"><code>model.error</code></td>
378
+ <td style="text-align:left">Triggered when model loading fails.</td>
379
+ <td style="text-align:left"><code>ModelErrorEvent</code></td>
380
+ </tr>
381
+ <tr>
382
+ <td style="text-align:left"><code>pano.prepare</code></td>
383
+ <td style="text-align:left">Triggered before switching to a new pano. <code>ExtendableEvent</code>, supports <code>waitUntil</code>.</td>
384
+ <td style="text-align:left"><code>PanoPrepareEvent</code></td>
385
+ </tr>
386
+ <tr>
259
387
  <td style="text-align:left"><code>pano.arrived</code></td>
260
388
  <td style="text-align:left">Triggered when arrival at a panorama node.</td>
261
389
  <td style="text-align:left"><code>PanoEvent</code></td>
262
390
  </tr>
263
391
  <tr>
392
+ <td style="text-align:left"><code>pano.moving</code></td>
393
+ <td style="text-align:left">Triggered during pano transition animation.</td>
394
+ <td style="text-align:left"><code>PanoEvent</code></td>
395
+ </tr>
396
+ <tr>
397
+ <td style="text-align:left"><code>pano.error</code></td>
398
+ <td style="text-align:left">Triggered when pano loading or movement fails.</td>
399
+ <td style="text-align:left"><code>PanoEvent</code></td>
400
+ </tr>
401
+ <tr>
402
+ <td style="text-align:left"><code>pano.texture.progress</code></td>
403
+ <td style="text-align:left">Triggered when panorama texture loading progresses.</td>
404
+ <td style="text-align:left"><code>PanoTextureEvent</code></td>
405
+ </tr>
406
+ <tr>
264
407
  <td style="text-align:left"><code>render</code></td>
265
408
  <td style="text-align:left">Triggered after each render frame.</td>
266
409
  <td style="text-align:left"><code>RenderEvent</code></td>
267
410
  </tr>
268
411
  <tr>
412
+ <td style="text-align:left"><code>render.prepare</code></td>
413
+ <td style="text-align:left">Triggered before each render frame.</td>
414
+ <td style="text-align:left"><code>RenderEvent</code></td>
415
+ </tr>
416
+ <tr>
269
417
  <td style="text-align:left"><code>error</code></td>
270
418
  <td style="text-align:left">Triggered on internal errors.</td>
271
419
  <td style="text-align:left"><code>Error</code></td>
272
420
  </tr>
273
421
  </tbody>
274
422
  </table>
423
+ <blockquote>
424
+ <p>事件系统详解见 <a href="features_event.html">Event</a>。手势事件详解见 <a href="features_gesture.html">Gesture</a>。
425
+ <code>pano.prepare</code> 的 <code>waitUntil</code> / <code>preventDefault</code> 用法见 <a href="../../ai_guides/features/event.md#event-%E5%AF%B9%E8%B1%A1">Event - Event 对象</a>。
426
+ 模型生命周期事件见 <a href="../../ai_guides/features/model.md#events">Model</a> 和 <a href="features_load-progress.html">Load Progress</a>。</p>
427
+ </blockquote>
275
428
  <h3 id="legacy-events-deprecated" class="tsd-anchor-link">Legacy Events (Deprecated)<a href="#legacy-events-deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
276
429
  <p>Older events are still supported for compatibility but should be avoided in new code.</p>
277
430
  <table>
@@ -309,4 +462,4 @@
309
462
  <pre><code class="typescript"><span class="hl-8">// Recommended: Use the new event system</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&#39;gesture.tap&#39;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&#39;User tapped at:&#39;</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// Legacy (Avoid):</span><br/><span class="hl-8">// five.on(&#39;wantsTapGesture&#39;, (raycaster) =&gt; { ... });</span>
310
463
  </code><button type="button">Copy</button></pre>
311
464
 
312
- </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-sdk-api-reference"><span>Five <wbr/>SDK <wbr/>API <wbr/>Reference</span></a><ul><li><a href="#core-class"><span>Core <wbr/>Class: </span></a></li><li><ul><li><a href="#constructor"><span>Constructor</span></a></li><li><a href="#properties"><span>Properties</span></a></li><li><a href="#static-properties"><span>Static <wbr/>Properties</span></a></li></ul></li><li><a href="#initialization-configuration-"><span>Initialization <wbr/>Configuration ()</span></a></li><li><a href="#core-methods"><span>Core <wbr/>Methods</span></a></li><li><ul><li><a href="#"><span></span></a></li><li><a href="#-1"><span></span></a></li><li><a href="#-2"><span></span></a></li><li><a href="#-3"><span></span></a></li><li><a href="#-4"><span></span></a></li><li><a href="#-5"><span></span></a></li><li><a href="#-6"><span></span></a></li><li><a href="#-7"><span></span></a></li><li><a href="#-8"><span></span></a></li><li><a href="#-9"><span></span></a></li><li><a href="#-10"><span></span></a></li></ul></li><li><a href="#state-management"><span>State <wbr/>Management</span></a></li><li><a href="#data-structures"><span>Data <wbr/>Structures</span></a></li><li><ul><li><a href="#-11"><span></span></a></li><li><a href="#panorama-point"><span> (<wbr/>Panorama <wbr/>Point)</span></a></li></ul></li><li><a href="#events"><span>Events</span></a></li><li><ul><li><a href="#recommended-events-modern"><span>Recommended <wbr/>Events (<wbr/>Modern)</span></a></li><li><ul><li><a href="#interaction-gestures"><span>Interaction &amp; <wbr/>Gestures</span></a></li><li><a href="#state-mode"><span>State &amp; <wbr/>Mode</span></a></li><li><a href="#lifecycle-resources"><span>Lifecycle &amp; <wbr/>Resources</span></a></li></ul></li><li><a href="#legacy-events-deprecated"><span>Legacy <wbr/>Events (<wbr/>Deprecated)</span></a></li><li><a href="#usage-example"><span>Usage <wbr/>Example</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
465
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-sdk-api-reference"><span>Five <wbr/>SDK <wbr/>API <wbr/>Reference</span></a><ul><li><a href="#core-class"><span>Core <wbr/>Class: </span></a></li><li><ul><li><a href="#constructor"><span>Constructor</span></a></li><li><a href="#properties"><span>Properties</span></a></li><li><a href="#static-properties"><span>Static <wbr/>Properties</span></a></li></ul></li><li><a href="#initialization-configuration-"><span>Initialization <wbr/>Configuration ()</span></a></li><li><a href="#core-methods"><span>Core <wbr/>Methods</span></a></li><li><ul><li><a href="#_"><span></span></a></li><li><a href="#_-1"><span></span></a></li><li><a href="#_-2"><span></span></a></li><li><a href="#_-3"><span></span></a></li><li><a href="#_-4"><span></span></a></li><li><a href="#_-5"><span></span></a></li><li><a href="#_-6"><span></span></a></li><li><a href="#_-7"><span></span></a></li><li><a href="#_-8"><span></span></a></li><li><a href="#_-9"><span></span></a></li><li><a href="#_-10"><span></span></a></li><li><a href="#_-11"><span></span></a></li><li><a href="#_-12"><span> / </span></a></li><li><a href="#_-13"><span></span></a></li><li><a href="#_-14"><span></span></a></li></ul></li><li><a href="#state-management"><span>State <wbr/>Management</span></a></li><li><a href="#data-structures"><span>Data <wbr/>Structures</span></a></li><li><ul><li><a href="#_-15"><span></span></a></li><li><a href="#panorama-point"><span> (<wbr/>Panorama <wbr/>Point)</span></a></li></ul></li><li><a href="#events"><span>Events</span></a></li><li><ul><li><a href="#recommended-events-modern"><span>Recommended <wbr/>Events (<wbr/>Modern)</span></a></li><li><ul><li><a href="#interaction-gestures"><span>Interaction &amp; <wbr/>Gestures</span></a></li><li><a href="#state-mode"><span>State &amp; <wbr/>Mode</span></a></li><li><a href="#lifecycle-resources"><span>Lifecycle &amp; <wbr/>Resources</span></a></li></ul></li><li><a href="#legacy-events-deprecated"><span>Legacy <wbr/>Events (<wbr/>Deprecated)</span></a></li><li><a href="#usage-example"><span>Usage <wbr/>Example</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>