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

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 (762) hide show
  1. package/AGENTS_READ_ME.md +6 -1
  2. package/AI_CONTEXT.md +6 -1
  3. package/README.md +10 -6
  4. package/ai_guides/README.md +40 -2
  5. package/ai_guides/ai-doc-guidelines.md +31 -1
  6. package/ai_guides/api.md +107 -13
  7. package/ai_guides/features/3dtile.md +49 -141
  8. package/ai_guides/features/camera-animation.md +42 -4
  9. package/ai_guides/features/clipper.md +4 -2
  10. package/ai_guides/features/{coordnate-system.md → coordinate-system.md} +22 -2
  11. package/ai_guides/features/event.md +108 -10
  12. package/ai_guides/features/five.md +20 -16
  13. package/ai_guides/features/flowing-light-2d-pass.md +442 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +425 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/ai_guides/features/gesture.md +4 -1
  17. package/ai_guides/features/get-screen-pixels.md +4 -2
  18. package/ai_guides/features/image-options.md +5 -2
  19. package/ai_guides/features/load-external-model.md +27 -2
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +159 -0
  22. package/ai_guides/features/mode.md +5 -1
  23. package/ai_guides/features/model.md +5 -2
  24. package/ai_guides/features/move-pano-effect.md +3 -1
  25. package/ai_guides/features/multi-work.md +3 -1
  26. package/ai_guides/features/pano-filter.md +149 -0
  27. package/ai_guides/features/pano-tile.md +8 -15
  28. package/ai_guides/features/pano-uv.md +131 -0
  29. package/ai_guides/features/parameter.md +117 -118
  30. package/ai_guides/features/plugin.md +210 -0
  31. package/ai_guides/features/postprocessing.md +40 -5
  32. package/ai_guides/features/raycast.md +16 -2
  33. package/ai_guides/features/request-proxy.md +3 -1
  34. package/ai_guides/features/screen-project.md +4 -1
  35. package/ai_guides/features/state.md +25 -3
  36. package/ai_guides/features/view-layer.md +187 -0
  37. package/ai_guides/features/work.md +64 -3
  38. package/ai_guides/glossary.md +28 -7
  39. package/ai_guides/intro.md +1 -1
  40. package/ai_guides/quick-start.md +1 -0
  41. package/ai_guides/release_notes/6.8.md +222 -0
  42. package/ai_guides/template.md +28 -3
  43. package/docs/00_FOR_AI_AGENTS.md +3 -2
  44. package/docs/README.md +3 -2
  45. package/docs/assets/hierarchy.js +1 -1
  46. package/docs/assets/main.js +1 -1
  47. package/docs/assets/navigation.js +1 -1
  48. package/docs/assets/search.js +1 -1
  49. package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
  50. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  51. package/docs/classes/five.BoundingMesh.html +2 -2
  52. package/docs/classes/five.Camera.html +3 -3
  53. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  54. package/docs/classes/five.Five.html +77 -76
  55. package/docs/classes/five.FivePass.html +1 -1
  56. package/docs/classes/five.Histogram.html +19 -0
  57. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  58. package/docs/classes/five.Model.html +32 -32
  59. package/docs/classes/five.ModelScene.html +1 -1
  60. package/docs/classes/five.NetworkSubscribe.html +5 -5
  61. package/docs/classes/five.PBMContainer.html +1 -1
  62. package/docs/classes/five.PBMCustomShader.html +42 -3
  63. package/docs/classes/five.PBMGSObject.html +5 -3
  64. package/docs/classes/five.PBMGroup.html +1 -1
  65. package/docs/classes/five.PBMMesh.html +1 -1
  66. package/docs/classes/five.PBMMeshMaterial.html +16 -7
  67. package/docs/classes/five.PBMPanoFilter.html +61 -0
  68. package/docs/classes/five.PBMPointCloud.html +1 -1
  69. package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
  70. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  71. package/docs/classes/five.PBMUpdateable.html +41 -0
  72. package/docs/classes/five.PanoCircleMesh.html +1 -1
  73. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  74. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  75. package/docs/classes/five.Parameter.html +59 -55
  76. package/docs/classes/five.Scene.html +1 -1
  77. package/docs/classes/five.Subscribe.html +5 -5
  78. package/docs/classes/five.Tile.html +1 -1
  79. package/docs/classes/five.Tile3D.html +30 -26
  80. package/docs/classes/five.TileNode.html +1 -1
  81. package/docs/classes/five.Tileset.html +3 -2
  82. package/docs/classes/five.Trajectory.html +1 -1
  83. package/docs/classes/five.TrajectoryNode.html +1 -1
  84. package/docs/classes/five.Work.html +16 -16
  85. package/docs/classes/five.WorkResolvedObserver.html +41 -16
  86. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  87. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  88. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  89. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  90. package/docs/classes/gltf-loader.GLTFParser.html +1 -1
  91. package/docs/classes/gltf-loader.THREEGLTFLoader.html +2 -2
  92. package/docs/classes/line.Line.html +1 -1
  93. package/docs/classes/line.LineGeometry.html +1 -1
  94. package/docs/classes/line.LineMaterial.html +1 -1
  95. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  96. package/docs/classes/line.THREE_Line2.html +1 -1
  97. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  98. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  99. package/docs/classes/plugins.CSS3DObject.html +7 -0
  100. package/docs/classes/plugins.CSS3DSprite.html +7 -0
  101. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  102. package/docs/classes/sticker.Sticker.html +1 -1
  103. package/docs/classes/vfx.Airflow.html +1 -1
  104. package/docs/classes/vfx.Flame.html +1 -1
  105. package/docs/classes/vfx.Particle.html +6 -6
  106. package/docs/classes/vfx.ParticleGPU.html +3 -3
  107. package/docs/classes/vfx.SpotLight.html +1 -1
  108. package/docs/documents/README.html +132 -3
  109. package/docs/documents/ai-doc-guidelines.html +48 -3
  110. package/docs/documents/api.html +179 -26
  111. package/docs/documents/features_3dtile.html +143 -46
  112. package/docs/documents/features_camera-animation.html +79 -6
  113. package/docs/documents/features_clipper.html +5 -2
  114. package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +56 -4
  115. package/docs/documents/features_event.html +47 -8
  116. package/docs/documents/features_five.html +20 -16
  117. package/docs/documents/features_flowing-light-2d-pass.html +259 -0
  118. package/docs/documents/features_flowing-light-3d-pass.html +249 -0
  119. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  120. package/docs/documents/features_gesture.html +5 -1
  121. package/docs/documents/features_get-screen-pixels.html +5 -2
  122. package/docs/documents/features_image-options.html +5 -2
  123. package/docs/documents/features_load-external-model.html +31 -4
  124. package/docs/documents/features_load-progress.html +110 -0
  125. package/docs/documents/features_material.html +341 -0
  126. package/docs/documents/features_mode.html +6 -1
  127. package/docs/documents/features_model.html +6 -2
  128. package/docs/documents/features_move-pano-effect.html +4 -1
  129. package/docs/documents/features_multi-work.html +4 -1
  130. package/docs/documents/features_pano-filter.html +123 -0
  131. package/docs/documents/features_pano-tile.html +35 -20
  132. package/docs/documents/features_pano-uv.html +82 -0
  133. package/docs/documents/features_parameter.html +84 -56
  134. package/docs/documents/features_plugin.html +105 -0
  135. package/docs/documents/features_postprocessing.html +23 -6
  136. package/docs/documents/features_raycast.html +9 -3
  137. package/docs/documents/features_request-proxy.html +4 -1
  138. package/docs/documents/features_screen-project.html +5 -1
  139. package/docs/documents/features_state.html +12 -2
  140. package/docs/documents/features_view-layer.html +158 -0
  141. package/docs/documents/features_work.html +64 -3
  142. package/docs/documents/glossary.html +33 -8
  143. package/docs/documents/intro.html +1 -1
  144. package/docs/documents/quick-start.html +1 -0
  145. package/docs/documents/release_notes_6.8.html +203 -0
  146. package/docs/documents/template.html +54 -4
  147. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  148. package/docs/functions/five.loadAt3d.html +1 -1
  149. package/docs/functions/five.loadB3dm.html +1 -1
  150. package/docs/functions/five.loadDome.html +1 -1
  151. package/docs/functions/five.loadDomez.html +1 -1
  152. package/docs/functions/five.loadFbx.html +1 -1
  153. package/docs/functions/five.loadGltf.html +1 -1
  154. package/docs/functions/five.loadPbm.html +1 -1
  155. package/docs/functions/five.loadPly.html +1 -1
  156. package/docs/functions/five.loadPnts.html +1 -1
  157. package/docs/functions/five.loadSplat.html +1 -1
  158. package/docs/functions/five.loadSpz.html +1 -1
  159. package/docs/functions/five.loadX3p.html +1 -1
  160. package/docs/functions/five.parseWork.html +1 -1
  161. package/docs/functions/plugins.CSS3DPlugin.html +1 -0
  162. package/docs/functions/plugins.GaussianSplattingEntranceAnimationPlugin.html +1 -0
  163. package/docs/functions/react.useFiveCurrentObserver.html +2 -2
  164. package/docs/functions/react.useFiveFloor.html +2 -2
  165. package/docs/functions/react.useFiveProject2d.html +2 -2
  166. package/docs/functions/vue.useFiveCurrentObserver.html +2 -2
  167. package/docs/functions/vue.useFiveFloor.html +2 -2
  168. package/docs/functions/vue.useFiveWorks.html +2 -2
  169. package/docs/hierarchy.html +1 -1
  170. package/docs/index.html +132 -3
  171. package/docs/interfaces/five.AddableObject.html +1 -1
  172. package/docs/interfaces/five.AjaxOptions.html +1 -1
  173. package/docs/interfaces/five.BaseEvent.html +7 -2
  174. package/docs/interfaces/five.BaseExtendableEvent.html +11 -0
  175. package/docs/interfaces/five.EventCallback.html +60 -52
  176. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  177. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
  178. package/docs/interfaces/five.GestureEvent.html +21 -2
  179. package/docs/interfaces/five.GesturePointer.html +20 -0
  180. package/docs/interfaces/five.ImageOptions.html +1 -1
  181. package/docs/interfaces/five.IntersectEvent.html +10 -2
  182. package/docs/interfaces/five.IntersectMesh.html +1 -1
  183. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  184. package/docs/interfaces/five.Intersection.html +4 -3
  185. package/docs/interfaces/five.LooseWorkObserver.html +2 -2
  186. package/docs/interfaces/five.LooseWorkPanorama.html +2 -2
  187. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  188. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +10 -10
  189. package/docs/interfaces/five.ModeChangeEvent.html +9 -2
  190. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  191. package/docs/interfaces/five.ModelEvent.html +7 -2
  192. package/docs/interfaces/five.ModelSceneEvent.html +7 -2
  193. package/docs/interfaces/five.ModelTileEvent.html +13 -0
  194. package/docs/interfaces/five.MovePanoOptions.html +8 -8
  195. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  196. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  197. package/docs/interfaces/five.NetworkOptions.html +1 -1
  198. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  199. package/docs/interfaces/five.NetworkResourceEvent.html +7 -2
  200. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  201. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  202. package/docs/interfaces/five.ObjectEvent.html +7 -2
  203. package/docs/interfaces/five.PBMClipperParameter.html +2 -2
  204. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
  205. package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
  206. package/docs/interfaces/five.PBMMaterial.html +1 -1
  207. package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
  208. package/docs/interfaces/five.PBMPanoDepth.html +5 -5
  209. package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
  210. package/docs/interfaces/five.PBMPanoPicture.html +8 -6
  211. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
  212. package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
  213. package/docs/interfaces/five.PanoCircleMeshInterface.html +2 -2
  214. package/docs/interfaces/five.PanoEvent.html +15 -2
  215. package/docs/interfaces/five.PanoPrepareEvent.html +15 -0
  216. package/docs/interfaces/five.PanoTextureEvent.html +11 -2
  217. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  218. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  219. package/docs/interfaces/five.ParameterMaterialValue.html +42 -38
  220. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  221. package/docs/interfaces/five.ParameterValue.html +56 -52
  222. package/docs/interfaces/five.Pose.html +1 -1
  223. package/docs/interfaces/five.RenderEvent.html +7 -2
  224. package/docs/interfaces/five.ResolvedParameterValue.html +57 -54
  225. package/docs/interfaces/five.RgbaData.html +7 -0
  226. package/docs/interfaces/five.SplatData.html +2 -2
  227. package/docs/interfaces/five.State.html +1 -1
  228. package/docs/interfaces/five.StateEvent.html +9 -2
  229. package/docs/interfaces/five.TextureOptions.html +1 -1
  230. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  231. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
  232. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  233. package/docs/interfaces/five.ViewLayer.html +30 -26
  234. package/docs/interfaces/five.WorkCubeImage.html +3 -2
  235. package/docs/interfaces/five.WorkImage.html +6 -5
  236. package/docs/interfaces/five.WorkInitial.html +8 -8
  237. package/docs/interfaces/five.WorkModel.html +8 -8
  238. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  239. package/docs/interfaces/five.WorkObserver.html +42 -17
  240. package/docs/interfaces/five.WorkObserverJson.html +2 -2
  241. package/docs/interfaces/five.WorkObserverProto.html +26 -0
  242. package/docs/interfaces/five.WorkPanoramaJson.html +2 -2
  243. package/docs/interfaces/five.WorkTile.html +6 -5
  244. package/docs/interfaces/five.WorkVideo.html +4 -4
  245. package/docs/interfaces/five.WorksEvent.html +7 -2
  246. package/docs/interfaces/five.XRControllerEvent.html +10 -2
  247. package/docs/interfaces/five.XRControllerState.html +8 -0
  248. package/docs/interfaces/five.XRGestureEvent.html +13 -2
  249. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  250. package/docs/interfaces/five.XRSessionEvent.html +9 -2
  251. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  252. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  253. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  254. package/docs/interfaces/plugins.CSS3DPluginController.html +50 -0
  255. package/docs/interfaces/plugins.CSS3DPluginType.Config.html +2 -0
  256. package/docs/interfaces/plugins.CSS3DPluginType.CreateCSS3DObjectType.html +10 -0
  257. package/docs/interfaces/plugins.CSS3DPluginType.EventMap.html +10 -0
  258. package/docs/interfaces/plugins.CSS3DPluginType.Params.html +4 -0
  259. package/docs/interfaces/plugins.CSS3DPluginType.State.html +8 -0
  260. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +3 -3
  261. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  262. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  263. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationController.html +44 -0
  264. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.BoundingAABB2D.html +3 -0
  265. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Config.html +8 -0
  266. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.EventMap.html +10 -0
  267. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Keyframe.html +3 -0
  268. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.State.html +8 -0
  269. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  270. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  271. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +2 -2
  272. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  273. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  274. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  275. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  276. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  277. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  278. package/docs/interfaces/plugins.PlayingState.html +2 -2
  279. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  280. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  281. package/docs/interfaces/plugins.TrajectoryController.html +8 -8
  282. package/docs/interfaces/react.FiveInjectionTypes.html +21 -21
  283. package/docs/interfaces/sticker.IntersectionLike.html +2 -2
  284. package/docs/interfaces/vfx.ParticleArgs.html +4 -4
  285. package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
  286. package/docs/modules/five.html +1 -1
  287. package/docs/modules/plugins.CSS3DPluginType.html +1 -0
  288. package/docs/modules/plugins.GaussianSplattingEntranceAnimationPluginType.html +1 -0
  289. package/docs/modules/plugins.html +1 -1
  290. package/docs/modules.html +1 -1
  291. package/docs/types/five.ControllerEventTypes.html +30 -26
  292. package/docs/types/five.EasingFunction.html +1 -0
  293. package/docs/types/five.EventTypes.html +27 -25
  294. package/docs/types/five.LegacyEventType.html +7 -7
  295. package/docs/types/five.NetworkProgressCallback.html +1 -1
  296. package/docs/types/five.PBMAlphaMode.html +1 -1
  297. package/docs/types/five.PBMColorStyle.html +1 -1
  298. package/docs/types/five.PBMFloorStyle.html +1 -1
  299. package/docs/types/five.PBMMeshShaderType.html +1 -1
  300. package/docs/types/five.PBMPointBack.html +1 -1
  301. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  302. package/docs/types/five.PBMPointShape.html +1 -1
  303. package/docs/types/five.PBMPointSize.html +1 -1
  304. package/docs/types/five.PBMTransition.html +1 -1
  305. package/docs/types/five.ParseOptions.html +6 -6
  306. package/docs/types/five.Works.html +1 -1
  307. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  308. package/docs/types/plugins.CSS3DPluginType.PluginData.html +1 -0
  309. package/docs/types/plugins.CSS3DPluginType.ServerData.html +1 -0
  310. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  311. package/five/application/analysis.d.ts +40 -0
  312. package/five/application/controllers.d.ts +41 -0
  313. package/five/application/events-legacy.d.ts +454 -0
  314. package/five/application/events.d.ts +69 -0
  315. package/five/application/five.d.ts +519 -0
  316. package/five/application/fiveInitArgs.d.ts +176 -0
  317. package/five/application/fiveLoadOptions.d.ts +21 -0
  318. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  319. package/five/application/getViewportScale.d.ts +2 -0
  320. package/five/application/initLights.d.ts +3 -0
  321. package/five/application/mode.d.ts +28 -0
  322. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  323. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  324. package/five/assets/gradient-png-data-url.d.ts +2 -0
  325. package/five/assets/loading-png-data-url.d.ts +2 -0
  326. package/five/assets/phone-png-data-url.d.ts +2 -0
  327. package/five/assets/realsee-png-data-url.d.ts +2 -0
  328. package/five/bvh/bvhMath.d.ts +33 -0
  329. package/five/bvh/bvhMesh.d.ts +7 -0
  330. package/five/bvh/bvhNode.d.ts +29 -0
  331. package/five/bvh/bvhObject.d.ts +18 -0
  332. package/five/bvh/bvhPoints.d.ts +6 -0
  333. package/five/bvh/index.d.ts +10 -0
  334. package/five/bvh/worker.d.ts +35 -0
  335. package/five/cardboard/helper.d.ts +2 -0
  336. package/five/cardboard/index.d.ts +13 -0
  337. package/five/cardboard/sensor.d.ts +158 -0
  338. package/five/certificates/hardware.d.ts +1 -0
  339. package/five/controllers/base.d.ts +167 -0
  340. package/five/controllers/events.d.ts +73 -0
  341. package/five/controllers/floorplan.d.ts +119 -0
  342. package/five/controllers/mapview.d.ts +139 -0
  343. package/five/controllers/model.d.ts +57 -0
  344. package/five/controllers/panorama.d.ts +144 -0
  345. package/five/controllers/panoramaLike.d.ts +87 -0
  346. package/five/controllers/topview.d.ts +42 -0
  347. package/five/controllers/vrPanorama.d.ts +56 -0
  348. package/five/controllers/xrPanorama.d.ts +81 -0
  349. package/five/core/camera.d.ts +65 -0
  350. package/five/core/internalWebGLRenderer.d.ts +14 -0
  351. package/five/core/panoVideo.d.ts +18 -0
  352. package/five/core/scene.d.ts +10 -0
  353. package/five/core/tiling.d.ts +43 -0
  354. package/five/declare.d.ts +2 -1
  355. package/five/gaussian-splatting/util/renderData.d.ts +66 -0
  356. package/five/gaussian-splatting/wasm/data.d.ts +20 -0
  357. package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
  358. package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
  359. package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
  360. package/five/index.d.ts +60 -4636
  361. package/five/index.js +272 -392
  362. package/five/index.mjs +26890 -31013
  363. package/five/meshes/boundingMesh.d.ts +13 -0
  364. package/five/meshes/intersectMesh.d.ts +8 -0
  365. package/five/meshes/panoCircleMesh.d.ts +35 -0
  366. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  367. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  368. package/five/meshes/panoSphereMesh.d.ts +27 -0
  369. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  370. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  371. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  372. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  373. package/five/model/index.d.ts +70 -0
  374. package/five/model/intersection.d.ts +18 -0
  375. package/five/model/loaders/at3d.d.ts +12 -0
  376. package/five/model/loaders/b3dm.d.ts +9 -0
  377. package/five/model/loaders/dome.d.ts +22 -0
  378. package/five/model/loaders/domez.d.ts +11 -0
  379. package/five/model/loaders/fbx.d.ts +8 -0
  380. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  381. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  382. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  383. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  384. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  385. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  386. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +26 -0
  387. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +11 -0
  388. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
  389. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  390. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  391. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  392. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  393. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  394. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  395. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  396. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  397. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  398. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  399. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +25 -0
  400. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  401. package/five/model/loaders/glTF-helpers/index.d.ts +51 -0
  402. package/five/model/loaders/glTF-helpers/parser.d.ts +115 -0
  403. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  404. package/five/model/loaders/gltf.d.ts +10 -0
  405. package/five/model/loaders/obj.d.ts +9 -0
  406. package/five/model/loaders/pbm.d.ts +26 -0
  407. package/five/model/loaders/ply.d.ts +24 -0
  408. package/five/model/loaders/pnts.d.ts +8 -0
  409. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  410. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  411. package/five/model/loaders/shared.d.ts +16 -0
  412. package/five/model/loaders/splat.d.ts +8 -0
  413. package/five/model/loaders/spz.d.ts +14 -0
  414. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  415. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  416. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  417. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  418. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  419. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  420. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  421. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  422. package/five/model/loaders/x3p.d.ts +22 -0
  423. package/five/model/materials/pbmMaterial.d.ts +137 -0
  424. package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
  425. package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -0
  426. package/five/model/model-scene.d.ts +172 -0
  427. package/five/model/model.d.ts +209 -0
  428. package/five/model/objects/pbmContainer.d.ts +28 -0
  429. package/five/model/objects/pbmGaussianSplattingObject.d.ts +43 -0
  430. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +59 -0
  431. package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
  432. package/five/model/objects/pbmGroup.d.ts +8 -0
  433. package/five/model/objects/pbmMesh.d.ts +10 -0
  434. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  435. package/five/model/parameter.d.ts +141 -0
  436. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  437. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  438. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  439. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  440. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  441. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  442. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  443. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  444. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  445. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  446. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  447. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  448. package/five/model/tile3d/header.d.ts +88 -0
  449. package/five/model/tile3d/index.d.ts +216 -0
  450. package/five/model/tile3d/tile-cache.d.ts +18 -0
  451. package/five/model/tile3d/tile-content.d.ts +10 -0
  452. package/five/model/tile3d/tile-node.d.ts +24 -0
  453. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  454. package/five/model/tile3d/tile.d.ts +79 -0
  455. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  456. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  457. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  458. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  459. package/five/model/tile3d/tileset.d.ts +70 -0
  460. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  461. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  462. package/five/model/tile3d/trajectory.d.ts +30 -0
  463. package/five/model/tile3d/types.d.ts +33 -0
  464. package/five/model/view-layer.d.ts +20 -0
  465. package/five/renderer/five-renderer.d.ts +17 -0
  466. package/five/renderer/index.d.ts +3 -0
  467. package/five/renderer/postprocessing/composer.d.ts +37 -0
  468. package/five/renderer/postprocessing/index.d.ts +7 -0
  469. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +17 -0
  470. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  471. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  472. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  473. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  474. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  475. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  476. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  477. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  478. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  479. package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
  480. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  481. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  482. package/five/texture/histogram.d.ts +54 -0
  483. package/five/texture/imageBitmap.d.ts +13 -0
  484. package/five/texture/initTexture.d.ts +3 -0
  485. package/five/texture/loader.d.ts +39 -0
  486. package/five/texture/textureData.d.ts +11 -0
  487. package/five/thirdparty/fflate.d.ts +1407 -0
  488. package/five/thirdparty/hammer.d.ts +375 -0
  489. package/five/thirdparty/jsrsasign.d.ts +753 -0
  490. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  491. package/five/three-version-check.d.ts +1 -0
  492. package/five/types/addableObject.d.ts +12 -0
  493. package/five/types/cube.d.ts +1 -0
  494. package/five/types/gestureInput.d.ts +24 -0
  495. package/five/types/imageOptions.d.ts +20 -0
  496. package/five/types/intersectMeshInterface.d.ts +8 -0
  497. package/five/types/movePanoEffect.d.ts +13 -0
  498. package/five/types/movePanoOptions.d.ts +36 -0
  499. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  500. package/five/types/plugin.d.ts +25 -0
  501. package/five/types/pose.d.ts +17 -0
  502. package/five/types/state.d.ts +20 -0
  503. package/five/types/viewport.d.ts +22 -0
  504. package/five/utils/ajax.d.ts +66 -0
  505. package/five/utils/animationFrameLoop.d.ts +45 -0
  506. package/five/utils/array.d.ts +31 -0
  507. package/five/utils/asyncTaskQueue.d.ts +8 -0
  508. package/five/utils/bufferGeometry.d.ts +33 -0
  509. package/five/utils/calculateProgress.d.ts +39 -0
  510. package/five/utils/calculateThreeMouse.d.ts +13 -0
  511. package/five/utils/canplayVideo.d.ts +2 -0
  512. package/five/utils/clamp.d.ts +2 -0
  513. package/five/utils/clock.d.ts +17 -0
  514. package/five/utils/createSymbol.d.ts +5 -0
  515. package/five/utils/decodeText.d.ts +2 -0
  516. package/five/utils/deepEqual.d.ts +2 -0
  517. package/five/utils/deepFreeze.d.ts +2 -0
  518. package/five/utils/defineProperty.d.ts +9 -0
  519. package/five/utils/detector.d.ts +14 -0
  520. package/five/utils/distance.d.ts +10 -0
  521. package/five/utils/draco.d.ts +26 -0
  522. package/five/utils/easing.d.ts +63 -0
  523. package/five/utils/error.d.ts +1 -0
  524. package/five/utils/event.d.ts +210 -0
  525. package/five/utils/formatRad.d.ts +7 -0
  526. package/five/utils/imageSupport.d.ts +6 -0
  527. package/five/utils/imageURL.d.ts +42 -0
  528. package/five/utils/isEmptyObject.d.ts +2 -0
  529. package/five/utils/isNil.d.ts +6 -0
  530. package/five/utils/isNumber.d.ts +2 -0
  531. package/five/utils/isPowerOfTwo.d.ts +2 -0
  532. package/five/utils/isPromise.d.ts +2 -0
  533. package/five/utils/isSimilar.d.ts +6 -0
  534. package/five/utils/json.d.ts +7 -0
  535. package/five/utils/ktx2.d.ts +30 -0
  536. package/five/utils/lzma/index.d.ts +2 -0
  537. package/five/utils/lzma/lzma.d.ts +3 -0
  538. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  539. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  540. package/five/utils/memoryUsage.d.ts +29 -0
  541. package/five/utils/motion.d.ts +38 -0
  542. package/five/utils/noop.d.ts +6 -0
  543. package/five/utils/now.d.ts +7 -0
  544. package/five/utils/pano.d.ts +9 -0
  545. package/five/utils/pick.d.ts +3 -0
  546. package/five/utils/poseUtils.d.ts +5 -0
  547. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  548. package/five/utils/renderDepth.d.ts +2 -0
  549. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  550. package/five/utils/requestPermission.d.ts +3 -0
  551. package/five/utils/shaderContentFix.d.ts +7 -0
  552. package/five/utils/shaderMaterial.d.ts +20 -0
  553. package/five/utils/stateUtils.d.ts +5 -0
  554. package/five/utils/string-pattern.d.ts +8 -0
  555. package/five/utils/subscribe.d.ts +67 -0
  556. package/five/utils/tileCube.d.ts +19 -0
  557. package/five/utils/toFastProperties.d.ts +1 -0
  558. package/five/utils/typedCache.d.ts +10 -0
  559. package/five/utils/uniform.d.ts +15 -0
  560. package/five/utils/url.d.ts +35 -0
  561. package/five/utils/uuid.d.ts +5 -0
  562. package/five/utils/values.d.ts +2 -0
  563. package/five/utils/vectorCoordinates.d.ts +29 -0
  564. package/five/utils/volume.d.ts +111 -0
  565. package/five/utils/webglError.d.ts +7 -0
  566. package/five/utils/worker.d.ts +26 -0
  567. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  568. package/five/webxr/motionHelper.d.ts +68 -0
  569. package/five/webxr/xrButton.d.ts +4 -0
  570. package/five/webxr/xrController.d.ts +24 -0
  571. package/five/webxr/xrManager.d.ts +84 -0
  572. package/five/work/_ALLOW_HOST.d.ts +2 -0
  573. package/five/work/index.d.ts +7 -0
  574. package/five/work/keychain.d.ts +5 -0
  575. package/five/work/looseWorkType.d.ts +121 -0
  576. package/five/work/verify.d.ts +7 -0
  577. package/five/work/work.d.ts +206 -0
  578. package/five/work/workFetcher.d.ts +4 -0
  579. package/five/work/workJson.d.ts +3 -0
  580. package/five/work/workJsonType.d.ts +73 -0
  581. package/five/work/workObserverProto.d.ts +39 -0
  582. package/five/work/workParser.d.ts +6 -0
  583. package/five/work/workResolvedObserver.d.ts +12 -0
  584. package/five/work/workVerify.d.ts +2 -0
  585. package/five/work/works.d.ts +10 -0
  586. package/gltf-loader/gltf-object.d.ts +17 -0
  587. package/gltf-loader/index.d.ts +60 -160
  588. package/gltf-loader/index.js +9 -9
  589. package/gltf-loader/index.mjs +1351 -1451
  590. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  591. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  592. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  593. package/line/circle_png.d.ts +1 -0
  594. package/line/index.d.ts +19 -69
  595. package/line/index.js +4 -4
  596. package/line/index.mjs +334 -513
  597. package/line/utils/Line2.d.ts +7 -0
  598. package/line/utils/LineGeometry.d.ts +10 -0
  599. package/line/utils/LineMaterial.d.ts +20 -0
  600. package/line/utils/LineSegments2.d.ts +11 -0
  601. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  602. package/llms.txt +48 -3
  603. package/package.json +4 -4
  604. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  605. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  606. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  607. package/plugins/BasePlugin/index.d.ts +119 -0
  608. package/plugins/CSS3DPlugin/Controller.d.ts +60 -0
  609. package/plugins/CSS3DPlugin/index.d.ts +5 -0
  610. package/plugins/CSS3DPlugin/typing.d.ts +32 -0
  611. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  612. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  613. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  614. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  615. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  616. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  617. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  618. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  619. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  620. package/plugins/GaussianSplattingEntranceAnimationPlugin/Controller.d.ts +30 -0
  621. package/plugins/GaussianSplattingEntranceAnimationPlugin/index.d.ts +5 -0
  622. package/plugins/GaussianSplattingEntranceAnimationPlugin/typing.d.ts +28 -0
  623. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  624. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  625. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  626. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  627. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  628. package/plugins/OrientationPlugin/index.d.ts +6 -0
  629. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  630. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  631. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  632. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  633. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  634. package/plugins/PluginTemplate/index.d.ts +5 -0
  635. package/plugins/PluginTemplate/typing.d.ts +21 -0
  636. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  637. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  638. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  639. package/plugins/index.d.ts +11 -1102
  640. package/plugins/index.js +37 -21
  641. package/plugins/index.mjs +3630 -4247
  642. package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
  643. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  644. package/plugins/utils/absoluteUrl.d.ts +5 -0
  645. package/plugins/utils/clamp.d.ts +2 -0
  646. package/plugins/utils/loadImage.d.ts +1 -0
  647. package/plugins/utils/motion.d.ts +38 -0
  648. package/plugins/utils/now.d.ts +6 -0
  649. package/plugins/utils/uuid.d.ts +2 -0
  650. package/react/canvas.d.ts +19 -0
  651. package/react/context.d.ts +12 -0
  652. package/react/createProvider.d.ts +95 -0
  653. package/react/createStore.d.ts +144 -0
  654. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  655. package/react/hooks/useFiveAction.d.ts +147 -0
  656. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  657. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  658. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  659. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  660. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  661. package/react/hooks/useFiveFloor.d.ts +15 -0
  662. package/react/hooks/useFiveHelper.d.ts +14 -0
  663. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  664. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  665. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  666. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  667. package/react/hooks/useFiveProject2d.d.ts +20 -0
  668. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  669. package/react/hooks/useFiveState.d.ts +6 -0
  670. package/react/hooks/useFiveWork.d.ts +29 -0
  671. package/react/index.d.ts +24 -830
  672. package/react/index.js +3 -3
  673. package/react/index.mjs +572 -783
  674. package/react/rendererPool.d.ts +7 -0
  675. package/react/withFive.d.ts +213 -0
  676. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  677. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  678. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  679. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  680. package/shader-lib/ShineModel/index.d.ts +7 -0
  681. package/shader-lib/SweepModel/index.d.ts +7 -0
  682. package/shader-lib/index.d.ts +5 -86
  683. package/shader-lib/index.js +13 -14
  684. package/shader-lib/index.mjs +424 -824
  685. package/sticker/geometry.d.ts +3 -0
  686. package/sticker/index.d.ts +68 -71
  687. package/sticker/index.js +3 -3
  688. package/sticker/index.mjs +102 -142
  689. package/umd/five-gltf-loader.js +9 -9
  690. package/umd/five-line.js +4 -4
  691. package/umd/five-plugins.js +37 -21
  692. package/umd/five-react.js +3 -3
  693. package/umd/five-shader-lib.js +13 -14
  694. package/umd/five-sticker.js +3 -3
  695. package/umd/five-vfx.js +21 -21
  696. package/umd/five-vue.js +3 -3
  697. package/umd/five.js +267 -387
  698. package/vfx/airflow/airflow.d.ts +18 -0
  699. package/vfx/airflow/fragment-shader.d.ts +2 -0
  700. package/vfx/airflow/vertex-shader.d.ts +2 -0
  701. package/vfx/common/scale-shader.d.ts +2 -0
  702. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  703. package/vfx/frame/fragment-shader.d.ts +2 -0
  704. package/vfx/frame/frame.d.ts +22 -0
  705. package/vfx/frame/vertex-shader.d.ts +2 -0
  706. package/vfx/index.d.ts +7 -363
  707. package/vfx/index.js +21 -21
  708. package/vfx/index.mjs +454 -910
  709. package/vfx/particle/fragment-shader.d.ts +2 -0
  710. package/vfx/particle/instance.d.ts +36 -0
  711. package/vfx/particle/particle.d.ts +205 -0
  712. package/vfx/particle/utils.d.ts +11 -0
  713. package/vfx/particle/vertex-shader.d.ts +2 -0
  714. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  715. package/vfx/particle-gpu/instance.d.ts +36 -0
  716. package/vfx/particle-gpu/particle.d.ts +95 -0
  717. package/vfx/particle-gpu/utils.d.ts +11 -0
  718. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  719. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  720. package/vfx/spotLight/spotLight.d.ts +15 -0
  721. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  722. package/vue/context.d.ts +7 -0
  723. package/vue/hooks/FiveCanvas.d.ts +36 -0
  724. package/vue/hooks/FiveProvider.d.ts +35 -0
  725. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  726. package/vue/hooks/useFiveAction.d.ts +178 -0
  727. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  728. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  729. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  730. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  731. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  732. package/vue/hooks/useFiveFloor.d.ts +16 -0
  733. package/vue/hooks/useFiveHelper.d.ts +15 -0
  734. package/vue/hooks/useFiveModel.d.ts +7 -0
  735. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  736. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  737. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  738. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  739. package/vue/hooks/useFiveScene.d.ts +6 -0
  740. package/vue/hooks/useFiveState.d.ts +16 -0
  741. package/vue/hooks/useFiveWork.d.ts +30 -0
  742. package/vue/index.d.ts +23 -467
  743. package/vue/index.js +3 -3
  744. package/vue/index.mjs +309 -301
  745. package/vue/rendererPool.d.ts +10 -0
  746. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  747. package/work-downloader/components/model.d.ts +3 -0
  748. package/work-downloader/components/observer.d.ts +7 -0
  749. package/work-downloader/download.d.ts +16 -0
  750. package/work-downloader/index.d.ts +2 -33
  751. package/work-downloader/index.js +3 -3
  752. package/work-downloader/index.mjs +317 -556
  753. package/work-downloader/type.d.ts +28 -0
  754. package/work-downloader/utils/download-to-file.d.ts +1 -0
  755. package/work-downloader/utils/image-processing.d.ts +7 -0
  756. package/work-downloader/utils/join-url.d.ts +2 -0
  757. package/work-downloader/utils/log.d.ts +1 -0
  758. package/work-downloader/utils/relative-url.d.ts +1 -0
  759. package/ai_guides/plugin.md +0 -206
  760. package/docs/documents/plugin.html +0 -60
  761. package/docs/media/five.ts +0 -2881
  762. package/docs/media/pass.ts +0 -64
package/docs/documents/features_pano-uv.html ADDED
@@ -0,0 +1,82 @@
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/pano-uv | 如视 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/pano-uv</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="全景图-uv-与方向转换-panorama-uv-conversion" class="tsd-anchor-link">全景图 UV 与方向转换 (Panorama UV Conversion)<a href="#全景图-uv-与方向转换-panorama-uv-conversion" 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>: 提供了一组工具方法，用于在<strong>全景图 UV 坐标</strong> (Equirectangular UV / Cubemap UV) 与<strong>三维空间方向向量</strong> (Vector3) 之间进行转换。</li>
4
+ <li><strong>Schema</strong>: 依赖 <code>WorkObserver</code> 实例，提供四个核心转换方法。</li>
5
+ <li><strong>Concepts</strong>: Equirectangular Projection, Cubemap Projection, UV Origin, Coordinate Systems.</li>
6
+ <li><strong>Configuration</strong>: <code>uvOrigin</code> (UV 原点设置).</li>
7
+ <li><strong>Examples</strong>: 向量转全景 UV、UV 转向量、Cubemap 转换。</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/work/work.d.ts">WorkObserver</a></p>
12
+ </blockquote>
13
+ <p>这些方法挂载在 <code>WorkObserver</code> 实例上，依赖当前观察点 (Observer) 的位姿信息 (Position &amp; Quaternion) 以及 <code>work.transform</code> 进行计算。</p>
14
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">WorkObserver</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 将方向向量转化为全景图 uv</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">vector</span><span class="hl-8"> - 全局方向向量 (World Space)</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">uvOrigin</span><span class="hl-8"> - UV 原点位置，默认为 &#39;top-left&#39;</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">vectorToEquirectangularUv</span><span class="hl-1">(</span><span class="hl-6">vector</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 将全景图 uv 转化为方向向量</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">uv</span><span class="hl-8"> - 全景图 UV 坐标 [0, 1]</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">uvOrigin</span><span class="hl-8"> - UV 原点位置，默认为 &#39;top-left&#39;</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">equirectangularUvToVector</span><span class="hl-1">(</span><span class="hl-6">uv</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 将方向向量转化为六视图 uv</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">vector</span><span class="hl-8"> - 全局方向向量 (World Space)</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">uvOrigin</span><span class="hl-8"> - UV 原点位置，默认为 &#39;top-left&#39;</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">vectorToCubemapUv</span><span class="hl-1">(</span><span class="hl-6">vector</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): [</span><span class="hl-13">cubeFace</span><span class="hl-1">: </span><span class="hl-7">CubeFace</span><span class="hl-1">, </span><span class="hl-13">cubemapUv</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">];</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 将六视图 uv 转化为方向向量</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">cubeFace</span><span class="hl-8"> - 立方体面 (&#39;up&#39; | &#39;down&#39; | &#39;left&#39; | &#39;right&#39; | &#39;front&#39; | &#39;back&#39;)</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">uv</span><span class="hl-8"> - 该面上的 UV 坐标 [0, 1]</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">uvOrigin</span><span class="hl-8"> - UV 原点位置，默认为 &#39;top-left&#39;</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">cubemapUvToVector</span><span class="hl-1">(</span><span class="hl-6">cubeFace</span><span class="hl-1">: </span><span class="hl-7">CubeFace</span><span class="hl-1">, </span><span class="hl-6">uv</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector2</span><span class="hl-1">, </span><span class="hl-6">uvOrigin</span><span class="hl-1">?: </span><span class="hl-9">&#39;top-left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;bottom-left&#39;</span><span class="hl-1">): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Vector3</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">type</span><span class="hl-1"> </span><span class="hl-7">CubeFace</span><span class="hl-1"> = </span><span class="hl-9">&#39;up&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;down&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;left&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;right&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;front&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;back&#39;</span><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-坐标系转换-coordinate-transformation" class="tsd-anchor-link">1. 坐标系转换 (Coordinate Transformation)<a href="#1-坐标系转换-coordinate-transformation" 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
+ <ol>
21
+ <li><strong>World Space (世界坐标系)</strong>: <code>vector</code> 参数所处的坐标系。</li>
22
+ <li><strong>Work Space (Work 坐标系)</strong>: 考虑 <code>work.transform</code> 带来的整体旋转。</li>
23
+ <li><strong>Observer Space (观察者坐标系)</strong>: 考虑 <code>observer.quaternion</code> 带来的观察点旋转。</li>
24
+ <li><strong>Panorama Space (全景图空间)</strong>: 最终映射到 2D 图片上的 UV 坐标。</li>
25
+ </ol>
26
+ <h3 id="2-投影方式-projection-types" class="tsd-anchor-link">2. 投影方式 (Projection Types)<a href="#2-投影方式-projection-types" 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>
27
+ <ul>
28
+ <li><strong>Equirectangular (等距柱状投影)</strong>: 将球体展开为 2:1 的矩形图片。常用于全景图预览。</li>
29
+ <li><strong>Cubemap (立方体贴图)</strong>: 将球体投影到立方体的六个面上。常用于高清全景浏览。</li>
30
+ </ul>
31
+ <h3 id="3-uv-原点-uv-origin" class="tsd-anchor-link">3. UV 原点 (UV Origin)<a href="#3-uv-原点-uv-origin" 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>
32
+ <ul>
33
+ <li><strong>top-left (默认)</strong>: 原点 <code>(0, 0)</code> 在图片<strong>左上角</strong>。U 轴向右，V 轴向下。符合大多数 Web 图片处理习惯 (Canvas, DOM)。</li>
34
+ <li><strong>bottom-left</strong>: 原点 <code>(0, 0)</code> 在图片<strong>左下角</strong>。U 轴向右，V 轴向上。符合 WebGL / OpenGL 纹理坐标习惯。</li>
35
+ </ul>
36
+ <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>
37
+ <p>所有方法均包含可选参数 <code>uvOrigin</code>。</p>
38
+ <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>
39
+ <table>
40
+ <thead>
41
+ <tr>
42
+ <th style="text-align:left">Parameter</th>
43
+ <th style="text-align:left">Type</th>
44
+ <th style="text-align:left">Default</th>
45
+ <th style="text-align:left">Description</th>
46
+ </tr>
47
+ </thead>
48
+ <tbody>
49
+ <tr>
50
+ <td style="text-align:left"><code>uvOrigin</code></td>
51
+ <td style="text-align:left"><code>'top-left' | 'bottom-left'</code></td>
52
+ <td style="text-align:left"><code>'top-left'</code></td>
53
+ <td style="text-align:left">指定 UV 坐标系的原点位置。</td>
54
+ </tr>
55
+ </tbody>
56
+ </table>
57
+ <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>
58
+ <h3 id="1-点击全景图获取空间方向-click-to-vector" class="tsd-anchor-link">1. 点击全景图获取空间方向 (Click to Vector)<a href="#1-点击全景图获取空间方向-click-to-vector" 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>
59
+ <p>假设你有一个全景图的点击事件，获取到了点击位置的 UV：</p>
60
+ <pre><code class="typescript"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">observer</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">work</span><span class="hl-1">.</span><span class="hl-6">observers</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">];</span><br/><span class="hl-8">// 假设这是用户点击全景图后归一化得到的 UV (0~1)</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">clickUv</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-4">THREE</span><span class="hl-1">.</span><span class="hl-5">Vector2</span><span class="hl-1">(</span><span class="hl-11">0.5</span><span class="hl-1">, </span><span class="hl-11">0.5</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 转换为世界空间的方向向量</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">direction</span><span class="hl-1"> = </span><span class="hl-6">observer</span><span class="hl-1">.</span><span class="hl-5">equirectangularUvToVector</span><span class="hl-1">(</span><span class="hl-6">clickUv</span><span class="hl-1">);</span><br/><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">&#39;点击方向:&#39;</span><span class="hl-1">, </span><span class="hl-6">direction</span><span class="hl-1">);</span>
61
+ </code><button type="button">Copy</button></pre>
62
+
63
+ <h3 id="2-将空间点映射到全景图上-world-point-to-uv" class="tsd-anchor-link">2. 将空间点映射到全景图上 (World Point to UV)<a href="#2-将空间点映射到全景图上-world-point-to-uv" 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>
64
+ <p>假设场景中有一个 3D 物体，你想知道它在当前全景图上的位置（例如打标签）：</p>
65
+ <pre><code class="typescript"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">observer</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">work</span><span class="hl-1">.</span><span class="hl-6">observers</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">];</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">objectPosition</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-4">THREE</span><span class="hl-1">.</span><span class="hl-5">Vector3</span><span class="hl-1">(</span><span class="hl-11">10</span><span class="hl-1">, </span><span class="hl-11">2</span><span class="hl-1">, </span><span class="hl-11">5</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 计算物体相对于观察点的方向向量</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">direction</span><span class="hl-1"> = </span><span class="hl-6">objectPosition</span><span class="hl-1">.</span><span class="hl-5">clone</span><span class="hl-1">().</span><span class="hl-5">sub</span><span class="hl-1">(</span><span class="hl-6">observer</span><span class="hl-1">.</span><span class="hl-6">position</span><span class="hl-1">).</span><span class="hl-5">normalize</span><span class="hl-1">();</span><br/><br/><span class="hl-8">// 获取全景图 UV</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">uv</span><span class="hl-1"> = </span><span class="hl-6">observer</span><span class="hl-1">.</span><span class="hl-5">vectorToEquirectangularUv</span><span class="hl-1">(</span><span class="hl-6">direction</span><span class="hl-1">);</span><br/><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">`物体在全景图上的位置: u=</span><span class="hl-3">${</span><span class="hl-6">uv</span><span class="hl-12">.</span><span class="hl-6">x</span><span class="hl-3">}</span><span class="hl-9">, v=</span><span class="hl-3">${</span><span class="hl-6">uv</span><span class="hl-12">.</span><span class="hl-6">y</span><span class="hl-3">}</span><span class="hl-9">`</span><span class="hl-1">);</span>
66
+ </code><button type="button">Copy</button></pre>
67
+
68
+ <h3 id="3-处理-cubemap-坐标-cubemap-conversion" class="tsd-anchor-link">3. 处理 Cubemap 坐标 (Cubemap Conversion)<a href="#3-处理-cubemap-坐标-cubemap-conversion" 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>
69
+ <p>如果你使用的是六面体全景图资源：</p>
70
+ <pre><code class="typescript"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">observer</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">work</span><span class="hl-1">.</span><span class="hl-6">observers</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">];</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">direction</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-4">THREE</span><span class="hl-1">.</span><span class="hl-5">Vector3</span><span class="hl-1">(</span><span class="hl-11">0</span><span class="hl-1">, </span><span class="hl-11">0</span><span class="hl-1">, -</span><span class="hl-11">1</span><span class="hl-1">); </span><span class="hl-8">// 正前方</span><br/><br/><span class="hl-8">// 获取对应的面和 UV</span><br/><span class="hl-3">const</span><span class="hl-1"> [</span><span class="hl-4">face</span><span class="hl-1">, </span><span class="hl-4">uv</span><span class="hl-1">] = </span><span class="hl-6">observer</span><span class="hl-1">.</span><span class="hl-5">vectorToCubemapUv</span><span class="hl-1">(</span><span class="hl-6">direction</span><span class="hl-1">);</span><br/><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">`正前方对应 Cubemap 的 </span><span class="hl-3">${</span><span class="hl-6">face</span><span class="hl-3">}</span><span class="hl-9"> 面，UV 为`</span><span class="hl-1">, </span><span class="hl-6">uv</span><span class="hl-1">);</span>
71
+ </code><button type="button">Copy</button></pre>
72
+
73
+ <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>
74
+ <ul>
75
+ <li><a href="features_work.html">Work</a>: 了解 WorkObserver 的数据结构。</li>
76
+ <li><a href="features_coordinate-system.html">Coordinate System</a>: 了解 Five 的坐标系定义。</li>
77
+ </ul>
78
+ <hr>
79
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">全景UV</span><span class="hl-1">, </span><span class="hl-2">方向转换</span><span class="hl-1">, </span><span class="hl-2">全景坐标</span><span class="hl-1">, </span><span class="hl-2">像素映射</span><span class="hl-1">, </span><span class="hl-2">全景标注</span><span class="hl-1">, </span><span class="hl-2">work</span><span class="hl-1">, </span><span class="hl-2">observer</span><span class="hl-1">, </span><span class="hl-2">uv</span><span class="hl-1">, </span><span class="hl-2">projection</span><span class="hl-1">, </span><span class="hl-2">math</span><span class="hl-1">, </span><span class="hl-2">equirectangular</span><span class="hl-1">, </span><span class="hl-2">cubemap</span><span class="hl-1">]</span>
80
+ </code><button type="button">Copy</button></pre>
81
+
82
+ </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="#全景图-uv-与方向转换-panorama-uv-conversion"><span>全景图 <wbr/>UV 与方向转换 (<wbr/>Panorama <wbr/>UV <wbr/>Conversion)</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-坐标系转换-coordinate-transformation"><span>1. 坐标系转换 (<wbr/>Coordinate <wbr/>Transformation)</span></a></li><li><a href="#2-投影方式-projection-types"><span>2. 投影方式 (<wbr/>Projection <wbr/>Types)</span></a></li><li><a href="#3-uv-原点-uv-origin"><span>3. <wbr/>UV 原点 (<wbr/>UV <wbr/>Origin)</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></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-点击全景图获取空间方向-click-to-vector"><span>1. 点击全景图获取空间方向 (<wbr/>Click to <wbr/>Vector)</span></a></li><li><a href="#2-将空间点映射到全景图上-world-point-to-uv"><span>2. 将空间点映射到全景图上 (<wbr/>World <wbr/>Point to <wbr/>UV)</span></a></li><li><a href="#3-处理-cubemap-坐标-cubemap-conversion"><span>3. 处理 <wbr/>Cubemap 坐标 (<wbr/>Cubemap <wbr/>Conversion)</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>
package/docs/documents/features_parameter.html CHANGED
@@ -1,81 +1,109 @@
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/parameter | 如视 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/parameter</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="parameter-配置" class="tsd-anchor-link">Parameter (配置)<a href="#parameter-配置" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/parameter | 如视 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/parameter</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="parameter-配置系统" class="tsd-anchor-link">Parameter (配置系统)<a href="#parameter-配置系统" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
2
2
  <ul>
3
3
  <li><strong>Summary</strong>: Five 用于控制三维模型渲染表现的核心配置系统，采用树形继承设计。</li>
4
- <li><strong>Schema</strong>: 包含材质、楼层、阴影、LOD 等配置项。</li>
5
- <li><strong>Concepts</strong>: Hierarchy (树形继承), Material, LOD, Point Cloud。</li>
6
- <li><strong>Examples</strong>: 全局设置与局部差异化配置。</li>
4
+ <li><strong>Schema</strong>: 是所有配置项的容器，通过继承机制管理 Material 和 3DTile 等子配置。</li>
5
+ <li><strong>Concepts</strong>: Hierarchy (树形继承), Override (覆盖), Resolution (解析)。</li>
6
+ <li><strong>Examples</strong>: 全局配置、局部覆盖、参数重置。</li>
7
7
  </ul>
8
8
  <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
9
- <h3 id="parameter-class" class="tsd-anchor-link">Parameter Class<a href="#parameter-class" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
10
- <p><code>Parameter</code> 是一个配置容器，提供了读写配置项的方法。</p>
11
- <pre><code class="typescript"><span class="hl-8">// 简化定义</span><br/><span class="hl-3">class</span><span class="hl-1"> </span><span class="hl-7">Parameter</span><span class="hl-1"> </span><span class="hl-3">implements</span><span class="hl-1"> </span><span class="hl-7">Readonly</span><span class="hl-1">&lt;</span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">ParameterValue</span><span class="hl-1">&gt;&gt; {</span><br/><span class="hl-1"> </span><span class="hl-8">// 可以直接通过属性访问配置项，例如 parameter.opacity</span><br/><span class="hl-1"> </span><span class="hl-3">readonly</span><span class="hl-1"> [</span><span class="hl-6">key</span><span class="hl-1"> </span><span class="hl-3">in</span><span class="hl-1"> </span><span class="hl-6">keyof</span><span class="hl-1"> </span><span class="hl-6">ParameterValue</span><span class="hl-1">]?: </span><span class="hl-7">ParameterValue</span><span class="hl-1">[</span><span class="hl-7">key</span><span class="hl-1">];</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** 设置配置项 */</span><br/><span class="hl-1"> </span><span class="hl-5">set</span><span class="hl-1">&lt;</span><span class="hl-7">K</span><span class="hl-1"> </span><span class="hl-3">extends</span><span class="hl-1"> </span><span class="hl-3">keyof</span><span class="hl-1"> </span><span class="hl-7">ParameterValue</span><span class="hl-1">&gt;(</span><span class="hl-6">key</span><span class="hl-1">: </span><span class="hl-7">K</span><span class="hl-1">, </span><span class="hl-6">value</span><span class="hl-1">: </span><span class="hl-7">ParameterValue</span><span class="hl-1">[</span><span class="hl-7">K</span><span class="hl-1">]): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-6">values</span><span class="hl-1">: </span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">ParameterValue</span><span class="hl-1">&gt;): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** 重置当前层级的配置项 (恢复继承) */</span><br/><span class="hl-1"> </span><span class="hl-5">reset</span><span class="hl-1">(...</span><span class="hl-6">keys</span><span class="hl-1">: (</span><span class="hl-3">keyof</span><span class="hl-1"> </span><span class="hl-7">ParameterValue</span><span class="hl-1">)[]): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 获取最终计算值 (包含继承逻辑)</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">upstream</span><span class="hl-8"> - 上游 Parameter 对象列表</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">resolveValue</span><span class="hl-1">(...</span><span class="hl-6">upstream</span><span class="hl-1">: </span><span class="hl-7">Parameter</span><span class="hl-1">[]): </span><span class="hl-7">ResolvedParameterValue</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
9
+ <blockquote>
10
+ <p><strong>Definition</strong>: <a href="../../five/model/parameter.d.ts">Parameter</a></p>
11
+ </blockquote>
12
+ <p><code>Parameter</code> 类是配置的入口。它并不直接包含所有配置字段的定义，而是将它们组织在不同的接口中。</p>
13
+ <h3 id="parameter-categories-参数分类" class="tsd-anchor-link">Parameter Categories (参数分类)<a href="#parameter-categories-参数分类" 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>
14
+ <p>为了便于理解，我们将参数分为两大类：</p>
15
+ <table>
16
+ <thead>
17
+ <tr>
18
+ <th style="text-align:left">Category</th>
19
+ <th style="text-align:left">Description</th>
20
+ <th style="text-align:left">Link</th>
21
+ </tr>
22
+ </thead>
23
+ <tbody>
24
+ <tr>
25
+ <td style="text-align:left"><strong>Material &amp; Appearance</strong></td>
26
+ <td style="text-align:left">控制“长什么样”。包括材质、颜色、楼层显示、阴影、点云样式等。</td>
27
+ <td style="text-align:left"><a href="features_material.html">Material Params</a></td>
28
+ </tr>
29
+ <tr>
30
+ <td style="text-align:left"><strong>3DTile &amp; Performance</strong></td>
31
+ <td style="text-align:left">控制“怎么加载”。包括 LOD (细节层级)、显存配额、网络并发、SSE 阈值等。</td>
32
+ <td style="text-align:left"><a href="features_3dtile.html">3DTile Params</a></td>
33
+ </tr>
34
+ </tbody>
35
+ </table>
36
+ <h3 id="parameter-class-api" class="tsd-anchor-link">Parameter Class API<a href="#parameter-class-api" 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
+ <h4 id="1-getting-values-获取值" class="tsd-anchor-link">1. Getting Values (获取值)<a href="#1-getting-values-获取值" 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>
38
+ <p>获取参数值<strong>不使用</strong> <code>get()</code> 方法，而是直接访问属性。</p>
39
+ <ul>
40
+ <li><strong>Direct Access (直接访问)</strong>: 获取当前 <code>Parameter</code> 实例上设置的值。如果未设置，返回 <code>undefined</code>。</li>
41
+ <li><strong>Resolve Value (计算最终值)</strong>: 获取经过树形继承计算后的最终生效值。
42
+ <ul>
43
+ <li>如果不传参，则基于默认值计算 (Default -&gt; Current)。</li>
44
+ <li>如果传入上游 Parameter，则基于默认值 + 上游 Parameter 计算 (Default -&gt; Upstream -&gt; Current)。</li>
45
+ </ul>
46
+ </li>
47
+ </ul>
48
+ <pre><code class="typescript"><span class="hl-8">// 方式 A: 直接访问 (获取当前层级配置)</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">currentVal</span><span class="hl-1"> = </span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-6">maxMemoryUsage</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// 方式 B: 计算最终值 (包含继承逻辑)</span><br/><br/><span class="hl-8">// 1. 基础用法：仅继承默认值</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">finalVal</span><span class="hl-1"> = </span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">resolveValue</span><span class="hl-1">().</span><span class="hl-6">maxMemoryUsage</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// 2. 进阶用法：指定继承源 (例如 ViewLayer 继承自 Model)</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">inheritedVal</span><span class="hl-1"> = </span><span class="hl-6">viewLayerParam</span><span class="hl-1">.</span><span class="hl-5">resolveValue</span><span class="hl-1">(</span><span class="hl-6">parentParameter</span><span class="hl-1">).</span><span class="hl-6">maxMemoryUsage</span><span class="hl-1">;</span>
49
+ </code><button type="button">Copy</button></pre>
50
+
51
+ <h4 id="2-methods-方法" class="tsd-anchor-link">2. Methods (方法)<a href="#2-methods-方法" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
52
+ <p><code>Parameter</code> 实例提供了以下核心方法来管理配置：</p>
53
+ <pre><code class="typescript"><span class="hl-3">class</span><span class="hl-1"> </span><span class="hl-7">Parameter</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 设置配置项</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">key</span><span class="hl-8"> 参数名 (如 &#39;opacity&#39;, &#39;maxMemoryUsage&#39;)</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">value</span><span class="hl-8"> 参数值</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-6">key</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-6">value</span><span class="hl-1">: </span><span class="hl-7">any</span><span class="hl-1">): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 重置配置项（移除当前层级的设置，恢复继承上游的值）</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">keys</span><span class="hl-8"> 要重置的参数名列表</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">reset</span><span class="hl-1">(...</span><span class="hl-6">keys</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">[]): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 获取经过继承计算后的最终值（每次调用创建新对象）</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">upstream</span><span class="hl-8"> 上游 Parameter 对象列表（通常由引擎自动传入）</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-5">resolveValue</span><span class="hl-1">(...</span><span class="hl-6">upstream</span><span class="hl-1">: </span><span class="hl-7">Parameter</span><span class="hl-1">[]): </span><span class="hl-7">ResolvedParameterValue</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 获取经过继承计算后的最终值（复用 target 对象，避免重复创建）</span><br/><span class="hl-8"> * 适用于高频调用场景（如逐帧更新），可显著减少 GC 压力。</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">target</span><span class="hl-8"> 用于写入结果的已有对象，其属性会被重置为默认值后重新赋值</span><br/><span class="hl-8"> * </span><span class="hl-3">@param</span><span class="hl-8"> </span><span class="hl-6">upstream</span><span class="hl-8"> 上游 Parameter 对象列表</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-3">static</span><span class="hl-1"> </span><span class="hl-5">resolveValueTo</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">target</span><span class="hl-1">: </span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">ResolvedParameterValue</span><span class="hl-1">&gt;,</span><br/><span class="hl-1"> ...</span><span class="hl-6">upstream</span><span class="hl-1">: </span><span class="hl-7">Partial</span><span class="hl-1">&lt;</span><span class="hl-7">ParameterValue</span><span class="hl-1">&gt;[]</span><br/><span class="hl-1"> ): </span><span class="hl-7">ResolvedParameterValue</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
12
54
  </code><button type="button">Copy</button></pre>
13
55
 
14
- <h3 id="parametervalue-interface" class="tsd-anchor-link">ParameterValue Interface<a href="#parametervalue-interface" 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>
15
- <p>所有的配置项定义在 <code>ParameterValue</code> 接口中。</p>
16
- <pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> </span><span class="hl-3">*</span><span class="hl-1"> </span><span class="hl-10">as</span><span class="hl-1"> </span><span class="hl-6">THREE</span><span class="hl-1"> </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&#39;three&#39;</span><span class="hl-1">;</span><br/><br/><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">ParameterValue</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">// --- 基础材质表现 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/** 模型透明度 [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">brightness</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">colorSaturation</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">colorBrightness</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// --- 全景混动与过渡 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/** 模型贴图和全景图的混合程度 [0-1] (0:纯模型纹理, 1:纯全景纹理) */</span><br/><span class="hl-1"> </span><span class="hl-6">modelAlpha</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// --- 楼层控制 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/** 当前显示的楼层索引 (null 为显示所有) */</span><br/><span class="hl-1"> </span><span class="hl-6">shownFloorIndex</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">null</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 楼层隐藏样式 (&#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-9">&#39;OPACITY&#39;</span><span class="hl-1"> | </span><span class="hl-9">&#39;VISIBILITY&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// --- 阴影 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否产生阴影 */</span><br/><span class="hl-1"> </span><span class="hl-6">castShadow</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否接受阴影 */</span><br/><span class="hl-1"> </span><span class="hl-6">receiveShadow</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// --- 点云特有 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/** 点云大小 */</span><br/><span class="hl-1"> </span><span class="hl-6">pointSize</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/><br/><span class="hl-1"> </span><span class="hl-8">// --- 3DTile / LOD 控制 ---</span><br/><span class="hl-1"> </span><span class="hl-8">/** 最小细节层级 */</span><br/><span class="hl-1"> </span><span class="hl-6">minLevelOfDetail</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 最大细节层级 */</span><br/><span class="hl-1"> </span><span class="hl-6">maxLevelOfDetail</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 几何误差阈值 (越小越精细) */</span><br/><span class="hl-1"> </span><span class="hl-6">minGeometricError</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 最大网络并发请求数 */</span><br/><span class="hl-1"> </span><span class="hl-6">maxRequests</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 最大内存使用量 (MB) */</span><br/><span class="hl-1"> </span><span class="hl-6">maxMemoryUsage</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// ... 更多高级参数请参考 five/index.d.ts</span><br/><span class="hl-1">}</span>
56
+ <blockquote>
57
+ <p><code>resolveValue()</code> 内部已委托给 <code>resolveValueTo({}, ...)</code>，两者计算逻辑一致，区别仅在于是否复用对象。</p>
58
+ </blockquote>
59
+ <h4 id="3-version-版本标识" class="tsd-anchor-link">3. Version (版本标识)<a href="#3-version-版本标识" 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>
60
+ <p><code>ResolvedParameterValue</code> 通过 <code>versionNumber: number</code> 标识当前配置的版本。引擎内部使用整数哈希（而非字符串拼接）计算版本号，用于高效的脏检查。</p>
61
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">ResolvedParameterValue</span><span class="hl-1"> </span><span class="hl-3">extends</span><span class="hl-1"> </span><span class="hl-7">ParameterValue</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">versionNumber</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
17
62
  </code><button type="button">Copy</button></pre>
18
63
 
19
64
  <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>
20
- <h3 id="1-树形继承关系-hierarchy" class="tsd-anchor-link">1. 树形继承关系 (Hierarchy)<a href="#1-树形继承关系-hierarchy" 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>
21
- <p>Parameter 遵循 <strong>“就近原则” (Override)</strong> 的继承逻辑。当渲染引擎需要获取某个属性值时，会按照以下顺序查找：</p>
65
+ <h3 id="树形继承关系-hierarchy" class="tsd-anchor-link">树形继承关系 (Hierarchy)<a href="#树形继承关系-hierarchy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
66
+ <p>Parameter 遵循 <strong>“就近原则” (Override)</strong> 的继承逻辑。</p>
22
67
  <ol>
23
- <li><strong>ViewLayer Parameter</strong>: 最具体，优先级最高。</li>
24
- <li><strong>Model Parameter</strong>: 覆盖该 Model 下的所有 ViewLayer。</li>
25
- <li><strong>ModelScene Parameter</strong>: 全局默认值，优先级最低。</li>
68
+ <li><strong>ViewLayer Parameter</strong>: 最具体，优先级最高。通常对应一个具体的 <code>.gltf</code> 文件或数据块。</li>
69
+ <li><strong>Model Parameter</strong>: 覆盖该 Model 下的所有 ViewLayer。一个 Model 可能包含多个 ViewLayer (如 Mesh 层和 PointCloud 层)。</li>
70
+ <li><strong>ModelScene Parameter</strong>: 全局默认值，优先级最低。影响整个场景。</li>
26
71
  </ol>
27
72
  <pre><code class="mermaid"><span class="hl-1">graph TD</span><br/><span class="hl-1"> Scene[ModelScene.parameter] --&gt;|Inherit| Model[Model.parameter]</span><br/><span class="hl-1"> Model --&gt;|Inherit| Layer1[ViewLayer.parameter]</span><br/><span class="hl-1"> Model --&gt;|Inherit| Layer2[ViewLayer.parameter]</span>
28
73
  </code><button type="button">Copy</button></pre>
29
74
 
30
- <p><strong>示例逻辑</strong>:</p>
31
- <ul>
32
- <li>如果 <code>ModelScene</code> 设置 <code>opacity = 0.5</code>，所有模型都会变半透明。</li>
33
- <li>如果此时 <code>Model A</code> 设置 <code>opacity = 1.0</code>，那么 <code>Model A</code> 及其下的 ViewLayer 会变为不透明，而其他 Model 保持半透明。</li>
34
- </ul>
35
- <h3 id="2-参数分类" class="tsd-anchor-link">2. 参数分类<a href="#2-参数分类" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
36
- <h4 id="材质与外观-material-appearance" class="tsd-anchor-link">材质与外观 (Material &amp; Appearance)<a href="#材质与外观-material-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></h4>
37
- <p>控制模型“长什么样”。比如：</p>
38
- <ul>
39
- <li><strong><code>modelAlpha</code></strong>: 核心参数。Five 的模型纹理通常来自全景图投影。该值控制是显示原始模型 UV 贴图，还是显示全景投影贴图。</li>
40
- <li><strong><code>shownFloorIndex</code></strong>: 实现“分层拆解”效果。</li>
41
- <li><strong><code>floorStyle</code></strong>: 控制楼层隐藏的表现形式。</li>
42
- </ul>
43
- <h4 id="3dtile-性能-lod" class="tsd-anchor-link">3DTile &amp; 性能 (LOD)<a href="#3dtile-性能-lod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4>
44
- <p>控制模型“怎么加载”。比如：</p>
45
- <ul>
46
- <li><strong><code>maxMemoryUsage</code></strong>: 显存控制。当加载的模型块超过此限制时，会自动卸载不可见的块。</li>
47
- <li><strong><code>maxScreenSpaceError</code></strong>: 画质控制。值越小，加载的模型精度越高（允许的屏幕空间误差越小），但网络和渲染开销越大。</li>
48
- <li><strong><code>minGeometricError</code></strong>: 几何误差阈值。值越小，加载的模型精度越高（允许的几何误差越小），但网络和渲染开销越大。</li>
49
- <li><strong><code>maxRequests</code></strong>: 最大并发请求数。控制同时加载的模型块数量，避免对服务器压力过大。</li>
50
- </ul>
51
- <h4 id="点云-point-cloud" class="tsd-anchor-link">点云 (Point Cloud)<a href="#点云-point-cloud" 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>
52
- <p>专用于 <code>type: point_cloud</code> 的 ViewLayer。比如：</p>
53
- <ul>
54
- <li><strong><code>pointSize</code></strong>: 控制点的像素大小。</li>
55
- <li><strong><code>pointScale</code></strong>: 点云整体缩放。</li>
56
- </ul>
75
+ <blockquote>
76
+ <p><strong>Global Configuration (全局设置)</strong>:
77
+ 若需修改所有模型的默认表现（如统一调暗亮度、统一设置显存上限），<strong>请直接配置 <code>five.modelScene.parameter</code></strong>。它是继承链的根节点，其设置会向下传递给所有 Model 和 ViewLayer。</p>
78
+ <p><strong>Why modelScene? (生命周期优势)</strong>:
79
+ <code>Model</code> 实例是跟随 Work 加载生命周期的（需 <code>five.load(work)</code> 后才能访问，且切换 Work 会销毁重建）。
80
+ 相比之下，<code>ModelScene</code> 是常驻对象。因此，<strong>使用 <code>modelScene</code> 进行配置更安全且持久</strong>，既无需等待 Work 加载完成，也无需担心切换 Work 导致配置丢失。</p>
81
+ </blockquote>
57
82
  <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>
58
- <h3 id="基础用法：设置全局透明度" class="tsd-anchor-link">基础用法：设置全局透明度<a href="#基础用法：设置全局透明度" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
59
- <pre><code class="typescript"><span class="hl-8">// 将整个场景的模型设为半透明</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;opacity&#39;</span><span class="hl-1">, </span><span class="hl-11">0.5</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 恢复默认</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">remove</span><span class="hl-1">(</span><span class="hl-9">&#39;opacity&#39;</span><span class="hl-1">);</span>
83
+ <h3 id="1-基础配置-basic-usage" class="tsd-anchor-link">1. 基础配置 (Basic Usage)<a href="#1-基础配置-basic-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
84
+ <pre><code class="typescript"><span class="hl-8">// 1. 设置全局最大显存 (影响所有模型)</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;maxMemoryUsage&#39;</span><span class="hl-1">, </span><span class="hl-11">512</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 2. 设置全局半透明</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;opacity&#39;</span><span class="hl-1">, </span><span class="hl-11">0.5</span><span class="hl-1">);</span>
60
85
  </code><button type="button">Copy</button></pre>
61
86
 
62
- <h3 id="进阶用法：差异化配置" class="tsd-anchor-link">进阶用法：差异化配置<a href="#进阶用法：差异化配置" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
63
- <pre><code class="typescript"><span class="hl-8">// 1. 全局开启阴影</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;castShadow&#39;</span><span class="hl-1">, </span><span class="hl-3">true</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 2. 但让第一个模型不产生阴影</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">mainModel</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">models</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">];</span><br/><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-6">mainModel</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">mainModel</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;castShadow&#39;</span><span class="hl-1">, </span><span class="hl-3">false</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-8">// 3. 让特定的点云图层点变大</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">pointCloudLayer</span><span class="hl-1"> = </span><span class="hl-6">mainModel</span><span class="hl-1">.</span><span class="hl-6">viewLayers</span><span class="hl-1">.</span><span class="hl-5">find</span><span class="hl-1">(</span><span class="hl-6">l</span><span class="hl-1"> </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-6">l</span><span class="hl-1">.</span><span class="hl-6">type</span><span class="hl-1"> === </span><span class="hl-9">&#39;point_cloud&#39;</span><span class="hl-1">);</span><br/><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-6">pointCloudLayer</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">pointCloudLayer</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;pointSize&#39;</span><span class="hl-1">, </span><span class="hl-11">2.0</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
87
+ <h3 id="2-局部覆盖-override" class="tsd-anchor-link">2. 局部覆盖 (Override)<a href="#2-局部覆盖-override" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
88
+ <pre><code class="typescript"><span class="hl-8">// 场景中大部分模型不产生阴影</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;castShadow&#39;</span><span class="hl-1">, </span><span class="hl-3">false</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// 但让特定的“主角”模型产生阴影</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">heroModel</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">models</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">];</span><br/><span class="hl-6">heroModel</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;castShadow&#39;</span><span class="hl-1">, </span><span class="hl-3">true</span><span class="hl-1">);</span>
89
+ </code><button type="button">Copy</button></pre>
90
+
91
+ <h3 id="3-重置配置-reset" class="tsd-anchor-link">3. 重置配置 (Reset)<a href="#3-重置配置-reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
92
+ <pre><code class="typescript"><span class="hl-8">// 假设之前设置了 opacity</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">set</span><span class="hl-1">(</span><span class="hl-9">&#39;opacity&#39;</span><span class="hl-1">, </span><span class="hl-11">0.5</span><span class="hl-1">);</span><br/><br/><span class="hl-8">// ... 一段时间后 ...</span><br/><br/><span class="hl-8">// 移除该设置，恢复默认值 (或继承值)</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">reset</span><span class="hl-1">(</span><span class="hl-9">&#39;opacity&#39;</span><span class="hl-1">);</span>
93
+ </code><button type="button">Copy</button></pre>
94
+
95
+ <h3 id="4-获取配置-get-value" class="tsd-anchor-link">4. 获取配置 (Get Value)<a href="#4-获取配置-get-value" 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>
96
+ <pre><code class="typescript"><span class="hl-8">// 获取当前对象上的配置（如果未设置，则为 undefined）</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ownOpacity</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-6">opacity</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// 获取最终生效的配置（计算继承链后的值）</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">finalOpacity</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">modelScene</span><span class="hl-1">.</span><span class="hl-6">parameter</span><span class="hl-1">.</span><span class="hl-5">resolveValue</span><span class="hl-1">().</span><span class="hl-6">opacity</span><span class="hl-1">;</span>
64
97
  </code><button type="button">Copy</button></pre>
65
98
 
66
- <h2 id="common-pitfalls" class="tsd-anchor-link">Common Pitfalls<a href="#common-pitfalls" 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>
67
- <ol>
68
- <li><strong>拼写错误</strong>: <code>parameter.set()</code> 的 key 是字符串，拼写错误不会报错（除非使用 TypeScript），但配置不会生效。</li>
69
- <li><strong>层级混淆</strong>: 在 <code>ModelScene</code> 上设置了 <code>shownFloorIndex</code>，却期望只影响某个 Model。请务必确认操作的 <code>parameter</code> 对象所属的层级。</li>
70
- <li><strong>类型错误</strong>: 某些数值参数（如 <code>opacity</code>）需要 <code>number</code> 类型，传入字符串可能导致渲染计算 NaN 错误。</li>
71
- </ol>
72
99
  <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>
73
100
  <ul>
74
- <li><a href="features_model.html">Model</a>: Parameter 的宿主之一。</li>
75
- <li><a href="features_3dtile.html">3DTile</a>: 受 Parameter 控制的底层技术。</li>
101
+ <li><a href="features_material.html">Material Parameters</a>: 材质与外观参数详情。</li>
102
+ <li><a href="features_3dtile.html">3DTile Parameters</a>: 性能与加载参数详情。</li>
103
+ <li><a href="features_model.html">Model</a>: Parameter 的宿主。</li>
76
104
  </ul>
77
105
  <hr>
78
- <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">parameter</span><span class="hl-1">, </span><span class="hl-2">config</span><span class="hl-1">, </span><span class="hl-2">appearance</span><span class="hl-1">, </span><span class="hl-2">3dtile</span><span class="hl-1">]</span>
106
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">配置</span><span class="hl-1">, </span><span class="hl-2">参数</span><span class="hl-1">, </span><span class="hl-2">继承</span><span class="hl-1">, </span><span class="hl-2">覆盖</span><span class="hl-1">, </span><span class="hl-2">全局配置</span><span class="hl-1">, </span><span class="hl-2">局部配置</span><span class="hl-1">, </span><span class="hl-2">parameter</span><span class="hl-1">, </span><span class="hl-2">config</span><span class="hl-1">, </span><span class="hl-2">hierarchy</span><span class="hl-1">, </span><span class="hl-2">api</span><span class="hl-1">, </span><span class="hl-2">set</span><span class="hl-1">, </span><span class="hl-2">reset</span><span class="hl-1">, </span><span class="hl-2">modelScene</span><span class="hl-1">]</span>
79
107
  </code><button type="button">Copy</button></pre>
80
108
 
81
- </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="#parameter-配置"><span>Parameter (配置)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#parameter-class"><span>Parameter <wbr/>Class</span></a></li><li><a href="#parametervalue-interface"><span>Parameter<wbr/>Value <wbr/>Interface</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#1-树形继承关系-hierarchy"><span>1. 树形继承关系 (<wbr/>Hierarchy)</span></a></li><li><a href="#2-参数分类"><span>2. 参数分类</span></a></li><li><ul><li><a href="#材质与外观-material-appearance"><span>材质与外观 (<wbr/>Material &amp; <wbr/>Appearance)</span></a></li><li><a href="#3dtile-性能-lod"><span>3<wbr/>D<wbr/>Tile &amp; 性能 (<wbr/>LOD)</span></a></li><li><a href="#点云-point-cloud"><span>点云 (<wbr/>Point <wbr/>Cloud)</span></a></li></ul></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#基础用法：设置全局透明度"><span>基础用法：设置全局透明度</span></a></li><li><a href="#进阶用法：差异化配置"><span>进阶用法：差异化配置</span></a></li></ul></li><li><a href="#common-pitfalls"><span>Common <wbr/>Pitfalls</span></a></li><li><a href="#related"><span>Related</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
109
+ </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="#parameter-配置系统"><span>Parameter (配置系统)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#parameter-categories-参数分类"><span>Parameter <wbr/>Categories (参数分类)</span></a></li><li><a href="#parameter-class-api"><span>Parameter <wbr/>Class <wbr/>API</span></a></li><li><ul><li><a href="#1-getting-values-获取值"><span>1. <wbr/>Getting <wbr/>Values (获取值)</span></a></li><li><a href="#2-methods-方法"><span>2. <wbr/>Methods (方法)</span></a></li><li><a href="#3-version-版本标识"><span>3. <wbr/>Version (版本标识)</span></a></li></ul></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#树形继承关系-hierarchy"><span>树形继承关系 (<wbr/>Hierarchy)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#1-基础配置-basic-usage"><span>1. 基础配置 (<wbr/>Basic <wbr/>Usage)</span></a></li><li><a href="#2-局部覆盖-override"><span>2. 局部覆盖 (<wbr/>Override)</span></a></li><li><a href="#3-重置配置-reset"><span>3. 重置配置 (<wbr/>Reset)</span></a></li><li><a href="#4-获取配置-get-value"><span>4. 获取配置 (<wbr/>Get <wbr/>Value)</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>