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

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 (1138) hide show
  1. package/AGENTS_READ_ME.md +4 -0
  2. package/AI_CONTEXT.md +4 -0
  3. package/README.md +64 -13
  4. package/ai_guides/README.md +122 -0
  5. package/ai_guides/ai-doc-guidelines.md +102 -0
  6. package/ai_guides/api.md +274 -0
  7. package/ai_guides/features/3dtile.md +172 -0
  8. package/ai_guides/features/camera-animation.md +205 -0
  9. package/ai_guides/features/clipper.md +135 -0
  10. package/ai_guides/features/coordinate-system.md +128 -0
  11. package/ai_guides/features/event.md +154 -0
  12. package/ai_guides/features/five.md +184 -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/ai_guides/features/gesture.md +180 -0
  17. package/ai_guides/features/get-screen-pixels.md +182 -0
  18. package/ai_guides/features/image-options.md +164 -0
  19. package/ai_guides/features/load-external-model.md +350 -0
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +151 -0
  22. package/ai_guides/features/mode.md +269 -0
  23. package/ai_guides/features/model.md +186 -0
  24. package/ai_guides/features/move-pano-effect.md +145 -0
  25. package/ai_guides/features/multi-work.md +146 -0
  26. package/ai_guides/features/pano-tile.md +132 -0
  27. package/ai_guides/features/pano-uv.md +131 -0
  28. package/ai_guides/features/parameter.md +153 -0
  29. package/ai_guides/features/plugin.md +210 -0
  30. package/ai_guides/features/postprocessing.md +259 -0
  31. package/ai_guides/features/raycast.md +175 -0
  32. package/ai_guides/features/request-proxy.md +112 -0
  33. package/ai_guides/features/screen-project.md +165 -0
  34. package/ai_guides/features/state.md +101 -0
  35. package/ai_guides/features/view-layer.md +187 -0
  36. package/ai_guides/features/work.md +303 -0
  37. package/ai_guides/glossary.md +93 -0
  38. package/ai_guides/intro.md +23 -0
  39. package/ai_guides/quick-start.md +69 -0
  40. package/ai_guides/release_notes/6.6.md +86 -0
  41. package/ai_guides/release_notes/6.7.md +401 -0
  42. package/ai_guides/release_notes/6.8.md +90 -0
  43. package/ai_guides/support.md +23 -0
  44. package/ai_guides/template.md +70 -0
  45. package/docs/00_FOR_AI_AGENTS.md +11 -0
  46. package/docs/README.md +11 -0
  47. package/docs/assets/hierarchy.js +1 -1
  48. package/docs/assets/highlight.css +33 -19
  49. package/docs/assets/navigation.js +1 -1
  50. package/docs/assets/search.js +1 -1
  51. package/docs/classes/five.AdaptiveLuminancePass.html +1 -1
  52. package/docs/classes/five.BoundingMesh.html +1 -1
  53. package/docs/classes/five.Camera.html +1 -1
  54. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  55. package/docs/classes/five.Five.html +75 -81
  56. package/docs/classes/five.FivePass.html +1 -1
  57. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  58. package/docs/classes/five.Model.html +32 -32
  59. package/docs/classes/five.ModelScene.html +1 -1
  60. package/docs/classes/five.NetworkSubscribe.html +2 -2
  61. package/docs/classes/five.PBMContainer.html +1 -1
  62. package/docs/classes/five.PBMGSObject.html +14 -12
  63. package/docs/classes/five.PBMGroup.html +1 -1
  64. package/docs/classes/five.PBMMesh.html +1 -1
  65. package/docs/classes/five.PBMMeshMaterial.html +15 -6
  66. package/docs/classes/five.PBMPointCloud.html +1 -1
  67. package/docs/classes/five.PBMPointCloudMaterial.html +1 -1
  68. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  69. package/docs/classes/five.PanoCircleMesh.html +1 -1
  70. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  71. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  72. package/docs/classes/five.Parameter.html +54 -50
  73. package/docs/classes/five.Scene.html +1 -1
  74. package/docs/classes/five.Subscribe.html +2 -2
  75. package/docs/classes/five.Tile.html +1 -1
  76. package/docs/classes/five.Tile3D.html +30 -26
  77. package/docs/classes/five.TileNode.html +1 -1
  78. package/docs/classes/five.Trajectory.html +1 -1
  79. package/docs/classes/five.TrajectoryNode.html +1 -1
  80. package/docs/classes/five.Work.html +16 -16
  81. package/docs/classes/five.WorkResolvedObserver.html +28 -3
  82. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  83. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  84. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  85. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  86. package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
  87. package/docs/classes/line.Line.html +1 -1
  88. package/docs/classes/line.LineGeometry.html +1 -1
  89. package/docs/classes/line.LineMaterial.html +1 -1
  90. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  91. package/docs/classes/line.THREE_Line2.html +1 -1
  92. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  93. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  94. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  95. package/docs/classes/react.Store.html +1 -1
  96. package/docs/classes/sticker.Sticker.html +2 -2
  97. package/docs/classes/vfx.Airflow.html +1 -1
  98. package/docs/classes/vfx.Flame.html +1 -1
  99. package/docs/classes/vfx.Particle.html +1 -1
  100. package/docs/classes/vfx.ParticleGPU.html +1 -1
  101. package/docs/classes/vfx.SpotLight.html +1 -1
  102. package/docs/documents/README.html +138 -0
  103. package/docs/documents/ai-doc-guidelines.html +117 -0
  104. package/docs/documents/api.html +337 -0
  105. package/docs/documents/features_3dtile.html +216 -0
  106. package/docs/documents/features_camera-animation.html +157 -0
  107. package/docs/documents/features_clipper.html +80 -0
  108. package/docs/documents/features_coordinate-system.html +127 -0
  109. package/docs/documents/features_event.html +104 -0
  110. package/docs/documents/features_five.html +147 -0
  111. package/docs/documents/features_flowing-light-2d-pass.html +356 -0
  112. package/docs/documents/features_flowing-light-3d-pass.html +351 -0
  113. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  114. package/docs/documents/features_gesture.html +120 -0
  115. package/docs/documents/features_get-screen-pixels.html +88 -0
  116. package/docs/documents/features_image-options.html +108 -0
  117. package/docs/documents/features_load-external-model.html +600 -0
  118. package/docs/documents/features_load-progress.html +110 -0
  119. package/docs/documents/features_material.html +334 -0
  120. package/docs/documents/features_mode.html +114 -0
  121. package/docs/documents/features_model.html +141 -0
  122. package/docs/documents/features_move-pano-effect.html +110 -0
  123. package/docs/documents/features_multi-work.html +97 -0
  124. package/docs/documents/features_pano-tile.html +100 -0
  125. package/docs/documents/features_pano-uv.html +82 -0
  126. package/docs/documents/features_parameter.html +101 -0
  127. package/docs/documents/features_plugin.html +105 -0
  128. package/docs/documents/features_postprocessing.html +109 -0
  129. package/docs/documents/features_raycast.html +98 -0
  130. package/docs/documents/features_request-proxy.html +78 -0
  131. package/docs/documents/features_screen-project.html +112 -0
  132. package/docs/documents/features_state.html +71 -0
  133. package/docs/documents/features_view-layer.html +158 -0
  134. package/docs/documents/features_work.html +129 -0
  135. package/docs/documents/glossary.html +94 -0
  136. package/docs/documents/intro.html +24 -6
  137. package/docs/documents/quick-start.html +23 -45
  138. package/docs/documents/release_notes_6.6.html +79 -0
  139. package/docs/documents/release_notes_6.7.html +14 -14
  140. package/docs/documents/release_notes_6.8.html +103 -0
  141. package/docs/documents/support.html +39 -15
  142. package/docs/documents/template.html +80 -0
  143. package/docs/functions/five.loadAt3d.html +1 -1
  144. package/docs/functions/five.loadB3dm.html +1 -1
  145. package/docs/functions/five.loadDome.html +1 -1
  146. package/docs/functions/five.loadDomez.html +1 -1
  147. package/docs/functions/five.loadFbx.html +1 -1
  148. package/docs/functions/five.loadGltf.html +1 -1
  149. package/docs/functions/five.loadPbm.html +1 -1
  150. package/docs/functions/five.loadPly.html +1 -1
  151. package/docs/functions/five.loadPnts.html +1 -1
  152. package/docs/functions/five.loadSplat.html +1 -1
  153. package/docs/functions/five.loadSpz.html +1 -1
  154. package/docs/functions/five.loadX3p.html +1 -1
  155. package/docs/functions/five.parseWork.html +1 -1
  156. package/docs/functions/react.createFiveProvider.html +1 -1
  157. package/docs/functions/react.useFiveAction.html +6 -6
  158. package/docs/functions/react.useFiveCurrentObserver.html +1 -1
  159. package/docs/functions/react.useFiveCurrentState.html +1 -1
  160. package/docs/functions/react.useFiveEventCallback.html +1 -1
  161. package/docs/functions/react.useFiveFloor.html +1 -1
  162. package/docs/functions/react.useFiveHelper.html +1 -1
  163. package/docs/functions/react.useFiveModelIntersectRaycaster.html +2 -2
  164. package/docs/functions/react.useFiveProject2d.html +2 -2
  165. package/docs/functions/react.useFiveSceneEffect.html +1 -1
  166. package/docs/functions/react.useFiveWork.html +2 -2
  167. package/docs/functions/vue.useFiveAction.html +8 -8
  168. package/docs/functions/vue.useFiveCurrentObserver.html +1 -1
  169. package/docs/functions/vue.useFiveCurrentState.html +1 -1
  170. package/docs/functions/vue.useFiveEventCallback.html +1 -1
  171. package/docs/functions/vue.useFiveFloor.html +1 -1
  172. package/docs/functions/vue.useFiveHelper.html +1 -1
  173. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +2 -2
  174. package/docs/functions/vue.useFiveProject2d.html +2 -2
  175. package/docs/functions/vue.useFiveState.html +1 -1
  176. package/docs/functions/vue.useFiveWorks.html +4 -4
  177. package/docs/hierarchy.html +1 -1
  178. package/docs/index.html +135 -34
  179. package/docs/interfaces/five.AddableObject.html +1 -1
  180. package/docs/interfaces/five.AjaxOptions.html +1 -1
  181. package/docs/interfaces/five.BaseEvent.html +2 -2
  182. package/docs/interfaces/five.EventCallback.html +15 -11
  183. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  184. package/docs/interfaces/five.GestureEvent.html +2 -2
  185. package/docs/interfaces/five.ImageOptions.html +1 -1
  186. package/docs/interfaces/five.IntersectEvent.html +2 -2
  187. package/docs/interfaces/five.IntersectMesh.html +1 -1
  188. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  189. package/docs/interfaces/five.Intersection.html +4 -3
  190. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  191. package/docs/interfaces/five.ModeChangeEvent.html +2 -2
  192. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  193. package/docs/interfaces/five.ModelEvent.html +2 -2
  194. package/docs/interfaces/five.ModelSceneEvent.html +2 -2
  195. package/docs/interfaces/five.ModelTileEvent.html +8 -0
  196. package/docs/interfaces/five.MovePanoOptions.html +4 -4
  197. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  198. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  199. package/docs/interfaces/five.NetworkOptions.html +1 -1
  200. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  201. package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
  202. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  203. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  204. package/docs/interfaces/five.ObjectEvent.html +2 -2
  205. package/docs/interfaces/five.PBMMaterial.html +1 -1
  206. package/docs/interfaces/five.PBMMeshMaterialParameters.html +1 -1
  207. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +1 -1
  208. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  209. package/docs/interfaces/five.PanoEvent.html +2 -2
  210. package/docs/interfaces/five.PanoTextureEvent.html +2 -2
  211. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  212. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  213. package/docs/interfaces/five.ParameterMaterialValue.html +39 -35
  214. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  215. package/docs/interfaces/five.ParameterValue.html +53 -49
  216. package/docs/interfaces/five.Pose.html +6 -7
  217. package/docs/interfaces/five.RenderEvent.html +2 -2
  218. package/docs/interfaces/five.ResolvedParameterValue.html +53 -49
  219. package/docs/interfaces/five.SplatData.html +10 -0
  220. package/docs/interfaces/five.State.html +6 -6
  221. package/docs/interfaces/five.StateEvent.html +2 -2
  222. package/docs/interfaces/five.TextureOptions.html +1 -1
  223. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  224. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  225. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  226. package/docs/interfaces/five.ViewLayer.html +30 -26
  227. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  228. package/docs/interfaces/five.WorkImage.html +1 -1
  229. package/docs/interfaces/five.WorkModel.html +8 -8
  230. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  231. package/docs/interfaces/five.WorkObserver.html +28 -3
  232. package/docs/interfaces/five.WorkTile.html +1 -1
  233. package/docs/interfaces/five.WorksEvent.html +2 -2
  234. package/docs/interfaces/five.XRControllerEvent.html +2 -2
  235. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  236. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  237. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  238. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  239. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  240. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  241. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +1 -1
  242. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  243. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  244. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  245. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  246. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
  247. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  248. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  249. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  250. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  251. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  252. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  253. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  254. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  255. package/docs/interfaces/plugins.TrajectoryController.html +1 -1
  256. package/docs/interfaces/react.FiveInjectionTypes.html +14 -14
  257. package/docs/modules/five.html +1 -1
  258. package/docs/modules.html +1 -1
  259. package/docs/types/five.EventTypes.html +12 -10
  260. package/docs/types/five.FivePlugin.html +1 -1
  261. package/docs/types/five.FivePluginInit.html +1 -1
  262. package/docs/types/five.FivePluginInstance.html +1 -1
  263. package/docs/types/five.NetworkProgressCallback.html +1 -1
  264. package/docs/types/five.ParseOptions.html +6 -6
  265. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  266. package/docs/variables/react.FiveCanvas.html +1 -1
  267. package/docs/variables/react.useFiveScene.html +1 -1
  268. package/docs/variables/vue.FiveCanvas.html +1 -1
  269. package/docs/variables/vue.FiveProvider.html +1 -1
  270. package/five/application/analysis.d.ts +40 -0
  271. package/five/application/controllers.d.ts +41 -0
  272. package/five/application/events-legacy.d.ts +454 -0
  273. package/five/application/events.d.ts +69 -0
  274. package/five/application/five.d.ts +518 -0
  275. package/five/application/fiveInitArgs.d.ts +176 -0
  276. package/five/application/fiveLoadOptions.d.ts +21 -0
  277. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  278. package/five/application/getViewportScale.d.ts +2 -0
  279. package/five/application/initLights.d.ts +3 -0
  280. package/five/application/mode.d.ts +28 -0
  281. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  282. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  283. package/five/assets/gradient-png-data-url.d.ts +2 -0
  284. package/five/assets/loading-png-data-url.d.ts +2 -0
  285. package/five/assets/phone-png-data-url.d.ts +2 -0
  286. package/five/assets/realsee-pmg-data-url.d.ts +2 -0
  287. package/five/bvh/bvhMath.d.ts +33 -0
  288. package/five/bvh/bvhMesh.d.ts +7 -0
  289. package/five/bvh/bvhNode.d.ts +29 -0
  290. package/five/bvh/bvhObject.d.ts +18 -0
  291. package/five/bvh/bvhPoints.d.ts +6 -0
  292. package/five/bvh/index.d.ts +10 -0
  293. package/five/bvh/worker.d.ts +35 -0
  294. package/five/cardboard/helper.d.ts +2 -0
  295. package/five/cardboard/index.d.ts +13 -0
  296. package/five/cardboard/sensor.d.ts +158 -0
  297. package/five/certificates/hardware.d.ts +1 -0
  298. package/five/controllers/base.d.ts +166 -0
  299. package/five/controllers/events.d.ts +69 -0
  300. package/five/controllers/floorplan.d.ts +119 -0
  301. package/five/controllers/mapview.d.ts +138 -0
  302. package/five/controllers/model.d.ts +57 -0
  303. package/five/controllers/panorama.d.ts +143 -0
  304. package/five/controllers/panoramaLike.d.ts +87 -0
  305. package/five/controllers/topview.d.ts +42 -0
  306. package/five/controllers/vrPanorama.d.ts +56 -0
  307. package/five/controllers/xrPanorama.d.ts +81 -0
  308. package/five/core/camera.d.ts +65 -0
  309. package/five/core/internalWebGLRenderer.d.ts +14 -0
  310. package/five/core/panoVideo.d.ts +18 -0
  311. package/five/core/scene.d.ts +10 -0
  312. package/five/core/tiling.d.ts +43 -0
  313. package/five/declare.d.ts +2 -1
  314. package/five/gs/util/renderData.d.ts +32 -0
  315. package/five/gs/wasm/data.d.ts +20 -0
  316. package/five/gs/wasm/sort.d.ts +18 -0
  317. package/five/gs/worker/dataWorker.d.ts +1 -0
  318. package/five/gs/worker/sortWorker.d.ts +1 -0
  319. package/five/index.d.ts +57 -4644
  320. package/five/index.js +503 -78
  321. package/five/index.mjs +6386 -5154
  322. package/five/meshes/boundingMesh.d.ts +12 -0
  323. package/five/meshes/intersectMesh.d.ts +8 -0
  324. package/five/meshes/panoCircleMesh.d.ts +35 -0
  325. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  326. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  327. package/five/meshes/panoSphereMesh.d.ts +27 -0
  328. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  329. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  330. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  331. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  332. package/five/model/index.d.ts +70 -0
  333. package/five/model/intersection.d.ts +18 -0
  334. package/five/model/loaders/at3d.d.ts +12 -0
  335. package/five/model/loaders/b3dm.d.ts +9 -0
  336. package/five/model/loaders/dome.d.ts +22 -0
  337. package/five/model/loaders/domez.d.ts +11 -0
  338. package/five/model/loaders/fbx.d.ts +8 -0
  339. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  340. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  341. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  342. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  343. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  344. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  345. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +9 -0
  346. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  347. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  348. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  349. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  350. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  351. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  352. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  353. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  354. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  355. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  356. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +24 -0
  357. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  358. package/five/model/loaders/glTF-helpers/index.d.ts +47 -0
  359. package/five/model/loaders/glTF-helpers/parser.d.ts +114 -0
  360. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  361. package/five/model/loaders/gltf.d.ts +10 -0
  362. package/five/model/loaders/obj.d.ts +9 -0
  363. package/five/model/loaders/pbm.d.ts +26 -0
  364. package/five/model/loaders/ply.d.ts +24 -0
  365. package/five/model/loaders/pnts.d.ts +8 -0
  366. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  367. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  368. package/five/model/loaders/shared.d.ts +16 -0
  369. package/five/model/loaders/splat.d.ts +8 -0
  370. package/five/model/loaders/spz.d.ts +14 -0
  371. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  372. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  373. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  374. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  375. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  376. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  377. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  378. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  379. package/five/model/loaders/x3p.d.ts +22 -0
  380. package/five/model/materials/pbmMaterial.d.ts +87 -0
  381. package/five/model/materials/pbmMeshMaterial.d.ts +124 -0
  382. package/five/model/materials/pbmPointCloudMaterial.d.ts +72 -0
  383. package/five/model/model-scene.d.ts +172 -0
  384. package/five/model/model.d.ts +209 -0
  385. package/five/model/objects/pbmContainer.d.ts +28 -0
  386. package/five/model/objects/pbmGSObject.d.ts +40 -0
  387. package/five/model/objects/pbmGSRenderMesh.d.ts +32 -0
  388. package/five/model/objects/pbmGroup.d.ts +8 -0
  389. package/five/model/objects/pbmMesh.d.ts +10 -0
  390. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  391. package/five/model/parameter.d.ts +136 -0
  392. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  393. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  394. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  395. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  396. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  397. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  398. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  399. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  400. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  401. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  402. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  403. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  404. package/five/model/tile3d/header.d.ts +88 -0
  405. package/five/model/tile3d/index.d.ts +214 -0
  406. package/five/model/tile3d/tile-cache.d.ts +18 -0
  407. package/five/model/tile3d/tile-content.d.ts +10 -0
  408. package/five/model/tile3d/tile-node.d.ts +24 -0
  409. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  410. package/five/model/tile3d/tile.d.ts +79 -0
  411. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  412. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  413. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  414. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  415. package/five/model/tile3d/tileset.d.ts +69 -0
  416. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  417. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  418. package/five/model/tile3d/trajectory.d.ts +30 -0
  419. package/five/model/tile3d/types.d.ts +33 -0
  420. package/five/model/view-layer.d.ts +20 -0
  421. package/five/renderer/five-renderer.d.ts +17 -0
  422. package/five/renderer/index.d.ts +3 -0
  423. package/five/renderer/postprocessing/composer.d.ts +37 -0
  424. package/five/renderer/postprocessing/index.d.ts +7 -0
  425. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +15 -0
  426. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  427. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  428. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  429. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  430. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  431. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  432. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  433. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  434. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  435. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  436. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  437. package/five/texture/imageBitmap.d.ts +13 -0
  438. package/five/texture/initTexture.d.ts +3 -0
  439. package/five/texture/loader.d.ts +39 -0
  440. package/five/thirdparty/fflate.d.ts +1407 -0
  441. package/five/thirdparty/hammer.d.ts +259 -0
  442. package/five/thirdparty/jsrsasign.d.ts +768 -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 +35 -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 +149 -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 +3 -3
  541. package/gltf-loader/index.mjs +3 -3
  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 +3 -3
  548. package/line/index.mjs +3 -3
  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 +65 -0
  555. package/package.json +10 -1
  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 +2 -2
  587. package/plugins/index.mjs +2 -2
  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 +2 -2
  619. package/react/index.mjs +2 -2
  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 +2 -2
  630. package/shader-lib/index.mjs +2 -2
  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 +3 -3
  635. package/umd/five-gltf-loader.js +3 -3
  636. package/umd/five-line.js +3 -3
  637. package/umd/five-plugins.js +2 -2
  638. package/umd/five-react.js +2 -2
  639. package/umd/five-shader-lib.js +2 -2
  640. package/umd/five-sticker.js +3 -3
  641. package/umd/five-vfx.js +2 -2
  642. package/umd/five-vue.js +2 -2
  643. package/umd/five.js +503 -78
  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 +2 -2
  654. package/vfx/index.mjs +2 -2
  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 +2 -2
  690. package/vue/index.mjs +2 -2
  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 +2 -2
  698. package/work-downloader/index.mjs +2 -2
  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/coordinate.html +0 -13
  706. package/docs/documents/five.FivePlugin.plugins.html +0 -92
  707. package/docs/documents/five.Pose.coordinate.html +0 -13
  708. package/docs/documents/mode.html +0 -15
  709. package/docs/documents/plugins.html +0 -92
  710. package/docs/documents/state.html +0 -2
  711. package/docs/documents/work.html +0 -67
  712. package/docs/media/coordinate.jpg +0 -0
  713. package/docs_markdown/README.md +0 -33
  714. package/docs_markdown/_media/coordinate.jpg +0 -0
  715. package/docs_markdown/documents/coordinate.md +0 -29
  716. package/docs_markdown/documents/intro.md +0 -15
  717. package/docs_markdown/documents/mode.md +0 -21
  718. package/docs_markdown/documents/plugins.md +0 -226
  719. package/docs_markdown/documents/quick-start.md +0 -105
  720. package/docs_markdown/documents/release_notes/6.7.md +0 -407
  721. package/docs_markdown/documents/state.md +0 -7
  722. package/docs_markdown/documents/support.md +0 -13
  723. package/docs_markdown/documents/work.md +0 -148
  724. package/docs_markdown/five/README.md +0 -309
  725. package/docs_markdown/five/classes/AdaptiveLuminancePass.md +0 -238
  726. package/docs_markdown/five/classes/AnimationFrameLoop.md +0 -195
  727. package/docs_markdown/five/classes/BoundingMesh.md +0 -75
  728. package/docs_markdown/five/classes/Camera.md +0 -527
  729. package/docs_markdown/five/classes/EffectComposer.md +0 -241
  730. package/docs_markdown/five/classes/EyeDomeLightingPass.md +0 -232
  731. package/docs_markdown/five/classes/Fetcher.md +0 -133
  732. package/docs_markdown/five/classes/Five.md +0 -2231
  733. package/docs_markdown/five/classes/FivePass.md +0 -193
  734. package/docs_markdown/five/classes/FiveRenderer.md +0 -107
  735. package/docs_markdown/five/classes/FullScreenQuad.md +0 -95
  736. package/docs_markdown/five/classes/InternalWebGLRenderer.md +0 -65
  737. package/docs_markdown/five/classes/Model.md +0 -1009
  738. package/docs_markdown/five/classes/ModelScene.md +0 -495
  739. package/docs_markdown/five/classes/Motion.md +0 -235
  740. package/docs_markdown/five/classes/NetworkSubscribe.md +0 -289
  741. package/docs_markdown/five/classes/PBMContainer.md +0 -137
  742. package/docs_markdown/five/classes/PBMCustomShader.md +0 -171
  743. package/docs_markdown/five/classes/PBMGSObject.md +0 -257
  744. package/docs_markdown/five/classes/PBMGroup.md +0 -35
  745. package/docs_markdown/five/classes/PBMMesh.md +0 -43
  746. package/docs_markdown/five/classes/PBMMeshMaterial.md +0 -889
  747. package/docs_markdown/five/classes/PBMPointCloud.md +0 -41
  748. package/docs_markdown/five/classes/PBMPointCloudMaterial.md +0 -371
  749. package/docs_markdown/five/classes/PBMSkinnedMesh.md +0 -67
  750. package/docs_markdown/five/classes/PanoCircleMesh.md +0 -296
  751. package/docs_markdown/five/classes/PanoCircleMeshCustom.md +0 -296
  752. package/docs_markdown/five/classes/PanoCircleMeshSolid.md +0 -296
  753. package/docs_markdown/five/classes/Parameter.md +0 -905
  754. package/docs_markdown/five/classes/Scene.md +0 -109
  755. package/docs_markdown/five/classes/Subscribe.md +0 -271
  756. package/docs_markdown/five/classes/TextureLoader.md +0 -199
  757. package/docs_markdown/five/classes/Tile.md +0 -517
  758. package/docs_markdown/five/classes/Tile3D.md +0 -1287
  759. package/docs_markdown/five/classes/TileCache.md +0 -123
  760. package/docs_markdown/five/classes/TileNode.md +0 -171
  761. package/docs_markdown/five/classes/TileRequestScheduler.md +0 -69
  762. package/docs_markdown/five/classes/Tileset.md +0 -379
  763. package/docs_markdown/five/classes/Trajectory.md +0 -111
  764. package/docs_markdown/five/classes/TrajectoryNode.md +0 -129
  765. package/docs_markdown/five/classes/Work.md +0 -299
  766. package/docs_markdown/five/classes/WorkResolvedObserver.md +0 -302
  767. package/docs_markdown/five/classes/XRButton.md +0 -37
  768. package/docs_markdown/five/enumerations/VolumePlaneIntersect.md +0 -33
  769. package/docs_markdown/five/functions/coordinatesToVector.md +0 -33
  770. package/docs_markdown/five/functions/createDebugBoundingMesh.md +0 -25
  771. package/docs_markdown/five/functions/createWorks.md +0 -21
  772. package/docs_markdown/five/functions/defaultImageURLTransform.md +0 -33
  773. package/docs_markdown/five/functions/getViewportScale.md +0 -15
  774. package/docs_markdown/five/functions/headingToLongitude.md +0 -29
  775. package/docs_markdown/five/functions/imageSupport.md +0 -15
  776. package/docs_markdown/five/functions/isBoundingVolume.md +0 -21
  777. package/docs_markdown/five/functions/isPanoId.md +0 -21
  778. package/docs_markdown/five/functions/loadAt3d.md +0 -47
  779. package/docs_markdown/five/functions/loadB3dm.md +0 -39
  780. package/docs_markdown/five/functions/loadDome.md +0 -43
  781. package/docs_markdown/five/functions/loadDomez.md +0 -43
  782. package/docs_markdown/five/functions/loadFbx.md +0 -35
  783. package/docs_markdown/five/functions/loadGltf.md +0 -39
  784. package/docs_markdown/five/functions/loadPbm.md +0 -47
  785. package/docs_markdown/five/functions/loadPly.md +0 -61
  786. package/docs_markdown/five/functions/loadPnts.md +0 -35
  787. package/docs_markdown/five/functions/loadSplat.md +0 -35
  788. package/docs_markdown/five/functions/loadSpz.md +0 -35
  789. package/docs_markdown/five/functions/loadX3p.md +0 -39
  790. package/docs_markdown/five/functions/longitudeToHeading.md +0 -29
  791. package/docs_markdown/five/functions/makeBoundingVolume.md +0 -21
  792. package/docs_markdown/five/functions/panoEqual.md +0 -25
  793. package/docs_markdown/five/functions/panoParse.md +0 -21
  794. package/docs_markdown/five/functions/panoStringify.md +0 -21
  795. package/docs_markdown/five/functions/parseWork.md +0 -33
  796. package/docs_markdown/five/functions/vectorToCoordinates.md +0 -31
  797. package/docs_markdown/five/functions/workToJson.md +0 -21
  798. package/docs_markdown/five/interfaces/AddableObject.md +0 -77
  799. package/docs_markdown/five/interfaces/AjaxOptions.md +0 -81
  800. package/docs_markdown/five/interfaces/AnimationFrame.md +0 -67
  801. package/docs_markdown/five/interfaces/AnimationFrameContext.md +0 -55
  802. package/docs_markdown/five/interfaces/BaseEvent.md +0 -60
  803. package/docs_markdown/five/interfaces/BoundingVolume.md +0 -241
  804. package/docs_markdown/five/interfaces/BoxBoundingVolume.md +0 -325
  805. package/docs_markdown/five/interfaces/CameraPose.md +0 -49
  806. package/docs_markdown/five/interfaces/CullingVolume.md +0 -141
  807. package/docs_markdown/five/interfaces/Draco.md +0 -219
  808. package/docs_markdown/five/interfaces/EventCallback.md +0 -3374
  809. package/docs_markdown/five/interfaces/FiveInitArgs.md +0 -435
  810. package/docs_markdown/five/interfaces/FiveLoadOptions.md +0 -71
  811. package/docs_markdown/five/interfaces/FloorplanControllerCustomInitArgs.md +0 -93
  812. package/docs_markdown/five/interfaces/GestureEvent.md +0 -233
  813. package/docs_markdown/five/interfaces/ImageOptions.md +0 -147
  814. package/docs_markdown/five/interfaces/ImageURLMappings.md +0 -13
  815. package/docs_markdown/five/interfaces/ImageURLOptions.md +0 -89
  816. package/docs_markdown/five/interfaces/IntersectEvent.md +0 -89
  817. package/docs_markdown/five/interfaces/IntersectMesh.md +0 -33
  818. package/docs_markdown/five/interfaces/IntersectMeshInterface.md +0 -27
  819. package/docs_markdown/five/interfaces/Intersection.md +0 -53
  820. package/docs_markdown/five/interfaces/KTX2.md +0 -131
  821. package/docs_markdown/five/interfaces/LoosePanoWork.md +0 -81
  822. package/docs_markdown/five/interfaces/LooseWork.md +0 -145
  823. package/docs_markdown/five/interfaces/LooseWorkInitial.md +0 -89
  824. package/docs_markdown/five/interfaces/LooseWorkModel.md +0 -113
  825. package/docs_markdown/five/interfaces/LooseWorkObserver.md +0 -153
  826. package/docs_markdown/five/interfaces/LooseWorkPanorama.md +0 -121
  827. package/docs_markdown/five/interfaces/LooseWorkVideo.md +0 -33
  828. package/docs_markdown/five/interfaces/LooseWorkWithExtrinsics.md +0 -93
  829. package/docs_markdown/five/interfaces/MapviewControllerCustomInitArgs.md +0 -96
  830. package/docs_markdown/five/interfaces/ModeChangeEvent.md +0 -105
  831. package/docs_markdown/five/interfaces/ModelControllerCustomInitArgs.md +0 -147
  832. package/docs_markdown/five/interfaces/ModelEvent.md +0 -89
  833. package/docs_markdown/five/interfaces/ModelOptions.md +0 -54
  834. package/docs_markdown/five/interfaces/ModelSceneEvent.md +0 -73
  835. package/docs_markdown/five/interfaces/MotionKeyframe.md +0 -39
  836. package/docs_markdown/five/interfaces/MovePanoOptions.md +0 -192
  837. package/docs_markdown/five/interfaces/NetworkAbortError.md +0 -13
  838. package/docs_markdown/five/interfaces/NetworkFirbiddenError.md +0 -13
  839. package/docs_markdown/five/interfaces/NetworkOptions.md +0 -53
  840. package/docs_markdown/five/interfaces/NetworkProxyError.md +0 -13
  841. package/docs_markdown/five/interfaces/NetworkResourceEvent.md +0 -97
  842. package/docs_markdown/five/interfaces/NetworkResponseError.md +0 -21
  843. package/docs_markdown/five/interfaces/NetworkTimeoutError.md +0 -13
  844. package/docs_markdown/five/interfaces/ObjectEvent.md +0 -73
  845. package/docs_markdown/five/interfaces/PBMClipperParameter.md +0 -25
  846. package/docs_markdown/five/interfaces/PBMCustomShaderInitArgs.md +0 -57
  847. package/docs_markdown/five/interfaces/PBMCustomShaderSlots.md +0 -53
  848. package/docs_markdown/five/interfaces/PBMMaterial.md +0 -18
  849. package/docs_markdown/five/interfaces/PBMMeshMaterialParameters.md +0 -221
  850. package/docs_markdown/five/interfaces/PBMPanoDepth.md +0 -49
  851. package/docs_markdown/five/interfaces/PBMPanoPicture.md +0 -59
  852. package/docs_markdown/five/interfaces/PBMPointCloudMaterialParameters.md +0 -221
  853. package/docs_markdown/five/interfaces/PBMRefinedScreen.md +0 -49
  854. package/docs_markdown/five/interfaces/PanoCircleMeshCustomOptions.md +0 -73
  855. package/docs_markdown/five/interfaces/PanoCircleMeshInterface.md +0 -222
  856. package/docs_markdown/five/interfaces/PanoCircleMeshOptions.md +0 -25
  857. package/docs_markdown/five/interfaces/PanoCircleMeshSolidOptions.md +0 -25
  858. package/docs_markdown/five/interfaces/PanoEvent.md +0 -121
  859. package/docs_markdown/five/interfaces/PanoTextureEvent.md +0 -97
  860. package/docs_markdown/five/interfaces/PanoramaControllerCustomInitArgs.md +0 -260
  861. package/docs_markdown/five/interfaces/PanoramaLikeControllerCustomInitArgs.md +0 -112
  862. package/docs_markdown/five/interfaces/ParameterMaterialValue.md +0 -363
  863. package/docs_markdown/five/interfaces/ParameterTilesetValue.md +0 -161
  864. package/docs_markdown/five/interfaces/ParameterValue.md +0 -715
  865. package/docs_markdown/five/interfaces/Pass.md +0 -100
  866. package/docs_markdown/five/interfaces/Pose.md +0 -69
  867. package/docs_markdown/five/interfaces/RegionBoundingVolume.md +0 -349
  868. package/docs_markdown/five/interfaces/RenderEvent.md +0 -73
  869. package/docs_markdown/five/interfaces/ResolvedParameterValue.md +0 -727
  870. package/docs_markdown/five/interfaces/SphereBoundingVolume.md +0 -317
  871. package/docs_markdown/five/interfaces/State.md +0 -123
  872. package/docs_markdown/five/interfaces/StateEvent.md +0 -87
  873. package/docs_markdown/five/interfaces/TextureOptions.md +0 -157
  874. package/docs_markdown/five/interfaces/Tile3DOptions.md +0 -83
  875. package/docs_markdown/five/interfaces/TileCoordinateSystem.md +0 -25
  876. package/docs_markdown/five/interfaces/TileHeader.md +0 -89
  877. package/docs_markdown/five/interfaces/TilesetHeader.md +0 -209
  878. package/docs_markdown/five/interfaces/TilesetOptions.md +0 -205
  879. package/docs_markdown/five/interfaces/TopviewControllerCustomInitArgs.md +0 -101
  880. package/docs_markdown/five/interfaces/TrajectoryHeader.md +0 -41
  881. package/docs_markdown/five/interfaces/VRPanoramaControllerCustomInitArgs.md +0 -264
  882. package/docs_markdown/five/interfaces/ViewLayer.md +0 -1505
  883. package/docs_markdown/five/interfaces/Viewport.md +0 -57
  884. package/docs_markdown/five/interfaces/WebXRAxesParams.md +0 -57
  885. package/docs_markdown/five/interfaces/WebXRControllerParams.md +0 -25
  886. package/docs_markdown/five/interfaces/WorkCubeImage.md +0 -86
  887. package/docs_markdown/five/interfaces/WorkImage.md +0 -117
  888. package/docs_markdown/five/interfaces/WorkInitial.md +0 -89
  889. package/docs_markdown/five/interfaces/WorkInitialJson.md +0 -65
  890. package/docs_markdown/five/interfaces/WorkJson.md +0 -89
  891. package/docs_markdown/five/interfaces/WorkModel.md +0 -113
  892. package/docs_markdown/five/interfaces/WorkModelJson.md +0 -49
  893. package/docs_markdown/five/interfaces/WorkModelLayer.md +0 -59
  894. package/docs_markdown/five/interfaces/WorkModelLayerJson.md +0 -41
  895. package/docs_markdown/five/interfaces/WorkObserver.md +0 -184
  896. package/docs_markdown/five/interfaces/WorkObserverJson.md +0 -97
  897. package/docs_markdown/five/interfaces/WorkPanoramaJson.md +0 -125
  898. package/docs_markdown/five/interfaces/WorkPanoramasJson.md +0 -25
  899. package/docs_markdown/five/interfaces/WorkTile.md +0 -115
  900. package/docs_markdown/five/interfaces/WorkVideo.md +0 -49
  901. package/docs_markdown/five/interfaces/WorksEvent.md +0 -89
  902. package/docs_markdown/five/interfaces/XRControllerEvent.md +0 -177
  903. package/docs_markdown/five/interfaces/XRGestureEvent.md +0 -125
  904. package/docs_markdown/five/interfaces/XRPanoramaControllerCustomInitArgs.md +0 -264
  905. package/docs_markdown/five/interfaces/XRSessionEvent.md +0 -81
  906. package/docs_markdown/five/interfaces/documents/coordinate.md +0 -29
  907. package/docs_markdown/five/type-aliases/AjaxResponseType.md +0 -11
  908. package/docs_markdown/five/type-aliases/AjaxResponseTypeMapping.md +0 -17
  909. package/docs_markdown/five/type-aliases/AnimationFrameLoopType.md +0 -11
  910. package/docs_markdown/five/type-aliases/BoundingVolumeJson.md +0 -11
  911. package/docs_markdown/five/type-aliases/BoxBoundingVolumeJson.md +0 -19
  912. package/docs_markdown/five/type-aliases/ControllerCustomInitTypes.md +0 -67
  913. package/docs_markdown/five/type-aliases/ControllerEventTypes.md +0 -669
  914. package/docs_markdown/five/type-aliases/CubeFace.md +0 -11
  915. package/docs_markdown/five/type-aliases/EventTypes.md +0 -381
  916. package/docs_markdown/five/type-aliases/FivePlugin.md +0 -31
  917. package/docs_markdown/five/type-aliases/FivePluginInit.md +0 -21
  918. package/docs_markdown/five/type-aliases/FivePluginInstance.md +0 -21
  919. package/docs_markdown/five/type-aliases/GestureTypes.md +0 -11
  920. package/docs_markdown/five/type-aliases/LegacyEventType.md +0 -1852
  921. package/docs_markdown/five/type-aliases/LoadResultType.md +0 -109
  922. package/docs_markdown/five/type-aliases/Mode.md +0 -19
  923. package/docs_markdown/five/type-aliases/Models.md +0 -121
  924. package/docs_markdown/five/type-aliases/MotionCircle.md +0 -13
  925. package/docs_markdown/five/type-aliases/MotionConfig.md +0 -17
  926. package/docs_markdown/five/type-aliases/MotionInitalValue.md +0 -17
  927. package/docs_markdown/five/type-aliases/MotionValue.md +0 -17
  928. package/docs_markdown/five/type-aliases/MovePanoEffect.md +0 -24
  929. package/docs_markdown/five/type-aliases/NetWorkMeta.md +0 -71
  930. package/docs_markdown/five/type-aliases/NetworkError.md +0 -11
  931. package/docs_markdown/five/type-aliases/NetworkErrorCallback.md +0 -21
  932. package/docs_markdown/five/type-aliases/NetworkProgressCallback.md +0 -21
  933. package/docs_markdown/five/type-aliases/NetworkResponse.md +0 -37
  934. package/docs_markdown/five/type-aliases/NetworkState.md +0 -11
  935. package/docs_markdown/five/type-aliases/NetworkSuccessCallback.md +0 -27
  936. package/docs_markdown/five/type-aliases/NetworkType.md +0 -11
  937. package/docs_markdown/five/type-aliases/PBMAlphaMode.md +0 -11
  938. package/docs_markdown/five/type-aliases/PBMColorStyle.md +0 -11
  939. package/docs_markdown/five/type-aliases/PBMFloorStyle.md +0 -11
  940. package/docs_markdown/five/type-aliases/PBMMeshShaderType.md +0 -11
  941. package/docs_markdown/five/type-aliases/PBMPointBack.md +0 -11
  942. package/docs_markdown/five/type-aliases/PBMPointCloudShaderType.md +0 -11
  943. package/docs_markdown/five/type-aliases/PBMPointShape.md +0 -11
  944. package/docs_markdown/five/type-aliases/PBMPointSize.md +0 -11
  945. package/docs_markdown/five/type-aliases/PBMTransition.md +0 -11
  946. package/docs_markdown/five/type-aliases/Pano.md +0 -27
  947. package/docs_markdown/five/type-aliases/PanoId.md +0 -11
  948. package/docs_markdown/five/type-aliases/ParseOptions.md +0 -65
  949. package/docs_markdown/five/type-aliases/PostProcessingType.md +0 -11
  950. package/docs_markdown/five/type-aliases/RegionBoundingVolumeJson.md +0 -19
  951. package/docs_markdown/five/type-aliases/RequestAnimationFrameArgs.md +0 -17
  952. package/docs_markdown/five/type-aliases/Scissor.md +0 -15
  953. package/docs_markdown/five/type-aliases/SphereBoundingVolumeJson.md +0 -19
  954. package/docs_markdown/five/type-aliases/SubscribeEventMap.md +0 -15
  955. package/docs_markdown/five/type-aliases/TileCacheOptions.md +0 -47
  956. package/docs_markdown/five/type-aliases/TileContentData.md +0 -51
  957. package/docs_markdown/five/type-aliases/TileRequestOrder.md +0 -11
  958. package/docs_markdown/five/type-aliases/TileRequestSchedulerOptions.md +0 -69
  959. package/docs_markdown/five/type-aliases/TilesetFrameState.md +0 -199
  960. package/docs_markdown/five/type-aliases/TrajectoryContentData.md +0 -59
  961. package/docs_markdown/five/type-aliases/WebXRControllerKey.md +0 -11
  962. package/docs_markdown/five/type-aliases/WebXRControllerType.md +0 -11
  963. package/docs_markdown/five/type-aliases/Works.md +0 -59
  964. package/docs_markdown/five/type-aliases/documents/plugins.md +0 -226
  965. package/docs_markdown/five/variables/PROXY_CONTROLLER_EVENT_NAMES.md +0 -11
  966. package/docs_markdown/five/variables/controllersDefaultInitArgs.md +0 -41
  967. package/docs_markdown/five/variables/draco.md +0 -11
  968. package/docs_markdown/five/variables/ktx2.md +0 -11
  969. package/docs_markdown/gltf-loader/README.md +0 -23
  970. package/docs_markdown/gltf-loader/classes/DDSLoader.md +0 -57
  971. package/docs_markdown/gltf-loader/classes/DRACOLoader.md +0 -143
  972. package/docs_markdown/gltf-loader/classes/GLTFLoader.md +0 -208
  973. package/docs_markdown/gltf-loader/classes/GLTFObject.md +0 -76
  974. package/docs_markdown/gltf-loader/classes/GLTFParser.md +0 -75
  975. package/docs_markdown/gltf-loader/classes/THREEGLTFLoader.md +0 -151
  976. package/docs_markdown/gltf-loader/interfaces/DDS.md +0 -57
  977. package/docs_markdown/gltf-loader/interfaces/GLTF.md +0 -98
  978. package/docs_markdown/gltf-loader/interfaces/GLTFReference.md +0 -25
  979. package/docs_markdown/gltf-loader/interfaces/THREEGLTF.md +0 -89
  980. package/docs_markdown/line/README.md +0 -20
  981. package/docs_markdown/line/classes/Line.md +0 -151
  982. package/docs_markdown/line/classes/LineGeometry.md +0 -273
  983. package/docs_markdown/line/classes/LineMaterial.md +0 -83
  984. package/docs_markdown/line/classes/LineSegmentsGeometry.md +0 -219
  985. package/docs_markdown/line/classes/THREE_Line2.md +0 -81
  986. package/docs_markdown/line/classes/THREE_LineSegments2.md +0 -81
  987. package/docs_markdown/line/type-aliases/LineMaterialParameters.md +0 -67
  988. package/docs_markdown/modules.md +0 -28
  989. package/docs_markdown/plugins/README.md +0 -43
  990. package/docs_markdown/plugins/classes/CSS3DRenderer.md +0 -93
  991. package/docs_markdown/plugins/classes/OrbitControls.md +0 -461
  992. package/docs_markdown/plugins/classes/RoundedBoxGeometry.md +0 -79
  993. package/docs_markdown/plugins/functions/BackgroundPlugin.md +0 -25
  994. package/docs_markdown/plugins/functions/DynamicPathLinePlugin.md +0 -25
  995. package/docs_markdown/plugins/functions/ItemMaskPlugin.md +0 -25
  996. package/docs_markdown/plugins/functions/OrientationPlugin.md +0 -25
  997. package/docs_markdown/plugins/functions/PanoAnimePlugin.md +0 -25
  998. package/docs_markdown/plugins/functions/TrajectoryPlugin.md +0 -25
  999. package/docs_markdown/plugins/interfaces/BackgroundPluginController.md +0 -313
  1000. package/docs_markdown/plugins/interfaces/DynamicPathLinePluginController.md +0 -755
  1001. package/docs_markdown/plugins/interfaces/ItemMaskController.md +0 -393
  1002. package/docs_markdown/plugins/interfaces/Keyframe.md +0 -25
  1003. package/docs_markdown/plugins/interfaces/OrientationPluginController.md +0 -491
  1004. package/docs_markdown/plugins/interfaces/PanoAnimeController.md +0 -365
  1005. package/docs_markdown/plugins/interfaces/PlayingState.md +0 -25
  1006. package/docs_markdown/plugins/interfaces/TrajectoryController.md +0 -609
  1007. package/docs_markdown/plugins/namespaces/BackgroundPluginType/README.md +0 -25
  1008. package/docs_markdown/plugins/namespaces/BackgroundPluginType/enumerations/WarningCodeType.md +0 -17
  1009. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/Config.md +0 -9
  1010. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/EventMap.md +0 -205
  1011. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/Params.md +0 -25
  1012. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/PluginDataItem.md +0 -9
  1013. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/Mirror.md +0 -17
  1014. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/Mode.md +0 -11
  1015. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/PluginData.md +0 -11
  1016. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/State.md +0 -19
  1017. package/docs_markdown/plugins/namespaces/BasePlugin/README.md +0 -22
  1018. package/docs_markdown/plugins/namespaces/BasePlugin/classes/Controller.md +0 -318
  1019. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/BaseOptions.md +0 -19
  1020. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/Config.md +0 -39
  1021. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/State.md +0 -49
  1022. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/StateChangeParams.md +0 -45
  1023. package/docs_markdown/plugins/namespaces/BasePlugin/type-aliases/EventMap.md +0 -110
  1024. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/README.md +0 -20
  1025. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/Config.md +0 -181
  1026. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/EventMap.md +0 -261
  1027. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/Params.md +0 -37
  1028. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/PathConfig.md +0 -141
  1029. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/State.md +0 -67
  1030. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/type-aliases/PluginData.md +0 -21
  1031. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/type-aliases/ServerData.md +0 -73
  1032. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/README.md +0 -21
  1033. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/Config.md +0 -11
  1034. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/EventMap.md +0 -109
  1035. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/ItemType.md +0 -121
  1036. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/MaskType.md +0 -33
  1037. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/Params.md +0 -27
  1038. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/State.md +0 -87
  1039. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/type-aliases/PluginData.md +0 -27
  1040. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/type-aliases/ServerData.md +0 -27
  1041. package/docs_markdown/plugins/namespaces/OrientationPluginType/README.md +0 -19
  1042. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/Config.md +0 -27
  1043. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/EventMap.md +0 -109
  1044. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/Params.md +0 -27
  1045. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/State.md +0 -67
  1046. package/docs_markdown/plugins/namespaces/OrientationPluginType/type-aliases/PluginData.md +0 -11
  1047. package/docs_markdown/plugins/namespaces/OrientationPluginType/type-aliases/ServerData.md +0 -11
  1048. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/README.md +0 -20
  1049. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/Config.md +0 -19
  1050. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/ConfigChangeEvent.md +0 -39
  1051. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/EventMap.md +0 -157
  1052. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/Params.md +0 -27
  1053. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/State.md +0 -57
  1054. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/type-aliases/PluginData.md +0 -11
  1055. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/type-aliases/ServerData.md +0 -11
  1056. package/docs_markdown/plugins/namespaces/PluginTemplateType/README.md +0 -19
  1057. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/Config.md +0 -19
  1058. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/EventMap.md +0 -109
  1059. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/Params.md +0 -27
  1060. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/State.md +0 -57
  1061. package/docs_markdown/plugins/namespaces/PluginTemplateType/type-aliases/PluginData.md +0 -11
  1062. package/docs_markdown/plugins/namespaces/PluginTemplateType/type-aliases/ServerData.md +0 -19
  1063. package/docs_markdown/react/README.md +0 -58
  1064. package/docs_markdown/react/classes/Store.md +0 -184
  1065. package/docs_markdown/react/functions/createFiveFeature.md +0 -27
  1066. package/docs_markdown/react/functions/createFiveProvider.md +0 -42
  1067. package/docs_markdown/react/functions/createStore.md +0 -158
  1068. package/docs_markdown/react/functions/unsafe__useFiveInstance.md +0 -27
  1069. package/docs_markdown/react/functions/useFiveAction.md +0 -82
  1070. package/docs_markdown/react/functions/useFiveCameraDirection.md +0 -19
  1071. package/docs_markdown/react/functions/useFiveCameraRaycaster.md +0 -19
  1072. package/docs_markdown/react/functions/useFiveCurrentObserver.md +0 -25
  1073. package/docs_markdown/react/functions/useFiveCurrentState.md +0 -25
  1074. package/docs_markdown/react/functions/useFiveEventCallback.md +0 -44
  1075. package/docs_markdown/react/functions/useFiveFloor.md +0 -25
  1076. package/docs_markdown/react/functions/useFiveHelper.md +0 -25
  1077. package/docs_markdown/react/functions/useFiveModelIntersectRaycaster.md +0 -45
  1078. package/docs_markdown/react/functions/useFiveModelReadyState.md +0 -20
  1079. package/docs_markdown/react/functions/useFiveProject2d.md +0 -49
  1080. package/docs_markdown/react/functions/useFiveSceneEffect.md +0 -39
  1081. package/docs_markdown/react/functions/useFiveState.md +0 -15
  1082. package/docs_markdown/react/functions/useFiveWork.md +0 -39
  1083. package/docs_markdown/react/functions/withFive.md +0 -47
  1084. package/docs_markdown/react/interfaces/FiveActionReactCallbacks.md +0 -270
  1085. package/docs_markdown/react/interfaces/FiveCanvasProps.md +0 -29
  1086. package/docs_markdown/react/interfaces/FiveInjectionTypes.md +0 -1075
  1087. package/docs_markdown/react/interfaces/PropTypeOfFiveFeatures.md +0 -23
  1088. package/docs_markdown/react/type-aliases/FiveInjectionActionFeature.md +0 -11
  1089. package/docs_markdown/react/type-aliases/FiveInjectionDataFeature.md +0 -11
  1090. package/docs_markdown/react/type-aliases/FiveInjectionFeature.md +0 -11
  1091. package/docs_markdown/react/type-aliases/FiveProviderPropTypes.md +0 -139
  1092. package/docs_markdown/react/type-aliases/FiveProviderType.md +0 -11
  1093. package/docs_markdown/react/type-aliases/StoreActionMapHanlder.md +0 -25
  1094. package/docs_markdown/react/type-aliases/StoreActionMapType.md +0 -15
  1095. package/docs_markdown/react/type-aliases/StoreProviderType.md +0 -11
  1096. package/docs_markdown/react/type-aliases/StoreValueMapType.md +0 -11
  1097. package/docs_markdown/react/variables/FiveCanvas.md +0 -25
  1098. package/docs_markdown/react/variables/INJECTION_PROPNAME.md +0 -11
  1099. package/docs_markdown/react/variables/useFiveScene.md +0 -43
  1100. package/docs_markdown/sticker/README.md +0 -15
  1101. package/docs_markdown/sticker/classes/Sticker.md +0 -208
  1102. package/docs_markdown/sticker/interfaces/IntersectionLike.md +0 -39
  1103. package/docs_markdown/vfx/README.md +0 -27
  1104. package/docs_markdown/vfx/classes/Airflow.md +0 -175
  1105. package/docs_markdown/vfx/classes/Flame.md +0 -241
  1106. package/docs_markdown/vfx/classes/Particle.md +0 -488
  1107. package/docs_markdown/vfx/classes/ParticleGPU.md +0 -195
  1108. package/docs_markdown/vfx/classes/SpotLight.md +0 -159
  1109. package/docs_markdown/vfx/interfaces/ParticleArgs.md +0 -338
  1110. package/docs_markdown/vfx/interfaces/ParticleGPUArgs.md +0 -301
  1111. package/docs_markdown/vfx/interfaces/ParticleGPUTweenKeyframe.md +0 -31
  1112. package/docs_markdown/vfx/interfaces/ParticleTweenKeyframe.md +0 -31
  1113. package/docs_markdown/vfx/type-aliases/ParticleGPUType.md +0 -11
  1114. package/docs_markdown/vfx/type-aliases/ParticleType.md +0 -11
  1115. package/docs_markdown/vue/README.md +0 -42
  1116. package/docs_markdown/vue/functions/unsafe__useFiveInject.md +0 -27
  1117. package/docs_markdown/vue/functions/useFiveAction.md +0 -104
  1118. package/docs_markdown/vue/functions/useFiveCameraDirection.md +0 -19
  1119. package/docs_markdown/vue/functions/useFiveCameraRaycaster.md +0 -19
  1120. package/docs_markdown/vue/functions/useFiveCurrentObserver.md +0 -25
  1121. package/docs_markdown/vue/functions/useFiveCurrentState.md +0 -25
  1122. package/docs_markdown/vue/functions/useFiveEventCallback.md +0 -40
  1123. package/docs_markdown/vue/functions/useFiveFloor.md +0 -25
  1124. package/docs_markdown/vue/functions/useFiveHelper.md +0 -25
  1125. package/docs_markdown/vue/functions/useFiveModel.md +0 -17
  1126. package/docs_markdown/vue/functions/useFiveModelBounding.md +0 -17
  1127. package/docs_markdown/vue/functions/useFiveModelIntersectRaycaster.md +0 -35
  1128. package/docs_markdown/vue/functions/useFiveModelReadyState.md +0 -20
  1129. package/docs_markdown/vue/functions/useFiveProject2d.md +0 -38
  1130. package/docs_markdown/vue/functions/useFiveScene.md +0 -17
  1131. package/docs_markdown/vue/functions/useFiveState.md +0 -25
  1132. package/docs_markdown/vue/functions/useFiveWorks.md +0 -39
  1133. package/docs_markdown/vue/interfaces/FiveActionVueCallbacks.md +0 -301
  1134. package/docs_markdown/vue/type-aliases/FiveModelIntersectRaycaster.md +0 -21
  1135. package/docs_markdown/vue/type-aliases/FiveProviderComponent.md +0 -11
  1136. package/docs_markdown/vue/type-aliases/Project2d.md +0 -25
  1137. package/docs_markdown/vue/variables/FiveCanvas.md +0 -37
  1138. package/docs_markdown/vue/variables/FiveProvider.md +0 -32
package/docs/documents/features_load-progress.html ADDED
@@ -0,0 +1,110 @@
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/load-progress | 如视 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/load-progress</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="resource-loading-progress-资源加载进度" class="tsd-anchor-link">Resource Loading Progress (资源加载进度)<a href="#resource-loading-progress-资源加载进度" 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
+ <ul>
3
+ <li><strong>Summary</strong>: 监控 3D 模型与全景图的加载状态和实时进度。</li>
4
+ <li><strong>Schema</strong>: <code>Model</code>, <code>Tile</code>, <code>PanoTextureEvent</code></li>
5
+ <li><strong>Concepts</strong>: Loaded vs Refined, Level of Detail (LOD), Panorama Lifecycle</li>
6
+ <li><strong>Configuration</strong>: <code>minLevelOfDetail</code>, <code>maxScreenSpaceError</code></li>
7
+ <li><strong>Examples</strong>: 状态检查、进度监听、生命周期事件</li>
8
+ </ul>
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/index.d.ts">Model</a>, <a href="../../five/model/tile3d/tile.d.ts">Tile</a>, <a href="../../five/controllers/events.d.ts">PanoTextureEvent</a></p>
12
+ </blockquote>
13
+ <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>
14
+ <p>在 3D Tiles 模型（如 Five 的 Work 模型）中，&quot;加载&quot; 分为两个阶段：</p>
15
+ <ol>
16
+ <li>
17
+ <p><strong>Loaded (初步加载完成)</strong>:</p>
18
+ <ul>
19
+ <li>表示模型已经加载了足够用于显示的<strong>基础</strong>数据。</li>
20
+ <li>受 <code>minLevelOfDetail</code> 参数影响。只有当满足最小 LOD 要求的 Tile 加载完毕后，<code>loaded</code> 才会变为 <code>true</code>。</li>
21
+ <li>通常作为 &quot;首屏加载完成&quot; 的标志，此时模型可能还比较模糊。</li>
22
+ </ul>
23
+ </li>
24
+ <li>
25
+ <p><strong>Refined (细化完成)</strong>:</p>
26
+ <ul>
27
+ <li>表示模型在当前视角下，已经加载了所有必要的<strong>高清</strong>数据，达到了最佳渲染效果。</li>
28
+ <li>受 <code>maxScreenSpaceError</code> 参数影响。该值越小，需要的 Tile 精度越高，细化完成所需的时间越长。</li>
29
+ <li>这是一个动态状态。当相机移动时，可能会因为需要加载新的高清分块而从 <code>refined: true</code> 变为 <code>false</code>。</li>
30
+ </ul>
31
+ </li>
32
+ </ol>
33
+ <h2 id="instance-properties" class="tsd-anchor-link">Instance Properties<a href="#instance-properties" 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>
34
+ <h3 id="model-status" class="tsd-anchor-link">Model Status<a href="#model-status" 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>
35
+ <table>
36
+ <thead>
37
+ <tr>
38
+ <th style="text-align:left">Property</th>
39
+ <th style="text-align:left">Type</th>
40
+ <th style="text-align:left">Description</th>
41
+ </tr>
42
+ </thead>
43
+ <tbody>
44
+ <tr>
45
+ <td style="text-align:left"><code>five.model.loaded</code></td>
46
+ <td style="text-align:left"><code>boolean</code></td>
47
+ <td style="text-align:left">检查模型是否已完成初步加载 (Loaded)。</td>
48
+ </tr>
49
+ <tr>
50
+ <td style="text-align:left"><code>five.model.refined</code></td>
51
+ <td style="text-align:left"><code>boolean</code></td>
52
+ <td style="text-align:left">检查模型是否已完成细化 (Refined)。</td>
53
+ </tr>
54
+ <tr>
55
+ <td style="text-align:left"><code>five.model.refineProgress</code></td>
56
+ <td style="text-align:left"><code>[number, number]</code></td>
57
+ <td style="text-align:left">细化进度元组 <code>[current, total]</code> (已加载/总需加载)。</td>
58
+ </tr>
59
+ </tbody>
60
+ </table>
61
+ <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>
62
+ <h3 id="1-model-loading-模型加载" class="tsd-anchor-link">1. Model Loading (模型加载)<a href="#1-model-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>
63
+ <h4 id="检查当前状态-state-checking" class="tsd-anchor-link">检查当前状态 (State Checking)<a href="#检查当前状态-state-checking" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
64
+ <pre><code class="ts"><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">model</span><span class="hl-1">.</span><span class="hl-6">loaded</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;Model is ready (basic data loaded)!&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">model</span><span class="hl-1">.</span><span class="hl-6">refined</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;Model is fully refined (high-res data loaded)!&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
65
+ </code><button type="button">Copy</button></pre>
66
+
67
+ <h4 id="监控细化进度-refine-progress" class="tsd-anchor-link">监控细化进度 (Refine Progress)<a href="#监控细化进度-refine-progress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
68
+ <p><code>five.model.refineProgress</code> 提供了当前视图下模型细化的整体进度。</p>
69
+ <pre><code class="ts"><span class="hl-3">const</span><span class="hl-1"> [</span><span class="hl-4">current</span><span class="hl-1">, </span><span class="hl-4">total</span><span class="hl-1">] = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">model</span><span class="hl-1">.</span><span class="hl-6">refineProgress</span><span class="hl-1">;</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">`Model Refine Progress: </span><span class="hl-3">${</span><span class="hl-6">current</span><span class="hl-3">}</span><span class="hl-9"> / </span><span class="hl-3">${</span><span class="hl-6">total</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">);</span><br/><br/><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-6">current</span><span class="hl-1"> === </span><span class="hl-6">total</span><span class="hl-1"> &amp;&amp; </span><span class="hl-6">total</span><span class="hl-1"> &gt; </span><span class="hl-11">0</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;Model is fully refined for current view.&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
70
+ </code><button type="button">Copy</button></pre>
71
+
72
+ <h4 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></h4>
73
+ <pre><code class="ts"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;modelLoaded&quot;</span><span class="hl-1">, () </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;Model has been loaded.&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
74
+ </code><button type="button">Copy</button></pre>
75
+
76
+ <h4 id="advanced-tile-级别进度" class="tsd-anchor-link">(Advanced) Tile 级别进度<a href="#advanced-tile-级别进度" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
77
+ <p>对于 <code>3dtiles</code> 类型的模型，你可以访问具体的 Tile 对象来查看进度。</p>
78
+ <pre><code class="ts"><span class="hl-8">// 仅示例，通常在调试或特定渲染逻辑中使用</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">progress</span><span class="hl-1"> = </span><span class="hl-6">tile</span><span class="hl-1">.</span><span class="hl-6">content</span><span class="hl-1">.</span><span class="hl-6">loadProgress</span><span class="hl-1">; </span><span class="hl-8">// [0, 1]</span>
79
+ </code><button type="button">Copy</button></pre>
80
+
81
+ <h4 id="tile-lifecycle-monitoring-tile-生命周期监控" class="tsd-anchor-link">Tile Lifecycle Monitoring (Tile 生命周期监控)<a href="#tile-lifecycle-monitoring-tile-生命周期监控" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
82
+ <p>监控单个 Tile 的加载与卸载事件，用于更精细的调试或资源统计。</p>
83
+ <pre><code class="ts"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;model.tileLoad&quot;</span><span class="hl-1">, (</span><span class="hl-6">tile</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">`Tile loaded: </span><span class="hl-3">${</span><span class="hl-6">tile</span><span class="hl-12">.</span><span class="hl-6">debugLabel</span><span class="hl-3">}</span><span class="hl-9">, Size: </span><span class="hl-3">${</span><span class="hl-6">tile</span><span class="hl-12">.</span><span class="hl-6">content</span><span class="hl-12">.</span><span class="hl-6">byteLength</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;model.tileUnload&quot;</span><span class="hl-1">, (</span><span class="hl-6">tile</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">`Tile unloaded: </span><span class="hl-3">${</span><span class="hl-6">tile</span><span class="hl-12">.</span><span class="hl-6">debugLabel</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
84
+ </code><button type="button">Copy</button></pre>
85
+
86
+ <h3 id="2-panorama-loading-全景图加载" class="tsd-anchor-link">2. Panorama Loading (全景图加载)<a href="#2-panorama-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>
87
+ <p>全景图通常在用户移动到某个点位时按需加载。</p>
88
+ <h4 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></h4>
89
+ <p>使用 <code>pano.texture.progress</code> 事件获取当前全景图的加载进度。</p>
90
+ <pre><code class="ts"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.texture.progress&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">progress</span><span class="hl-1">, </span><span class="hl-4">pano</span><span class="hl-1"> } = </span><span class="hl-6">event</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">`Pano </span><span class="hl-3">${</span><span class="hl-6">pano</span><span class="hl-12">.</span><span class="hl-6">panoIndex</span><span class="hl-3">}</span><span class="hl-9"> loading: </span><span class="hl-3">${</span><span class="hl-12">(</span><span class="hl-6">progress</span><span class="hl-12"> </span><span class="hl-1">*</span><span class="hl-12"> </span><span class="hl-11">100</span><span class="hl-12">).</span><span class="hl-5">toFixed</span><span class="hl-12">(</span><span class="hl-11">1</span><span class="hl-12">)</span><span class="hl-3">}</span><span class="hl-9">%`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
91
+ </code><button type="button">Copy</button></pre>
92
+
93
+ <h4 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></h4>
94
+ <ul>
95
+ <li><strong><code>pano.texture.load</code></strong>: 开始加载。</li>
96
+ <li><strong><code>pano.texture.success</code></strong>: 加载完成。</li>
97
+ <li><strong><code>pano.texture.error</code></strong>: 加载失败。</li>
98
+ </ul>
99
+ <pre><code class="ts"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.texture.load&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">`Started loading pano </span><span class="hl-3">${</span><span class="hl-6">event</span><span class="hl-12">.</span><span class="hl-6">pano</span><span class="hl-12">.</span><span class="hl-6">panoIndex</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.texture.success&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">`Finished loading pano </span><span class="hl-3">${</span><span class="hl-6">event</span><span class="hl-12">.</span><span class="hl-6">pano</span><span class="hl-12">.</span><span class="hl-6">panoIndex</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.texture.error&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-9">`Failed to load pano </span><span class="hl-3">${</span><span class="hl-6">event</span><span class="hl-12">.</span><span class="hl-6">pano</span><span class="hl-12">.</span><span class="hl-6">panoIndex</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-6">error</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
100
+ </code><button type="button">Copy</button></pre>
101
+
102
+ <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>
103
+ <ul>
104
+ <li><a href="api.html">Five Class</a>: Five 核心类 API 索引。</li>
105
+ </ul>
106
+ <hr>
107
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">loading</span><span class="hl-1">, </span><span class="hl-2">progress</span><span class="hl-1">, </span><span class="hl-2">refined</span><span class="hl-1">, </span><span class="hl-2">loaded</span><span class="hl-1">, </span><span class="hl-2">event</span><span class="hl-1">]</span>
108
+ </code><button type="button">Copy</button></pre>
109
+
110
+ </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="#resource-loading-progress-资源加载进度"><span>Resource <wbr/>Loading <wbr/>Progress (资源加载进度)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><a href="#concepts"><span>Concepts</span></a></li><li><a href="#instance-properties"><span>Instance <wbr/>Properties</span></a></li><li><ul><li><a href="#model-status"><span>Model <wbr/>Status</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-model-loading-模型加载"><span>1. <wbr/>Model <wbr/>Loading (模型加载)</span></a></li><li><ul><li><a href="#检查当前状态-state-checking"><span>检查当前状态 (<wbr/>State <wbr/>Checking)</span></a></li><li><a href="#监控细化进度-refine-progress"><span>监控细化进度 (<wbr/>Refine <wbr/>Progress)</span></a></li><li><a href="#监听加载完成事件"><span>监听加载完成事件</span></a></li><li><a href="#advanced-tile-级别进度"><span>(<wbr/>Advanced) <wbr/>Tile 级别进度</span></a></li><li><a href="#tile-lifecycle-monitoring-tile-生命周期监控"><span>Tile <wbr/>Lifecycle <wbr/>Monitoring (<wbr/>Tile 生命周期监控)</span></a></li></ul></li><li><a href="#2-panorama-loading-全景图加载"><span>2. <wbr/>Panorama <wbr/>Loading (全景图加载)</span></a></li><li><ul><li><a href="#监听加载进度"><span>监听加载进度</span></a></li><li><a href="#生命周期事件"><span>生命周期事件</span></a></li></ul></li></ul></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_material.html ADDED
@@ -0,0 +1,334 @@
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/material | 如视 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/material</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="material-parameters-材质参数" class="tsd-anchor-link">Material Parameters (材质参数)<a href="#material-parameters-材质参数" 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
+ <ul>
3
+ <li><strong>Summary</strong>: 配置 3D 模型与全景图过渡的视觉表现、渲染样式及特效。</li>
4
+ <li><strong>Schema</strong>: 对应 <code>ParameterMaterialValue</code> 接口，定义了材质、点云、楼层等外观属性。</li>
5
+ <li><strong>Concepts</strong>: Transparency (透明度), Point Cloud (点云), Floor Style (楼层样式), PBR (物理渲染)。</li>
6
+ <li><strong>Configuration</strong>: 包含透明度、混合模式、点云大小/形状、阴影设置等详细参数。</li>
7
+ <li><strong>Examples</strong>: 模型透明度调整、点云样式定制。</li>
8
+ </ul>
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/parameter.d.ts">ParameterMaterialValue</a></p>
12
+ </blockquote>
13
+ <p>以下是 <code>ParameterMaterialValue</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">ParameterMaterialValue</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 模型整体透明度 [0, 1] */</span><br/><span class="hl-1"> </span><span class="hl-6">opacity</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">pointScale</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">/** 点云大小绘制方式 (&#39;ATTENUATION&#39; | &#39;FIXED&#39;) */</span><br/><span class="hl-1"> </span><span class="hl-6">pointSize</span><span class="hl-1">: </span><span class="hl-7">PBMPointSize</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 楼层显示样式 (&#39;OPACITY&#39; | &#39;VISIBILITY&#39;) */</span><br/><span class="hl-1"> </span><span class="hl-6">floorStyle</span><span class="hl-1">: </span><span class="hl-7">PBMFloorStyle</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">// ... 更多字段见下方配置表</span><br/><span class="hl-1">}</span>
15
+ </code><button type="button">Copy</button></pre>
16
+
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>
18
+ <h3 id="1-transparency-blending-透明度与混合" class="tsd-anchor-link">1. Transparency &amp; Blending (透明度与混合)<a href="#1-transparency-blending-透明度与混合" 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>
19
+ <p>材质系统提供了两种维度的透明度控制：</p>
20
+ <ul>
21
+ <li><strong>Opacity (<code>opacity</code>)</strong>: 控制模型整体的不透明度 (0-1)。</li>
22
+ <li><strong>Model Alpha (<code>modelAlpha</code>)</strong>: 控制纹理混合的权重。
23
+ <ul>
24
+ <li><code>0</code>: 仅显示模型自带的 UV 纹理（通常是颜色单一的白模或人工烘焙的纹理）。</li>
25
+ <li><code>1</code>: 仅显示从全景图投影到模型上的纹理（真实感强，但可能存在投影误差）。</li>
26
+ <li><code>0.5</code>: 两者混合。</li>
27
+ </ul>
28
+ </li>
29
+ </ul>
30
+ <h3 id="2-point-cloud-rendering-点云渲染" class="tsd-anchor-link">2. Point Cloud Rendering (点云渲染)<a href="#2-point-cloud-rendering-点云渲染" 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>
31
+ <p>Five 支持高性能的点云渲染（PBM），并提供灵活的样式配置：</p>
32
+ <ul>
33
+ <li><strong>Size Attenuation</strong>: 通过 <code>pointSize: 'ATTENUATION'</code> 开启近大远小的透视效果，增强空间感。</li>
34
+ <li><strong>Pixel Limits</strong>: 通过 <code>pointMinPixel</code> 和 <code>pointMaxPixel</code> 限制点在屏幕上的最小/最大像素尺寸，防止远处点消失或近处点过大遮挡视线。</li>
35
+ </ul>
36
+ <h3 id="3-floor-management-楼层管理" class="tsd-anchor-link">3. Floor Management (楼层管理)<a href="#3-floor-management-楼层管理" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
37
+ <p>对于多楼层场景，可以通过参数控制楼层的显示策略：</p>
38
+ <ul>
39
+ <li><strong>Floor Style (<code>floorStyle</code>)</strong>: 控制非当前楼层的显示方式（如 <code>OPACITY</code> 半透明、<code>VISIBILITY</code> 隐藏等）。</li>
40
+ <li><strong>Shown Floor (<code>shownFloorIndex</code>)</strong>: 指定当前高亮显示的楼层索引。</li>
41
+ </ul>
42
+ <h3 id="4-vertex-marks-semantic-filtering-顶点标记与语义过滤" class="tsd-anchor-link">4. Vertex Marks &amp; Semantic Filtering (顶点标记与语义过滤)<a href="#4-vertex-marks-semantic-filtering-顶点标记与语义过滤" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
43
+ <p><code>vertexMarks</code> 是一个<strong>全局开关</strong>，用于控制是否启用模型顶点上的语义标记（<code>_feature_id_rsmask</code>）逻辑。</p>
44
+ <ul>
45
+ <li><strong>机制</strong>: 模型顶点预置了 <code>_feature_id_rsmask</code> 属性，不同的值代表不同的语义部分。</li>
46
+ <li><strong>当前支持</strong>: 目前主要支持 <code>_feature_id_rsmask=1</code>（通常标记为天花板/房顶）。
47
+ <ul>
48
+ <li>当 <code>vertexMarks</code> 开启时，标记为 <code>1</code> 的顶点部分会在特定视角（如俯视）下自动隐藏，实现“开盖”效果，优化室内布局观测体验。</li>
49
+ </ul>
50
+ </li>
51
+ <li><strong>未来扩展</strong>: 该机制设计支持更多标记值，未来可能用于控制其他特定模型部件的显示效果。</li>
52
+ </ul>
53
+ <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>
54
+ <p>以下表格列出了控制材质与外观的可用参数，按使用频率和场景分类。</p>
55
+ <h3 id="common-configuration-常用配置" class="tsd-anchor-link">Common Configuration (常用配置)<a href="#common-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>
56
+ <table>
57
+ <thead>
58
+ <tr>
59
+ <th style="text-align:left">Parameter</th>
60
+ <th style="text-align:left">Type</th>
61
+ <th style="text-align:left">Default</th>
62
+ <th style="text-align:left">Description</th>
63
+ </tr>
64
+ </thead>
65
+ <tbody>
66
+ <tr>
67
+ <td style="text-align:left"><code>opacity</code></td>
68
+ <td style="text-align:left"><code>number</code></td>
69
+ <td style="text-align:left"><code>1.0</code></td>
70
+ <td style="text-align:left">模型整体透明度 [0, 1]。0 为完全透明，1 为完全不透明。</td>
71
+ </tr>
72
+ <tr>
73
+ <td style="text-align:left"><code>pointScale</code></td>
74
+ <td style="text-align:left"><code>number</code></td>
75
+ <td style="text-align:left"><code>0.02</code></td>
76
+ <td style="text-align:left">点的基础缩放比例（控制点的大小）。</td>
77
+ </tr>
78
+ <tr>
79
+ <td style="text-align:left"><code>pointSize</code></td>
80
+ <td style="text-align:left"><code>PBMPointSize</code></td>
81
+ <td style="text-align:left"><code>'ATTENUATION'</code></td>
82
+ <td style="text-align:left">点云大小绘制方式。<br><code>'ATTENUATION'</code>: 随距离衰减（近大远小）；<br><code>'FIXED'</code>: 固定像素大小。</td>
83
+ </tr>
84
+ <tr>
85
+ <td style="text-align:left"><code>pointShape</code></td>
86
+ <td style="text-align:left"><code>PBMPointShape</code></td>
87
+ <td style="text-align:left"><code>'CIRCLE'</code></td>
88
+ <td style="text-align:left">点云形状。<br><code>'CIRCLE'</code>: 圆形；<br><code>'SQUARE'</code>:方形。</td>
89
+ </tr>
90
+ <tr>
91
+ <td style="text-align:left"><code>pointBack</code></td>
92
+ <td style="text-align:left"><code>PBMPointBack</code></td>
93
+ <td style="text-align:left"><code>'DARK'</code></td>
94
+ <td style="text-align:left">点云背面绘制方式。</td>
95
+ </tr>
96
+ <tr>
97
+ <td style="text-align:left"><code>pointMinPixel</code></td>
98
+ <td style="text-align:left"><code>number</code></td>
99
+ <td style="text-align:left"><code>0</code></td>
100
+ <td style="text-align:left">点云最小像素尺寸。</td>
101
+ </tr>
102
+ <tr>
103
+ <td style="text-align:left"><code>pointMaxPixel</code></td>
104
+ <td style="text-align:left"><code>number</code></td>
105
+ <td style="text-align:left"><code>40</code></td>
106
+ <td style="text-align:left">点云最大像素尺寸。</td>
107
+ </tr>
108
+ <tr>
109
+ <td style="text-align:left"><code>pointAppearAnimation</code></td>
110
+ <td style="text-align:left"><code>boolean</code></td>
111
+ <td style="text-align:left"><code>true</code></td>
112
+ <td style="text-align:left">是否开启点云出现动画。</td>
113
+ </tr>
114
+ <tr>
115
+ <td style="text-align:left"><code>vertexMarks</code></td>
116
+ <td style="text-align:left"><code>boolean</code></td>
117
+ <td style="text-align:left"><code>true</code></td>
118
+ <td style="text-align:left">是否显示/生效标注。</td>
119
+ </tr>
120
+ <tr>
121
+ <td style="text-align:left"><code>brightness</code></td>
122
+ <td style="text-align:left"><code>number</code></td>
123
+ <td style="text-align:left"><code>1.0</code></td>
124
+ <td style="text-align:left">场景亮度倍数。</td>
125
+ </tr>
126
+ <tr>
127
+ <td style="text-align:left"><code>floorStyle</code></td>
128
+ <td style="text-align:left"><code>PBMFloorStyle</code></td>
129
+ <td style="text-align:left"><code>'OPACITY'</code></td>
130
+ <td style="text-align:left">楼层显示样式。</td>
131
+ </tr>
132
+ <tr>
133
+ <td style="text-align:left"><code>shownFloorIndex</code></td>
134
+ <td style="text-align:left"><code>number</code></td>
135
+ <td style="text-align:left"><code>-1</code></td>
136
+ <td style="text-align:left">当前显示的楼层索引。<code>-1</code> 表示显示所有楼层。</td>
137
+ </tr>
138
+ <tr>
139
+ <td style="text-align:left"><code>castShadow</code></td>
140
+ <td style="text-align:left"><code>boolean</code></td>
141
+ <td style="text-align:left"><code>false</code></td>
142
+ <td style="text-align:left">模型是否产生阴影。</td>
143
+ </tr>
144
+ <tr>
145
+ <td style="text-align:left"><code>receiveShadow</code></td>
146
+ <td style="text-align:left"><code>boolean</code></td>
147
+ <td style="text-align:left"><code>false</code></td>
148
+ <td style="text-align:left">模型是否接收阴影。</td>
149
+ </tr>
150
+ <tr>
151
+ <td style="text-align:left"><code>useAddBlend</code></td>
152
+ <td style="text-align:left"><code>boolean</code></td>
153
+ <td style="text-align:left"><code>false</code></td>
154
+ <td style="text-align:left">是否使用半透明叠加渲染。</td>
155
+ </tr>
156
+ <tr>
157
+ <td style="text-align:left"><code>customShaders</code></td>
158
+ <td style="text-align:left"><code>PBMCustomShader[]</code></td>
159
+ <td style="text-align:left"><code>[]</code></td>
160
+ <td style="text-align:left">自定义 Shader 配置。</td>
161
+ </tr>
162
+ <tr>
163
+ <td style="text-align:left"><code>clippers</code></td>
164
+ <td style="text-align:left"><code>PBMClipperParameter[]</code></td>
165
+ <td style="text-align:left"><code>[]</code></td>
166
+ <td style="text-align:left">模型裁切参数。</td>
167
+ </tr>
168
+ <tr>
169
+ <td style="text-align:left"><code>boundingBox</code></td>
170
+ <td style="text-align:left"><code>THREE.Box3</code></td>
171
+ <td style="text-align:left"><code>Infinity</code></td>
172
+ <td style="text-align:left">模型包围盒。</td>
173
+ </tr>
174
+ </tbody>
175
+ </table>
176
+ <h3 id="advanced-appearance-进阶外观配置" class="tsd-anchor-link">Advanced Appearance (进阶外观配置)<a href="#advanced-appearance-进阶外观配置" 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>
177
+ <blockquote>
178
+ <p>这些参数较少使用，仅在需要精细调整特殊视觉效果时修改。</p>
179
+ </blockquote>
180
+ <table>
181
+ <thead>
182
+ <tr>
183
+ <th style="text-align:left">Parameter</th>
184
+ <th style="text-align:left">Type</th>
185
+ <th style="text-align:left">Default</th>
186
+ <th style="text-align:left">Description</th>
187
+ </tr>
188
+ </thead>
189
+ <tbody>
190
+ <tr>
191
+ <td style="text-align:left"><code>colorSaturation</code></td>
192
+ <td style="text-align:left"><code>number</code></td>
193
+ <td style="text-align:left"><code>0.0</code></td>
194
+ <td style="text-align:left">饱和度调整值。</td>
195
+ </tr>
196
+ <tr>
197
+ <td style="text-align:left"><code>colorBrightness</code></td>
198
+ <td style="text-align:left"><code>number</code></td>
199
+ <td style="text-align:left"><code>0.0</code></td>
200
+ <td style="text-align:left">亮度调整值（与 <code>brightness</code> 叠加）。</td>
201
+ </tr>
202
+ <tr>
203
+ <td style="text-align:left"><code>colorStyle</code></td>
204
+ <td style="text-align:left"><code>PBMColorStyle</code></td>
205
+ <td style="text-align:left"><code>'RGB'</code></td>
206
+ <td style="text-align:left">颜色显示样式。</td>
207
+ </tr>
208
+ <tr>
209
+ <td style="text-align:left"><code>constantColor</code></td>
210
+ <td style="text-align:left"><code>THREE.Vector3</code></td>
211
+ <td style="text-align:left"><code>(0.6, 0.6, 0.6)</code></td>
212
+ <td style="text-align:left">模型纯色模式下的颜色值。</td>
213
+ </tr>
214
+ <tr>
215
+ <td style="text-align:left"><code>outlineGain</code></td>
216
+ <td style="text-align:left"><code>number</code></td>
217
+ <td style="text-align:left"><code>0.0</code></td>
218
+ <td style="text-align:left">轮廓线增益。</td>
219
+ </tr>
220
+ <tr>
221
+ <td style="text-align:left"><code>distanceGain</code></td>
222
+ <td style="text-align:left"><code>number</code></td>
223
+ <td style="text-align:left"><code>0.0</code></td>
224
+ <td style="text-align:left">距离增益。</td>
225
+ </tr>
226
+ <tr>
227
+ <td style="text-align:left"><code>gsSHDegree</code></td>
228
+ <td style="text-align:left"><code>number</code></td>
229
+ <td style="text-align:left"><code>0</code></td>
230
+ <td style="text-align:left">3D Gaussian Splatting 的球谐阶数。</td>
231
+ </tr>
232
+ </tbody>
233
+ </table>
234
+ <h3 id="internal-low-level-内部与底层配置" class="tsd-anchor-link">Internal &amp; Low-Level (内部与底层配置)<a href="#internal-low-level-内部与底层配置" 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>
235
+ <blockquote>
236
+ <p><strong>注意</strong>: 以下参数主要用于引擎内部状态同步或特定底层逻辑，<strong>不建议开发者手动修改</strong>，以免引起渲染异常。</p>
237
+ </blockquote>
238
+ <table>
239
+ <thead>
240
+ <tr>
241
+ <th style="text-align:left">Parameter</th>
242
+ <th style="text-align:left">Type</th>
243
+ <th style="text-align:left">Default</th>
244
+ <th style="text-align:left">Description</th>
245
+ </tr>
246
+ </thead>
247
+ <tbody>
248
+ <tr>
249
+ <td style="text-align:left"><code>modelAlpha</code></td>
250
+ <td style="text-align:left"><code>number</code></td>
251
+ <td style="text-align:left"><code>1.0</code></td>
252
+ <td style="text-align:left">模型纹理混合系数。通常由 Five 内部模式切换控制。</td>
253
+ </tr>
254
+ <tr>
255
+ <td style="text-align:left"><code>useHQWeight</code></td>
256
+ <td style="text-align:left"><code>boolean</code></td>
257
+ <td style="text-align:left"><code>false</code></td>
258
+ <td style="text-align:left">是否使用高质量权重计算（影响渲染质量）。</td>
259
+ </tr>
260
+ <tr>
261
+ <td style="text-align:left"><code>useHQDepth</code></td>
262
+ <td style="text-align:left"><code>boolean</code></td>
263
+ <td style="text-align:left"><code>false</code></td>
264
+ <td style="text-align:left">是否使用高质量深度遮罩。</td>
265
+ </tr>
266
+ <tr>
267
+ <td style="text-align:left"><code>progress</code></td>
268
+ <td style="text-align:left"><code>number</code></td>
269
+ <td style="text-align:left"><code>0</code></td>
270
+ <td style="text-align:left">全景图混合进度。</td>
271
+ </tr>
272
+ <tr>
273
+ <td style="text-align:left"><code>transition</code></td>
274
+ <td style="text-align:left"><code>PBMTransition</code></td>
275
+ <td style="text-align:left"><code>'FADE'</code></td>
276
+ <td style="text-align:left">全景图过渡混合模式。</td>
277
+ </tr>
278
+ <tr>
279
+ <td style="text-align:left"><code>gradientTexture</code></td>
280
+ <td style="text-align:left"><code>THREE.Texture</code></td>
281
+ <td style="text-align:left"><code>default</code></td>
282
+ <td style="text-align:left">高程着色材质纹理。</td>
283
+ </tr>
284
+ <tr>
285
+ <td style="text-align:left"><code>pano0</code></td>
286
+ <td style="text-align:left"><code>PBMPanoPicture</code></td>
287
+ <td style="text-align:left"><code>null</code></td>
288
+ <td style="text-align:left">起始点全景图信息。</td>
289
+ </tr>
290
+ <tr>
291
+ <td style="text-align:left"><code>pano1</code></td>
292
+ <td style="text-align:left"><code>PBMPanoPicture</code></td>
293
+ <td style="text-align:left"><code>null</code></td>
294
+ <td style="text-align:left">结束点全景图信息。</td>
295
+ </tr>
296
+ <tr>
297
+ <td style="text-align:left"><code>pano0Depth</code></td>
298
+ <td style="text-align:left"><code>PBMPanoDepth</code></td>
299
+ <td style="text-align:left"><code>null</code></td>
300
+ <td style="text-align:left">起始点深度信息。</td>
301
+ </tr>
302
+ <tr>
303
+ <td style="text-align:left"><code>pano1Depth</code></td>
304
+ <td style="text-align:left"><code>PBMPanoDepth</code></td>
305
+ <td style="text-align:left"><code>null</code></td>
306
+ <td style="text-align:left">结束点深度信息。</td>
307
+ </tr>
308
+ <tr>
309
+ <td style="text-align:left"><code>refinedScreen</code></td>
310
+ <td style="text-align:left"><code>PBMRefinedScreen</code></td>
311
+ <td style="text-align:left"><code>null</code></td>
312
+ <td style="text-align:left">细化瓦片的屏幕渲染配置。</td>
313
+ </tr>
314
+ </tbody>
315
+ </table>
316
+ <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>
317
+ <h3 id="1-adjusting-model-transparency-and-style-调整模型透明度与样式" class="tsd-anchor-link">1. Adjusting Model Transparency and Style (调整模型透明度与样式)<a href="#1-adjusting-model-transparency-and-style-调整模型透明度与样式" 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>
318
+ <pre><code class="typescript"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">model</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">opacity:</span><span class="hl-1"> </span><span class="hl-11">0.5</span><span class="hl-1">, </span><span class="hl-8">// Make model semi-transparent (半透明)</span><br/><span class="hl-1"> </span><span class="hl-6">modelAlpha:</span><span class="hl-1"> </span><span class="hl-11">0.0</span><span class="hl-1">, </span><span class="hl-8">// Show original UV texture only (仅显示原始UV贴图)</span><br/><span class="hl-1"> </span><span class="hl-6">floorStyle:</span><span class="hl-1"> </span><span class="hl-9">&#39;wireframe&#39;</span><span class="hl-1"> </span><span class="hl-8">// Wireframe mode (线框模式)</span><br/><span class="hl-1">});</span>
319
+ </code><button type="button">Copy</button></pre>
320
+
321
+ <h3 id="2-configuring-point-cloud-appearance-配置点云外观" class="tsd-anchor-link">2. Configuring Point Cloud Appearance (配置点云外观)<a href="#2-configuring-point-cloud-appearance-配置点云外观" 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>
322
+ <pre><code class="typescript"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">model</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">pointSize:</span><span class="hl-1"> </span><span class="hl-9">&#39;ATTENUATION&#39;</span><span class="hl-1">, </span><span class="hl-8">// 大小随距离衰减</span><br/><span class="hl-1"> </span><span class="hl-6">pointScale:</span><span class="hl-1"> </span><span class="hl-11">0.05</span><span class="hl-1">, </span><span class="hl-8">// 基础大小</span><br/><span class="hl-1"> </span><span class="hl-6">pointMaxPixel:</span><span class="hl-1"> </span><span class="hl-11">20</span><span class="hl-1"> </span><span class="hl-8">// 最大像素限制</span><br/><span class="hl-1">});</span>
323
+ </code><button type="button">Copy</button></pre>
324
+
325
+ <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>
326
+ <ul>
327
+ <li><a href="features_parameter.html">Parameter</a>: 配置系统入口与继承逻辑。</li>
328
+ <li><a href="features_3dtile.html">3DTile Params</a>: 性能与加载相关参数。</li>
329
+ </ul>
330
+ <hr>
331
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">material</span><span class="hl-1">, </span><span class="hl-2">appearance</span><span class="hl-1">, </span><span class="hl-2">pointcloud</span><span class="hl-1">, </span><span class="hl-2">parameter</span><span class="hl-1">, </span><span class="hl-2">roof</span><span class="hl-1">, </span><span class="hl-2">ceiling</span><span class="hl-1">, </span><span class="hl-2">config</span><span class="hl-1">]</span>
332
+ </code><button type="button">Copy</button></pre>
333
+
334
+ </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="#material-parameters-材质参数"><span>Material <wbr/>Parameters (材质参数)</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-transparency-blending-透明度与混合"><span>1. <wbr/>Transparency &amp; <wbr/>Blending (透明度与混合)</span></a></li><li><a href="#2-point-cloud-rendering-点云渲染"><span>2. <wbr/>Point <wbr/>Cloud <wbr/>Rendering (点云渲染)</span></a></li><li><a href="#3-floor-management-楼层管理"><span>3. <wbr/>Floor <wbr/>Management (楼层管理)</span></a></li><li><a href="#4-vertex-marks-semantic-filtering-顶点标记与语义过滤"><span>4. <wbr/>Vertex <wbr/>Marks &amp; <wbr/>Semantic <wbr/>Filtering (顶点标记与语义过滤)</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><ul><li><a href="#common-configuration-常用配置"><span>Common <wbr/>Configuration (常用配置)</span></a></li><li><a href="#advanced-appearance-进阶外观配置"><span>Advanced <wbr/>Appearance (进阶外观配置)</span></a></li><li><a href="#internal-low-level-内部与底层配置"><span>Internal &amp; <wbr/>Low-<wbr/>Level (内部与底层配置)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-adjusting-model-transparency-and-style-调整模型透明度与样式"><span>1. <wbr/>Adjusting <wbr/>Model <wbr/>Transparency and <wbr/>Style (调整模型透明度与样式)</span></a></li><li><a href="#2-configuring-point-cloud-appearance-配置点云外观"><span>2. <wbr/>Configuring <wbr/>Point <wbr/>Cloud <wbr/>Appearance (配置点云外观)</span></a></li></ul></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>