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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (764) hide show
  1. package/AGENTS_READ_ME.md +6 -1
  2. package/AI_CONTEXT.md +6 -1
  3. package/README.md +10 -6
  4. package/ai_guides/README.md +40 -2
  5. package/ai_guides/ai-doc-guidelines.md +31 -1
  6. package/ai_guides/api.md +107 -13
  7. package/ai_guides/features/3dtile.md +49 -141
  8. package/ai_guides/features/camera-animation.md +42 -4
  9. package/ai_guides/features/clipper.md +4 -2
  10. package/ai_guides/features/{coordnate-system.md → coordinate-system.md} +22 -2
  11. package/ai_guides/features/event.md +108 -10
  12. package/ai_guides/features/five.md +20 -16
  13. package/ai_guides/features/flowing-light-2d-pass.md +442 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +425 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/ai_guides/features/gesture.md +4 -1
  17. package/ai_guides/features/get-screen-pixels.md +4 -2
  18. package/ai_guides/features/image-options.md +5 -2
  19. package/ai_guides/features/load-external-model.md +27 -2
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +159 -0
  22. package/ai_guides/features/mode.md +5 -1
  23. package/ai_guides/features/model.md +5 -2
  24. package/ai_guides/features/move-pano-effect.md +3 -1
  25. package/ai_guides/features/multi-work.md +3 -1
  26. package/ai_guides/features/pano-filter.md +149 -0
  27. package/ai_guides/features/pano-tile.md +8 -15
  28. package/ai_guides/features/pano-uv.md +131 -0
  29. package/ai_guides/features/parameter.md +117 -118
  30. package/ai_guides/features/plugin.md +210 -0
  31. package/ai_guides/features/postprocessing.md +40 -5
  32. package/ai_guides/features/raycast.md +16 -2
  33. package/ai_guides/features/request-proxy.md +3 -1
  34. package/ai_guides/features/screen-project.md +4 -1
  35. package/ai_guides/features/state.md +25 -3
  36. package/ai_guides/features/view-layer.md +187 -0
  37. package/ai_guides/features/work.md +64 -3
  38. package/ai_guides/glossary.md +28 -7
  39. package/ai_guides/intro.md +1 -1
  40. package/ai_guides/quick-start.md +1 -0
  41. package/ai_guides/release_notes/6.8.md +222 -0
  42. package/ai_guides/template.md +28 -3
  43. package/docs/00_FOR_AI_AGENTS.md +3 -2
  44. package/docs/README.md +3 -2
  45. package/docs/assets/hierarchy.js +1 -1
  46. package/docs/assets/main.js +1 -1
  47. package/docs/assets/navigation.js +1 -1
  48. package/docs/assets/search.js +1 -1
  49. package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
  50. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  51. package/docs/classes/five.BoundingMesh.html +2 -2
  52. package/docs/classes/five.Camera.html +3 -3
  53. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  54. package/docs/classes/five.Five.html +77 -76
  55. package/docs/classes/five.FivePass.html +1 -1
  56. package/docs/classes/five.Histogram.html +19 -0
  57. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  58. package/docs/classes/five.Model.html +32 -32
  59. package/docs/classes/five.ModelScene.html +1 -1
  60. package/docs/classes/five.NetworkSubscribe.html +5 -5
  61. package/docs/classes/five.PBMContainer.html +1 -1
  62. package/docs/classes/five.PBMCustomShader.html +42 -3
  63. package/docs/classes/five.PBMGSObject.html +5 -3
  64. package/docs/classes/five.PBMGroup.html +1 -1
  65. package/docs/classes/five.PBMMesh.html +1 -1
  66. package/docs/classes/five.PBMMeshMaterial.html +16 -7
  67. package/docs/classes/five.PBMPanoFilter.html +61 -0
  68. package/docs/classes/five.PBMPointCloud.html +1 -1
  69. package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
  70. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  71. package/docs/classes/five.PBMUpdateable.html +41 -0
  72. package/docs/classes/five.PanoCircleMesh.html +1 -1
  73. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  74. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  75. package/docs/classes/five.Parameter.html +59 -55
  76. package/docs/classes/five.Scene.html +1 -1
  77. package/docs/classes/five.Subscribe.html +5 -5
  78. package/docs/classes/five.Tile.html +1 -1
  79. package/docs/classes/five.Tile3D.html +30 -26
  80. package/docs/classes/five.TileNode.html +1 -1
  81. package/docs/classes/five.Tileset.html +3 -2
  82. package/docs/classes/five.Trajectory.html +1 -1
  83. package/docs/classes/five.TrajectoryNode.html +1 -1
  84. package/docs/classes/five.Work.html +16 -16
  85. package/docs/classes/five.WorkResolvedObserver.html +41 -16
  86. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  87. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  88. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  89. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  90. package/docs/classes/gltf-loader.GLTFParser.html +1 -1
  91. package/docs/classes/gltf-loader.THREEGLTFLoader.html +2 -2
  92. package/docs/classes/line.Line.html +1 -1
  93. package/docs/classes/line.LineGeometry.html +1 -1
  94. package/docs/classes/line.LineMaterial.html +1 -1
  95. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  96. package/docs/classes/line.THREE_Line2.html +1 -1
  97. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  98. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  99. package/docs/classes/plugins.CSS3DObject.html +9 -0
  100. package/docs/classes/plugins.CSS3DRenderer.html +4 -2
  101. package/docs/classes/plugins.CSS3DSprite.html +11 -0
  102. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  103. package/docs/classes/sticker.Sticker.html +1 -1
  104. package/docs/classes/vfx.Airflow.html +1 -1
  105. package/docs/classes/vfx.Flame.html +1 -1
  106. package/docs/classes/vfx.Particle.html +6 -6
  107. package/docs/classes/vfx.ParticleGPU.html +3 -3
  108. package/docs/classes/vfx.SpotLight.html +1 -1
  109. package/docs/documents/README.html +132 -3
  110. package/docs/documents/ai-doc-guidelines.html +48 -3
  111. package/docs/documents/api.html +179 -26
  112. package/docs/documents/features_3dtile.html +143 -46
  113. package/docs/documents/features_camera-animation.html +79 -6
  114. package/docs/documents/features_clipper.html +5 -2
  115. package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +56 -4
  116. package/docs/documents/features_event.html +47 -8
  117. package/docs/documents/features_five.html +20 -16
  118. package/docs/documents/features_flowing-light-2d-pass.html +259 -0
  119. package/docs/documents/features_flowing-light-3d-pass.html +249 -0
  120. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  121. package/docs/documents/features_gesture.html +5 -1
  122. package/docs/documents/features_get-screen-pixels.html +5 -2
  123. package/docs/documents/features_image-options.html +5 -2
  124. package/docs/documents/features_load-external-model.html +31 -4
  125. package/docs/documents/features_load-progress.html +110 -0
  126. package/docs/documents/features_material.html +341 -0
  127. package/docs/documents/features_mode.html +6 -1
  128. package/docs/documents/features_model.html +6 -2
  129. package/docs/documents/features_move-pano-effect.html +4 -1
  130. package/docs/documents/features_multi-work.html +4 -1
  131. package/docs/documents/features_pano-filter.html +123 -0
  132. package/docs/documents/features_pano-tile.html +35 -20
  133. package/docs/documents/features_pano-uv.html +82 -0
  134. package/docs/documents/features_parameter.html +84 -56
  135. package/docs/documents/features_plugin.html +105 -0
  136. package/docs/documents/features_postprocessing.html +23 -6
  137. package/docs/documents/features_raycast.html +9 -3
  138. package/docs/documents/features_request-proxy.html +4 -1
  139. package/docs/documents/features_screen-project.html +5 -1
  140. package/docs/documents/features_state.html +12 -2
  141. package/docs/documents/features_view-layer.html +158 -0
  142. package/docs/documents/features_work.html +64 -3
  143. package/docs/documents/glossary.html +33 -8
  144. package/docs/documents/intro.html +1 -1
  145. package/docs/documents/quick-start.html +1 -0
  146. package/docs/documents/release_notes_6.8.html +203 -0
  147. package/docs/documents/template.html +54 -4
  148. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  149. package/docs/functions/five.loadAt3d.html +1 -1
  150. package/docs/functions/five.loadB3dm.html +1 -1
  151. package/docs/functions/five.loadDome.html +1 -1
  152. package/docs/functions/five.loadDomez.html +1 -1
  153. package/docs/functions/five.loadFbx.html +1 -1
  154. package/docs/functions/five.loadGltf.html +1 -1
  155. package/docs/functions/five.loadPbm.html +1 -1
  156. package/docs/functions/five.loadPly.html +1 -1
  157. package/docs/functions/five.loadPnts.html +1 -1
  158. package/docs/functions/five.loadSplat.html +1 -1
  159. package/docs/functions/five.loadSpz.html +1 -1
  160. package/docs/functions/five.loadX3p.html +1 -1
  161. package/docs/functions/five.parseWork.html +1 -1
  162. package/docs/functions/plugins.CSS3DPlugin.html +1 -0
  163. package/docs/functions/plugins.GaussianSplattingEntranceAnimationPlugin.html +1 -0
  164. package/docs/functions/react.useFiveCurrentObserver.html +2 -2
  165. package/docs/functions/react.useFiveFloor.html +2 -2
  166. package/docs/functions/react.useFiveProject2d.html +2 -2
  167. package/docs/functions/vue.useFiveCurrentObserver.html +2 -2
  168. package/docs/functions/vue.useFiveFloor.html +2 -2
  169. package/docs/functions/vue.useFiveWorks.html +2 -2
  170. package/docs/hierarchy.html +1 -1
  171. package/docs/index.html +132 -3
  172. package/docs/interfaces/five.AddableObject.html +1 -1
  173. package/docs/interfaces/five.AjaxOptions.html +1 -1
  174. package/docs/interfaces/five.BaseEvent.html +7 -2
  175. package/docs/interfaces/five.BaseExtendableEvent.html +11 -0
  176. package/docs/interfaces/five.EventCallback.html +60 -52
  177. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  178. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
  179. package/docs/interfaces/five.GestureEvent.html +21 -2
  180. package/docs/interfaces/five.GesturePointer.html +20 -0
  181. package/docs/interfaces/five.ImageOptions.html +1 -1
  182. package/docs/interfaces/five.IntersectEvent.html +10 -2
  183. package/docs/interfaces/five.IntersectMesh.html +1 -1
  184. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  185. package/docs/interfaces/five.Intersection.html +4 -3
  186. package/docs/interfaces/five.LooseWorkObserver.html +2 -2
  187. package/docs/interfaces/five.LooseWorkPanorama.html +2 -2
  188. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  189. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +10 -10
  190. package/docs/interfaces/five.ModeChangeEvent.html +9 -2
  191. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  192. package/docs/interfaces/five.ModelEvent.html +7 -2
  193. package/docs/interfaces/five.ModelSceneEvent.html +7 -2
  194. package/docs/interfaces/five.ModelTileEvent.html +13 -0
  195. package/docs/interfaces/five.MovePanoOptions.html +8 -8
  196. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  197. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  198. package/docs/interfaces/five.NetworkOptions.html +1 -1
  199. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  200. package/docs/interfaces/five.NetworkResourceEvent.html +7 -2
  201. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  202. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  203. package/docs/interfaces/five.ObjectEvent.html +7 -2
  204. package/docs/interfaces/five.PBMClipperParameter.html +2 -2
  205. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
  206. package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
  207. package/docs/interfaces/five.PBMMaterial.html +1 -1
  208. package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
  209. package/docs/interfaces/five.PBMPanoDepth.html +5 -5
  210. package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
  211. package/docs/interfaces/five.PBMPanoPicture.html +8 -6
  212. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
  213. package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
  214. package/docs/interfaces/five.PanoCircleMeshInterface.html +2 -2
  215. package/docs/interfaces/five.PanoEvent.html +15 -2
  216. package/docs/interfaces/five.PanoPrepareEvent.html +15 -0
  217. package/docs/interfaces/five.PanoTextureEvent.html +11 -2
  218. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  219. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  220. package/docs/interfaces/five.ParameterMaterialValue.html +42 -38
  221. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  222. package/docs/interfaces/five.ParameterValue.html +56 -52
  223. package/docs/interfaces/five.Pose.html +1 -1
  224. package/docs/interfaces/five.RenderEvent.html +7 -2
  225. package/docs/interfaces/five.ResolvedParameterValue.html +57 -54
  226. package/docs/interfaces/five.RgbaData.html +7 -0
  227. package/docs/interfaces/five.SplatData.html +2 -2
  228. package/docs/interfaces/five.State.html +1 -1
  229. package/docs/interfaces/five.StateEvent.html +9 -2
  230. package/docs/interfaces/five.TextureOptions.html +1 -1
  231. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  232. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
  233. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  234. package/docs/interfaces/five.ViewLayer.html +30 -26
  235. package/docs/interfaces/five.WorkCubeImage.html +3 -2
  236. package/docs/interfaces/five.WorkImage.html +6 -5
  237. package/docs/interfaces/five.WorkInitial.html +8 -8
  238. package/docs/interfaces/five.WorkModel.html +8 -8
  239. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  240. package/docs/interfaces/five.WorkObserver.html +42 -17
  241. package/docs/interfaces/five.WorkObserverJson.html +2 -2
  242. package/docs/interfaces/five.WorkObserverProto.html +26 -0
  243. package/docs/interfaces/five.WorkPanoramaJson.html +2 -2
  244. package/docs/interfaces/five.WorkTile.html +6 -5
  245. package/docs/interfaces/five.WorkVideo.html +4 -4
  246. package/docs/interfaces/five.WorksEvent.html +7 -2
  247. package/docs/interfaces/five.XRControllerEvent.html +10 -2
  248. package/docs/interfaces/five.XRControllerState.html +8 -0
  249. package/docs/interfaces/five.XRGestureEvent.html +13 -2
  250. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  251. package/docs/interfaces/five.XRSessionEvent.html +9 -2
  252. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  253. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  254. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  255. package/docs/interfaces/plugins.CSS3DPluginController.html +52 -0
  256. package/docs/interfaces/plugins.CSS3DPluginType.Config.html +2 -0
  257. package/docs/interfaces/plugins.CSS3DPluginType.CreateCSS3DObjectType.html +10 -0
  258. package/docs/interfaces/plugins.CSS3DPluginType.EventMap.html +10 -0
  259. package/docs/interfaces/plugins.CSS3DPluginType.Params.html +4 -0
  260. package/docs/interfaces/plugins.CSS3DPluginType.State.html +8 -0
  261. package/docs/interfaces/plugins.CSS3DRendererParameters.html +2 -0
  262. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +3 -3
  263. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  264. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  265. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationController.html +44 -0
  266. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.BoundingAABB2D.html +3 -0
  267. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Config.html +8 -0
  268. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.EventMap.html +10 -0
  269. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Keyframe.html +3 -0
  270. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.State.html +8 -0
  271. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  272. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  273. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +2 -2
  274. package/docs/interfaces/plugins.OrientationPluginController.html +6 -6
  275. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  276. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  277. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  278. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  279. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  280. package/docs/interfaces/plugins.PlayingState.html +2 -2
  281. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  282. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  283. package/docs/interfaces/plugins.TrajectoryController.html +8 -8
  284. package/docs/interfaces/react.FiveInjectionTypes.html +21 -21
  285. package/docs/interfaces/sticker.IntersectionLike.html +2 -2
  286. package/docs/interfaces/vfx.ParticleArgs.html +4 -4
  287. package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
  288. package/docs/modules/five.html +1 -1
  289. package/docs/modules/plugins.CSS3DPluginType.html +1 -0
  290. package/docs/modules/plugins.GaussianSplattingEntranceAnimationPluginType.html +1 -0
  291. package/docs/modules/plugins.html +1 -1
  292. package/docs/modules.html +1 -1
  293. package/docs/types/five.ControllerEventTypes.html +30 -26
  294. package/docs/types/five.EasingFunction.html +1 -0
  295. package/docs/types/five.EventTypes.html +27 -25
  296. package/docs/types/five.LegacyEventType.html +7 -7
  297. package/docs/types/five.NetworkProgressCallback.html +1 -1
  298. package/docs/types/five.PBMAlphaMode.html +1 -1
  299. package/docs/types/five.PBMColorStyle.html +1 -1
  300. package/docs/types/five.PBMFloorStyle.html +1 -1
  301. package/docs/types/five.PBMMeshShaderType.html +1 -1
  302. package/docs/types/five.PBMPointBack.html +1 -1
  303. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  304. package/docs/types/five.PBMPointShape.html +1 -1
  305. package/docs/types/five.PBMPointSize.html +1 -1
  306. package/docs/types/five.PBMTransition.html +1 -1
  307. package/docs/types/five.ParseOptions.html +6 -6
  308. package/docs/types/five.Works.html +1 -1
  309. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  310. package/docs/types/plugins.CSS3DPluginType.PluginData.html +1 -0
  311. package/docs/types/plugins.CSS3DPluginType.ServerData.html +1 -0
  312. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  313. package/five/application/analysis.d.ts +40 -0
  314. package/five/application/controllers.d.ts +41 -0
  315. package/five/application/events-legacy.d.ts +454 -0
  316. package/five/application/events.d.ts +69 -0
  317. package/five/application/five.d.ts +519 -0
  318. package/five/application/fiveInitArgs.d.ts +176 -0
  319. package/five/application/fiveLoadOptions.d.ts +21 -0
  320. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  321. package/five/application/getViewportScale.d.ts +2 -0
  322. package/five/application/initLights.d.ts +3 -0
  323. package/five/application/mode.d.ts +28 -0
  324. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  325. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  326. package/five/assets/gradient-png-data-url.d.ts +2 -0
  327. package/five/assets/loading-png-data-url.d.ts +2 -0
  328. package/five/assets/phone-png-data-url.d.ts +2 -0
  329. package/five/assets/realsee-png-data-url.d.ts +2 -0
  330. package/five/bvh/bvhMath.d.ts +33 -0
  331. package/five/bvh/bvhMesh.d.ts +7 -0
  332. package/five/bvh/bvhNode.d.ts +29 -0
  333. package/five/bvh/bvhObject.d.ts +18 -0
  334. package/five/bvh/bvhPoints.d.ts +6 -0
  335. package/five/bvh/index.d.ts +10 -0
  336. package/five/bvh/worker.d.ts +35 -0
  337. package/five/cardboard/helper.d.ts +2 -0
  338. package/five/cardboard/index.d.ts +13 -0
  339. package/five/cardboard/sensor.d.ts +158 -0
  340. package/five/certificates/hardware.d.ts +1 -0
  341. package/five/controllers/base.d.ts +167 -0
  342. package/five/controllers/events.d.ts +73 -0
  343. package/five/controllers/floorplan.d.ts +119 -0
  344. package/five/controllers/mapview.d.ts +139 -0
  345. package/five/controllers/model.d.ts +57 -0
  346. package/five/controllers/panorama.d.ts +144 -0
  347. package/five/controllers/panoramaLike.d.ts +87 -0
  348. package/five/controllers/topview.d.ts +42 -0
  349. package/five/controllers/vrPanorama.d.ts +56 -0
  350. package/five/controllers/xrPanorama.d.ts +81 -0
  351. package/five/core/camera.d.ts +65 -0
  352. package/five/core/internalWebGLRenderer.d.ts +14 -0
  353. package/five/core/panoVideo.d.ts +18 -0
  354. package/five/core/scene.d.ts +10 -0
  355. package/five/core/tiling.d.ts +43 -0
  356. package/five/declare.d.ts +2 -1
  357. package/five/gaussian-splatting/util/renderData.d.ts +66 -0
  358. package/five/gaussian-splatting/wasm/data.d.ts +20 -0
  359. package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
  360. package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
  361. package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
  362. package/five/index.d.ts +60 -4636
  363. package/five/index.js +272 -392
  364. package/five/index.mjs +26894 -31013
  365. package/five/meshes/boundingMesh.d.ts +13 -0
  366. package/five/meshes/intersectMesh.d.ts +8 -0
  367. package/five/meshes/panoCircleMesh.d.ts +35 -0
  368. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  369. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  370. package/five/meshes/panoSphereMesh.d.ts +27 -0
  371. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  372. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  373. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  374. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  375. package/five/model/index.d.ts +70 -0
  376. package/five/model/intersection.d.ts +18 -0
  377. package/five/model/loaders/at3d.d.ts +12 -0
  378. package/five/model/loaders/b3dm.d.ts +9 -0
  379. package/five/model/loaders/dome.d.ts +22 -0
  380. package/five/model/loaders/domez.d.ts +11 -0
  381. package/five/model/loaders/fbx.d.ts +8 -0
  382. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  383. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  384. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  385. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  386. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  387. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  388. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +26 -0
  389. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +11 -0
  390. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
  391. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  392. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  393. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  394. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  395. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  396. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  397. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  398. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  399. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  400. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  401. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +25 -0
  402. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  403. package/five/model/loaders/glTF-helpers/index.d.ts +51 -0
  404. package/five/model/loaders/glTF-helpers/parser.d.ts +115 -0
  405. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  406. package/five/model/loaders/gltf.d.ts +10 -0
  407. package/five/model/loaders/obj.d.ts +9 -0
  408. package/five/model/loaders/pbm.d.ts +26 -0
  409. package/five/model/loaders/ply.d.ts +24 -0
  410. package/five/model/loaders/pnts.d.ts +8 -0
  411. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  412. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  413. package/five/model/loaders/shared.d.ts +16 -0
  414. package/five/model/loaders/splat.d.ts +8 -0
  415. package/five/model/loaders/spz.d.ts +14 -0
  416. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  417. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  418. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  419. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  420. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  421. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  422. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  423. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  424. package/five/model/loaders/x3p.d.ts +22 -0
  425. package/five/model/materials/pbmMaterial.d.ts +137 -0
  426. package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
  427. package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -0
  428. package/five/model/model-scene.d.ts +172 -0
  429. package/five/model/model.d.ts +209 -0
  430. package/five/model/objects/pbmContainer.d.ts +28 -0
  431. package/five/model/objects/pbmGaussianSplattingObject.d.ts +43 -0
  432. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +59 -0
  433. package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
  434. package/five/model/objects/pbmGroup.d.ts +8 -0
  435. package/five/model/objects/pbmMesh.d.ts +10 -0
  436. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  437. package/five/model/parameter.d.ts +141 -0
  438. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  439. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  440. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  441. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  442. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  443. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  444. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  445. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  446. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  447. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  448. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  449. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  450. package/five/model/tile3d/header.d.ts +88 -0
  451. package/five/model/tile3d/index.d.ts +216 -0
  452. package/five/model/tile3d/tile-cache.d.ts +18 -0
  453. package/five/model/tile3d/tile-content.d.ts +10 -0
  454. package/five/model/tile3d/tile-node.d.ts +24 -0
  455. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  456. package/five/model/tile3d/tile.d.ts +79 -0
  457. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  458. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  459. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  460. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  461. package/five/model/tile3d/tileset.d.ts +70 -0
  462. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  463. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  464. package/five/model/tile3d/trajectory.d.ts +30 -0
  465. package/five/model/tile3d/types.d.ts +33 -0
  466. package/five/model/view-layer.d.ts +20 -0
  467. package/five/renderer/five-renderer.d.ts +17 -0
  468. package/five/renderer/index.d.ts +3 -0
  469. package/five/renderer/postprocessing/composer.d.ts +37 -0
  470. package/five/renderer/postprocessing/index.d.ts +7 -0
  471. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +17 -0
  472. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  473. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  474. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  475. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  476. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  477. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  478. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  479. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  480. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  481. package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
  482. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  483. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  484. package/five/texture/histogram.d.ts +54 -0
  485. package/five/texture/imageBitmap.d.ts +13 -0
  486. package/five/texture/initTexture.d.ts +3 -0
  487. package/five/texture/loader.d.ts +39 -0
  488. package/five/texture/textureData.d.ts +11 -0
  489. package/five/thirdparty/fflate.d.ts +1407 -0
  490. package/five/thirdparty/hammer.d.ts +375 -0
  491. package/five/thirdparty/jsrsasign.d.ts +753 -0
  492. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  493. package/five/three-version-check.d.ts +1 -0
  494. package/five/types/addableObject.d.ts +12 -0
  495. package/five/types/cube.d.ts +1 -0
  496. package/five/types/gestureInput.d.ts +24 -0
  497. package/five/types/imageOptions.d.ts +20 -0
  498. package/five/types/intersectMeshInterface.d.ts +8 -0
  499. package/five/types/movePanoEffect.d.ts +13 -0
  500. package/five/types/movePanoOptions.d.ts +36 -0
  501. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  502. package/five/types/plugin.d.ts +25 -0
  503. package/five/types/pose.d.ts +17 -0
  504. package/five/types/state.d.ts +20 -0
  505. package/five/types/viewport.d.ts +22 -0
  506. package/five/utils/ajax.d.ts +66 -0
  507. package/five/utils/animationFrameLoop.d.ts +45 -0
  508. package/five/utils/array.d.ts +31 -0
  509. package/five/utils/asyncTaskQueue.d.ts +8 -0
  510. package/five/utils/bufferGeometry.d.ts +33 -0
  511. package/five/utils/calculateProgress.d.ts +39 -0
  512. package/five/utils/calculateThreeMouse.d.ts +13 -0
  513. package/five/utils/canplayVideo.d.ts +2 -0
  514. package/five/utils/clamp.d.ts +2 -0
  515. package/five/utils/clock.d.ts +17 -0
  516. package/five/utils/createSymbol.d.ts +5 -0
  517. package/five/utils/decodeText.d.ts +2 -0
  518. package/five/utils/deepEqual.d.ts +2 -0
  519. package/five/utils/deepFreeze.d.ts +2 -0
  520. package/five/utils/defineProperty.d.ts +9 -0
  521. package/five/utils/detector.d.ts +14 -0
  522. package/five/utils/distance.d.ts +10 -0
  523. package/five/utils/draco.d.ts +26 -0
  524. package/five/utils/easing.d.ts +63 -0
  525. package/five/utils/error.d.ts +1 -0
  526. package/five/utils/event.d.ts +210 -0
  527. package/five/utils/formatRad.d.ts +7 -0
  528. package/five/utils/imageSupport.d.ts +6 -0
  529. package/five/utils/imageURL.d.ts +42 -0
  530. package/five/utils/isEmptyObject.d.ts +2 -0
  531. package/five/utils/isNil.d.ts +6 -0
  532. package/five/utils/isNumber.d.ts +2 -0
  533. package/five/utils/isPowerOfTwo.d.ts +2 -0
  534. package/five/utils/isPromise.d.ts +2 -0
  535. package/five/utils/isSimilar.d.ts +6 -0
  536. package/five/utils/json.d.ts +7 -0
  537. package/five/utils/ktx2.d.ts +30 -0
  538. package/five/utils/lzma/index.d.ts +2 -0
  539. package/five/utils/lzma/lzma.d.ts +3 -0
  540. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  541. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  542. package/five/utils/memoryUsage.d.ts +29 -0
  543. package/five/utils/motion.d.ts +38 -0
  544. package/five/utils/noop.d.ts +6 -0
  545. package/five/utils/now.d.ts +7 -0
  546. package/five/utils/pano.d.ts +9 -0
  547. package/five/utils/pick.d.ts +3 -0
  548. package/five/utils/poseUtils.d.ts +5 -0
  549. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  550. package/five/utils/renderDepth.d.ts +2 -0
  551. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  552. package/five/utils/requestPermission.d.ts +3 -0
  553. package/five/utils/shaderContentFix.d.ts +7 -0
  554. package/five/utils/shaderMaterial.d.ts +20 -0
  555. package/five/utils/stateUtils.d.ts +5 -0
  556. package/five/utils/string-pattern.d.ts +8 -0
  557. package/five/utils/subscribe.d.ts +67 -0
  558. package/five/utils/tileCube.d.ts +19 -0
  559. package/five/utils/toFastProperties.d.ts +1 -0
  560. package/five/utils/typedCache.d.ts +10 -0
  561. package/five/utils/uniform.d.ts +15 -0
  562. package/five/utils/url.d.ts +35 -0
  563. package/five/utils/uuid.d.ts +5 -0
  564. package/five/utils/values.d.ts +2 -0
  565. package/five/utils/vectorCoordinates.d.ts +29 -0
  566. package/five/utils/volume.d.ts +111 -0
  567. package/five/utils/webglError.d.ts +7 -0
  568. package/five/utils/worker.d.ts +26 -0
  569. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  570. package/five/webxr/motionHelper.d.ts +68 -0
  571. package/five/webxr/xrButton.d.ts +4 -0
  572. package/five/webxr/xrController.d.ts +24 -0
  573. package/five/webxr/xrManager.d.ts +84 -0
  574. package/five/work/_ALLOW_HOST.d.ts +2 -0
  575. package/five/work/index.d.ts +7 -0
  576. package/five/work/keychain.d.ts +5 -0
  577. package/five/work/looseWorkType.d.ts +121 -0
  578. package/five/work/verify.d.ts +7 -0
  579. package/five/work/work.d.ts +206 -0
  580. package/five/work/workFetcher.d.ts +4 -0
  581. package/five/work/workJson.d.ts +3 -0
  582. package/five/work/workJsonType.d.ts +73 -0
  583. package/five/work/workObserverProto.d.ts +39 -0
  584. package/five/work/workParser.d.ts +6 -0
  585. package/five/work/workResolvedObserver.d.ts +12 -0
  586. package/five/work/workVerify.d.ts +2 -0
  587. package/five/work/works.d.ts +10 -0
  588. package/gltf-loader/gltf-object.d.ts +17 -0
  589. package/gltf-loader/index.d.ts +60 -160
  590. package/gltf-loader/index.js +9 -9
  591. package/gltf-loader/index.mjs +1351 -1451
  592. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  593. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  594. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  595. package/line/circle_png.d.ts +1 -0
  596. package/line/index.d.ts +19 -69
  597. package/line/index.js +4 -4
  598. package/line/index.mjs +334 -513
  599. package/line/utils/Line2.d.ts +7 -0
  600. package/line/utils/LineGeometry.d.ts +10 -0
  601. package/line/utils/LineMaterial.d.ts +20 -0
  602. package/line/utils/LineSegments2.d.ts +11 -0
  603. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  604. package/llms.txt +48 -3
  605. package/package.json +4 -4
  606. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  607. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  608. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  609. package/plugins/BasePlugin/index.d.ts +119 -0
  610. package/plugins/CSS3DPlugin/Controller.d.ts +64 -0
  611. package/plugins/CSS3DPlugin/index.d.ts +5 -0
  612. package/plugins/CSS3DPlugin/typing.d.ts +32 -0
  613. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  614. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  615. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  616. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  617. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  618. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  619. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  620. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  621. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  622. package/plugins/GaussianSplattingEntranceAnimationPlugin/Controller.d.ts +30 -0
  623. package/plugins/GaussianSplattingEntranceAnimationPlugin/index.d.ts +5 -0
  624. package/plugins/GaussianSplattingEntranceAnimationPlugin/typing.d.ts +28 -0
  625. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  626. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  627. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  628. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  629. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  630. package/plugins/OrientationPlugin/index.d.ts +6 -0
  631. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  632. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  633. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  634. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  635. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  636. package/plugins/PluginTemplate/index.d.ts +5 -0
  637. package/plugins/PluginTemplate/typing.d.ts +21 -0
  638. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  639. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  640. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  641. package/plugins/index.d.ts +11 -1102
  642. package/plugins/index.js +35 -21
  643. package/plugins/index.mjs +3668 -4247
  644. package/plugins/thirdParty/CSS3DRenderer.d.ts +45 -0
  645. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  646. package/plugins/utils/absoluteUrl.d.ts +5 -0
  647. package/plugins/utils/clamp.d.ts +2 -0
  648. package/plugins/utils/loadImage.d.ts +1 -0
  649. package/plugins/utils/motion.d.ts +38 -0
  650. package/plugins/utils/now.d.ts +6 -0
  651. package/plugins/utils/uuid.d.ts +2 -0
  652. package/react/canvas.d.ts +19 -0
  653. package/react/context.d.ts +12 -0
  654. package/react/createProvider.d.ts +95 -0
  655. package/react/createStore.d.ts +144 -0
  656. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  657. package/react/hooks/useFiveAction.d.ts +147 -0
  658. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  659. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  660. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  661. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  662. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  663. package/react/hooks/useFiveFloor.d.ts +15 -0
  664. package/react/hooks/useFiveHelper.d.ts +14 -0
  665. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  666. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  667. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  668. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  669. package/react/hooks/useFiveProject2d.d.ts +20 -0
  670. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  671. package/react/hooks/useFiveState.d.ts +6 -0
  672. package/react/hooks/useFiveWork.d.ts +29 -0
  673. package/react/index.d.ts +24 -830
  674. package/react/index.js +3 -3
  675. package/react/index.mjs +572 -783
  676. package/react/rendererPool.d.ts +7 -0
  677. package/react/withFive.d.ts +213 -0
  678. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  679. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  680. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  681. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  682. package/shader-lib/ShineModel/index.d.ts +7 -0
  683. package/shader-lib/SweepModel/index.d.ts +7 -0
  684. package/shader-lib/index.d.ts +5 -86
  685. package/shader-lib/index.js +13 -14
  686. package/shader-lib/index.mjs +424 -824
  687. package/sticker/geometry.d.ts +3 -0
  688. package/sticker/index.d.ts +68 -71
  689. package/sticker/index.js +3 -3
  690. package/sticker/index.mjs +102 -142
  691. package/umd/five-gltf-loader.js +9 -9
  692. package/umd/five-line.js +4 -4
  693. package/umd/five-plugins.js +35 -21
  694. package/umd/five-react.js +3 -3
  695. package/umd/five-shader-lib.js +13 -14
  696. package/umd/five-sticker.js +3 -3
  697. package/umd/five-vfx.js +21 -21
  698. package/umd/five-vue.js +3 -3
  699. package/umd/five.js +267 -387
  700. package/vfx/airflow/airflow.d.ts +18 -0
  701. package/vfx/airflow/fragment-shader.d.ts +2 -0
  702. package/vfx/airflow/vertex-shader.d.ts +2 -0
  703. package/vfx/common/scale-shader.d.ts +2 -0
  704. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  705. package/vfx/frame/fragment-shader.d.ts +2 -0
  706. package/vfx/frame/frame.d.ts +22 -0
  707. package/vfx/frame/vertex-shader.d.ts +2 -0
  708. package/vfx/index.d.ts +7 -363
  709. package/vfx/index.js +21 -21
  710. package/vfx/index.mjs +454 -910
  711. package/vfx/particle/fragment-shader.d.ts +2 -0
  712. package/vfx/particle/instance.d.ts +36 -0
  713. package/vfx/particle/particle.d.ts +205 -0
  714. package/vfx/particle/utils.d.ts +11 -0
  715. package/vfx/particle/vertex-shader.d.ts +2 -0
  716. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  717. package/vfx/particle-gpu/instance.d.ts +36 -0
  718. package/vfx/particle-gpu/particle.d.ts +95 -0
  719. package/vfx/particle-gpu/utils.d.ts +11 -0
  720. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  721. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  722. package/vfx/spotLight/spotLight.d.ts +15 -0
  723. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  724. package/vue/context.d.ts +7 -0
  725. package/vue/hooks/FiveCanvas.d.ts +36 -0
  726. package/vue/hooks/FiveProvider.d.ts +35 -0
  727. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  728. package/vue/hooks/useFiveAction.d.ts +178 -0
  729. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  730. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  731. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  732. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  733. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  734. package/vue/hooks/useFiveFloor.d.ts +16 -0
  735. package/vue/hooks/useFiveHelper.d.ts +15 -0
  736. package/vue/hooks/useFiveModel.d.ts +7 -0
  737. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  738. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  739. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  740. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  741. package/vue/hooks/useFiveScene.d.ts +6 -0
  742. package/vue/hooks/useFiveState.d.ts +16 -0
  743. package/vue/hooks/useFiveWork.d.ts +30 -0
  744. package/vue/index.d.ts +23 -467
  745. package/vue/index.js +3 -3
  746. package/vue/index.mjs +309 -301
  747. package/vue/rendererPool.d.ts +10 -0
  748. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  749. package/work-downloader/components/model.d.ts +3 -0
  750. package/work-downloader/components/observer.d.ts +7 -0
  751. package/work-downloader/download.d.ts +16 -0
  752. package/work-downloader/index.d.ts +2 -33
  753. package/work-downloader/index.js +3 -3
  754. package/work-downloader/index.mjs +339 -556
  755. package/work-downloader/type.d.ts +28 -0
  756. package/work-downloader/utils/download-to-file.d.ts +1 -0
  757. package/work-downloader/utils/image-processing.d.ts +7 -0
  758. package/work-downloader/utils/join-url.d.ts +2 -0
  759. package/work-downloader/utils/log.d.ts +1 -0
  760. package/work-downloader/utils/relative-url.d.ts +1 -0
  761. package/ai_guides/plugin.md +0 -206
  762. package/docs/documents/plugin.html +0 -60
  763. package/docs/media/five.ts +0 -2881
  764. package/docs/media/pass.ts +0 -64
package/docs/classes/vfx.Particle.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Particle | 如视 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="../modules/vfx.html">vfx</a></li><li><a href="" aria-current="page">Particle</a></li></ul><h1>Class Particle</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="7285"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Points</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">THREE.ShaderMaterial</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Particle</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:112</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
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>Particle | 如视 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="../modules/vfx.html">vfx</a></li><li><a href="" aria-current="page">Particle</a></li></ul><h1>Class Particle</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="8226"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Points</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">THREE.ShaderMaterial</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Particle</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:112</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
2
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#accelerationbase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Base</span></a>
3
3
  <a href="#accelerationspread" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Spread</span></a>
4
4
  <a href="#angleaccelerationbase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Acceleration<wbr/>Base</span></a>
@@ -49,12 +49,12 @@
49
49
  </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:187</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="colorspread"><span>color<wbr/>Spread</span><a href="#colorspread" 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><div class="tsd-signature"><span class="tsd-kind-property">colorSpread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>颜色（hsl）的扩散值</p>
50
50
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-description"><h4 class="tsd-anchor-link" id="description-1">Description<a href="#description-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
51
51
  <code>{ x: h, y: s, z: l }</code></p>
52
- </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:193</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="colortween"><span>color<wbr/>Tween</span><a href="#colortween" 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><div class="tsd-signature"><span class="tsd-kind-property">colorTween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Vector3</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>颜色（hsl）随时间分布的增益</p>
52
+ </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:193</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="colortween"><span>color<wbr/>Tween</span><a href="#colortween" 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><div class="tsd-signature"><span class="tsd-kind-property">colorTween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Vector3</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-comment tsd-typography"><p>颜色（hsl）随时间分布的增益</p>
53
53
  </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-description"><h4 class="tsd-anchor-link" id="description-2">Description<a href="#description-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></h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
54
54
  <code>{ x: h, y: s, z: l }</code></p>
55
55
  </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:200</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="needsrender"><span>needs<wbr/>Render</span><a href="#needsrender" 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><div class="tsd-signature"><span class="tsd-kind-property">needsRender</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:114</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="opacitybase"><span>opacity<wbr/>Base</span><a href="#opacitybase" 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><div class="tsd-signature"><span class="tsd-kind-property">opacityBase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>透明度</p>
56
56
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:203</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="opacityspread"><span>opacity<wbr/>Spread</span><a href="#opacityspread" 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><div class="tsd-signature"><span class="tsd-kind-property">opacitySpread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>透明度的扩散值</p>
57
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:205</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="opacitytween"><span>opacity<wbr/>Tween</span><a href="#opacitytween" 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><div class="tsd-signature"><span class="tsd-kind-property">opacityTween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>透明度随时间分布的增益</p>
57
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:205</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="opacitytween"><span>opacity<wbr/>Tween</span><a href="#opacitytween" 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><div class="tsd-signature"><span class="tsd-kind-property">opacityTween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-comment tsd-typography"><p>透明度随时间分布的增益</p>
58
58
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:207</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="particledeathage"><span>particle<wbr/>Death<wbr/>Age</span><a href="#particledeathage" 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><div class="tsd-signature"><span class="tsd-kind-property">particleDeathAge</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子存活时长</p>
59
59
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:212</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="particlespersecond"><span>particles<wbr/>Per<wbr/>Second</span><a href="#particlespersecond" 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><div class="tsd-signature"><span class="tsd-kind-property">particlesPerSecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>一秒产生多少粒子</p>
60
60
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:210</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="paused"><span>paused</span><a href="#paused" 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><div class="tsd-signature"><span class="tsd-kind-property">paused</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>是否暂停</p>
@@ -67,7 +67,7 @@
67
67
  <code>SPHERE</code> 形式通过一个 数字 的扩散值 positionSphereSpread，乘上一个随机单位向量 计算。</p>
68
68
  </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:133</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sizebase"><span>size<wbr/>Base</span><a href="#sizebase" 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><div class="tsd-signature"><span class="tsd-kind-property">sizeBase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子大小</p>
69
69
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:175</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sizespread"><span>size<wbr/>Spread</span><a href="#sizespread" 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><div class="tsd-signature"><span class="tsd-kind-property">sizeSpread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子大小的扩散值</p>
70
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:177</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sizetween"><span>size<wbr/>Tween</span><a href="#sizetween" 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><div class="tsd-signature"><span class="tsd-kind-property">sizeTween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>粒子大小随时间分布的增益</p>
70
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:177</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sizetween"><span>size<wbr/>Tween</span><a href="#sizetween" 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><div class="tsd-signature"><span class="tsd-kind-property">sizeTween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-comment tsd-typography"><p>粒子大小随时间分布的增益</p>
71
71
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:179</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="velocitycubebase"><span>velocity<wbr/>Cube<wbr/>Base</span><a href="#velocitycubebase" 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><div class="tsd-signature"><span class="tsd-kind-property">velocityCubeBase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>粒子速度的<code>CUBE</code>计算形式下的速度值</p>
72
72
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:148</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="velocitycubespread"><span>velocity<wbr/>Cube<wbr/>Spread</span><a href="#velocitycubespread" 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><div class="tsd-signature"><span class="tsd-kind-property">velocityCubeSpread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>粒子速度的<code>CUBE</code>计算形式下的扩散值</p>
73
73
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:150</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="velocityspherebase"><span>velocity<wbr/>Sphere<wbr/>Base</span><a href="#velocityspherebase" 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><div class="tsd-signature"><span class="tsd-kind-property">velocitySphereBase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子速度的<code>SPHERE</code>计算形式下的速度值</p>
@@ -77,8 +77,8 @@
77
77
  <code>CUBE</code> 形式通过一个 三维向量 的速度值 velocityCubeBase 加上 三维向量 的扩散值 velocityCubeSpread 乘上一个 [0, 1] 的随机三维向量 计算。
78
78
  <code>SPHERE</code> 形式通过一个 数字 的速度值 velocitySphereBase 加上 数字 的扩散值 velocitySphereSpread 乘上 粒子坐标与粒子的初始位置坐标方向的单位向量 计算。</p>
79
79
  </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:146</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="blending"><span>blending</span><a href="#blending" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="blendingblending"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">blending</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>材质混合方式</p>
80
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blending</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:293</li></ul></aside></div></li><li><div class="tsd-signature" id="blendingblending-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">blending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Blending</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:296</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="texture"><span>texture</span><a href="#texture" 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><ul class="tsd-signatures"><li><div class="tsd-signature" id="texturetexture"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">texture</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>贴图素材</p>
81
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Texture</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:273</li></ul></aside></div></li><li><div class="tsd-signature" id="texturetexture-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">texture</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Texture</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:277</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dispose"><span>dispose</span><a href="#dispose" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="dispose-1"><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>析构</p>
80
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blending</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:293</li></ul></aside></div></li><li><div class="tsd-signature" id="blendingblending-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">blending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Blending</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:296</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="texture"><span>texture</span><a href="#texture" 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><ul class="tsd-signatures"><li><div class="tsd-signature" id="texturetexture"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">texture</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>贴图素材</p>
81
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:273</li></ul></aside></div></li><li><div class="tsd-signature" id="texturetexture-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">texture</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:277</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dispose"><span>dispose</span><a href="#dispose" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="dispose-1"><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>析构</p>
82
82
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:475</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pause"><span>pause</span><a href="#pause" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>暂停</p>
83
83
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:354</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="play"><span>play</span><a href="#play" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="play-1"><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>开始</p>
84
84
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:363</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settime"><span>set<wbr/>Time</span><a href="#settime" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="settime-1"><span class="tsd-kind-call-signature">setTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#settime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>通过 Five 默认调用的 setTime 方法</p>
package/docs/classes/vfx.ParticleGPU.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ParticleGPU | 如视 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="../modules/vfx.html">vfx</a></li><li><a href="" aria-current="page">ParticleGPU</a></li></ul><h1>Class ParticleGPU</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="7378"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Points</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">THREE.ShaderMaterial</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ParticleGPU</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:81</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
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>ParticleGPU | 如视 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="../modules/vfx.html">vfx</a></li><li><a href="" aria-current="page">ParticleGPU</a></li></ul><h1>Class ParticleGPU</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="8319"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Points</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">THREE.ShaderMaterial</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ParticleGPU</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:81</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
2
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#needsrender" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render</span></a>
3
3
  <a href="#particledeathage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particle<wbr/>Death<wbr/>Age</span></a>
4
4
  <a href="#particlespersecond" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particles<wbr/>Per<wbr/>Second</span></a>
@@ -10,8 +10,8 @@
10
10
  <a href="#play" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a>
11
11
  <a href="#settime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time</span></a>
12
12
  </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorparticlegpu"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ParticleGPU</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/vfx.ParticleGPUArgs.html" class="tsd-signature-type tsd-kind-interface">ParticleGPUArgs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ParticleGPU</a><a href="#constructorparticlegpu" 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></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/vfx.ParticleGPUArgs.html" class="tsd-signature-type tsd-kind-interface">ParticleGPUArgs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ParticleGPU</a></h4><aside class="tsd-sources"><p>Overrides THREE.Points&lt;THREE.BufferGeometry, THREE.ShaderMaterial&gt;.constructor</p><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:93</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="needsrender"><span>needs<wbr/>Render</span><a href="#needsrender" 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><div class="tsd-signature"><span class="tsd-kind-property">needsRender</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:82</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="particledeathage"><span>particle<wbr/>Death<wbr/>Age</span><a href="#particledeathage" 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><div class="tsd-signature"><span class="tsd-kind-property">particleDeathAge</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:91</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="particlespersecond"><span>particles<wbr/>Per<wbr/>Second</span><a href="#particlespersecond" 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><div class="tsd-signature"><span class="tsd-kind-property">particlesPerSecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:90</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="paused"><span>paused</span><a href="#paused" 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><div class="tsd-signature"><span class="tsd-kind-property">paused</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:83</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="blending"><span>blending</span><a href="#blending" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="blendingblending"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">blending</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>材质混合方式</p>
13
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blending</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:265</li></ul></aside></div></li><li><div class="tsd-signature" id="blendingblending-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">blending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Blending</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:268</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="texture"><span>texture</span><a href="#texture" 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><ul class="tsd-signatures"><li><div class="tsd-signature" id="texturetexture"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">texture</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>贴图素材</p>
14
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Texture</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:245</li></ul></aside></div></li><li><div class="tsd-signature" id="texturetexture-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">texture</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Texture</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:249</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dispose"><span>dispose</span><a href="#dispose" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="dispose-1"><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>析构</p>
13
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blending</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:265</li></ul></aside></div></li><li><div class="tsd-signature" id="blendingblending-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">blending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Blending</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:268</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="texture"><span>texture</span><a href="#texture" 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><ul class="tsd-signatures"><li><div class="tsd-signature" id="texturetexture"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">texture</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>贴图素材</p>
14
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:245</li></ul></aside></div></li><li><div class="tsd-signature" id="texturetexture-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">texture</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Texture</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:249</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dispose"><span>dispose</span><a href="#dispose" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="dispose-1"><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>析构</p>
15
15
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:308</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pause"><span>pause</span><a href="#pause" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>暂停</p>
16
16
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:273</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="play"><span>play</span><a href="#play" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="play-1"><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>开始</p>
17
17
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:282</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settime"><span>set<wbr/>Time</span><a href="#settime" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="settime-1"><span class="tsd-kind-call-signature">setTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#settime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>通过 Five 默认调用的 setTime 方法</p>
package/docs/classes/vfx.SpotLight.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpotLight | 如视 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="../modules/vfx.html">vfx</a></li><li><a href="" aria-current="page">SpotLight</a></li></ul><h1>Class SpotLight</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="7235"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Group</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SpotLight</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:5</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
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>SpotLight | 如视 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="../modules/vfx.html">vfx</a></li><li><a href="" aria-current="page">SpotLight</a></li></ul><h1>Class SpotLight</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="8176"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Group</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SpotLight</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:5</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-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><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
2
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#needsrender" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render</span></a>
3
3
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#anglepower" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle<wbr/>Power</span></a>
4
4
  <a href="#attenuation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>attenuation</span></a>
package/docs/documents/README.html CHANGED
@@ -66,14 +66,16 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
66
66
  <ul>
67
67
  <li><a href="features_five.html">Five</a>: 核心类 <code>Five</code>，管理渲染循环与全局状态。</li>
68
68
  <li><a href="features_work.html">Work</a>: 数据载体，描述三维空间的数据结构 (VR 看房数据)。</li>
69
+ <li><a href="features_pano-uv.html">Panorama UV</a>: 全景图 UV 与空间方向转换工具。</li>
69
70
  <li><a href="features_mode.html">Mode</a>: 五种核心浏览模式 (Panorama, Floorplan, Topview, Model, Map)。</li>
70
71
  <li><a href="features_state.html">State</a>: 状态管理 (Pose, Mode, PanoIndex)，用于复原场景。</li>
71
- <li><a href="features_coordnate-system.html">Coordinate System</a>: 坐标系定义 (右手坐标系, Y轴向上)。</li>
72
+ <li><a href="features_coordinate-system.html">Coordinate System</a>: 坐标系定义 (右手坐标系, Y轴向上)。</li>
72
73
  </ul>
73
74
  <h3 id="3-data-resource-数据与资源" class="tsd-anchor-link">3. Data &amp; Resource (数据与资源)<a href="#3-data-resource-数据与资源" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
74
75
  <p>数据加载与资源管理配置。</p>
75
76
  <ul>
76
77
  <li><a href="features_load-external-model.html">Load External Model</a>: 加载外部 3D 模型 (GLTF, OBJ 等)。</li>
78
+ <li><a href="features_load-progress.html">Load Progress</a>: 监控模型与全景图的加载进度 (Loaded/Refined)。</li>
77
79
  <li><a href="features_multi-work.html">Multi-Work (Sandbox)</a>: 多 Work 加载与沙盘场景管理。</li>
78
80
  <li><a href="features_request-proxy.html">Request Proxy</a>: 请求拦截与代理 (CDN 替换、鉴权)。</li>
79
81
  <li><a href="features_image-options.html">Image Options</a>: 图片资源配置 (CDN, 格式, 尺寸)。</li>
@@ -84,6 +86,11 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
84
86
  <li><a href="features_pano-tile.html">Pano Tile</a>: 全景瓦片渲染机制（高分辨率分片加载）。</li>
85
87
  <li><a href="features_model.html">Model</a>: 内置模型渲染 (Mesh/Geometry)。</li>
86
88
  <li><a href="features_postprocessing.html">Postprocessing</a>: 后处理效果 (Pass, EffectComposer)。</li>
89
+ <li><a href="features_flowing-light-2d-pass.html">Flowing Light 2D Pass</a>: 屏幕空间流光特效(InstancedMesh 优化)。</li>
90
+ <li><a href="features_flowing-light-3d-pass.html">Flowing Light 3D Pass</a>: 3D 世界坐标流光特效(InstancedMesh 优化)。</li>
91
+ <li><a href="features_gaussian-blur-pass.html">Gaussian Blur Pass</a>: 高斯模糊特效。</li>
92
+ <li><a href="features_material.html">Material</a>: 材质参数配置 (透明度、点云大小、顶点标记)。</li>
93
+ <li><a href="features_pano-filter.html">Pano Filter</a>: 全景图滤镜 (亮度、对比度、色温调节)。</li>
87
94
  <li><a href="features_get-screen-pixels.html">Get Screen Pixels</a>: 获取屏幕像素 (放大镜/截图)。</li>
88
95
  <li><a href="features_move-pano-effect.html">Move Pano Effect</a>: 全景点位切换的过渡效果。</li>
89
96
  <li><a href="features_clipper.html">Clipper</a>: 模型裁切功能 (房屋剖面)。</li>
@@ -101,7 +108,8 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
101
108
  <h3 id="6-advanced-extensions-进阶与扩展" class="tsd-anchor-link">6. Advanced &amp; Extensions (进阶与扩展)<a href="#6-advanced-extensions-进阶与扩展" 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>
102
109
  <p>复杂配置与功能扩展。</p>
103
110
  <ul>
104
- <li><a href="plugin.html">Plugin</a>: 插件开发指南。</li>
111
+ <li><a href="features_plugin.html">Plugin</a>: 插件开发指南。</li>
112
+ <li><a href="features_view-layer.html">ViewLayer</a>: 视图层。</li>
105
113
  <li><a href="features_parameter.html">Parameter</a>: Five 初始化详细参数配置。</li>
106
114
  </ul>
107
115
  <h3 id="7-meta-support-其他" class="tsd-anchor-link">7. Meta &amp; Support (其他)<a href="#7-meta-support-其他" 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>
@@ -110,11 +118,132 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
110
118
  <li><a href="ai-doc-guidelines.html">AI Documentation Guidelines</a>: AI 文档编写与维护规范 (必读)。</li>
111
119
  <li>Release Notes: 版本更新记录。
112
120
  <ul>
121
+ <li><a href="release_notes_6.8.html">6.8</a></li>
113
122
  <li><a href="release_notes_6.7.html">6.7</a></li>
114
123
  <li><a href="release_notes_6.6.html">6.6</a></li>
115
124
  </ul>
116
125
  </li>
117
126
  </ul>
127
+ <h2 id="common-scenarios-场景-→-文档速查" class="tsd-anchor-link">Common Scenarios (场景 → 文档速查)<a href="#common-scenarios-场景-→-文档速查" 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>
128
+ <blockquote>
129
+ <p><strong>Keyword Search Tip:</strong> Each doc in <code>features/</code> has a <code>tags</code> yaml block at the bottom with Chinese and English keywords. Use these for keyword matching when the scenario table below doesn't cover your need.</p>
130
+ </blockquote>
131
+ <table>
132
+ <thead>
133
+ <tr>
134
+ <th style="text-align:left">Scenario</th>
135
+ <th style="text-align:left">Docs</th>
136
+ <th style="text-align:left">Tags</th>
137
+ </tr>
138
+ </thead>
139
+ <tbody>
140
+ <tr>
141
+ <td style="text-align:left">点击拾取物体 / Object picking</td>
142
+ <td style="text-align:left"><a href="features_raycast.html">Raycast</a></td>
143
+ <td style="text-align:left">click, hit-test, floor-detection, 碰撞检测, 物体选择</td>
144
+ </tr>
145
+ <tr>
146
+ <td style="text-align:left">3D 标签 / HTML overlay on 3D point</td>
147
+ <td style="text-align:left"><a href="features_screen-project.html">Screen Project</a></td>
148
+ <td style="text-align:left">label, HUD, tooltip, 坐标转换, 3D转2D</td>
149
+ </tr>
150
+ <tr>
151
+ <td style="text-align:left">全景滤镜 / 色温调节 / Color correction</td>
152
+ <td style="text-align:left"><a href="features_pano-filter.html">Pano Filter</a></td>
153
+ <td style="text-align:left">warm, cool, brightness, contrast, saturation, 暖色, 冷色, 饱和度</td>
154
+ </tr>
155
+ <tr>
156
+ <td style="text-align:left">加载外部 GLTF/OBJ/FBX 模型</td>
157
+ <td style="text-align:left"><a href="features_load-external-model.html">Load External Model</a></td>
158
+ <td style="text-align:left">gltf, glb, ply, splat, fbx, draco, point-cloud, dispose</td>
159
+ </tr>
160
+ <tr>
161
+ <td style="text-align:left">相机巡航 / 自动导览 / Camera fly-through</td>
162
+ <td style="text-align:left"><a href="features_camera-animation.html">Camera Animation</a></td>
163
+ <td style="text-align:left">rotate, zoom, auto-tour, 运镜, 旋转, 缩放</td>
164
+ </tr>
165
+ <tr>
166
+ <td style="text-align:left">截图 / 放大镜 / Screen capture</td>
167
+ <td style="text-align:left"><a href="features_get-screen-pixels.html">Get Screen Pixels</a></td>
168
+ <td style="text-align:left">magnifier, screenshot, color-picker, 取色器</td>
169
+ </tr>
170
+ <tr>
171
+ <td style="text-align:left">模型裁切 / 房屋剖面</td>
172
+ <td style="text-align:left"><a href="features_clipper.html">Clipper</a></td>
173
+ <td style="text-align:left">clipping-box, section-view, discard, 开盖, 剖面</td>
174
+ </tr>
175
+ <tr>
176
+ <td style="text-align:left">流光特效 / Flowing light effect</td>
177
+ <td style="text-align:left"><a href="features_flowing-light-2d-pass.html">Flowing Light 2D</a>, <a href="features_flowing-light-3d-pass.html">Flowing Light 3D</a></td>
178
+ <td style="text-align:left">光带, 导航路径, 动态路径, instanced</td>
179
+ </tr>
180
+ <tr>
181
+ <td style="text-align:left">模糊特效 / Blur effect</td>
182
+ <td style="text-align:left"><a href="features_gaussian-blur-pass.html">Gaussian Blur Pass</a></td>
183
+ <td style="text-align:left">毛玻璃, 背景虚化, gaussian</td>
184
+ </tr>
185
+ <tr>
186
+ <td style="text-align:left">保存/恢复场景状态</td>
187
+ <td style="text-align:left"><a href="features_state.html">State</a></td>
188
+ <td style="text-align:left">snapshot, save, restore, 快照, 场景还原</td>
189
+ </tr>
190
+ <tr>
191
+ <td style="text-align:left">多场景切换 / 沙盘</td>
192
+ <td style="text-align:left"><a href="features_multi-work.html">Multi-Work</a></td>
193
+ <td style="text-align:left">sandbox, 多户型, 拼接, workCode</td>
194
+ </tr>
195
+ <tr>
196
+ <td style="text-align:left">请求鉴权 / CDN 替换</td>
197
+ <td style="text-align:left"><a href="features_request-proxy.html">Request Proxy</a></td>
198
+ <td style="text-align:left">authentication, token, url-rewrite, cors, 私有化</td>
199
+ </tr>
200
+ <tr>
201
+ <td style="text-align:left">插件开发</td>
202
+ <td style="text-align:left"><a href="features_plugin.html">Plugin</a></td>
203
+ <td style="text-align:left">lifecycle, extension, baseplugin, 状态管理</td>
204
+ </tr>
205
+ <tr>
206
+ <td style="text-align:left">事件监听 / 拦截默认行为</td>
207
+ <td style="text-align:left"><a href="features_event.html">Event</a></td>
208
+ <td style="text-align:left">preventDefault, waitUntil, on, off, gesture, 回调</td>
209
+ </tr>
210
+ <tr>
211
+ <td style="text-align:left">手势交互 / 自定义拖拽</td>
212
+ <td style="text-align:left"><a href="features_gesture.html">Gesture</a></td>
213
+ <td style="text-align:left">tap, pan, pinch, press, 触摸, 鼠标</td>
214
+ </tr>
215
+ <tr>
216
+ <td style="text-align:left">后处理特效 / 自定义 Shader</td>
217
+ <td style="text-align:left"><a href="features_postprocessing.html">Postprocessing</a></td>
218
+ <td style="text-align:left">effect-composer, addPass, edl, 描边, 景深</td>
219
+ </tr>
220
+ <tr>
221
+ <td style="text-align:left">材质 / 透明度 / 点云样式</td>
222
+ <td style="text-align:left"><a href="features_material.html">Material</a></td>
223
+ <td style="text-align:left">opacity, pointcloud, roof, ceiling, 天花板, 顶点标记</td>
224
+ </tr>
225
+ <tr>
226
+ <td style="text-align:left">模式切换 / 全景↔模型↔户型图</td>
227
+ <td style="text-align:left"><a href="features_mode.html">Mode</a></td>
228
+ <td style="text-align:left">panorama, floorplan, mapview, topview, VR</td>
229
+ </tr>
230
+ <tr>
231
+ <td style="text-align:left">全景高清瓦片 / 分片加载</td>
232
+ <td style="text-align:left"><a href="features_pano-tile.html">Pano Tile</a></td>
233
+ <td style="text-align:left">LOD, tile, 按需加载, 高清全景</td>
234
+ </tr>
235
+ <tr>
236
+ <td style="text-align:left">图片 CDN / 私有化部署</td>
237
+ <td style="text-align:left"><a href="features_image-options.html">Image Options</a></td>
238
+ <td style="text-align:left">avif, webp, cdn, private-deployment</td>
239
+ </tr>
240
+ <tr>
241
+ <td style="text-align:left">加载进度 / 首屏优化</td>
242
+ <td style="text-align:left"><a href="features_load-progress.html">Load Progress</a></td>
243
+ <td style="text-align:left">refined, loaded, loading-bar, 首屏</td>
244
+ </tr>
245
+ </tbody>
246
+ </table>
118
247
  <h2 id="terminology-summary" class="tsd-anchor-link">Terminology Summary<a href="#terminology-summary" 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>
119
248
  <ul>
120
249
  <li><strong>Work</strong>: 包含全景图、模型、户型数据的 JSON 对象。</li>
@@ -127,4 +256,4 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
127
256
  <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">index</span><span class="hl-1">, </span><span class="hl-2">readme</span><span class="hl-1">, </span><span class="hl-2">guide</span><span class="hl-1">, </span><span class="hl-2">map</span><span class="hl-1">]</span>
128
257
  </code><button type="button">Copy</button></pre>
129
258
 
130
- </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-sdk-documentation"><span>Five <wbr/>SDK <wbr/>Documentation</span></a><ul><li><a href="#context-for-ai-agents"><span>Context for <wbr/>AI <wbr/>Agents</span></a></li><li><ul><li><a href="#1-documentation-maintenance-文档维护"><span>1. <wbr/>Documentation <wbr/>Maintenance (文档维护)</span></a></li><li><a href="#2-application-development-strategy-应用开发建议"><span>2. <wbr/>Application <wbr/>Development <wbr/>Strategy (应用开发建议)</span></a></li><li><a href="#3-general-retrieval-通用检索"><span>3. <wbr/>General <wbr/>Retrieval (通用检索)</span></a></li></ul></li><li><a href="#documentation-map"><span>Documentation <wbr/>Map</span></a></li><li><ul><li><a href="#1-essential-reference-必读速查"><span>1. <wbr/>Essential <wbr/>Reference (必读/速查)</span></a></li><li><a href="#2-core-concepts-核心概念"><span>2. <wbr/>Core <wbr/>Concepts (核心概念)</span></a></li><li><a href="#3-data-resource-数据与资源"><span>3. <wbr/>Data &amp; <wbr/>Resource (数据与资源)</span></a></li><li><a href="#4-rendering-visuals-渲染与视觉"><span>4. <wbr/>Rendering &amp; <wbr/>Visuals (渲染与视觉)</span></a></li><li><a href="#5-interaction-control-交互与控制"><span>5. <wbr/>Interaction &amp; <wbr/>Control (交互与控制)</span></a></li><li><a href="#6-advanced-extensions-进阶与扩展"><span>6. <wbr/>Advanced &amp; <wbr/>Extensions (进阶与扩展)</span></a></li><li><a href="#7-meta-support-其他"><span>7. <wbr/>Meta &amp; <wbr/>Support (其他)</span></a></li></ul></li><li><a href="#terminology-summary"><span>Terminology <wbr/>Summary</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>
259
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-sdk-documentation"><span>Five <wbr/>SDK <wbr/>Documentation</span></a><ul><li><a href="#context-for-ai-agents"><span>Context for <wbr/>AI <wbr/>Agents</span></a></li><li><ul><li><a href="#1-documentation-maintenance-文档维护"><span>1. <wbr/>Documentation <wbr/>Maintenance (文档维护)</span></a></li><li><a href="#2-application-development-strategy-应用开发建议"><span>2. <wbr/>Application <wbr/>Development <wbr/>Strategy (应用开发建议)</span></a></li><li><a href="#3-general-retrieval-通用检索"><span>3. <wbr/>General <wbr/>Retrieval (通用检索)</span></a></li></ul></li><li><a href="#documentation-map"><span>Documentation <wbr/>Map</span></a></li><li><ul><li><a href="#1-essential-reference-必读速查"><span>1. <wbr/>Essential <wbr/>Reference (必读/速查)</span></a></li><li><a href="#2-core-concepts-核心概念"><span>2. <wbr/>Core <wbr/>Concepts (核心概念)</span></a></li><li><a href="#3-data-resource-数据与资源"><span>3. <wbr/>Data &amp; <wbr/>Resource (数据与资源)</span></a></li><li><a href="#4-rendering-visuals-渲染与视觉"><span>4. <wbr/>Rendering &amp; <wbr/>Visuals (渲染与视觉)</span></a></li><li><a href="#5-interaction-control-交互与控制"><span>5. <wbr/>Interaction &amp; <wbr/>Control (交互与控制)</span></a></li><li><a href="#6-advanced-extensions-进阶与扩展"><span>6. <wbr/>Advanced &amp; <wbr/>Extensions (进阶与扩展)</span></a></li><li><a href="#7-meta-support-其他"><span>7. <wbr/>Meta &amp; <wbr/>Support (其他)</span></a></li></ul></li><li><a href="#common-scenarios-场景-→-文档速查"><span>Common <wbr/>Scenarios (场景 → 文档速查)</span></a></li><li><a href="#terminology-summary"><span>Terminology <wbr/>Summary</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>