@realsee/five 6.8.0-alpha.2 → 6.8.0-alpha.21

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 (715) hide show
  1. package/AGENTS_READ_ME.md +4 -0
  2. package/AI_CONTEXT.md +4 -0
  3. package/README.md +9 -6
  4. package/{guides → ai_guides}/README.md +12 -2
  5. package/ai_guides/ai-doc-guidelines.md +102 -0
  6. package/{guides → ai_guides}/api.md +24 -1
  7. package/ai_guides/features/3dtile.md +172 -0
  8. package/{guides → ai_guides}/features/camera-animation.md +24 -3
  9. package/{guides → ai_guides}/features/clipper.md +2 -0
  10. package/{guides/features/coordnate-system.md → ai_guides/features/coordinate-system.md} +2 -0
  11. package/{guides → ai_guides}/features/event.md +2 -0
  12. package/{guides → ai_guides}/features/five.md +4 -0
  13. package/ai_guides/features/flowing-light-2d-pass.md +438 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +420 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/{guides → ai_guides}/features/gesture.md +3 -0
  17. package/{guides → ai_guides}/features/get-screen-pixels.md +2 -0
  18. package/{guides → ai_guides}/features/image-options.md +3 -0
  19. package/{guides → ai_guides}/features/load-external-model.md +21 -0
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +153 -0
  22. package/{guides → ai_guides}/features/mode.md +4 -0
  23. package/{guides → ai_guides}/features/model.md +4 -1
  24. package/{guides → ai_guides}/features/move-pano-effect.md +2 -0
  25. package/{guides → ai_guides}/features/multi-work.md +2 -0
  26. package/ai_guides/features/pano-filter.md +148 -0
  27. package/{guides → ai_guides}/features/pano-tile.md +7 -14
  28. package/ai_guides/features/pano-uv.md +131 -0
  29. package/ai_guides/features/parameter.md +153 -0
  30. package/ai_guides/features/plugin.md +210 -0
  31. package/{guides → ai_guides}/features/postprocessing.md +39 -4
  32. package/{guides → ai_guides}/features/raycast.md +11 -0
  33. package/{guides → ai_guides}/features/request-proxy.md +2 -0
  34. package/{guides → ai_guides}/features/screen-project.md +2 -0
  35. package/{guides → ai_guides}/features/state.md +2 -0
  36. package/ai_guides/features/view-layer.md +187 -0
  37. package/{guides → ai_guides}/features/work.md +63 -2
  38. package/{guides → ai_guides}/glossary.md +26 -5
  39. package/{guides → ai_guides}/intro.md +1 -1
  40. package/{guides → ai_guides}/quick-start.md +1 -0
  41. package/ai_guides/release_notes/6.8.md +208 -0
  42. package/{guides → ai_guides}/template.md +17 -3
  43. package/docs/00_FOR_AI_AGENTS.md +11 -0
  44. package/docs/README.md +4 -7
  45. package/docs/assets/hierarchy.js +1 -1
  46. package/docs/assets/navigation.js +1 -1
  47. package/docs/assets/search.js +1 -1
  48. package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
  49. package/docs/classes/five.BoundingMesh.html +2 -2
  50. package/docs/classes/five.Camera.html +1 -1
  51. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  52. package/docs/classes/five.Five.html +73 -72
  53. package/docs/classes/five.FivePass.html +1 -1
  54. package/docs/classes/five.Histogram.html +19 -0
  55. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  56. package/docs/classes/five.Model.html +31 -31
  57. package/docs/classes/five.ModelScene.html +1 -1
  58. package/docs/classes/five.NetworkSubscribe.html +1 -1
  59. package/docs/classes/five.PBMContainer.html +1 -1
  60. package/docs/classes/five.PBMCustomShader.html +42 -3
  61. package/docs/classes/five.PBMGSObject.html +5 -3
  62. package/docs/classes/five.PBMGroup.html +1 -1
  63. package/docs/classes/five.PBMMesh.html +1 -1
  64. package/docs/classes/five.PBMMeshMaterial.html +16 -7
  65. package/docs/classes/five.PBMPanoFilter.html +61 -0
  66. package/docs/classes/five.PBMPointCloud.html +1 -1
  67. package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
  68. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  69. package/docs/classes/five.PBMUpdateable.html +41 -0
  70. package/docs/classes/five.PanoCircleMesh.html +1 -1
  71. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  72. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  73. package/docs/classes/five.Parameter.html +57 -53
  74. package/docs/classes/five.Scene.html +1 -1
  75. package/docs/classes/five.Subscribe.html +1 -1
  76. package/docs/classes/five.Tile.html +1 -1
  77. package/docs/classes/five.Tile3D.html +30 -26
  78. package/docs/classes/five.TileNode.html +1 -1
  79. package/docs/classes/five.Trajectory.html +1 -1
  80. package/docs/classes/five.TrajectoryNode.html +1 -1
  81. package/docs/classes/five.Work.html +16 -16
  82. package/docs/classes/five.WorkResolvedObserver.html +27 -2
  83. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  84. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  85. package/docs/classes/gltf-loader.GLTFLoader.html +1 -1
  86. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  87. package/docs/classes/gltf-loader.GLTFParser.html +1 -1
  88. package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
  89. package/docs/classes/line.Line.html +1 -1
  90. package/docs/classes/line.LineGeometry.html +1 -1
  91. package/docs/classes/line.LineMaterial.html +1 -1
  92. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  93. package/docs/classes/line.THREE_Line2.html +1 -1
  94. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  95. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  96. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  97. package/docs/classes/sticker.Sticker.html +1 -1
  98. package/docs/classes/vfx.Airflow.html +1 -1
  99. package/docs/classes/vfx.Flame.html +1 -1
  100. package/docs/classes/vfx.Particle.html +1 -1
  101. package/docs/classes/vfx.ParticleGPU.html +1 -1
  102. package/docs/classes/vfx.SpotLight.html +1 -1
  103. package/docs/documents/README.html +11 -2
  104. package/docs/documents/ai-doc-guidelines.html +60 -15
  105. package/docs/documents/api.html +40 -15
  106. package/docs/documents/features_3dtile.html +142 -45
  107. package/docs/documents/features_camera-animation.html +62 -5
  108. package/docs/documents/features_clipper.html +3 -0
  109. package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +4 -1
  110. package/docs/documents/features_event.html +3 -0
  111. package/docs/documents/features_five.html +4 -0
  112. package/docs/documents/features_flowing-light-2d-pass.html +356 -0
  113. package/docs/documents/features_flowing-light-3d-pass.html +351 -0
  114. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  115. package/docs/documents/features_gesture.html +4 -0
  116. package/docs/documents/features_get-screen-pixels.html +3 -0
  117. package/docs/documents/features_image-options.html +3 -0
  118. package/docs/documents/features_load-external-model.html +25 -2
  119. package/docs/documents/features_load-progress.html +110 -0
  120. package/docs/documents/features_material.html +341 -0
  121. package/docs/documents/features_mode.html +5 -0
  122. package/docs/documents/features_model.html +5 -1
  123. package/docs/documents/features_move-pano-effect.html +3 -0
  124. package/docs/documents/features_multi-work.html +3 -0
  125. package/docs/documents/features_pano-filter.html +122 -0
  126. package/docs/documents/features_pano-tile.html +34 -19
  127. package/docs/documents/features_pano-uv.html +82 -0
  128. package/docs/documents/features_parameter.html +76 -56
  129. package/docs/documents/features_plugin.html +105 -0
  130. package/docs/documents/features_postprocessing.html +22 -5
  131. package/docs/documents/features_raycast.html +4 -1
  132. package/docs/documents/features_request-proxy.html +3 -0
  133. package/docs/documents/features_screen-project.html +3 -0
  134. package/docs/documents/features_state.html +3 -0
  135. package/docs/documents/features_view-layer.html +158 -0
  136. package/docs/documents/features_work.html +63 -2
  137. package/docs/documents/glossary.html +31 -6
  138. package/docs/documents/intro.html +1 -1
  139. package/docs/documents/quick-start.html +1 -0
  140. package/docs/documents/release_notes_6.8.html +189 -0
  141. package/docs/documents/template.html +45 -4
  142. package/docs/functions/five.loadAt3d.html +1 -1
  143. package/docs/functions/five.loadB3dm.html +1 -1
  144. package/docs/functions/five.loadDome.html +1 -1
  145. package/docs/functions/five.loadDomez.html +1 -1
  146. package/docs/functions/five.loadFbx.html +1 -1
  147. package/docs/functions/five.loadGltf.html +1 -1
  148. package/docs/functions/five.loadPbm.html +1 -1
  149. package/docs/functions/five.loadPly.html +1 -1
  150. package/docs/functions/five.loadPnts.html +1 -1
  151. package/docs/functions/five.loadSplat.html +1 -1
  152. package/docs/functions/five.loadSpz.html +1 -1
  153. package/docs/functions/five.loadX3p.html +1 -1
  154. package/docs/functions/five.parseWork.html +1 -1
  155. package/docs/functions/vue.useFiveWorks.html +2 -2
  156. package/docs/hierarchy.html +1 -1
  157. package/docs/index.html +11 -2
  158. package/docs/interfaces/five.AddableObject.html +1 -1
  159. package/docs/interfaces/five.AjaxOptions.html +1 -1
  160. package/docs/interfaces/five.BaseEvent.html +2 -2
  161. package/docs/interfaces/five.EventCallback.html +53 -47
  162. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
  163. package/docs/interfaces/five.GestureEvent.html +2 -2
  164. package/docs/interfaces/five.ImageOptions.html +1 -1
  165. package/docs/interfaces/five.IntersectEvent.html +2 -2
  166. package/docs/interfaces/five.IntersectMesh.html +1 -1
  167. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  168. package/docs/interfaces/five.Intersection.html +4 -3
  169. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  170. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +9 -9
  171. package/docs/interfaces/five.ModeChangeEvent.html +2 -2
  172. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  173. package/docs/interfaces/five.ModelEvent.html +2 -2
  174. package/docs/interfaces/five.ModelSceneEvent.html +2 -2
  175. package/docs/interfaces/five.ModelTileEvent.html +8 -0
  176. package/docs/interfaces/five.MovePanoOptions.html +7 -7
  177. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  178. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  179. package/docs/interfaces/five.NetworkOptions.html +1 -1
  180. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  181. package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
  182. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  183. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  184. package/docs/interfaces/five.ObjectEvent.html +2 -2
  185. package/docs/interfaces/five.PBMClipperParameter.html +2 -2
  186. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
  187. package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
  188. package/docs/interfaces/five.PBMMaterial.html +1 -1
  189. package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
  190. package/docs/interfaces/five.PBMPanoDepth.html +5 -5
  191. package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
  192. package/docs/interfaces/five.PBMPanoPicture.html +8 -6
  193. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
  194. package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
  195. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  196. package/docs/interfaces/five.PanoEvent.html +2 -2
  197. package/docs/interfaces/five.PanoTextureEvent.html +2 -2
  198. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  199. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  200. package/docs/interfaces/five.ParameterMaterialValue.html +42 -38
  201. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  202. package/docs/interfaces/five.ParameterValue.html +56 -52
  203. package/docs/interfaces/five.Pose.html +1 -1
  204. package/docs/interfaces/five.RenderEvent.html +2 -2
  205. package/docs/interfaces/five.ResolvedParameterValue.html +56 -52
  206. package/docs/interfaces/five.RgbaData.html +7 -0
  207. package/docs/interfaces/five.SplatData.html +2 -2
  208. package/docs/interfaces/five.State.html +1 -1
  209. package/docs/interfaces/five.StateEvent.html +2 -2
  210. package/docs/interfaces/five.TextureOptions.html +1 -1
  211. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  212. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
  213. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  214. package/docs/interfaces/five.ViewLayer.html +30 -26
  215. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  216. package/docs/interfaces/five.WorkImage.html +1 -1
  217. package/docs/interfaces/five.WorkModel.html +8 -8
  218. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  219. package/docs/interfaces/five.WorkObserver.html +27 -2
  220. package/docs/interfaces/five.WorkTile.html +1 -1
  221. package/docs/interfaces/five.WorksEvent.html +2 -2
  222. package/docs/interfaces/five.XRControllerEvent.html +2 -2
  223. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  224. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  225. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  226. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  227. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  228. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  229. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +1 -1
  230. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  231. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  232. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  233. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  234. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
  235. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  236. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  237. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  238. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  239. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  240. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  241. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  242. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  243. package/docs/interfaces/plugins.TrajectoryController.html +1 -1
  244. package/docs/interfaces/react.FiveInjectionTypes.html +13 -13
  245. package/docs/modules/five.html +1 -1
  246. package/docs/modules.html +1 -1
  247. package/docs/types/five.ControllerEventTypes.html +27 -25
  248. package/docs/types/five.EasingFunction.html +1 -0
  249. package/docs/types/five.EventTypes.html +27 -25
  250. package/docs/types/five.FivePlugin.html +1 -1
  251. package/docs/types/five.FivePluginInit.html +1 -1
  252. package/docs/types/five.FivePluginInstance.html +1 -1
  253. package/docs/types/five.NetworkProgressCallback.html +1 -1
  254. package/docs/types/five.PBMAlphaMode.html +1 -1
  255. package/docs/types/five.PBMColorStyle.html +1 -1
  256. package/docs/types/five.PBMFloorStyle.html +1 -1
  257. package/docs/types/five.PBMMeshShaderType.html +1 -1
  258. package/docs/types/five.PBMPointBack.html +1 -1
  259. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  260. package/docs/types/five.PBMPointShape.html +1 -1
  261. package/docs/types/five.PBMPointSize.html +1 -1
  262. package/docs/types/five.PBMTransition.html +1 -1
  263. package/docs/types/five.ParseOptions.html +6 -6
  264. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  265. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  266. package/five/application/analysis.d.ts +40 -0
  267. package/five/application/controllers.d.ts +41 -0
  268. package/five/application/events-legacy.d.ts +454 -0
  269. package/five/application/events.d.ts +69 -0
  270. package/five/application/five.d.ts +519 -0
  271. package/five/application/fiveInitArgs.d.ts +176 -0
  272. package/five/application/fiveLoadOptions.d.ts +21 -0
  273. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  274. package/five/application/getViewportScale.d.ts +2 -0
  275. package/five/application/initLights.d.ts +3 -0
  276. package/five/application/mode.d.ts +28 -0
  277. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  278. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  279. package/five/assets/gradient-png-data-url.d.ts +2 -0
  280. package/five/assets/loading-png-data-url.d.ts +2 -0
  281. package/five/assets/phone-png-data-url.d.ts +2 -0
  282. package/five/assets/realsee-png-data-url.d.ts +2 -0
  283. package/five/bvh/bvhMath.d.ts +33 -0
  284. package/five/bvh/bvhMesh.d.ts +7 -0
  285. package/five/bvh/bvhNode.d.ts +29 -0
  286. package/five/bvh/bvhObject.d.ts +18 -0
  287. package/five/bvh/bvhPoints.d.ts +6 -0
  288. package/five/bvh/index.d.ts +10 -0
  289. package/five/bvh/worker.d.ts +35 -0
  290. package/five/cardboard/helper.d.ts +2 -0
  291. package/five/cardboard/index.d.ts +13 -0
  292. package/five/cardboard/sensor.d.ts +158 -0
  293. package/five/certificates/hardware.d.ts +1 -0
  294. package/five/controllers/base.d.ts +167 -0
  295. package/five/controllers/events.d.ts +71 -0
  296. package/five/controllers/floorplan.d.ts +119 -0
  297. package/five/controllers/mapview.d.ts +139 -0
  298. package/five/controllers/model.d.ts +57 -0
  299. package/five/controllers/panorama.d.ts +143 -0
  300. package/five/controllers/panoramaLike.d.ts +87 -0
  301. package/five/controllers/topview.d.ts +42 -0
  302. package/five/controllers/vrPanorama.d.ts +56 -0
  303. package/five/controllers/xrPanorama.d.ts +81 -0
  304. package/five/core/camera.d.ts +65 -0
  305. package/five/core/internalWebGLRenderer.d.ts +14 -0
  306. package/five/core/panoVideo.d.ts +18 -0
  307. package/five/core/scene.d.ts +10 -0
  308. package/five/core/tiling.d.ts +43 -0
  309. package/five/declare.d.ts +2 -1
  310. package/five/gaussian-splatting/util/renderData.d.ts +52 -0
  311. package/five/gaussian-splatting/wasm/data.d.ts +20 -0
  312. package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
  313. package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
  314. package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
  315. package/five/index.d.ts +60 -4637
  316. package/five/index.js +193 -341
  317. package/five/index.mjs +26455 -31011
  318. package/five/meshes/boundingMesh.d.ts +12 -0
  319. package/five/meshes/intersectMesh.d.ts +8 -0
  320. package/five/meshes/panoCircleMesh.d.ts +35 -0
  321. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  322. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  323. package/five/meshes/panoSphereMesh.d.ts +27 -0
  324. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  325. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  326. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  327. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  328. package/five/model/index.d.ts +70 -0
  329. package/five/model/intersection.d.ts +18 -0
  330. package/five/model/loaders/at3d.d.ts +12 -0
  331. package/five/model/loaders/b3dm.d.ts +9 -0
  332. package/five/model/loaders/dome.d.ts +22 -0
  333. package/five/model/loaders/domez.d.ts +11 -0
  334. package/five/model/loaders/fbx.d.ts +8 -0
  335. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  336. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  337. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  338. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  339. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  340. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  341. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +9 -0
  342. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  343. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  344. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  345. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  346. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  347. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  348. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  349. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  350. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  351. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  352. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +24 -0
  353. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  354. package/five/model/loaders/glTF-helpers/index.d.ts +47 -0
  355. package/five/model/loaders/glTF-helpers/parser.d.ts +114 -0
  356. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  357. package/five/model/loaders/gltf.d.ts +10 -0
  358. package/five/model/loaders/obj.d.ts +9 -0
  359. package/five/model/loaders/pbm.d.ts +26 -0
  360. package/five/model/loaders/ply.d.ts +24 -0
  361. package/five/model/loaders/pnts.d.ts +8 -0
  362. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  363. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  364. package/five/model/loaders/shared.d.ts +16 -0
  365. package/five/model/loaders/splat.d.ts +8 -0
  366. package/five/model/loaders/spz.d.ts +14 -0
  367. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  368. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  369. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  370. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  371. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  372. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  373. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  374. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  375. package/five/model/loaders/x3p.d.ts +22 -0
  376. package/five/model/materials/pbmMaterial.d.ts +137 -0
  377. package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
  378. package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -0
  379. package/five/model/model-scene.d.ts +172 -0
  380. package/five/model/model.d.ts +209 -0
  381. package/five/model/objects/pbmContainer.d.ts +28 -0
  382. package/five/model/objects/pbmGaussianSplattingObject.d.ts +43 -0
  383. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +55 -0
  384. package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
  385. package/five/model/objects/pbmGroup.d.ts +8 -0
  386. package/five/model/objects/pbmMesh.d.ts +10 -0
  387. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  388. package/five/model/parameter.d.ts +140 -0
  389. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  390. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  391. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  392. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  393. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  394. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  395. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  396. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  397. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  398. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  399. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  400. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  401. package/five/model/tile3d/header.d.ts +88 -0
  402. package/five/model/tile3d/index.d.ts +214 -0
  403. package/five/model/tile3d/tile-cache.d.ts +18 -0
  404. package/five/model/tile3d/tile-content.d.ts +10 -0
  405. package/five/model/tile3d/tile-node.d.ts +24 -0
  406. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  407. package/five/model/tile3d/tile.d.ts +79 -0
  408. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  409. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  410. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  411. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  412. package/five/model/tile3d/tileset.d.ts +69 -0
  413. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  414. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  415. package/five/model/tile3d/trajectory.d.ts +30 -0
  416. package/five/model/tile3d/types.d.ts +33 -0
  417. package/five/model/view-layer.d.ts +20 -0
  418. package/five/renderer/five-renderer.d.ts +17 -0
  419. package/five/renderer/index.d.ts +3 -0
  420. package/five/renderer/postprocessing/composer.d.ts +37 -0
  421. package/five/renderer/postprocessing/index.d.ts +7 -0
  422. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +17 -0
  423. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  424. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  425. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  426. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  427. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  428. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  429. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  430. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  431. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  432. package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
  433. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  434. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  435. package/five/texture/histogram.d.ts +54 -0
  436. package/five/texture/imageBitmap.d.ts +13 -0
  437. package/five/texture/initTexture.d.ts +3 -0
  438. package/five/texture/loader.d.ts +39 -0
  439. package/five/texture/textureData.d.ts +11 -0
  440. package/five/thirdparty/fflate.d.ts +1407 -0
  441. package/five/thirdparty/hammer.d.ts +375 -0
  442. package/five/thirdparty/jsrsasign.d.ts +753 -0
  443. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  444. package/five/three-version-check.d.ts +1 -0
  445. package/five/types/addableObject.d.ts +12 -0
  446. package/five/types/cube.d.ts +1 -0
  447. package/five/types/gestureInput.d.ts +24 -0
  448. package/five/types/imageOptions.d.ts +20 -0
  449. package/five/types/intersectMeshInterface.d.ts +8 -0
  450. package/five/types/movePanoEffect.d.ts +13 -0
  451. package/five/types/movePanoOptions.d.ts +36 -0
  452. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  453. package/five/types/plugin.d.ts +25 -0
  454. package/five/types/pose.d.ts +17 -0
  455. package/five/types/state.d.ts +20 -0
  456. package/five/types/viewport.d.ts +22 -0
  457. package/five/utils/ajax.d.ts +66 -0
  458. package/five/utils/animationFrameLoop.d.ts +45 -0
  459. package/five/utils/array.d.ts +31 -0
  460. package/five/utils/asyncTaskQueue.d.ts +8 -0
  461. package/five/utils/bufferGeometry.d.ts +33 -0
  462. package/five/utils/calculateProgress.d.ts +39 -0
  463. package/five/utils/calculateThreeMouse.d.ts +13 -0
  464. package/five/utils/canplayVideo.d.ts +2 -0
  465. package/five/utils/clamp.d.ts +2 -0
  466. package/five/utils/clock.d.ts +17 -0
  467. package/five/utils/createSymbol.d.ts +5 -0
  468. package/five/utils/decodeText.d.ts +2 -0
  469. package/five/utils/deepEqual.d.ts +2 -0
  470. package/five/utils/deepFreeze.d.ts +2 -0
  471. package/five/utils/defineProperty.d.ts +9 -0
  472. package/five/utils/detector.d.ts +14 -0
  473. package/five/utils/distance.d.ts +10 -0
  474. package/five/utils/draco.d.ts +26 -0
  475. package/five/utils/easing.d.ts +63 -0
  476. package/five/utils/event.d.ts +159 -0
  477. package/five/utils/formatRad.d.ts +7 -0
  478. package/five/utils/imageSupport.d.ts +6 -0
  479. package/five/utils/imageURL.d.ts +42 -0
  480. package/five/utils/isEmptyObject.d.ts +2 -0
  481. package/five/utils/isNil.d.ts +6 -0
  482. package/five/utils/isNumber.d.ts +2 -0
  483. package/five/utils/isPowerOfTwo.d.ts +2 -0
  484. package/five/utils/isPromise.d.ts +2 -0
  485. package/five/utils/isSimilar.d.ts +6 -0
  486. package/five/utils/json.d.ts +7 -0
  487. package/five/utils/ktx2.d.ts +30 -0
  488. package/five/utils/lzma/index.d.ts +2 -0
  489. package/five/utils/lzma/lzma.d.ts +3 -0
  490. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  491. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  492. package/five/utils/memoryUsage.d.ts +29 -0
  493. package/five/utils/motion.d.ts +38 -0
  494. package/five/utils/noop.d.ts +6 -0
  495. package/five/utils/now.d.ts +7 -0
  496. package/five/utils/pano.d.ts +9 -0
  497. package/five/utils/pick.d.ts +3 -0
  498. package/five/utils/poseUtils.d.ts +5 -0
  499. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  500. package/five/utils/renderDepth.d.ts +2 -0
  501. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  502. package/five/utils/requestPermission.d.ts +3 -0
  503. package/five/utils/shaderContentFix.d.ts +7 -0
  504. package/five/utils/shaderMaterial.d.ts +20 -0
  505. package/five/utils/stateUtils.d.ts +5 -0
  506. package/five/utils/string-pattern.d.ts +8 -0
  507. package/five/utils/subscribe.d.ts +67 -0
  508. package/five/utils/tileCube.d.ts +19 -0
  509. package/five/utils/toFastProperties.d.ts +1 -0
  510. package/five/utils/typedCache.d.ts +10 -0
  511. package/five/utils/uniform.d.ts +15 -0
  512. package/five/utils/url.d.ts +35 -0
  513. package/five/utils/uuid.d.ts +5 -0
  514. package/five/utils/values.d.ts +2 -0
  515. package/five/utils/vectorCoordinates.d.ts +29 -0
  516. package/five/utils/volume.d.ts +111 -0
  517. package/five/utils/webglError.d.ts +7 -0
  518. package/five/utils/worker.d.ts +26 -0
  519. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  520. package/five/webxr/motionHelper.d.ts +68 -0
  521. package/five/webxr/xrButton.d.ts +4 -0
  522. package/five/webxr/xrController.d.ts +24 -0
  523. package/five/webxr/xrManager.d.ts +84 -0
  524. package/five/work/_ALLOW_HOST.d.ts +2 -0
  525. package/five/work/index.d.ts +6 -0
  526. package/five/work/keychain.d.ts +5 -0
  527. package/five/work/looseWorkType.d.ts +121 -0
  528. package/five/work/verify.d.ts +7 -0
  529. package/five/work/work.d.ts +236 -0
  530. package/five/work/workFetcher.d.ts +4 -0
  531. package/five/work/workJson.d.ts +3 -0
  532. package/five/work/workJsonType.d.ts +73 -0
  533. package/five/work/workObserverUtils.d.ts +36 -0
  534. package/five/work/workParser.d.ts +6 -0
  535. package/five/work/workResolvedObserver.d.ts +12 -0
  536. package/five/work/workVerify.d.ts +2 -0
  537. package/five/work/works.d.ts +10 -0
  538. package/gltf-loader/gltf-object.d.ts +17 -0
  539. package/gltf-loader/index.d.ts +60 -160
  540. package/gltf-loader/index.js +9 -9
  541. package/gltf-loader/index.mjs +1351 -1451
  542. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  543. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  544. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  545. package/line/circle_png.d.ts +1 -0
  546. package/line/index.d.ts +19 -69
  547. package/line/index.js +4 -4
  548. package/line/index.mjs +334 -513
  549. package/line/utils/Line2.d.ts +7 -0
  550. package/line/utils/LineGeometry.d.ts +10 -0
  551. package/line/utils/LineMaterial.d.ts +20 -0
  552. package/line/utils/LineSegments2.d.ts +11 -0
  553. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  554. package/llms.txt +43 -31
  555. package/package.json +11 -2
  556. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  557. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  558. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  559. package/plugins/BasePlugin/index.d.ts +119 -0
  560. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  561. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  562. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  563. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  564. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  565. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  566. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  567. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  568. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  569. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  570. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  571. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  572. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  573. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  574. package/plugins/OrientationPlugin/index.d.ts +6 -0
  575. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  576. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  577. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  578. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  579. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  580. package/plugins/PluginTemplate/index.d.ts +5 -0
  581. package/plugins/PluginTemplate/typing.d.ts +21 -0
  582. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  583. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  584. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  585. package/plugins/index.d.ts +9 -1102
  586. package/plugins/index.js +17 -21
  587. package/plugins/index.mjs +3342 -4245
  588. package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
  589. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  590. package/plugins/utils/absoluteUrl.d.ts +5 -0
  591. package/plugins/utils/clamp.d.ts +2 -0
  592. package/plugins/utils/loadImage.d.ts +1 -0
  593. package/plugins/utils/motion.d.ts +38 -0
  594. package/plugins/utils/now.d.ts +6 -0
  595. package/plugins/utils/uuid.d.ts +5 -0
  596. package/react/canvas.d.ts +19 -0
  597. package/react/context.d.ts +11 -0
  598. package/react/createProvider.d.ts +95 -0
  599. package/react/createStore.d.ts +144 -0
  600. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  601. package/react/hooks/useFiveAction.d.ts +147 -0
  602. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  603. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  604. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  605. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  606. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  607. package/react/hooks/useFiveFloor.d.ts +15 -0
  608. package/react/hooks/useFiveHelper.d.ts +14 -0
  609. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  610. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  611. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  612. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  613. package/react/hooks/useFiveProject2d.d.ts +20 -0
  614. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  615. package/react/hooks/useFiveState.d.ts +6 -0
  616. package/react/hooks/useFiveWork.d.ts +29 -0
  617. package/react/index.d.ts +24 -830
  618. package/react/index.js +3 -3
  619. package/react/index.mjs +572 -783
  620. package/react/rendererPool.d.ts +7 -0
  621. package/react/withFive.d.ts +213 -0
  622. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  623. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  624. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  625. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  626. package/shader-lib/ShineModel/index.d.ts +7 -0
  627. package/shader-lib/SweepModel/index.d.ts +7 -0
  628. package/shader-lib/index.d.ts +5 -86
  629. package/shader-lib/index.js +13 -14
  630. package/shader-lib/index.mjs +424 -824
  631. package/sticker/geometry.d.ts +3 -0
  632. package/sticker/index.d.ts +68 -71
  633. package/sticker/index.js +3 -3
  634. package/sticker/index.mjs +102 -142
  635. package/umd/five-gltf-loader.js +9 -9
  636. package/umd/five-line.js +4 -4
  637. package/umd/five-plugins.js +17 -21
  638. package/umd/five-react.js +3 -3
  639. package/umd/five-shader-lib.js +13 -14
  640. package/umd/five-sticker.js +3 -3
  641. package/umd/five-vfx.js +21 -21
  642. package/umd/five-vue.js +3 -3
  643. package/umd/five.js +188 -336
  644. package/vfx/airflow/airflow.d.ts +18 -0
  645. package/vfx/airflow/fragment-shader.d.ts +2 -0
  646. package/vfx/airflow/vertex-shader.d.ts +2 -0
  647. package/vfx/common/scale-shader.d.ts +2 -0
  648. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  649. package/vfx/frame/fragment-shader.d.ts +2 -0
  650. package/vfx/frame/frame.d.ts +22 -0
  651. package/vfx/frame/vertex-shader.d.ts +2 -0
  652. package/vfx/index.d.ts +7 -363
  653. package/vfx/index.js +21 -21
  654. package/vfx/index.mjs +454 -910
  655. package/vfx/particle/fragment-shader.d.ts +2 -0
  656. package/vfx/particle/instance.d.ts +36 -0
  657. package/vfx/particle/particle.d.ts +205 -0
  658. package/vfx/particle/utils.d.ts +11 -0
  659. package/vfx/particle/vertex-shader.d.ts +2 -0
  660. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  661. package/vfx/particle-gpu/instance.d.ts +36 -0
  662. package/vfx/particle-gpu/particle.d.ts +95 -0
  663. package/vfx/particle-gpu/utils.d.ts +11 -0
  664. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  665. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  666. package/vfx/spotLight/spotLight.d.ts +15 -0
  667. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  668. package/vue/context.d.ts +7 -0
  669. package/vue/hooks/FiveCanvas.d.ts +36 -0
  670. package/vue/hooks/FiveProvider.d.ts +35 -0
  671. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  672. package/vue/hooks/useFiveAction.d.ts +178 -0
  673. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  674. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  675. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  676. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  677. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  678. package/vue/hooks/useFiveFloor.d.ts +16 -0
  679. package/vue/hooks/useFiveHelper.d.ts +15 -0
  680. package/vue/hooks/useFiveModel.d.ts +7 -0
  681. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  682. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  683. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  684. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  685. package/vue/hooks/useFiveScene.d.ts +6 -0
  686. package/vue/hooks/useFiveState.d.ts +16 -0
  687. package/vue/hooks/useFiveWork.d.ts +30 -0
  688. package/vue/index.d.ts +23 -467
  689. package/vue/index.js +3 -3
  690. package/vue/index.mjs +309 -301
  691. package/vue/rendererPool.d.ts +10 -0
  692. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  693. package/work-downloader/components/model.d.ts +3 -0
  694. package/work-downloader/components/observer.d.ts +7 -0
  695. package/work-downloader/download.d.ts +16 -0
  696. package/work-downloader/index.d.ts +2 -33
  697. package/work-downloader/index.js +3 -3
  698. package/work-downloader/index.mjs +317 -556
  699. package/work-downloader/type.d.ts +28 -0
  700. package/work-downloader/utils/download-to-file.d.ts +1 -0
  701. package/work-downloader/utils/image-processing.d.ts +7 -0
  702. package/work-downloader/utils/join-url.d.ts +2 -0
  703. package/work-downloader/utils/log.d.ts +1 -0
  704. package/work-downloader/utils/relative-url.d.ts +1 -0
  705. package/docs/documents/five.FivePlugin.plugin.html +0 -60
  706. package/docs/documents/plugin.html +0 -60
  707. package/docs/media/five.ts +0 -2881
  708. package/docs/media/pass.ts +0 -64
  709. package/guides/ai-doc-guidelines.md +0 -72
  710. package/guides/features/3dtile.md +0 -264
  711. package/guides/features/parameter.md +0 -178
  712. package/guides/plugin.md +0 -206
  713. /package/{guides → ai_guides}/release_notes/6.6.md +0 -0
  714. /package/{guides → ai_guides}/release_notes/6.7.md +0 -0
  715. /package/{guides → ai_guides}/support.md +0 -0
package/docs/documents/features_3dtile.html CHANGED
@@ -1,13 +1,17 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/3dtile | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/3dtile</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="3dtile" class="tsd-anchor-link">3DTile<a href="#3dtile" 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>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/3dtile | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/3dtile</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="3dtile-3d-瓦片" class="tsd-anchor-link">3DTile (3D 瓦片)<a href="#3dtile-3d-瓦片" 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>
2
2
  <ul>
3
3
  <li><strong>Summary</strong>: Five 用于加载和渲染大规模三维场景的核心模块，支持动态 LOD 调度与流式加载。</li>
4
- <li><strong>Schema</strong>: 通过 Parameter 配置 LOD、显存与并发控制。</li>
5
- <li><strong>Concepts</strong>: LOD, SSE, Cache Management, ViewLayer。</li>
4
+ <li><strong>Schema</strong>: 对应 <code>ParameterTilesetValue</code> 接口，通过 Parameter 配置 LOD、显存与并发控制。</li>
5
+ <li><strong>Concepts</strong>: LOD (细节层级), SSE (屏幕空间误差), Cache Management (显存管理), ViewLayer (视图层)。</li>
6
+ <li><strong>Configuration</strong>: 包含画质精度、显存配额、几何误差、并发请求等详细参数。</li>
6
7
  <li><strong>Examples</strong>: 画质平衡与多图层优化。</li>
7
8
  </ul>
8
9
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
9
- <p>3DTile 的核心配置通过 <code>Parameter</code> 系统进行控制。以下是 <code>ParameterValue</code> 接口中与 3DTile 调度相关的关键字段。</p>
10
- <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">Tile3DParameterValue</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">// --- 核心画质控制 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 屏幕空间误差阈值 (Screen Space Error, SSE)</span><br/><span class="hl-8"> * 单位: 像素</span><br/><span class="hl-8"> * 默认值: 16</span><br/><span class="hl-8"> * 说明: 控制加载精度的核心参数。</span><br/><span class="hl-8"> * - 值越小: 画质越高，加载更精细的瓦片，网络/渲染压力越大。</span><br/><span class="hl-8"> * - 值越大: 画质越低，性能越好。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">maxScreenSpaceError</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">// --- 显存与内存管理 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 最大显存占用</span><br/><span class="hl-8"> * 单位: MB</span><br/><span class="hl-8"> * 默认值: 512</span><br/><span class="hl-8"> * 说明: 当已加载瓦片的显存占用超过此阈值时，引擎会自动卸载不可见或低优先级的瓦片。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">maxMemoryUsage</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">/**</span><br/><span class="hl-8"> * 是否开启基于内存的动态 SSE 调整</span><br/><span class="hl-8"> * 默认值: false</span><br/><span class="hl-8"> * 说明: 开启后，引擎会根据当前显存占用情况自动调整 maxScreenSpaceError。</span><br/><span class="hl-8"> * - 目标: 尽量占满 maxMemoryUsage 设定的显存配额。</span><br/><span class="hl-8"> * - 行为: 实际使用的 SSE 会在 1.0 到 maxScreenSpaceError 之间动态变化。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">memoryAdjustedScreenSpaceError</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">// --- 几何误差控制 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 最小几何误差 (精度上限锁)</span><br/><span class="hl-8"> * 默认值: 0</span><br/><span class="hl-8"> * 说明: 当瓦片的几何误差小于此值时，强制停止细分。</span><br/><span class="hl-8"> * - 作用: 限制加载的最精细层级，防止过度细分。</span><br/><span class="hl-8"> * - 场景: 数据本身层级过深，或者不需要看清极微小细节时，调大此值可显著节省性能。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">minGeometricError</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">/**</span><br/><span class="hl-8"> * 最大几何误差 (最低精度保证)</span><br/><span class="hl-8"> * 默认值: 10000</span><br/><span class="hl-8"> * 说明: 当瓦片的几何误差大于此值时，强制继续细分，直到误差小于此值。</span><br/><span class="hl-8"> * - 作用: 设定模型允许的最粗糙程度。</span><br/><span class="hl-8"> * - 场景: 无论相机距离多远，都希望模型至少保持一定的精细度（例如不希望看到过于简化的多边形）时，调小此值。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">maxGeometricError</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">// --- LOD 层级控制 (不推荐) ---</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 最小 LOD 层级</span><br/><span class="hl-8"> * 默认值: 0</span><br/><span class="hl-8"> * 说明: 限制加载的最小层级深度 (Tree Depth)。即小于此层级的瓦片（更粗糙的）不会被显示。</span><br/><span class="hl-8"> * - 建议: 推荐优先使用 maxGeometricError。两者都用于控制模型显示的“最粗糙”程度（下限）。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">minLevelOfDetail</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">/**</span><br/><span class="hl-8"> * 最大 LOD 层级</span><br/><span class="hl-8"> * 默认值: 20</span><br/><span class="hl-8"> * 说明: 限制加载的最大层级深度 (Tree Depth)。即大于此层级的瓦片（更精细的）不会被加载。</span><br/><span class="hl-8"> * - 建议: 推荐优先使用 minGeometricError。两者都用于控制模型显示的“最精细”程度（上限）。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">maxLevelOfDetail</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">// --- 剔除策略 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 视锥体剔除</span><br/><span class="hl-8"> * 默认值: true</span><br/><span class="hl-8"> * 说明: 是否不加载/渲染相机视锥体之外的瓦片。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">cameraCulling</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">/**</span><br/><span class="hl-8"> * 是否预加载兄弟节点</span><br/><span class="hl-8"> * 默认值: true</span><br/><span class="hl-8"> * 说明: 是否在加载当前瓦片时，同时预加载其兄弟节点（同一层级的其他瓦片）。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">loadSiblings</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 是否允许跳级加载</span><br/><span class="hl-8"> * 默认值: false</span><br/><span class="hl-8"> * 说明: 是否在加载当前瓦片时，允许跳级加载。</span><br/><span class="hl-8"> * - 作用: 在快速移动视角或直接跳转到深层级位置时，跳过中间层级的瓦片，直接加载目标精度的瓦片。</span><br/><span class="hl-8"> * - 场景: 倾斜摄影等外表面模型，为了减少请求数并加快最终形态的呈现（可能会看到明显的从空白到精细的跳变）。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">skipLevelOfDetail</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">// --- 网络并发控制 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 最大并发请求数</span><br/><span class="hl-8"> * 范围: 0 - 20</span><br/><span class="hl-8"> * 默认值: 4</span><br/><span class="hl-8"> * 说明: 同时进行的最大网络下载请求数。建议保持默认，过大可能阻塞主线程或导致拥堵。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">maxRequests</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">/**</span><br/><span class="hl-8"> * 请求优先级策略</span><br/><span class="hl-8"> * 默认值: &#39;SCREEN_SPACE_ERROR&#39;</span><br/><span class="hl-8"> * 选项:</span><br/><span class="hl-8"> * - &#39;SCREEN_SPACE_ERROR&#39;: 优先加载 SSE 最大的瓦片 (最影响视觉质量的部分)。</span><br/><span class="hl-8"> * - &#39;SCREEN_LEVEL_VERTICAL&#39;: 优先加载垂直方向层级较高的瓦片 (通常用于多楼层建筑，优先加载当前楼层)。</span><br/><span class="hl-8"> * - &#39;SCREEN_VERTICAL&#39;: 优先加载屏幕垂直方向的瓦片。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">requestOrder</span><span class="hl-1">: </span><span class="hl-9">&#39;SCREEN_SPACE_ERROR&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;SCREEN_LEVEL_VERTICAL&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;SCREEN_VERTICAL&#39;</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
10
+ <blockquote>
11
+ <p><strong>Definition</strong>: <a href="../../five/model/parameter.d.ts">ParameterTilesetValue</a></p>
12
+ </blockquote>
13
+ <p>以下是 <code>ParameterTilesetValue</code> 的 TypeScript 定义摘要：</p>
14
+ <pre><code class="typescript"><span class="hl-10">export</span><span class="hl-1"> </span><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">ParameterTilesetValue</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 屏幕空间误差阈值 (像素) */</span><br/><span class="hl-1"> </span><span class="hl-6">maxScreenSpaceError</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 最大显存占用 (MB) */</span><br/><span class="hl-1"> </span><span class="hl-6">maxMemoryUsage</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 最小几何误差 (精度上限锁) */</span><br/><span class="hl-1"> </span><span class="hl-6">minGeometricError</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">// ... 更多字段见下方配置表</span><br/><span class="hl-1">}</span>
11
15
  </code><button type="button">Copy</button></pre>
12
16
 
13
17
  <h2 id="concepts" class="tsd-anchor-link">Concepts<a href="#concepts" 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,32 +40,7 @@
36
40
  </ul>
37
41
  </li>
38
42
  </ul>
39
- <h3 id="3-并发控制-max-requests" class="tsd-anchor-link">3. 并发控制 (Max Requests)<a href="#3-并发控制-max-requests" 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>
40
- <p>为了平衡网络加载与渲染性能，3DTile 限制了最大并发请求数。</p>
41
- <ul>
42
- <li><strong>默认值</strong>: 4</li>
43
- <li><strong>建议</strong>: 保持默认值，避免设置过大导致网络拥堵。</li>
44
- <li><strong>影响</strong>: 增加并发数可能提升加载速度，但也会增加服务器压力。</li>
45
- </ul>
46
- <h3 id="4-格式支持-supported-formats" class="tsd-anchor-link">4. 格式支持 (Supported Formats)<a href="#4-格式支持-supported-formats" 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>
47
- <p>Five 的 3DTile 引擎支持多种 3D Tiles 1.0/1.1 规范的瓦片格式及主流压缩标准。</p>
48
- <ul>
49
- <li><strong>瓦片格式</strong>:
50
- <ul>
51
- <li><strong>B3DM (Batched 3D Model)</strong>: 传统的 3D Tiles 格式，用于建筑模型。</li>
52
- <li><strong>PNTS (Point Cloud)</strong>: 传统的点云格式。</li>
53
- <li><strong>GLB / GLTF</strong>: 3D Tiles 1.1 标准推荐的格式，支持 Mesh 和点云。</li>
54
- </ul>
55
- </li>
56
- <li><strong>压缩与优化</strong>:
57
- <ul>
58
- <li><strong><a href="https://google.github.io/draco/">Draco</a></strong>: 几何压缩，显著减小模型体积。</li>
59
- <li><strong><a href="https://github.com/zeux/meshoptimizer">Meshopt</a></strong>: 另一种高效的几何压缩算法。</li>
60
- <li><strong><a href="https://github.com/KhronosGroup/KTX-Software">KTX2</a> / <a href="https://github.com/BinomialLLC/basis_universal">BasisU</a></strong>: 纹理压缩，大幅降低显存占用并提升上传速度。</li>
61
- </ul>
62
- </li>
63
- </ul>
64
- <h3 id="5-viewlayer-与-3dtile" class="tsd-anchor-link">5. ViewLayer 与 3DTile<a href="#5-viewlayer-与-3dtile" 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
+ <h3 id="3-viewlayer-与-3dtile" class="tsd-anchor-link">3. ViewLayer 与 3DTile<a href="#3-viewlayer-与-3dtile" 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>
65
44
  <p>目前所有的 <code>ViewLayer</code> 在底层都是一个 <code>Tile3D</code> 实例。它们各自拥有独立的：</p>
66
45
  <ul>
67
46
  <li><strong>配置</strong>: <code>maxScreenSpaceError</code>, <code>maxMemoryUsage</code> 等参数互不干扰。</li>
@@ -70,21 +49,139 @@
70
49
  <blockquote>
71
50
  <p><strong>注意</strong>: 即使是通过 <code>file_url</code> 加载的单体模型（如 <code>.obj</code>, <code>.at3d</code>），在 Five 内部也会被封装为 <code>Tile3D</code> 实例进行统一管理。</p>
72
51
  </blockquote>
73
- <h3 id="6-lod-参数调整" class="tsd-anchor-link">6. Lod 参数调整<a href="#6-lod-参数调整" 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>
74
- <p>优先修改 <code>maxScreenSpaceError</code> 而不是 <code>minLevelOfDetail</code> <code>maxGeometricError</code>。 SSE 是更直接、更符合渲染逻辑的 LOD 控制指标，而 <code>minLevelOfDetail</code> <code>maxGeometricError</code> 更关注数据切片方式，容易引入错误的 LOD 决策。</p>
75
- <p>可以适当开启 <code>memoryAdjustedScreenSpaceError</code> 动态调整 SSE，以平衡画质与显存占用。但是同时，需要合理配置 <code>maxScreenSpaceError</code> 与 <code>maxMemoryUsage</code>，避免出现内存整体占用过高导致 Crash 问题。</p>
76
- <ul>
77
- <li><code>maxScreenSpaceError</code> 尽量设置较为大的值，比如 32 / 48，根据场景和设备性能调整。</li>
78
- <li><code>maxMemoryUsage</code> 建议根据设备显存和场景复杂度调整。</li>
79
- </ul>
80
- <p>在特定场景，比如 <strong>全景模式下</strong> 不需要很高清的模型，可以定义上限的 <code>maxLevelOfDetail</code> <code>minGeometricError</code> 来限制加载层级优化性能。</p>
52
+ <h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#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>
53
+ <p>以下表格列出了控制 3DTile 加载与性能调度的所有可用参数。</p>
54
+ <h3 id="core-quality-performance-核心画质与性能" class="tsd-anchor-link">Core Quality &amp; Performance (核心画质与性能)<a href="#core-quality-performance-核心画质与性能" 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>
55
+ <table>
56
+ <thead>
57
+ <tr>
58
+ <th style="text-align:left">Parameter</th>
59
+ <th style="text-align:left">Type</th>
60
+ <th style="text-align:left">Default</th>
61
+ <th style="text-align:left">Description</th>
62
+ </tr>
63
+ </thead>
64
+ <tbody>
65
+ <tr>
66
+ <td style="text-align:left"><code>maxScreenSpaceError</code></td>
67
+ <td style="text-align:left"><code>number</code></td>
68
+ <td style="text-align:left"><code>16</code></td>
69
+ <td style="text-align:left"><strong>核心参数</strong>。屏幕空间误差阈值 (像素)。<br>值越小画质越高，性能开销越大。建议范围 8-32。</td>
70
+ </tr>
71
+ <tr>
72
+ <td style="text-align:left"><code>maxMemoryUsage</code></td>
73
+ <td style="text-align:left"><code>number</code></td>
74
+ <td style="text-align:left"><code>512</code></td>
75
+ <td style="text-align:left">最大显存占用 (MB)。超限后自动触发 LRU 淘汰机制。</td>
76
+ </tr>
77
+ <tr>
78
+ <td style="text-align:left"><code>memoryAdjustedScreenSpaceError</code></td>
79
+ <td style="text-align:left"><code>boolean</code></td>
80
+ <td style="text-align:left"><code>false</code></td>
81
+ <td style="text-align:left">是否开启基于内存的动态 SSE 调整。<br>开启后引擎会自动调整 SSE 以尽量占满显存配额。</td>
82
+ </tr>
83
+ <tr>
84
+ <td style="text-align:left"><code>cameraCulling</code></td>
85
+ <td style="text-align:left"><code>boolean</code></td>
86
+ <td style="text-align:left"><code>true</code></td>
87
+ <td style="text-align:left">是否开启视锥体剔除 (不加载视野外的瓦片)。<strong>建议始终开启</strong>。</td>
88
+ </tr>
89
+ </tbody>
90
+ </table>
91
+ <h3 id="geometric-error-control-几何误差控制" class="tsd-anchor-link">Geometric Error Control (几何误差控制)<a href="#geometric-error-control-几何误差控制" 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>
92
+ <table>
93
+ <thead>
94
+ <tr>
95
+ <th style="text-align:left">Parameter</th>
96
+ <th style="text-align:left">Type</th>
97
+ <th style="text-align:left">Default</th>
98
+ <th style="text-align:left">Description</th>
99
+ </tr>
100
+ </thead>
101
+ <tbody>
102
+ <tr>
103
+ <td style="text-align:left"><code>minGeometricError</code></td>
104
+ <td style="text-align:left"><code>number</code></td>
105
+ <td style="text-align:left"><code>0</code></td>
106
+ <td style="text-align:left">最小几何误差 (精度上限锁)。<br>当瓦片误差小于此值时停止细分。可用于限制过高精度的加载。</td>
107
+ </tr>
108
+ <tr>
109
+ <td style="text-align:left"><code>maxGeometricError</code></td>
110
+ <td style="text-align:left"><code>number</code></td>
111
+ <td style="text-align:left"><code>10000</code></td>
112
+ <td style="text-align:left">最大几何误差 (最低精度保证)。<br>强制细分直到误差小于此值。可用于避免模型过于模糊。</td>
113
+ </tr>
114
+ </tbody>
115
+ </table>
116
+ <h3 id="network-loading-网络与加载" class="tsd-anchor-link">Network &amp; Loading (网络与加载)<a href="#network-loading-网络与加载" 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>
117
+ <table>
118
+ <thead>
119
+ <tr>
120
+ <th style="text-align:left">Parameter</th>
121
+ <th style="text-align:left">Type</th>
122
+ <th style="text-align:left">Default</th>
123
+ <th style="text-align:left">Description</th>
124
+ </tr>
125
+ </thead>
126
+ <tbody>
127
+ <tr>
128
+ <td style="text-align:left"><code>maxRequests</code></td>
129
+ <td style="text-align:left"><code>number</code></td>
130
+ <td style="text-align:left"><code>4</code></td>
131
+ <td style="text-align:left">最大并发请求数。建议保持默认，避免网络拥堵。</td>
132
+ </tr>
133
+ <tr>
134
+ <td style="text-align:left"><code>requestOrder</code></td>
135
+ <td style="text-align:left"><code>string</code></td>
136
+ <td style="text-align:left"><code>'SCREEN_SPACE_ERROR'</code></td>
137
+ <td style="text-align:left">请求优先级策略。<br><code>'SCREEN_SPACE_ERROR'</code>: 优先加载 SSE 大的瓦片；<br><code>'SCREEN_LEVEL_VERTICAL'</code>: 优先加载垂直层级高的。</td>
138
+ </tr>
139
+ <tr>
140
+ <td style="text-align:left"><code>loadSiblings</code></td>
141
+ <td style="text-align:left"><code>boolean</code></td>
142
+ <td style="text-align:left"><code>true</code></td>
143
+ <td style="text-align:left">是否预加载兄弟节点。</td>
144
+ </tr>
145
+ <tr>
146
+ <td style="text-align:left"><code>skipLevelOfDetail</code></td>
147
+ <td style="text-align:left"><code>boolean</code></td>
148
+ <td style="text-align:left"><code>false</code></td>
149
+ <td style="text-align:left">是否允许跳级加载 (跳过中间层级直接加载高精瓦片)。</td>
150
+ </tr>
151
+ </tbody>
152
+ </table>
153
+ <h3 id="legacy-lod-control-不推荐" class="tsd-anchor-link">Legacy LOD Control (不推荐)<a href="#legacy-lod-control-不推荐" 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>
154
+ <table>
155
+ <thead>
156
+ <tr>
157
+ <th style="text-align:left">Parameter</th>
158
+ <th style="text-align:left">Type</th>
159
+ <th style="text-align:left">Default</th>
160
+ <th style="text-align:left">Description</th>
161
+ </tr>
162
+ </thead>
163
+ <tbody>
164
+ <tr>
165
+ <td style="text-align:left"><code>minLevelOfDetail</code></td>
166
+ <td style="text-align:left"><code>number</code></td>
167
+ <td style="text-align:left"><code>0</code></td>
168
+ <td style="text-align:left">最小 LOD 层级 (Tree Depth)。建议使用 <code>maxGeometricError</code> 替代。</td>
169
+ </tr>
170
+ <tr>
171
+ <td style="text-align:left"><code>maxLevelOfDetail</code></td>
172
+ <td style="text-align:left"><code>number</code></td>
173
+ <td style="text-align:left"><code>20</code></td>
174
+ <td style="text-align:left">最大 LOD 层级 (Tree Depth)。建议使用 <code>minGeometricError</code> 替代。</td>
175
+ </tr>
176
+ </tbody>
177
+ </table>
81
178
  <h2 id="examples" class="tsd-anchor-link">Examples<a href="#examples" 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>
82
- <h3 id="调整画质与内存平衡" class="tsd-anchor-link">调整画质与内存平衡<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>
179
+ <h3 id="1-adjusting-quality-memory-调整画质与内存平衡" class="tsd-anchor-link">1. Adjusting Quality &amp; Memory (调整画质与内存平衡)<a href="#1-adjusting-quality-memory-调整画质与内存平衡" 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>
83
180
  <p>在移动端或性能受限设备上，建议适当降低画质以保证流畅度。</p>
84
181
  <pre><code class="typescript"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">parameter</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// 1. 性能优先模式 (适用于低端设备)</span><br/><span class="hl-8">// 增大 SSE 阈值，降低画质</span><br/><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxScreenSpaceError&#39;</span><span class="hl-1">, </span><span class="hl-11">16</span><span class="hl-1">);</span><br/><span class="hl-8">// 限制显存，防止 Crash</span><br/><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxMemoryUsage&#39;</span><span class="hl-1">, </span><span class="hl-11">256</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 2. 画质优先模式 (适用于桌面端/截图)</span><br/><span class="hl-8">// 减小 SSE 阈值，提升细节</span><br/><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxScreenSpaceError&#39;</span><span class="hl-1">, </span><span class="hl-11">4</span><span class="hl-1">);</span><br/><span class="hl-8">// 允许更多显存占用</span><br/><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxMemoryUsage&#39;</span><span class="hl-1">, </span><span class="hl-11">1024</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 3. 重置为默认</span><br/><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">reset</span><span class="hl-1">(</span><span class="hl-9">&#39;maxScreenSpaceError&#39;</span><span class="hl-1">, </span><span class="hl-9">&#39;maxMemoryUsage&#39;</span><span class="hl-1">);</span>
85
182
  </code><button type="button">Copy</button></pre>
86
183
 
87
- <h3 id="多-viewlayer-优化" class="tsd-anchor-link">多 ViewLayer 优化<a href="#多-viewlayer-优化" 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>
184
+ <h3 id="2-multi-viewlayer-optimization-多-viewlayer-优化" class="tsd-anchor-link">2. Multi-ViewLayer Optimization (多 ViewLayer 优化)<a href="#2-multi-viewlayer-optimization-多-viewlayer-优化" 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>
88
185
  <p>在对比查看或多楼层场景中，通常存在多个 <code>ViewLayer</code>。为了避免资源竞争，建议对非焦点的 ViewLayer 进行降级处理。</p>
89
186
  <pre><code class="typescript"><span class="hl-8">// 假设 viewLayerA 是当前主要查看的模型，viewLayerB 是背景参考</span><br/><br/><span class="hl-8">// 聚焦 ViewLayerA: 正常画质</span><br/><span class="hl-6">viewLayerA</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">reset</span><span class="hl-1">(</span><span class="hl-9">&#39;maxScreenSpaceError&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 降级 ViewLayerB: 仅显示轮廓，节省资源</span><br/><span class="hl-6">viewLayerB</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxScreenSpaceError&#39;</span><span class="hl-1">, </span><span class="hl-11">48</span><span class="hl-1">); </span><span class="hl-8">// 极低画质</span><br/><span class="hl-6">viewLayerB</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxMemoryUsage&#39;</span><span class="hl-1">, </span><span class="hl-11">128</span><span class="hl-1">); </span><span class="hl-8">// 极低显存配额</span>
90
187
  </code><button type="button">Copy</button></pre>
@@ -108,12 +205,12 @@
108
205
  </ol>
109
206
  <h2 id="related" class="tsd-anchor-link">Related<a href="#related" 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>
110
207
  <ul>
111
- <li><a href="features_parameter.html">parameter.md</a>: 了解参数的继承关系及材质、点云相关配置。</li>
112
- <li><a href="features_model.html">model.md</a>: 了解 Model 和 ViewLayer 的关系。</li>
113
- <li><a href="features_work.html">work.md</a>: 了解 Work 数据结构。</li>
208
+ <li><a href="features_parameter.html">Parameter</a>: 了解参数的继承关系及材质、点云相关配置。</li>
209
+ <li><a href="features_model.html">Model</a>: 了解 Model 和 ViewLayer 的关系。</li>
210
+ <li><a href="features_work.html">Work</a>: 了解 Work 数据结构。</li>
114
211
  </ul>
115
212
  <hr>
116
213
  <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">3dtile</span><span class="hl-1">, </span><span class="hl-2">viewLayer</span><span class="hl-1">, </span><span class="hl-2">performance</span><span class="hl-1">, </span><span class="hl-2">lod</span><span class="hl-1">, </span><span class="hl-2">optimization</span><span class="hl-1">]</span>
117
214
  </code><button type="button">Copy</button></pre>
118
215
 
119
- </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="#3dtile"><span>3<wbr/>D<wbr/>Tile</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#1-lod-screen-space-error-sse"><span>1. <wbr/>LOD &amp; <wbr/>Screen <wbr/>Space <wbr/>Error (<wbr/>SSE)</span></a></li><li><a href="#2-显存管理-cache-management"><span>2. 显存管理 (<wbr/>Cache <wbr/>Management)</span></a></li><li><a href="#3-并发控制-max-requests"><span>3. 并发控制 (<wbr/>Max <wbr/>Requests)</span></a></li><li><a href="#4-格式支持-supported-formats"><span>4. 格式支持 (<wbr/>Supported <wbr/>Formats)</span></a></li><li><a href="#5-viewlayer-与-3dtile"><span>5. <wbr/>View<wbr/>Layer 与 3<wbr/>D<wbr/>Tile</span></a></li><li><a href="#6-lod-参数调整"><span>6. <wbr/>Lod 参数调整</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#调整画质与内存平衡"><span>调整画质与内存平衡</span></a></li><li><a href="#多-viewlayer-优化"><span>多 <wbr/>View<wbr/>Layer 优化</span></a></li></ul></li><li><a href="#debugging"><span>Debugging</span></a></li><li><a href="#common-pitfalls"><span>Common <wbr/>Pitfalls</span></a></li><li><a href="#related"><span>Related</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>
216
+ </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="#3dtile-3d-瓦片"><span>3<wbr/>D<wbr/>Tile (3<wbr/>D 瓦片)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#1-lod-screen-space-error-sse"><span>1. <wbr/>LOD &amp; <wbr/>Screen <wbr/>Space <wbr/>Error (<wbr/>SSE)</span></a></li><li><a href="#2-显存管理-cache-management"><span>2. 显存管理 (<wbr/>Cache <wbr/>Management)</span></a></li><li><a href="#3-viewlayer-与-3dtile"><span>3. <wbr/>View<wbr/>Layer 与 3<wbr/>D<wbr/>Tile</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><ul><li><a href="#core-quality-performance-核心画质与性能"><span>Core <wbr/>Quality &amp; <wbr/>Performance (核心画质与性能)</span></a></li><li><a href="#geometric-error-control-几何误差控制"><span>Geometric <wbr/>Error <wbr/>Control (几何误差控制)</span></a></li><li><a href="#network-loading-网络与加载"><span>Network &amp; <wbr/>Loading (网络与加载)</span></a></li><li><a href="#legacy-lod-control-不推荐"><span>Legacy <wbr/>LOD <wbr/>Control (不推荐)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-adjusting-quality-memory-调整画质与内存平衡"><span>1. <wbr/>Adjusting <wbr/>Quality &amp; <wbr/>Memory (调整画质与内存平衡)</span></a></li><li><a href="#2-multi-viewlayer-optimization-多-viewlayer-优化"><span>2. <wbr/>Multi-<wbr/>View<wbr/>Layer <wbr/>Optimization (多 <wbr/>View<wbr/>Layer 优化)</span></a></li></ul></li><li><a href="#debugging"><span>Debugging</span></a></li><li><a href="#common-pitfalls"><span>Common <wbr/>Pitfalls</span></a></li><li><a href="#related"><span>Related</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/features_camera-animation.html CHANGED
@@ -8,8 +8,11 @@
8
8
  </ul>
9
9
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
10
10
  <h3 id="movepanooptions" class="tsd-anchor-link">MovePanoOptions<a href="#movepanooptions" 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>
11
+ <blockquote>
12
+ <p><strong>Definition</strong>: <a href="../../five/types/movePanoOptions.d.ts">MovePanoOptions</a></p>
13
+ </blockquote>
11
14
  <p>点位移动参数配置。</p>
12
- <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">MovePanoOptions</span><span class="hl-1"> </span><span class="hl-3">extends</span><span class="hl-1"> </span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">Omit</span><span class="hl-1">&lt;</span><span class="hl-7">State</span><span class="hl-1">, </span><span class="hl-9">&quot;offset&quot;</span><span class="hl-1"> | </span><span class="hl-9">&#39;distance&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;mode&#39;</span><span class="hl-1">&gt;&gt; {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 动画效果: &#39;fly&#39; | &#39;fade&#39; | &#39;instant&#39; ... */</span><br/><span class="hl-1"> </span><span class="hl-6">effect</span><span class="hl-1">?: </span><span class="hl-7">MovePanoEffect</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 走点图片过度策略 */</span><br/><span class="hl-1"> </span><span class="hl-5">effectEasing</span><span class="hl-1">?: (</span><span class="hl-6">progress</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动耗时 (ms) */</span><br/><span class="hl-1"> </span><span class="hl-6">duration</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动开始回调 */</span><br/><span class="hl-1"> </span><span class="hl-5">moveStartCallback</span><span class="hl-1">?: (</span><span class="hl-6">toState</span><span class="hl-1">: </span><span class="hl-7">State</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动结束回调 */</span><br/><span class="hl-1"> </span><span class="hl-5">moveEndCallback</span><span class="hl-1">?: (</span><span class="hl-6">state</span><span class="hl-1">: </span><span class="hl-7">State</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动被取消回调 */</span><br/><span class="hl-1"> </span><span class="hl-5">moveCancelCallback</span><span class="hl-1">?: () </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
15
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">MovePanoOptions</span><span class="hl-1"> </span><span class="hl-3">extends</span><span class="hl-1"> </span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">Omit</span><span class="hl-1">&lt;</span><span class="hl-7">State</span><span class="hl-1">, </span><span class="hl-9">&quot;offset&quot;</span><span class="hl-1"> | </span><span class="hl-9">&#39;distance&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;mode&#39;</span><span class="hl-1">&gt;&gt; {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 动画效果: &#39;fly&#39; | &#39;fade&#39; | &#39;instant&#39; ... */</span><br/><span class="hl-1"> </span><span class="hl-6">effect</span><span class="hl-1">?: </span><span class="hl-7">MovePanoEffect</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 走点图片过度策略 */</span><br/><span class="hl-1"> </span><span class="hl-5">effectEasing</span><span class="hl-1">?: (</span><span class="hl-6">progress</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 运动耗时 (ms)</span><br/><span class="hl-8"> * - number: 固定时长</span><br/><span class="hl-8"> * - function: (distance, speed) =&gt; number 根据距离动态计算</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">duration</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | ((</span><span class="hl-6">distance</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">, </span><span class="hl-6">speed</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">number</span><span class="hl-1">) | </span><span class="hl-7">string</span><span class="hl-1"> | </span><span class="hl-7">null</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动开始回调 */</span><br/><span class="hl-1"> </span><span class="hl-5">moveStartCallback</span><span class="hl-1">?: (</span><span class="hl-6">toState</span><span class="hl-1">: </span><span class="hl-7">State</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动结束回调 */</span><br/><span class="hl-1"> </span><span class="hl-5">moveEndCallback</span><span class="hl-1">?: (</span><span class="hl-6">state</span><span class="hl-1">: </span><span class="hl-7">State</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 运动被取消回调 */</span><br/><span class="hl-1"> </span><span class="hl-5">moveCancelCallback</span><span class="hl-1">?: () </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
13
16
  </code><button type="button">Copy</button></pre>
14
17
 
15
18
  <h3 id="movepanoeffect" class="tsd-anchor-link">MovePanoEffect<a href="#movepanoeffect" 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,10 +60,64 @@
57
60
  <li><strong>Fade (渐变)</strong>: 保持相机位置不变，通过透明度渐变切换场景。适用于距离较远或不通视的点位切换。</li>
58
61
  </ul>
59
62
  <h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#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>
63
+ <h3 id="global-configuration-全局配置" class="tsd-anchor-link">Global Configuration (全局配置)<a href="#global-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></h3>
60
64
  <p>在 <code>new Five(config)</code> 初始化时可以设置全局动画参数：</p>
61
- <ul>
62
- <li><code>modeChangeDuration</code>: 模态切换 (如 Panorama -&gt; Mapview) 的默认时长 (ms)。默认为 1000ms。</li>
63
- </ul>
65
+ <table>
66
+ <thead>
67
+ <tr>
68
+ <th style="text-align:left">Parameter</th>
69
+ <th style="text-align:left">Type</th>
70
+ <th style="text-align:left">Default</th>
71
+ <th style="text-align:left">Description</th>
72
+ </tr>
73
+ </thead>
74
+ <tbody>
75
+ <tr>
76
+ <td style="text-align:left"><code>modeChangeDuration</code></td>
77
+ <td style="text-align:left"><code>number</code></td>
78
+ <td style="text-align:left"><code>1000</code></td>
79
+ <td style="text-align:left">模态切换 (如 Panorama -&gt; Mapview) 的默认时长 (ms)。</td>
80
+ </tr>
81
+ </tbody>
82
+ </table>
83
+ <h3 id="movepanooptions-configuration-移动参数" class="tsd-anchor-link">MovePanoOptions Configuration (移动参数)<a href="#movepanooptions-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></h3>
84
+ <p>调用 <code>five.moveToPano(index, options)</code> 时使用的配置参数：</p>
85
+ <table>
86
+ <thead>
87
+ <tr>
88
+ <th style="text-align:left">Parameter</th>
89
+ <th style="text-align:left">Type</th>
90
+ <th style="text-align:left">Default</th>
91
+ <th style="text-align:left">Description</th>
92
+ </tr>
93
+ </thead>
94
+ <tbody>
95
+ <tr>
96
+ <td style="text-align:left"><code>effect</code></td>
97
+ <td style="text-align:left"><code>MovePanoEffect</code></td>
98
+ <td style="text-align:left"><code>'fly'</code></td>
99
+ <td style="text-align:left">动画效果。<br><code>'fly'</code>: 空间移动（模拟行走）；<br><code>'fade'</code>: 淡入淡出（保持位置不变）；<br><code>'instant'</code>: 瞬间跳转。</td>
100
+ </tr>
101
+ <tr>
102
+ <td style="text-align:left"><code>duration</code></td>
103
+ <td style="text-align:left"><code>number</code> | <code>Function</code></td>
104
+ <td style="text-align:left">-</td>
105
+ <td style="text-align:left">动画时长 (ms)。若不传，则根据距离和速度自动计算。</td>
106
+ </tr>
107
+ <tr>
108
+ <td style="text-align:left"><code>effectEasing</code></td>
109
+ <td style="text-align:left"><code>Function</code></td>
110
+ <td style="text-align:left">-</td>
111
+ <td style="text-align:left">自定义过渡效果的缓动函数。</td>
112
+ </tr>
113
+ <tr>
114
+ <td style="text-align:left"><code>moveEndCallback</code></td>
115
+ <td style="text-align:left"><code>Function</code></td>
116
+ <td style="text-align:left">-</td>
117
+ <td style="text-align:left">动画结束后的回调函数。</td>
118
+ </tr>
119
+ </tbody>
120
+ </table>
64
121
  <h2 id="examples" class="tsd-anchor-link">Examples<a href="#examples" 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>
65
122
  <h3 id="1-旋转视角-rotate-camera" class="tsd-anchor-link">1. 旋转视角 (Rotate Camera)<a href="#1-旋转视角-rotate-camera" 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>
66
123
  <p>平滑旋转到指定角度。</p>
@@ -97,4 +154,4 @@
97
154
  <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">camera-animation</span><span class="hl-1">, </span><span class="hl-2">pose</span><span class="hl-1">, </span><span class="hl-2">state</span><span class="hl-1">]</span>
98
155
  </code><button type="button">Copy</button></pre>
99
156
 
100
- </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="#相机动画-camera-animation"><span>相机动画 (<wbr/>Camera <wbr/>Animation)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#movepanooptions"><span>Move<wbr/>Pano<wbr/>Options</span></a></li><li><a href="#movepanoeffect"><span>Move<wbr/>Pano<wbr/>Effect</span></a></li></ul></li><li><a href="#core-methods-核心方法"><span>Core <wbr/>Methods (核心方法)</span></a></li><li><ul><li><a href="#1-setstate"><span>1. set<wbr/>State</span></a></li><li><a href="#2-movetopano"><span>2. move<wbr/>To<wbr/>Pano</span></a></li><li><a href="#3-changemode"><span>3. change<wbr/>Mode</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#pose-位姿"><span>Pose (位姿)</span></a></li><li><a href="#animation-effects-动画效果"><span>Animation <wbr/>Effects (动画效果)</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-旋转视角-rotate-camera"><span>1. 旋转视角 (<wbr/>Rotate <wbr/>Camera)</span></a></li><li><a href="#2-切换全景点-change-pano"><span>2. 切换全景点 (<wbr/>Change <wbr/>Pano)</span></a></li><li><a href="#3-模态切换-change-mode"><span>3. 模态切换 (<wbr/>Change <wbr/>Mode)</span></a></li><li><a href="#4-自动巡更-auto-tour"><span>4. 自动巡更 (<wbr/>Auto <wbr/>Tour)</span></a></li></ul></li><li><a href="#common-pitfalls"><span>Common <wbr/>Pitfalls</span></a></li><li><a href="#related"><span>Related</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>
157
+ </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="#相机动画-camera-animation"><span>相机动画 (<wbr/>Camera <wbr/>Animation)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#movepanooptions"><span>Move<wbr/>Pano<wbr/>Options</span></a></li><li><a href="#movepanoeffect"><span>Move<wbr/>Pano<wbr/>Effect</span></a></li></ul></li><li><a href="#core-methods-核心方法"><span>Core <wbr/>Methods (核心方法)</span></a></li><li><ul><li><a href="#1-setstate"><span>1. set<wbr/>State</span></a></li><li><a href="#2-movetopano"><span>2. move<wbr/>To<wbr/>Pano</span></a></li><li><a href="#3-changemode"><span>3. change<wbr/>Mode</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#pose-位姿"><span>Pose (位姿)</span></a></li><li><a href="#animation-effects-动画效果"><span>Animation <wbr/>Effects (动画效果)</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><ul><li><a href="#global-configuration-全局配置"><span>Global <wbr/>Configuration (全局配置)</span></a></li><li><a href="#movepanooptions-configuration-移动参数"><span>Move<wbr/>Pano<wbr/>Options <wbr/>Configuration (移动参数)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-旋转视角-rotate-camera"><span>1. 旋转视角 (<wbr/>Rotate <wbr/>Camera)</span></a></li><li><a href="#2-切换全景点-change-pano"><span>2. 切换全景点 (<wbr/>Change <wbr/>Pano)</span></a></li><li><a href="#3-模态切换-change-mode"><span>3. 模态切换 (<wbr/>Change <wbr/>Mode)</span></a></li><li><a href="#4-自动巡更-auto-tour"><span>4. 自动巡更 (<wbr/>Auto <wbr/>Tour)</span></a></li></ul></li><li><a href="#common-pitfalls"><span>Common <wbr/>Pitfalls</span></a></li><li><a href="#related"><span>Related</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/features_clipper.html CHANGED
@@ -7,6 +7,9 @@
7
7
  <li><strong>Examples</strong>: 创建裁切盒并应用。</li>
8
8
  </ul>
9
9
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
10
+ <blockquote>
11
+ <p><strong>Definition</strong>: <a href="../../five/model/materials/pbmMaterial.d.ts">PBMClipperParameter</a></p>
12
+ </blockquote>
10
13
  <pre><code class="typescript"><span class="hl-8">/** 模型裁切参数 */</span><br/><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">PBMClipperParameter</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 裁切盒的变换矩阵。</span><br/><span class="hl-8"> * </span><span class="hl-3">@description</span><br/><span class="hl-8"> * 定义了一个变换后的立方体空间。</span><br/><span class="hl-8"> * 基础形状为边长为 1 的立方体，中心在 (0,0,0)，范围 [-0.5, 0.5]。</span><br/><span class="hl-8"> * 凡是落在这个变换后立方体内部的模型点，都会被丢弃 (discard)。</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">clippingBoxMatrix</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><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * (可选) 楼层索引。</span><br/><span class="hl-8"> * </span><span class="hl-3">@description</span><br/><span class="hl-8"> * 如果指定，则裁切仅对该楼层的点云生效。</span><br/><span class="hl-8"> * 如果未指定 (undefined)，则对所有楼层生效。</span><br/><span class="hl-8"> */</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><br/><span class="hl-1">}</span>
11
14
  </code><button type="button">Copy</button></pre>
12
15
 
package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} RENAMED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/coordnate-system | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/coordnate-system</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="坐标系-coordinate-system" class="tsd-anchor-link">坐标系 (Coordinate System)<a href="#坐标系-coordinate-system" 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>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/coordinate-system | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/coordinate-system</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="坐标系-coordinate-system" class="tsd-anchor-link">坐标系 (Coordinate System)<a href="#坐标系-coordinate-system" 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>
2
2
  <ul>
3
3
  <li><strong>Summary</strong>: 详解 Five 中的坐标系定义（Local, ENU, ECEF）及其相互转换关系。</li>
4
4
  <li><strong>Concepts</strong>: Local (Y-up), ENU (Z-up), ECEF, ENU84, RootMeta, Observers.</li>
@@ -6,6 +6,9 @@
6
6
  <li><strong>Examples</strong>: 坐标转换方法示例。</li>
7
7
  </ul>
8
8
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
9
+ <blockquote>
10
+ <p><strong>Definition</strong>: <a href="../../five/model/tile3d/header.d.ts">TilesetHeader</a></p>
11
+ </blockquote>
9
12
  <h3 id="rootmeta" class="tsd-anchor-link">RootMeta<a href="#rootmeta" 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>
10
13
  <p>3D Tiles <code>rootMeta</code> 字段中定义的坐标系元数据。</p>
11
14
  <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">RootMeta</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 模型垂直轴向 (如 &quot;Z&quot;, &quot;-Y&quot;) */</span><br/><span class="hl-1"> </span><span class="hl-6">upAxis</span><span class="hl-1">?: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 坐标系转换矩阵信息 */</span><br/><span class="hl-1"> </span><span class="hl-6">coordinate</span><span class="hl-1">?: </span><span class="hl-7">Coordinate</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
package/docs/documents/features_event.html CHANGED
@@ -6,6 +6,9 @@
6
6
  <li><strong>Examples</strong>: 监听全景移动、手势交互及状态变更。</li>
7
7
  </ul>
8
8
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
9
+ <blockquote>
10
+ <p><strong>Definition</strong>: <a href="../../five/application/five.d.ts">Five</a>, <a href="../../five/application/events.d.ts">EventTypes</a></p>
11
+ </blockquote>
9
12
  <p>Five 实例提供了以下方法来管理事件监听：</p>
10
13
  <h3 id="on" class="tsd-anchor-link">on<a href="#on" 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>
11
14
  <p>注册持久化事件监听器。</p>
package/docs/documents/features_five.html CHANGED
@@ -8,6 +8,9 @@
8
8
  </ul>
9
9
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
10
10
  <h3 id="fiveinitargs" class="tsd-anchor-link">FiveInitArgs<a href="#fiveinitargs" 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>
11
+ <blockquote>
12
+ <p><strong>Definition</strong>: <a href="../../five/application/fiveInitArgs.d.ts">FiveInitArgs</a></p>
13
+ </blockquote>
11
14
  <p><code>new Five(args)</code> 的初始化参数对象。</p>
12
15
  <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">/** 外部传入的渲染器 (如果传入，部分渲染配置将失效) */</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/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 屏幕渲染区域 { left, bottom, width, height }</span><br/><span class="hl-8"> * 必须配合外部 renderer 使用</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">viewport</span><span class="hl-1">?: </span><span class="hl-7">Viewport</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 背景颜色 (默认 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/><span class="hl-1"> </span><span class="hl-8">/** 背景透明度 (0-1, 默认 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/><span class="hl-1"> </span><span class="hl-8">/** 是否开启抗锯齿 (默认 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/><span class="hl-1"> </span><span class="hl-8">/** 全景图配置 (见 image-options.md) */</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/><span class="hl-1"> </span><span class="hl-8">/** 贴图配置 (见 image-options.md) */</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><span class="hl-8">/** 是否按需渲染 (默认 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/><span class="hl-1"> </span><span class="hl-8">/** 模式切换动画时长 (ms, 默认 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/><span class="hl-1"> </span><span class="hl-8">/** 是否支持滚轮缩放 (默认 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/><span class="hl-1"> </span><span class="hl-8">/** 插件列表 */</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/><span class="hl-1"> </span><span class="hl-8">/** 是否显示 Powered by Realsee */</span><br/><span class="hl-1"> </span><span class="hl-6">poweredByRealsee</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
13
16
  </code><button type="button">Copy</button></pre>
@@ -112,6 +115,7 @@
112
115
  <li><strong><code>updateCameraWithKeyframes(keyframes: { progress: number; value: Pose; key?: string }[], duration: number, userAction?: boolean)</code></strong>: 通过关键帧动画移动相机。</li>
113
116
  <li><strong><code>refresh()</code></strong>: 强制刷新画布尺寸。通常在窗口 resize 时调用，Five 会自动监听 resize，但在某些布局变化场景下可能需要手动调用。</li>
114
117
  <li><strong><code>getPixels(x, y, width, height, ...)</code> / <code>getPixels(options)</code></strong>: 获取画布指定区域的像素数据。常用于截图、生成缩略图或颜色拾取。支持配置区域、像素比 (pixelRatio)、Y轴翻转 (flipY) 及是否忽略全景图 (skipPanorama) 等。</li>
118
+ <li><strong><code>project2d(vector: THREE.Vector3, testModel?: boolean): THREE.Vector2 | null</code></strong>: 计算三维坐标对应到屏幕的二维坐标。如果坐标在视野外或被遮挡（开启 testModel 时），返回 null。详见 <a href="features_screen-project.html">screen-project.md</a>。</li>
115
119
  <li><strong><code>ready(args?: { tile?: boolean })</code></strong>: Promise，当 Five 状态稳定时 resolve。
116
120
  <ul>
117
121
  <li><strong>Resolve 时机</strong>：