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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (762) hide show
  1. package/AGENTS_READ_ME.md +6 -1
  2. package/AI_CONTEXT.md +6 -1
  3. package/README.md +10 -6
  4. package/ai_guides/README.md +40 -2
  5. package/ai_guides/ai-doc-guidelines.md +31 -1
  6. package/ai_guides/api.md +107 -13
  7. package/ai_guides/features/3dtile.md +49 -141
  8. package/ai_guides/features/camera-animation.md +42 -4
  9. package/ai_guides/features/clipper.md +4 -2
  10. package/ai_guides/features/{coordnate-system.md → coordinate-system.md} +22 -2
  11. package/ai_guides/features/event.md +108 -10
  12. package/ai_guides/features/five.md +20 -16
  13. package/ai_guides/features/flowing-light-2d-pass.md +442 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +425 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/ai_guides/features/gesture.md +4 -1
  17. package/ai_guides/features/get-screen-pixels.md +4 -2
  18. package/ai_guides/features/image-options.md +5 -2
  19. package/ai_guides/features/load-external-model.md +27 -2
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +159 -0
  22. package/ai_guides/features/mode.md +5 -1
  23. package/ai_guides/features/model.md +5 -2
  24. package/ai_guides/features/move-pano-effect.md +3 -1
  25. package/ai_guides/features/multi-work.md +3 -1
  26. package/ai_guides/features/pano-filter.md +149 -0
  27. package/ai_guides/features/pano-tile.md +8 -15
  28. package/ai_guides/features/pano-uv.md +131 -0
  29. package/ai_guides/features/parameter.md +117 -118
  30. package/ai_guides/features/plugin.md +210 -0
  31. package/ai_guides/features/postprocessing.md +40 -5
  32. package/ai_guides/features/raycast.md +16 -2
  33. package/ai_guides/features/request-proxy.md +3 -1
  34. package/ai_guides/features/screen-project.md +4 -1
  35. package/ai_guides/features/state.md +25 -3
  36. package/ai_guides/features/view-layer.md +187 -0
  37. package/ai_guides/features/work.md +64 -3
  38. package/ai_guides/glossary.md +28 -7
  39. package/ai_guides/intro.md +1 -1
  40. package/ai_guides/quick-start.md +1 -0
  41. package/ai_guides/release_notes/6.8.md +222 -0
  42. package/ai_guides/template.md +28 -3
  43. package/docs/00_FOR_AI_AGENTS.md +3 -2
  44. package/docs/README.md +3 -2
  45. package/docs/assets/hierarchy.js +1 -1
  46. package/docs/assets/main.js +1 -1
  47. package/docs/assets/navigation.js +1 -1
  48. package/docs/assets/search.js +1 -1
  49. package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
  50. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  51. package/docs/classes/five.BoundingMesh.html +2 -2
  52. package/docs/classes/five.Camera.html +3 -3
  53. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  54. package/docs/classes/five.Five.html +77 -76
  55. package/docs/classes/five.FivePass.html +1 -1
  56. package/docs/classes/five.Histogram.html +19 -0
  57. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  58. package/docs/classes/five.Model.html +32 -32
  59. package/docs/classes/five.ModelScene.html +1 -1
  60. package/docs/classes/five.NetworkSubscribe.html +5 -5
  61. package/docs/classes/five.PBMContainer.html +1 -1
  62. package/docs/classes/five.PBMCustomShader.html +42 -3
  63. package/docs/classes/five.PBMGSObject.html +5 -3
  64. package/docs/classes/five.PBMGroup.html +1 -1
  65. package/docs/classes/five.PBMMesh.html +1 -1
  66. package/docs/classes/five.PBMMeshMaterial.html +16 -7
  67. package/docs/classes/five.PBMPanoFilter.html +61 -0
  68. package/docs/classes/five.PBMPointCloud.html +1 -1
  69. package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
  70. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  71. package/docs/classes/five.PBMUpdateable.html +41 -0
  72. package/docs/classes/five.PanoCircleMesh.html +1 -1
  73. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  74. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  75. package/docs/classes/five.Parameter.html +59 -55
  76. package/docs/classes/five.Scene.html +1 -1
  77. package/docs/classes/five.Subscribe.html +5 -5
  78. package/docs/classes/five.Tile.html +1 -1
  79. package/docs/classes/five.Tile3D.html +30 -26
  80. package/docs/classes/five.TileNode.html +1 -1
  81. package/docs/classes/five.Tileset.html +3 -2
  82. package/docs/classes/five.Trajectory.html +1 -1
  83. package/docs/classes/five.TrajectoryNode.html +1 -1
  84. package/docs/classes/five.Work.html +16 -16
  85. package/docs/classes/five.WorkResolvedObserver.html +41 -16
  86. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  87. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  88. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  89. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  90. package/docs/classes/gltf-loader.GLTFParser.html +1 -1
  91. package/docs/classes/gltf-loader.THREEGLTFLoader.html +2 -2
  92. package/docs/classes/line.Line.html +1 -1
  93. package/docs/classes/line.LineGeometry.html +1 -1
  94. package/docs/classes/line.LineMaterial.html +1 -1
  95. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  96. package/docs/classes/line.THREE_Line2.html +1 -1
  97. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  98. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  99. package/docs/classes/plugins.CSS3DObject.html +7 -0
  100. package/docs/classes/plugins.CSS3DSprite.html +7 -0
  101. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  102. package/docs/classes/sticker.Sticker.html +1 -1
  103. package/docs/classes/vfx.Airflow.html +1 -1
  104. package/docs/classes/vfx.Flame.html +1 -1
  105. package/docs/classes/vfx.Particle.html +6 -6
  106. package/docs/classes/vfx.ParticleGPU.html +3 -3
  107. package/docs/classes/vfx.SpotLight.html +1 -1
  108. package/docs/documents/README.html +132 -3
  109. package/docs/documents/ai-doc-guidelines.html +48 -3
  110. package/docs/documents/api.html +179 -26
  111. package/docs/documents/features_3dtile.html +143 -46
  112. package/docs/documents/features_camera-animation.html +79 -6
  113. package/docs/documents/features_clipper.html +5 -2
  114. package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +56 -4
  115. package/docs/documents/features_event.html +47 -8
  116. package/docs/documents/features_five.html +20 -16
  117. package/docs/documents/features_flowing-light-2d-pass.html +259 -0
  118. package/docs/documents/features_flowing-light-3d-pass.html +249 -0
  119. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  120. package/docs/documents/features_gesture.html +5 -1
  121. package/docs/documents/features_get-screen-pixels.html +5 -2
  122. package/docs/documents/features_image-options.html +5 -2
  123. package/docs/documents/features_load-external-model.html +31 -4
  124. package/docs/documents/features_load-progress.html +110 -0
  125. package/docs/documents/features_material.html +341 -0
  126. package/docs/documents/features_mode.html +6 -1
  127. package/docs/documents/features_model.html +6 -2
  128. package/docs/documents/features_move-pano-effect.html +4 -1
  129. package/docs/documents/features_multi-work.html +4 -1
  130. package/docs/documents/features_pano-filter.html +123 -0
  131. package/docs/documents/features_pano-tile.html +35 -20
  132. package/docs/documents/features_pano-uv.html +82 -0
  133. package/docs/documents/features_parameter.html +84 -56
  134. package/docs/documents/features_plugin.html +105 -0
  135. package/docs/documents/features_postprocessing.html +23 -6
  136. package/docs/documents/features_raycast.html +9 -3
  137. package/docs/documents/features_request-proxy.html +4 -1
  138. package/docs/documents/features_screen-project.html +5 -1
  139. package/docs/documents/features_state.html +12 -2
  140. package/docs/documents/features_view-layer.html +158 -0
  141. package/docs/documents/features_work.html +64 -3
  142. package/docs/documents/glossary.html +33 -8
  143. package/docs/documents/intro.html +1 -1
  144. package/docs/documents/quick-start.html +1 -0
  145. package/docs/documents/release_notes_6.8.html +203 -0
  146. package/docs/documents/template.html +54 -4
  147. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  148. package/docs/functions/five.loadAt3d.html +1 -1
  149. package/docs/functions/five.loadB3dm.html +1 -1
  150. package/docs/functions/five.loadDome.html +1 -1
  151. package/docs/functions/five.loadDomez.html +1 -1
  152. package/docs/functions/five.loadFbx.html +1 -1
  153. package/docs/functions/five.loadGltf.html +1 -1
  154. package/docs/functions/five.loadPbm.html +1 -1
  155. package/docs/functions/five.loadPly.html +1 -1
  156. package/docs/functions/five.loadPnts.html +1 -1
  157. package/docs/functions/five.loadSplat.html +1 -1
  158. package/docs/functions/five.loadSpz.html +1 -1
  159. package/docs/functions/five.loadX3p.html +1 -1
  160. package/docs/functions/five.parseWork.html +1 -1
  161. package/docs/functions/plugins.CSS3DPlugin.html +1 -0
  162. package/docs/functions/plugins.GaussianSplattingEntranceAnimationPlugin.html +1 -0
  163. package/docs/functions/react.useFiveCurrentObserver.html +2 -2
  164. package/docs/functions/react.useFiveFloor.html +2 -2
  165. package/docs/functions/react.useFiveProject2d.html +2 -2
  166. package/docs/functions/vue.useFiveCurrentObserver.html +2 -2
  167. package/docs/functions/vue.useFiveFloor.html +2 -2
  168. package/docs/functions/vue.useFiveWorks.html +2 -2
  169. package/docs/hierarchy.html +1 -1
  170. package/docs/index.html +132 -3
  171. package/docs/interfaces/five.AddableObject.html +1 -1
  172. package/docs/interfaces/five.AjaxOptions.html +1 -1
  173. package/docs/interfaces/five.BaseEvent.html +7 -2
  174. package/docs/interfaces/five.BaseExtendableEvent.html +11 -0
  175. package/docs/interfaces/five.EventCallback.html +60 -52
  176. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  177. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
  178. package/docs/interfaces/five.GestureEvent.html +21 -2
  179. package/docs/interfaces/five.GesturePointer.html +20 -0
  180. package/docs/interfaces/five.ImageOptions.html +1 -1
  181. package/docs/interfaces/five.IntersectEvent.html +10 -2
  182. package/docs/interfaces/five.IntersectMesh.html +1 -1
  183. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  184. package/docs/interfaces/five.Intersection.html +4 -3
  185. package/docs/interfaces/five.LooseWorkObserver.html +2 -2
  186. package/docs/interfaces/five.LooseWorkPanorama.html +2 -2
  187. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  188. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +10 -10
  189. package/docs/interfaces/five.ModeChangeEvent.html +9 -2
  190. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  191. package/docs/interfaces/five.ModelEvent.html +7 -2
  192. package/docs/interfaces/five.ModelSceneEvent.html +7 -2
  193. package/docs/interfaces/five.ModelTileEvent.html +13 -0
  194. package/docs/interfaces/five.MovePanoOptions.html +8 -8
  195. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  196. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  197. package/docs/interfaces/five.NetworkOptions.html +1 -1
  198. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  199. package/docs/interfaces/five.NetworkResourceEvent.html +7 -2
  200. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  201. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  202. package/docs/interfaces/five.ObjectEvent.html +7 -2
  203. package/docs/interfaces/five.PBMClipperParameter.html +2 -2
  204. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
  205. package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
  206. package/docs/interfaces/five.PBMMaterial.html +1 -1
  207. package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
  208. package/docs/interfaces/five.PBMPanoDepth.html +5 -5
  209. package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
  210. package/docs/interfaces/five.PBMPanoPicture.html +8 -6
  211. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
  212. package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
  213. package/docs/interfaces/five.PanoCircleMeshInterface.html +2 -2
  214. package/docs/interfaces/five.PanoEvent.html +15 -2
  215. package/docs/interfaces/five.PanoPrepareEvent.html +15 -0
  216. package/docs/interfaces/five.PanoTextureEvent.html +11 -2
  217. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  218. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  219. package/docs/interfaces/five.ParameterMaterialValue.html +42 -38
  220. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  221. package/docs/interfaces/five.ParameterValue.html +56 -52
  222. package/docs/interfaces/five.Pose.html +1 -1
  223. package/docs/interfaces/five.RenderEvent.html +7 -2
  224. package/docs/interfaces/five.ResolvedParameterValue.html +57 -54
  225. package/docs/interfaces/five.RgbaData.html +7 -0
  226. package/docs/interfaces/five.SplatData.html +2 -2
  227. package/docs/interfaces/five.State.html +1 -1
  228. package/docs/interfaces/five.StateEvent.html +9 -2
  229. package/docs/interfaces/five.TextureOptions.html +1 -1
  230. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  231. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
  232. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  233. package/docs/interfaces/five.ViewLayer.html +30 -26
  234. package/docs/interfaces/five.WorkCubeImage.html +3 -2
  235. package/docs/interfaces/five.WorkImage.html +6 -5
  236. package/docs/interfaces/five.WorkInitial.html +8 -8
  237. package/docs/interfaces/five.WorkModel.html +8 -8
  238. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  239. package/docs/interfaces/five.WorkObserver.html +42 -17
  240. package/docs/interfaces/five.WorkObserverJson.html +2 -2
  241. package/docs/interfaces/five.WorkObserverProto.html +26 -0
  242. package/docs/interfaces/five.WorkPanoramaJson.html +2 -2
  243. package/docs/interfaces/five.WorkTile.html +6 -5
  244. package/docs/interfaces/five.WorkVideo.html +4 -4
  245. package/docs/interfaces/five.WorksEvent.html +7 -2
  246. package/docs/interfaces/five.XRControllerEvent.html +10 -2
  247. package/docs/interfaces/five.XRControllerState.html +8 -0
  248. package/docs/interfaces/five.XRGestureEvent.html +13 -2
  249. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  250. package/docs/interfaces/five.XRSessionEvent.html +9 -2
  251. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  252. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  253. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  254. package/docs/interfaces/plugins.CSS3DPluginController.html +50 -0
  255. package/docs/interfaces/plugins.CSS3DPluginType.Config.html +2 -0
  256. package/docs/interfaces/plugins.CSS3DPluginType.CreateCSS3DObjectType.html +10 -0
  257. package/docs/interfaces/plugins.CSS3DPluginType.EventMap.html +10 -0
  258. package/docs/interfaces/plugins.CSS3DPluginType.Params.html +4 -0
  259. package/docs/interfaces/plugins.CSS3DPluginType.State.html +8 -0
  260. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +3 -3
  261. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  262. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  263. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationController.html +44 -0
  264. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.BoundingAABB2D.html +3 -0
  265. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Config.html +8 -0
  266. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.EventMap.html +10 -0
  267. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Keyframe.html +3 -0
  268. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.State.html +8 -0
  269. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  270. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  271. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +2 -2
  272. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  273. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  274. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  275. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  276. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  277. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  278. package/docs/interfaces/plugins.PlayingState.html +2 -2
  279. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  280. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  281. package/docs/interfaces/plugins.TrajectoryController.html +8 -8
  282. package/docs/interfaces/react.FiveInjectionTypes.html +21 -21
  283. package/docs/interfaces/sticker.IntersectionLike.html +2 -2
  284. package/docs/interfaces/vfx.ParticleArgs.html +4 -4
  285. package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
  286. package/docs/modules/five.html +1 -1
  287. package/docs/modules/plugins.CSS3DPluginType.html +1 -0
  288. package/docs/modules/plugins.GaussianSplattingEntranceAnimationPluginType.html +1 -0
  289. package/docs/modules/plugins.html +1 -1
  290. package/docs/modules.html +1 -1
  291. package/docs/types/five.ControllerEventTypes.html +30 -26
  292. package/docs/types/five.EasingFunction.html +1 -0
  293. package/docs/types/five.EventTypes.html +27 -25
  294. package/docs/types/five.LegacyEventType.html +7 -7
  295. package/docs/types/five.NetworkProgressCallback.html +1 -1
  296. package/docs/types/five.PBMAlphaMode.html +1 -1
  297. package/docs/types/five.PBMColorStyle.html +1 -1
  298. package/docs/types/five.PBMFloorStyle.html +1 -1
  299. package/docs/types/five.PBMMeshShaderType.html +1 -1
  300. package/docs/types/five.PBMPointBack.html +1 -1
  301. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  302. package/docs/types/five.PBMPointShape.html +1 -1
  303. package/docs/types/five.PBMPointSize.html +1 -1
  304. package/docs/types/five.PBMTransition.html +1 -1
  305. package/docs/types/five.ParseOptions.html +6 -6
  306. package/docs/types/five.Works.html +1 -1
  307. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  308. package/docs/types/plugins.CSS3DPluginType.PluginData.html +1 -0
  309. package/docs/types/plugins.CSS3DPluginType.ServerData.html +1 -0
  310. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  311. package/five/application/analysis.d.ts +40 -0
  312. package/five/application/controllers.d.ts +41 -0
  313. package/five/application/events-legacy.d.ts +454 -0
  314. package/five/application/events.d.ts +69 -0
  315. package/five/application/five.d.ts +519 -0
  316. package/five/application/fiveInitArgs.d.ts +176 -0
  317. package/five/application/fiveLoadOptions.d.ts +21 -0
  318. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  319. package/five/application/getViewportScale.d.ts +2 -0
  320. package/five/application/initLights.d.ts +3 -0
  321. package/five/application/mode.d.ts +28 -0
  322. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  323. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  324. package/five/assets/gradient-png-data-url.d.ts +2 -0
  325. package/five/assets/loading-png-data-url.d.ts +2 -0
  326. package/five/assets/phone-png-data-url.d.ts +2 -0
  327. package/five/assets/realsee-png-data-url.d.ts +2 -0
  328. package/five/bvh/bvhMath.d.ts +33 -0
  329. package/five/bvh/bvhMesh.d.ts +7 -0
  330. package/five/bvh/bvhNode.d.ts +29 -0
  331. package/five/bvh/bvhObject.d.ts +18 -0
  332. package/five/bvh/bvhPoints.d.ts +6 -0
  333. package/five/bvh/index.d.ts +10 -0
  334. package/five/bvh/worker.d.ts +35 -0
  335. package/five/cardboard/helper.d.ts +2 -0
  336. package/five/cardboard/index.d.ts +13 -0
  337. package/five/cardboard/sensor.d.ts +158 -0
  338. package/five/certificates/hardware.d.ts +1 -0
  339. package/five/controllers/base.d.ts +167 -0
  340. package/five/controllers/events.d.ts +73 -0
  341. package/five/controllers/floorplan.d.ts +119 -0
  342. package/five/controllers/mapview.d.ts +139 -0
  343. package/five/controllers/model.d.ts +57 -0
  344. package/five/controllers/panorama.d.ts +144 -0
  345. package/five/controllers/panoramaLike.d.ts +87 -0
  346. package/five/controllers/topview.d.ts +42 -0
  347. package/five/controllers/vrPanorama.d.ts +56 -0
  348. package/five/controllers/xrPanorama.d.ts +81 -0
  349. package/five/core/camera.d.ts +65 -0
  350. package/five/core/internalWebGLRenderer.d.ts +14 -0
  351. package/five/core/panoVideo.d.ts +18 -0
  352. package/five/core/scene.d.ts +10 -0
  353. package/five/core/tiling.d.ts +43 -0
  354. package/five/declare.d.ts +2 -1
  355. package/five/gaussian-splatting/util/renderData.d.ts +66 -0
  356. package/five/gaussian-splatting/wasm/data.d.ts +20 -0
  357. package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
  358. package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
  359. package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
  360. package/five/index.d.ts +60 -4636
  361. package/five/index.js +272 -392
  362. package/five/index.mjs +26890 -31013
  363. package/five/meshes/boundingMesh.d.ts +13 -0
  364. package/five/meshes/intersectMesh.d.ts +8 -0
  365. package/five/meshes/panoCircleMesh.d.ts +35 -0
  366. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  367. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  368. package/five/meshes/panoSphereMesh.d.ts +27 -0
  369. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  370. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  371. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  372. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  373. package/five/model/index.d.ts +70 -0
  374. package/five/model/intersection.d.ts +18 -0
  375. package/five/model/loaders/at3d.d.ts +12 -0
  376. package/five/model/loaders/b3dm.d.ts +9 -0
  377. package/five/model/loaders/dome.d.ts +22 -0
  378. package/five/model/loaders/domez.d.ts +11 -0
  379. package/five/model/loaders/fbx.d.ts +8 -0
  380. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  381. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  382. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  383. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  384. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  385. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  386. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +26 -0
  387. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +11 -0
  388. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
  389. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  390. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  391. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  392. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  393. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  394. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  395. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  396. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  397. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  398. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  399. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +25 -0
  400. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  401. package/five/model/loaders/glTF-helpers/index.d.ts +51 -0
  402. package/five/model/loaders/glTF-helpers/parser.d.ts +115 -0
  403. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  404. package/five/model/loaders/gltf.d.ts +10 -0
  405. package/five/model/loaders/obj.d.ts +9 -0
  406. package/five/model/loaders/pbm.d.ts +26 -0
  407. package/five/model/loaders/ply.d.ts +24 -0
  408. package/five/model/loaders/pnts.d.ts +8 -0
  409. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  410. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  411. package/five/model/loaders/shared.d.ts +16 -0
  412. package/five/model/loaders/splat.d.ts +8 -0
  413. package/five/model/loaders/spz.d.ts +14 -0
  414. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  415. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  416. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  417. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  418. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  419. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  420. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  421. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  422. package/five/model/loaders/x3p.d.ts +22 -0
  423. package/five/model/materials/pbmMaterial.d.ts +137 -0
  424. package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
  425. package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -0
  426. package/five/model/model-scene.d.ts +172 -0
  427. package/five/model/model.d.ts +209 -0
  428. package/five/model/objects/pbmContainer.d.ts +28 -0
  429. package/five/model/objects/pbmGaussianSplattingObject.d.ts +43 -0
  430. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +59 -0
  431. package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
  432. package/five/model/objects/pbmGroup.d.ts +8 -0
  433. package/five/model/objects/pbmMesh.d.ts +10 -0
  434. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  435. package/five/model/parameter.d.ts +141 -0
  436. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  437. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  438. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  439. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  440. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  441. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  442. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  443. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  444. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  445. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  446. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  447. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  448. package/five/model/tile3d/header.d.ts +88 -0
  449. package/five/model/tile3d/index.d.ts +216 -0
  450. package/five/model/tile3d/tile-cache.d.ts +18 -0
  451. package/five/model/tile3d/tile-content.d.ts +10 -0
  452. package/five/model/tile3d/tile-node.d.ts +24 -0
  453. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  454. package/five/model/tile3d/tile.d.ts +79 -0
  455. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  456. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  457. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  458. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  459. package/five/model/tile3d/tileset.d.ts +70 -0
  460. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  461. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  462. package/five/model/tile3d/trajectory.d.ts +30 -0
  463. package/five/model/tile3d/types.d.ts +33 -0
  464. package/five/model/view-layer.d.ts +20 -0
  465. package/five/renderer/five-renderer.d.ts +17 -0
  466. package/five/renderer/index.d.ts +3 -0
  467. package/five/renderer/postprocessing/composer.d.ts +37 -0
  468. package/five/renderer/postprocessing/index.d.ts +7 -0
  469. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +17 -0
  470. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  471. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  472. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  473. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  474. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  475. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  476. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  477. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  478. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  479. package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
  480. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  481. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  482. package/five/texture/histogram.d.ts +54 -0
  483. package/five/texture/imageBitmap.d.ts +13 -0
  484. package/five/texture/initTexture.d.ts +3 -0
  485. package/five/texture/loader.d.ts +39 -0
  486. package/five/texture/textureData.d.ts +11 -0
  487. package/five/thirdparty/fflate.d.ts +1407 -0
  488. package/five/thirdparty/hammer.d.ts +375 -0
  489. package/five/thirdparty/jsrsasign.d.ts +753 -0
  490. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  491. package/five/three-version-check.d.ts +1 -0
  492. package/five/types/addableObject.d.ts +12 -0
  493. package/five/types/cube.d.ts +1 -0
  494. package/five/types/gestureInput.d.ts +24 -0
  495. package/five/types/imageOptions.d.ts +20 -0
  496. package/five/types/intersectMeshInterface.d.ts +8 -0
  497. package/five/types/movePanoEffect.d.ts +13 -0
  498. package/five/types/movePanoOptions.d.ts +36 -0
  499. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  500. package/five/types/plugin.d.ts +25 -0
  501. package/five/types/pose.d.ts +17 -0
  502. package/five/types/state.d.ts +20 -0
  503. package/five/types/viewport.d.ts +22 -0
  504. package/five/utils/ajax.d.ts +66 -0
  505. package/five/utils/animationFrameLoop.d.ts +45 -0
  506. package/five/utils/array.d.ts +31 -0
  507. package/five/utils/asyncTaskQueue.d.ts +8 -0
  508. package/five/utils/bufferGeometry.d.ts +33 -0
  509. package/five/utils/calculateProgress.d.ts +39 -0
  510. package/five/utils/calculateThreeMouse.d.ts +13 -0
  511. package/five/utils/canplayVideo.d.ts +2 -0
  512. package/five/utils/clamp.d.ts +2 -0
  513. package/five/utils/clock.d.ts +17 -0
  514. package/five/utils/createSymbol.d.ts +5 -0
  515. package/five/utils/decodeText.d.ts +2 -0
  516. package/five/utils/deepEqual.d.ts +2 -0
  517. package/five/utils/deepFreeze.d.ts +2 -0
  518. package/five/utils/defineProperty.d.ts +9 -0
  519. package/five/utils/detector.d.ts +14 -0
  520. package/five/utils/distance.d.ts +10 -0
  521. package/five/utils/draco.d.ts +26 -0
  522. package/five/utils/easing.d.ts +63 -0
  523. package/five/utils/error.d.ts +1 -0
  524. package/five/utils/event.d.ts +210 -0
  525. package/five/utils/formatRad.d.ts +7 -0
  526. package/five/utils/imageSupport.d.ts +6 -0
  527. package/five/utils/imageURL.d.ts +42 -0
  528. package/five/utils/isEmptyObject.d.ts +2 -0
  529. package/five/utils/isNil.d.ts +6 -0
  530. package/five/utils/isNumber.d.ts +2 -0
  531. package/five/utils/isPowerOfTwo.d.ts +2 -0
  532. package/five/utils/isPromise.d.ts +2 -0
  533. package/five/utils/isSimilar.d.ts +6 -0
  534. package/five/utils/json.d.ts +7 -0
  535. package/five/utils/ktx2.d.ts +30 -0
  536. package/five/utils/lzma/index.d.ts +2 -0
  537. package/five/utils/lzma/lzma.d.ts +3 -0
  538. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  539. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  540. package/five/utils/memoryUsage.d.ts +29 -0
  541. package/five/utils/motion.d.ts +38 -0
  542. package/five/utils/noop.d.ts +6 -0
  543. package/five/utils/now.d.ts +7 -0
  544. package/five/utils/pano.d.ts +9 -0
  545. package/five/utils/pick.d.ts +3 -0
  546. package/five/utils/poseUtils.d.ts +5 -0
  547. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  548. package/five/utils/renderDepth.d.ts +2 -0
  549. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  550. package/five/utils/requestPermission.d.ts +3 -0
  551. package/five/utils/shaderContentFix.d.ts +7 -0
  552. package/five/utils/shaderMaterial.d.ts +20 -0
  553. package/five/utils/stateUtils.d.ts +5 -0
  554. package/five/utils/string-pattern.d.ts +8 -0
  555. package/five/utils/subscribe.d.ts +67 -0
  556. package/five/utils/tileCube.d.ts +19 -0
  557. package/five/utils/toFastProperties.d.ts +1 -0
  558. package/five/utils/typedCache.d.ts +10 -0
  559. package/five/utils/uniform.d.ts +15 -0
  560. package/five/utils/url.d.ts +35 -0
  561. package/five/utils/uuid.d.ts +5 -0
  562. package/five/utils/values.d.ts +2 -0
  563. package/five/utils/vectorCoordinates.d.ts +29 -0
  564. package/five/utils/volume.d.ts +111 -0
  565. package/five/utils/webglError.d.ts +7 -0
  566. package/five/utils/worker.d.ts +26 -0
  567. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  568. package/five/webxr/motionHelper.d.ts +68 -0
  569. package/five/webxr/xrButton.d.ts +4 -0
  570. package/five/webxr/xrController.d.ts +24 -0
  571. package/five/webxr/xrManager.d.ts +84 -0
  572. package/five/work/_ALLOW_HOST.d.ts +2 -0
  573. package/five/work/index.d.ts +7 -0
  574. package/five/work/keychain.d.ts +5 -0
  575. package/five/work/looseWorkType.d.ts +121 -0
  576. package/five/work/verify.d.ts +7 -0
  577. package/five/work/work.d.ts +206 -0
  578. package/five/work/workFetcher.d.ts +4 -0
  579. package/five/work/workJson.d.ts +3 -0
  580. package/five/work/workJsonType.d.ts +73 -0
  581. package/five/work/workObserverProto.d.ts +39 -0
  582. package/five/work/workParser.d.ts +6 -0
  583. package/five/work/workResolvedObserver.d.ts +12 -0
  584. package/five/work/workVerify.d.ts +2 -0
  585. package/five/work/works.d.ts +10 -0
  586. package/gltf-loader/gltf-object.d.ts +17 -0
  587. package/gltf-loader/index.d.ts +60 -160
  588. package/gltf-loader/index.js +9 -9
  589. package/gltf-loader/index.mjs +1351 -1451
  590. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  591. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  592. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  593. package/line/circle_png.d.ts +1 -0
  594. package/line/index.d.ts +19 -69
  595. package/line/index.js +4 -4
  596. package/line/index.mjs +334 -513
  597. package/line/utils/Line2.d.ts +7 -0
  598. package/line/utils/LineGeometry.d.ts +10 -0
  599. package/line/utils/LineMaterial.d.ts +20 -0
  600. package/line/utils/LineSegments2.d.ts +11 -0
  601. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  602. package/llms.txt +48 -3
  603. package/package.json +4 -4
  604. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  605. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  606. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  607. package/plugins/BasePlugin/index.d.ts +119 -0
  608. package/plugins/CSS3DPlugin/Controller.d.ts +60 -0
  609. package/plugins/CSS3DPlugin/index.d.ts +5 -0
  610. package/plugins/CSS3DPlugin/typing.d.ts +32 -0
  611. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  612. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  613. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  614. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  615. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  616. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  617. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  618. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  619. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  620. package/plugins/GaussianSplattingEntranceAnimationPlugin/Controller.d.ts +30 -0
  621. package/plugins/GaussianSplattingEntranceAnimationPlugin/index.d.ts +5 -0
  622. package/plugins/GaussianSplattingEntranceAnimationPlugin/typing.d.ts +28 -0
  623. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  624. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  625. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  626. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  627. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  628. package/plugins/OrientationPlugin/index.d.ts +6 -0
  629. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  630. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  631. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  632. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  633. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  634. package/plugins/PluginTemplate/index.d.ts +5 -0
  635. package/plugins/PluginTemplate/typing.d.ts +21 -0
  636. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  637. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  638. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  639. package/plugins/index.d.ts +11 -1102
  640. package/plugins/index.js +37 -21
  641. package/plugins/index.mjs +3630 -4247
  642. package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
  643. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  644. package/plugins/utils/absoluteUrl.d.ts +5 -0
  645. package/plugins/utils/clamp.d.ts +2 -0
  646. package/plugins/utils/loadImage.d.ts +1 -0
  647. package/plugins/utils/motion.d.ts +38 -0
  648. package/plugins/utils/now.d.ts +6 -0
  649. package/plugins/utils/uuid.d.ts +2 -0
  650. package/react/canvas.d.ts +19 -0
  651. package/react/context.d.ts +12 -0
  652. package/react/createProvider.d.ts +95 -0
  653. package/react/createStore.d.ts +144 -0
  654. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  655. package/react/hooks/useFiveAction.d.ts +147 -0
  656. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  657. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  658. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  659. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  660. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  661. package/react/hooks/useFiveFloor.d.ts +15 -0
  662. package/react/hooks/useFiveHelper.d.ts +14 -0
  663. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  664. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  665. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  666. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  667. package/react/hooks/useFiveProject2d.d.ts +20 -0
  668. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  669. package/react/hooks/useFiveState.d.ts +6 -0
  670. package/react/hooks/useFiveWork.d.ts +29 -0
  671. package/react/index.d.ts +24 -830
  672. package/react/index.js +3 -3
  673. package/react/index.mjs +572 -783
  674. package/react/rendererPool.d.ts +7 -0
  675. package/react/withFive.d.ts +213 -0
  676. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  677. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  678. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  679. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  680. package/shader-lib/ShineModel/index.d.ts +7 -0
  681. package/shader-lib/SweepModel/index.d.ts +7 -0
  682. package/shader-lib/index.d.ts +5 -86
  683. package/shader-lib/index.js +13 -14
  684. package/shader-lib/index.mjs +424 -824
  685. package/sticker/geometry.d.ts +3 -0
  686. package/sticker/index.d.ts +68 -71
  687. package/sticker/index.js +3 -3
  688. package/sticker/index.mjs +102 -142
  689. package/umd/five-gltf-loader.js +9 -9
  690. package/umd/five-line.js +4 -4
  691. package/umd/five-plugins.js +37 -21
  692. package/umd/five-react.js +3 -3
  693. package/umd/five-shader-lib.js +13 -14
  694. package/umd/five-sticker.js +3 -3
  695. package/umd/five-vfx.js +21 -21
  696. package/umd/five-vue.js +3 -3
  697. package/umd/five.js +267 -387
  698. package/vfx/airflow/airflow.d.ts +18 -0
  699. package/vfx/airflow/fragment-shader.d.ts +2 -0
  700. package/vfx/airflow/vertex-shader.d.ts +2 -0
  701. package/vfx/common/scale-shader.d.ts +2 -0
  702. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  703. package/vfx/frame/fragment-shader.d.ts +2 -0
  704. package/vfx/frame/frame.d.ts +22 -0
  705. package/vfx/frame/vertex-shader.d.ts +2 -0
  706. package/vfx/index.d.ts +7 -363
  707. package/vfx/index.js +21 -21
  708. package/vfx/index.mjs +454 -910
  709. package/vfx/particle/fragment-shader.d.ts +2 -0
  710. package/vfx/particle/instance.d.ts +36 -0
  711. package/vfx/particle/particle.d.ts +205 -0
  712. package/vfx/particle/utils.d.ts +11 -0
  713. package/vfx/particle/vertex-shader.d.ts +2 -0
  714. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  715. package/vfx/particle-gpu/instance.d.ts +36 -0
  716. package/vfx/particle-gpu/particle.d.ts +95 -0
  717. package/vfx/particle-gpu/utils.d.ts +11 -0
  718. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  719. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  720. package/vfx/spotLight/spotLight.d.ts +15 -0
  721. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  722. package/vue/context.d.ts +7 -0
  723. package/vue/hooks/FiveCanvas.d.ts +36 -0
  724. package/vue/hooks/FiveProvider.d.ts +35 -0
  725. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  726. package/vue/hooks/useFiveAction.d.ts +178 -0
  727. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  728. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  729. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  730. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  731. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  732. package/vue/hooks/useFiveFloor.d.ts +16 -0
  733. package/vue/hooks/useFiveHelper.d.ts +15 -0
  734. package/vue/hooks/useFiveModel.d.ts +7 -0
  735. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  736. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  737. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  738. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  739. package/vue/hooks/useFiveScene.d.ts +6 -0
  740. package/vue/hooks/useFiveState.d.ts +16 -0
  741. package/vue/hooks/useFiveWork.d.ts +30 -0
  742. package/vue/index.d.ts +23 -467
  743. package/vue/index.js +3 -3
  744. package/vue/index.mjs +309 -301
  745. package/vue/rendererPool.d.ts +10 -0
  746. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  747. package/work-downloader/components/model.d.ts +3 -0
  748. package/work-downloader/components/observer.d.ts +7 -0
  749. package/work-downloader/download.d.ts +16 -0
  750. package/work-downloader/index.d.ts +2 -33
  751. package/work-downloader/index.js +3 -3
  752. package/work-downloader/index.mjs +317 -556
  753. package/work-downloader/type.d.ts +28 -0
  754. package/work-downloader/utils/download-to-file.d.ts +1 -0
  755. package/work-downloader/utils/image-processing.d.ts +7 -0
  756. package/work-downloader/utils/join-url.d.ts +2 -0
  757. package/work-downloader/utils/log.d.ts +1 -0
  758. package/work-downloader/utils/relative-url.d.ts +1 -0
  759. package/ai_guides/plugin.md +0 -206
  760. package/docs/documents/plugin.html +0 -60
  761. package/docs/media/five.ts +0 -2881
  762. package/docs/media/pass.ts +0 -64
@@ -0,0 +1,7 @@
1
+ import { LineGeometry } from "./LineGeometry";
2
+ import { LineMaterial } from "./LineMaterial";
3
+ import { LineSegments2 } from "./LineSegments2";
4
+ declare class Line2 extends LineSegments2 {
5
+ constructor(geometry: LineGeometry, material: LineMaterial);
6
+ }
7
+ export { Line2 };
@@ -0,0 +1,10 @@
1
+ import * as THREE from "three";
2
+ import { LineSegmentsGeometry } from "./LineSegmentsGeometry";
3
+ declare class LineGeometry extends LineSegmentsGeometry {
4
+ constructor();
5
+ setPositions(array: ArrayLike<number>): this;
6
+ setColors(array: ArrayLike<number>): this;
7
+ fromLine(line: THREE.Line): this;
8
+ copy(): this;
9
+ }
10
+ export { LineGeometry };
@@ -0,0 +1,20 @@
1
+ import * as THREE from "three";
2
+ type LineMaterialParameters = {
3
+ color?: number | THREE.Vector3;
4
+ linewidth?: number;
5
+ dashed?: boolean;
6
+ dashScale?: number;
7
+ dashSize?: number;
8
+ gapSize?: number;
9
+ resolution?: THREE.Vector2;
10
+ };
11
+ declare class LineMaterial extends THREE.ShaderMaterial {
12
+ color: number | THREE.Vector3;
13
+ dashed: boolean;
14
+ dashScale: number;
15
+ dashSize: number;
16
+ gapSize: number;
17
+ resolution: THREE.Vector2;
18
+ constructor(parameters: LineMaterialParameters);
19
+ }
20
+ export { LineMaterial, LineMaterialParameters };
@@ -0,0 +1,11 @@
1
+ import * as THREE from 'three';
2
+ import { LineSegmentsGeometry } from './LineSegmentsGeometry';
3
+ import { LineMaterial } from './LineMaterial';
4
+ declare class LineSegments2 extends THREE.Mesh<LineSegmentsGeometry, LineMaterial> {
5
+ constructor(geometry: LineSegmentsGeometry, material: LineMaterial);
6
+ computeLineDistances(): this;
7
+ raycast(raycaster: THREE.Raycaster, intersects: (THREE.Intersection & {
8
+ pointOnLine: THREE.Vector3;
9
+ })[]): void;
10
+ }
11
+ export { LineSegments2 };
@@ -0,0 +1,15 @@
1
+ import * as THREE from "three";
2
+ declare class LineSegmentsGeometry extends THREE.InstancedBufferGeometry {
3
+ constructor();
4
+ applyMatrix4(matrix: THREE.Matrix4): this;
5
+ setPositions(array: ArrayLike<number> | number[]): this;
6
+ setColors(array: Float32Array | number[]): this;
7
+ fromWireframeGeometry(geometry: THREE.WireframeGeometry): this;
8
+ fromEdgesGeometry(geometry: THREE.EdgesGeometry): this;
9
+ fromMesh(mesh: THREE.Mesh): this;
10
+ fromLineSegments(lineSegments: THREE.LineSegments): this;
11
+ computeBoundingBox(): void;
12
+ computeBoundingSphere(): void;
13
+ toJSON(): void;
14
+ }
15
+ export { LineSegmentsGeometry };
package/llms.txt CHANGED
@@ -4,10 +4,17 @@
4
4
 
5
5
  ** Documentation for @realsee/five is located in the `ai_guides/` directory. Do NOT use docs/ **
6
6
 
7
+ > **Quick Lookup:** For API signatures, go directly to **[ai_guides/api.md](ai_guides/api.md)**. For terminology, see **[ai_guides/glossary.md](ai_guides/glossary.md)**.
8
+
9
+ > **Keyword Search Tip:** Each doc in `ai_guides/features/` has a `tags` 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.
10
+
11
+ > **Full Documentation Map:** For a categorized index with development strategies and architecture guidance, see **[ai_guides/README.md](ai_guides/README.md)**.
12
+
7
13
  ## Context & Guidelines
8
14
 
9
- * **[AI Documentation Guidelines](ai_guides/ai-doc-guidelines.md)**: RULES for writing and updating documentation. READ THIS FIRST before making changes.
15
+ * **[AI Documentation Guidelines](ai_guides/ai-doc-guidelines.md)**: RULES for writing and updating documentation. **Only read this when maintaining or writing docs, NOT when developing applications.**
10
16
  * **[Intro](ai_guides/intro.md)**: High-level overview of Five SDK capabilities.
17
+ * **[Glossary](ai_guides/glossary.md)**: Terminology definitions — READ THIS to understand core concepts (Observer, Pose, Mode, Work, PanoIndex, etc.) before writing code.
11
18
 
12
19
  ## Development Strategies
13
20
 
@@ -16,8 +23,10 @@
16
23
  * **[Parameter](ai_guides/features/parameter.md)**: Configuration for `new Five(config)`.
17
24
 
18
25
  ### Data Handling
26
+ * **[Panorama UV](ai_guides/features/pano-uv.md)**: 全景图 UV 与空间方向转换工具
19
27
  * **[Work](ai_guides/features/work.md)**: Understanding the core data structure (VR data).
20
28
  * **[Load External Model](ai_guides/features/load-external-model.md)**: Loading GLTF/OBJ/etc.
29
+ * **[Load Progress](ai_guides/features/load-progress.md)**: Monitoring loading status (Loaded vs Refined).
21
30
  * **[Multi-Work](ai_guides/features/multi-work.md)**: Handling multiple works (Sandbox mode).
22
31
  * **[Request Proxy](ai_guides/features/request-proxy.md)**: Intercepting/modifying requests (Auth/CDN).
23
32
  * **[Image Options](ai_guides/features/image-options.md)**: Configuring image resources.
@@ -26,7 +35,7 @@
26
35
  * **[State](ai_guides/features/state.md)**: CRITICAL for saving/restoring scenes (Pose, Mode, PanoIndex).
27
36
  * **[Five](ai_guides/features/five.md)**: The main renderer class.
28
37
  * **[Mode](ai_guides/features/mode.md)**: Viewing modes (Panorama, Model, Floorplan, etc.).
29
- * **[Coordinate System](ai_guides/features/coordnate-system.md)**: Coordinate system definitions.
38
+ * **[Coordinate System](ai_guides/features/coordinate-system.md)**: Coordinate system definitions.
30
39
 
31
40
  ### Interaction & Animation
32
41
  * **[Event](ai_guides/features/event.md)**: Tap, Gesture, and StateChange events.
@@ -38,8 +47,13 @@
38
47
 
39
48
  ### Rendering & Visuals
40
49
  * **[Pano Tile](ai_guides/features/pano-tile.md)**: Panorama tiling mechanism.
50
+ * **[Pano Filter](ai_guides/features/pano-filter.md)**: Color/Tone adjustments for panoramas.
41
51
  * **[Model](ai_guides/features/model.md)**: Built-in model rendering.
52
+ * **[Material](ai_guides/features/material.md)**: Material parameters (Opacity, PointScale, VertexMarks).
42
53
  * **[Postprocessing](ai_guides/features/postprocessing.md)**: Visual effects.
54
+ * **[Flowing Light 2D Pass](ai_guides/features/flowing-light-2d-pass.md)**: Flowing light screen-space effect with InstancedMesh rendering.
55
+ * **[Flowing Light 3D Pass](ai_guides/features/flowing-light-3d-pass.md)**: Flowing light effect with 3D world-space projection and InstancedMesh rendering.
56
+ * **[Gaussian Blur Pass](ai_guides/features/gaussian-blur-pass.md)**: Gaussian blur post-processing effect.
43
57
  * **[Clipper](ai_guides/features/clipper.md)**: Model clipping.
44
58
  * **[3D Tile](ai_guides/features/3dtile.md)**: Large scene 3D tiles.
45
59
  * **[Get Screen Pixels](ai_guides/features/get-screen-pixels.md)**: Screen capture/magnifier.
@@ -48,9 +62,40 @@
48
62
 
49
63
  * **[API Reference](ai_guides/api.md)**: Comprehensive API signature index.
50
64
  * **[Glossary](ai_guides/glossary.md)**: Terminology definitions (Observer, Pose, etc.).
51
- * **[Plugin](ai_guides/plugin.md)**: Plugin development guide.
65
+ * **[Plugin](ai_guides/features/plugin.md)**: Plugin development guide.
66
+ * **[ViewLayer](ai_guides/features/view-layer.md)**: ViewLayer documentation.
52
67
  * **[Support](ai_guides/support.md)**: Browser compatibility.
53
68
 
69
+ ## Common Scenarios (场景 → 文档速查)
70
+
71
+ > Use the `tags` column for keyword matching when your requirement doesn't exactly match the scenario description.
72
+
73
+ | Scenario | Docs | Tags |
74
+ | :--- | :--- | :--- |
75
+ | 点击拾取物体 / Object picking | [Raycast](ai_guides/features/raycast.md) | click, hit-test, floor-detection, 碰撞检测, 物体选择 |
76
+ | 3D 标签 / HTML overlay on 3D point | [Screen Project](ai_guides/features/screen-project.md) | label, HUD, tooltip, 坐标转换, 3D转2D |
77
+ | 全景滤镜 / 色温调节 / Color correction | [Pano Filter](ai_guides/features/pano-filter.md) | warm, cool, brightness, contrast, saturation, 暖色, 冷色, 饱和度 |
78
+ | 加载外部 GLTF/OBJ/FBX 模型 | [Load External Model](ai_guides/features/load-external-model.md) | gltf, glb, ply, splat, fbx, draco, point-cloud, dispose |
79
+ | 相机巡航 / 自动导览 / Camera fly-through | [Camera Animation](ai_guides/features/camera-animation.md) | rotate, zoom, auto-tour, 运镜, 旋转, 缩放 |
80
+ | 截图 / 放大镜 / Screen capture | [Get Screen Pixels](ai_guides/features/get-screen-pixels.md) | magnifier, screenshot, color-picker, 取色器 |
81
+ | 模型裁切 / 房屋剖面 | [Clipper](ai_guides/features/clipper.md) | clipping-box, section-view, discard, 开盖, 剖面 |
82
+ | 流光特效 / Flowing light effect | [Flowing Light 2D](ai_guides/features/flowing-light-2d-pass.md), [Flowing Light 3D](ai_guides/features/flowing-light-3d-pass.md) | 光带, 导航路径, 动态路径, instanced |
83
+ | 模糊特效 / Blur effect | [Gaussian Blur Pass](ai_guides/features/gaussian-blur-pass.md) | 毛玻璃, 背景虚化, gaussian |
84
+ | 保存/恢复场景状态 | [State](ai_guides/features/state.md) | snapshot, save, restore, 快照, 场景还原 |
85
+ | 多场景切换 / 沙盘 | [Multi-Work](ai_guides/features/multi-work.md) | sandbox, 多户型, 拼接, workCode |
86
+ | 请求鉴权 / CDN 替换 | [Request Proxy](ai_guides/features/request-proxy.md) | authentication, token, url-rewrite, cors, 私有化 |
87
+ | 插件开发 | [Plugin](ai_guides/features/plugin.md) | lifecycle, extension, baseplugin, 状态管理 |
88
+ | 事件监听 / 拦截默认行为 | [Event](ai_guides/features/event.md) | preventDefault, waitUntil, on, off, gesture, 回调 |
89
+ | 手势交互 / 自定义拖拽 | [Gesture](ai_guides/features/gesture.md) | tap, pan, pinch, press, 触摸, 鼠标 |
90
+ | 后处理特效 / 自定义 Shader | [Postprocessing](ai_guides/features/postprocessing.md) | effect-composer, addPass, edl, 描边, 景深 |
91
+ | 材质 / 透明度 / 点云样式 | [Material](ai_guides/features/material.md) | opacity, pointcloud, roof, ceiling, 天花板, 顶点标记 |
92
+ | 模式切换 / 全景↔模型↔户型图 | [Mode](ai_guides/features/mode.md) | panorama, floorplan, mapview, topview, VR |
93
+ | 全景高清瓦片 / 分片加载 | [Pano Tile](ai_guides/features/pano-tile.md) | LOD, tile, 按需加载, 高清全景 |
94
+ | 图片 CDN / 私有化部署 | [Image Options](ai_guides/features/image-options.md) | avif, webp, cdn, private-deployment |
95
+ | 加载进度 / 首屏优化 | [Load Progress](ai_guides/features/load-progress.md) | refined, loaded, loading-bar, 首屏 |
96
+
54
97
  ## Release Notes
98
+ * [6.8](ai_guides/release_notes/6.8.md)
55
99
  * [6.7](ai_guides/release_notes/6.7.md)
56
100
  * [6.6](ai_guides/release_notes/6.6.md)
101
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@realsee/five",
3
- "version": "6.8.0-alpha.3",
3
+ "version": "6.8.0-alpha.30",
4
4
  "description": "Realsee Renderer SDK",
5
5
  "author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
6
6
  "license": "SEE LICENSE IN TERMS.txt",
@@ -21,7 +21,7 @@
21
21
  }
22
22
  },
23
23
  "dependencies": {
24
- "protobufjs": "^7.5.4",
24
+ "protobufjs": "^8.0.0",
25
25
  "sharp": "^0.34.3",
26
26
  "tslib": "^2.8.1"
27
27
  },
@@ -81,8 +81,8 @@
81
81
  },
82
82
  "ai": {
83
83
  "documentation": {
84
- "entry": "./ai_guides/README.md",
85
- "root": "./ai_guides"
84
+ "llms.txt": "./llms.txt",
85
+ "guides": "./ai_guides"
86
86
  },
87
87
  "ignore": [
88
88
  "./docs"
@@ -0,0 +1,20 @@
1
+ import { BasePlugin } from '@realsee/five/plugins';
2
+ import { Five } from '@realsee/five';
3
+ import type { EventMap, Params, PluginData, State } from './typings';
4
+ export declare class Controller extends BasePlugin.Controller<State, EventMap, any, PluginData> {
5
+ protected data: PluginData;
6
+ state: State;
7
+ private gradientBg?;
8
+ private groundBg?;
9
+ private style?;
10
+ readonly pluginName = "BackgroundPlugin";
11
+ constructor(five: Five, params?: Params);
12
+ private _onFiveCameraUpdate;
13
+ private _addEventListener;
14
+ private _removeEventListener;
15
+ load: () => Promise<void>;
16
+ setState: (state: Partial<State>, options?: BasePlugin.BaseOptions) => void;
17
+ enable: () => void;
18
+ disable: (options?: BasePlugin.BaseOptions) => void;
19
+ dispose: () => void;
20
+ }
@@ -0,0 +1,5 @@
1
+ import type { Five } from '@realsee/five';
2
+ import type * as BackgroundPluginType from './typings';
3
+ import { Controller } from './Controller';
4
+ export declare const BackgroundPlugin: (five: Five, params?: BackgroundPluginType.Params) => Controller;
5
+ export type { BackgroundPluginType, Controller as BackgroundPluginController };
@@ -0,0 +1,44 @@
1
+ import type { BasePlugin } from '@realsee/five/plugins';
2
+ export declare enum WarningCodeType {
3
+ Warning_1 = "CAN_NOT_DRAW_ZONE"
4
+ }
5
+ export type Mode = 'Idle' | 'View' | 'Marking' | 'Waiting';
6
+ export type Mirror<T extends string> = Record<T, T>;
7
+ export type State = {
8
+ enabled: boolean;
9
+ };
10
+ export interface PluginDataItem {
11
+ }
12
+ export type PluginData = PluginDataItem;
13
+ export interface Config {
14
+ }
15
+ export interface Params {
16
+ config?: Partial<Config>;
17
+ initialState?: Partial<State>;
18
+ }
19
+ export interface EventMap extends BasePlugin.EventMap<State, PluginData> {
20
+ /**
21
+ * @param event - event.userAction是否是用户操作
22
+ * @description enabled 从 false 到 true 的回调
23
+ */
24
+ enable: (event: {
25
+ userAction: boolean;
26
+ }) => void;
27
+ /**
28
+ * @param event - event.userAction是否是用户操作
29
+ * @description enabled 从 true 到 false 的回调
30
+ */
31
+ disable: (event: {
32
+ userAction: boolean;
33
+ }) => void;
34
+ /**
35
+ * @description 插件 dispose
36
+ * */
37
+ dispose: () => void;
38
+ click: (index: number) => void;
39
+ /**
40
+ * @description 历史堆栈更新
41
+ * @param historyStackLength - 历史堆栈当前数量
42
+ * */
43
+ historyLengthChange: (historyStackLength: number) => void;
44
+ }
@@ -0,0 +1,119 @@
1
+ import { Five, Subscribe } from '@realsee/five';
2
+ export declare namespace BasePlugin {
3
+ /**
4
+ * 基本属性字段
5
+ */
6
+ interface State {
7
+ /**
8
+ * 插件是否启用
9
+ */
10
+ enabled: boolean;
11
+ /**
12
+ * 插件UI是否展示
13
+ */
14
+ visible?: boolean;
15
+ /**
16
+ * 插件的配置项
17
+ */
18
+ config?: unknown;
19
+ }
20
+ interface BaseOptions {
21
+ /** 是否是用户行为 */
22
+ userAction?: boolean;
23
+ }
24
+ interface Config {
25
+ /** 静态资源前缀 */
26
+ staticPrefix?: string;
27
+ /** 国际化转换函数 */
28
+ i18n?: (key: string) => string;
29
+ }
30
+ interface StateChangeParams<PluginState> {
31
+ /** 最新的State */
32
+ state: PluginState;
33
+ /** 上一个State */
34
+ prevState?: PluginState;
35
+ /** 是否是用户触发 */
36
+ userAction: boolean;
37
+ }
38
+ /**
39
+ * 插件基本事件
40
+ */
41
+ type EventMap<PluginState, PluginData> = {
42
+ /** 插件被销毁 */
43
+ dispose: () => void;
44
+ /** 插件状态变化 */
45
+ stateChange: (params: StateChangeParams<PluginState>) => void;
46
+ /** 数据变更 */
47
+ dataChange: (data: PluginData, prevData?: PluginData) => void;
48
+ /** 数据加载完成 */
49
+ dataLoaded: (data: PluginData) => void;
50
+ };
51
+ /**
52
+ * plugin 的基本控制器
53
+ */
54
+ abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState, PluginData>, PluginServerData, PluginData> {
55
+ five: Five;
56
+ protected abstract data?: PluginData;
57
+ /**
58
+ * 加载插件依赖数据
59
+ * @param serverData - 插件数据
60
+ * @param state - 插件 State
61
+ */
62
+ abstract load?(serverData: PluginServerData, state?: PluginState, userAction?: boolean): Promise<void>;
63
+ /**
64
+ * @description 插件事件钩子
65
+ */
66
+ hooks: Subscribe<PluginEventMap>;
67
+ readonly staticPrefix: string;
68
+ /**
69
+ * 当前状态
70
+ * @description
71
+ * ```text
72
+ * 可以通过 plugin.state 和 plugin.setState 来获取和设置。
73
+ * 通过 state 设置后,plugin 会通过合适的动画运动来达到设置的效果。
74
+ * 来迎合一些通过数据驱动的场景。
75
+ * ```
76
+ */
77
+ abstract state: PluginState;
78
+ constructor(five: Five, config?: Config);
79
+ /**
80
+ * 获取当前的插件状态,如果当初插件内存在需要通过动画变更的 state 值,则通过此方法可以得到中间状态
81
+ */
82
+ getCurrentState(): PluginState;
83
+ /**
84
+ * 插件自身DOM添加到父容器
85
+ * @param wrapper - Element元素
86
+ */
87
+ appendTo?(wrapper: Element): void;
88
+ /**
89
+ * 展示UI
90
+ */
91
+ show?(options?: BaseOptions): Promise<void> | void;
92
+ /**
93
+ * 隐藏UI
94
+ */
95
+ hide?(options?: BaseOptions): Promise<void> | void;
96
+ /**
97
+ * 设置state
98
+ * @param state - 插件的目标状态
99
+ * @param options - 配置项
100
+ */
101
+ setState?(state: Partial<PluginState>, options?: BaseOptions): void;
102
+ /**
103
+ * @description 获取静态资源的url
104
+ */
105
+ absoluteUrl(url: string): string;
106
+ /**
107
+ * 启用插件,让插件能够响应交互
108
+ */
109
+ abstract enable(options?: BaseOptions): void;
110
+ /**
111
+ * 禁用插件,让插件停止响应交互
112
+ */
113
+ abstract disable(options?: BaseOptions): void;
114
+ /**
115
+ * 插件进行销毁
116
+ */
117
+ abstract dispose(): void;
118
+ }
119
+ }
@@ -0,0 +1,60 @@
1
+ import type { Five } from '@realsee/five';
2
+ import { BasePlugin } from '../BasePlugin';
3
+ import * as THREE from 'three';
4
+ import { CSS3DRenderer, CSS3DObject } from '../thirdParty/CSS3DRenderer.js';
5
+ import type * as PluginType from './typing';
6
+ export declare class Controller extends BasePlugin.Controller<PluginType.State, PluginType.EventMap, PluginType.ServerData, PluginType.PluginData> {
7
+ /** 当前使用的数据 */
8
+ data?: PluginType.PluginData;
9
+ /** 插件当前状态 */
10
+ state: PluginType.State;
11
+ /** CSS3D 渲染器实例 */
12
+ renderer: CSS3DRenderer;
13
+ scene: THREE.Scene;
14
+ styleSheet: CSSStyleSheet;
15
+ camera: THREE.PerspectiveCamera;
16
+ cacheMap: WeakMap<object, any>;
17
+ private resizeObserver?;
18
+ private updateState;
19
+ constructor(five: Five, params?: PluginType.Params);
20
+ load(data: PluginType.ServerData): Promise<void>;
21
+ createCSS3DObject: ({ id, name, innerHTML, sprite, normal, position, scalar, visible, timeout, }: PluginType.CreateCSS3DObjectType) => CSS3DObject;
22
+ render: () => void;
23
+ private _addEventListener;
24
+ private _removeEventListener;
25
+ /**
26
+ * 将插件 DOM 挂载到指定容器
27
+ */
28
+ appendToFiveContainer(): void;
29
+ add(...object: THREE.Object3D[]): void;
30
+ remove(object: THREE.Object3D): void;
31
+ removeAll(): void;
32
+ /**
33
+ * 淡入指定的 CSS3DObject,设置 object.userData.visible = true
34
+ */
35
+ fadeInObjects(...objects: THREE.Object3D[]): void;
36
+ /**
37
+ * 淡出指定的 CSS3DObject,设置 object.userData.visible = false
38
+ */
39
+ fadeOutObjects(...objects: THREE.Object3D[]): void;
40
+ private _enable;
41
+ private _disable;
42
+ /**
43
+ * 启用插件,让插件能够响应交互
44
+ */
45
+ enable(options?: BasePlugin.BaseOptions): void;
46
+ /**
47
+ * 禁用插件,让插件停止响应交互
48
+ */
49
+ disable(options?: BasePlugin.BaseOptions): void;
50
+ /**
51
+ * 显示场景,设置 scene.visible = true
52
+ */
53
+ show(options?: BasePlugin.BaseOptions): void;
54
+ /**
55
+ * 隐藏场景,设置 scene.visible = false
56
+ */
57
+ hide(options?: BasePlugin.BaseOptions): void;
58
+ /** 销毁插件,移除所有副作用 */
59
+ dispose: () => void;
60
+ }
@@ -0,0 +1,5 @@
1
+ import type { Five } from '@realsee/five';
2
+ import type * as CSS3DPluginType from './typing';
3
+ import { Controller } from './Controller';
4
+ export declare const CSS3DPlugin: (five: Five, params?: CSS3DPluginType.Params) => Controller;
5
+ export type { CSS3DPluginType, Controller as CSS3DPluginController };
@@ -0,0 +1,32 @@
1
+ import type { BasePlugin } from '../BasePlugin';
2
+ export type PluginData = any;
3
+ export type ServerData = any;
4
+ export interface CreateCSS3DObjectType {
5
+ id?: string;
6
+ name?: string;
7
+ innerHTML: string;
8
+ sprite?: boolean;
9
+ normal?: THREE.Vector3;
10
+ position?: THREE.Vector3;
11
+ scalar?: number;
12
+ visible?: boolean;
13
+ timeout?: number;
14
+ }
15
+ /** 插件配置 */
16
+ export interface Config {
17
+ }
18
+ /** 插件初始化参数 */
19
+ export interface Params {
20
+ config?: Partial<Config>;
21
+ initialState?: Partial<State>;
22
+ }
23
+ /** 插件状态 */
24
+ export interface State extends BasePlugin.State {
25
+ /** 插件是否启用 */
26
+ enabled: boolean;
27
+ /** 插件整体是否可见 */
28
+ visible: boolean;
29
+ }
30
+ /** 插件事件 */
31
+ export interface EventMap extends BasePlugin.EventMap<State, ServerData> {
32
+ }
@@ -0,0 +1,167 @@
1
+ import type { Five } from '@realsee/five';
2
+ import { BasePlugin } from '@realsee/five/plugins';
3
+ import type * as PluginType from './typing';
4
+ export declare class Controller extends BasePlugin.Controller<PluginType.State, PluginType.EventMap, PluginType.ServerData, PluginType.PluginData> {
5
+ /** 当前使用的数据 */
6
+ data?: PluginType.PluginData;
7
+ /** 插件当前状态 */
8
+ state: PluginType.State;
9
+ /** config 的原始值 */
10
+ private _config;
11
+ get config(): {
12
+ lineCount: number;
13
+ spacing: number;
14
+ lineWidth: number;
15
+ color: number;
16
+ speed: number;
17
+ range: number;
18
+ waveAmp: number;
19
+ waveFreq: number;
20
+ particleCount: number;
21
+ maxDistance: number;
22
+ lineYOffset: number;
23
+ subMeshWidth: number;
24
+ subMeshColor: number;
25
+ subMeshOpacity: number;
26
+ subMeshMaxOpacity: number;
27
+ subMeshSegmentInterval: number;
28
+ subMeshHighlightWidth: number;
29
+ };
30
+ private paths;
31
+ private up;
32
+ private updateState;
33
+ constructor(five: Five, params?: PluginType.Params);
34
+ /**
35
+ * 加载服务端数据
36
+ */
37
+ load(serverData: PluginType.ServerData, state?: PluginType.State): Promise<void>;
38
+ /**
39
+ * 添加路径
40
+ */
41
+ addPath(pathConfig: PluginType.PathConfig): boolean;
42
+ /**
43
+ * 移除路径
44
+ */
45
+ removePath(pathId: string): boolean;
46
+ /**
47
+ * 启用路径
48
+ */
49
+ enablePath(pathId: string): boolean;
50
+ /**
51
+ * 禁用路径
52
+ */
53
+ disablePath(pathId: string): boolean;
54
+ /**
55
+ * 显示路径
56
+ */
57
+ showPath(pathId: string): boolean;
58
+ /**
59
+ * 隐藏路径
60
+ */
61
+ hidePath(pathId: string): boolean;
62
+ /**
63
+ * 获取所有路径ID
64
+ */
65
+ getPathIds(): string[];
66
+ /**
67
+ * 获取路径配置
68
+ */
69
+ getPathConfig(pathId: string): PluginType.PathConfig | undefined;
70
+ /**
71
+ * 清空所有路径
72
+ */
73
+ clearAllPaths(): void;
74
+ private getPositions;
75
+ private createLines;
76
+ private createParticleMaterial;
77
+ private createParticles;
78
+ /**
79
+ * 创建子网格面片的几何体
80
+ */
81
+ private createSubMeshGeometry;
82
+ /**
83
+ * 创建流光的 alpha 贴图
84
+ * @param segmentCount - 分段数(流光数量)
85
+ * @param highlightWidthInMeters - 单个高亮带的物理宽度(单位:米)
86
+ * @param totalLength - 路径总长度(单位:米)
87
+ * @param baseOpacity - 基础透明度(0-1)
88
+ * @param maxOpacity - 最大透明度(0-1)
89
+ * @returns DataTexture
90
+ */
91
+ private createAlphaMapTexture;
92
+ /**
93
+ * 创建子网格面片的材质
94
+ */
95
+ private createSubMeshMaterial;
96
+ /**
97
+ * 将路径点投影到屏幕空间
98
+ */
99
+ private projectPointsToScreen;
100
+ /**
101
+ * 找到最近的屏幕外点
102
+ */
103
+ private findNearestOffscreenPoint;
104
+ /**
105
+ * 找到最远的屏幕外点(从终点反向搜索)
106
+ */
107
+ private findFarestOffscreenPoint;
108
+ private updatePathAnimation;
109
+ /**
110
+ * 启动指定路径的动画
111
+ * @param pathId - 路径ID
112
+ * @param options - 配置选项
113
+ */
114
+ startPathAnimation(pathId: string, options?: {
115
+ startPointIndex?: number;
116
+ fromStart?: boolean;
117
+ }): boolean;
118
+ /**
119
+ * 停止指定路径的动画
120
+ */
121
+ stopPathAnimation(pathId: string, saveProgress?: boolean): boolean;
122
+ private _enable;
123
+ private _disable;
124
+ /**
125
+ * 启用插件
126
+ */
127
+ enable(options?: BasePlugin.BaseOptions): void;
128
+ /**
129
+ * 禁用插件
130
+ */
131
+ disable(options?: BasePlugin.BaseOptions): void;
132
+ /**
133
+ * 显示插件
134
+ */
135
+ show(options?: BasePlugin.BaseOptions): void;
136
+ /**
137
+ * 隐藏插件
138
+ */
139
+ hide(options?: BasePlugin.BaseOptions): void;
140
+ /**
141
+ * 设置状态
142
+ */
143
+ setState(state: Partial<PluginType.State>, options?: BasePlugin.BaseOptions): void;
144
+ /**
145
+ * 播放动画
146
+ */
147
+ play(fromStart?: boolean): void;
148
+ /**
149
+ * 暂停动画
150
+ */
151
+ pause(): void;
152
+ /**
153
+ * 重置动画状态(不自动开始播放)
154
+ */
155
+ reset(): void;
156
+ highlightPath(pathId: string, highlight: boolean): void;
157
+ /**
158
+ * 更新指定路径的屏幕空间投影优化
159
+ * @param pathId - 路径ID,如果不提供则更新所有路径
160
+ */
161
+ updateScreenProjection(pathId?: string): void;
162
+ private disposePathResources;
163
+ /**
164
+ * 销毁插件
165
+ */
166
+ dispose(): void;
167
+ }
@@ -0,0 +1,5 @@
1
+ import type { Five } from '@realsee/five';
2
+ import type * as DynamicPathLinePluginType from './typing';
3
+ import { Controller } from './Controller';
4
+ export declare const DynamicPathLinePlugin: (five: Five, params?: DynamicPathLinePluginType.Params) => Controller;
5
+ export type { DynamicPathLinePluginType, Controller as DynamicPathLinePluginController };
@@ -0,0 +1,7 @@
1
+ import { LineGeometry } from "./LineGeometry";
2
+ import { LineMaterial } from "./LineMaterial";
3
+ import { LineSegments2 } from "./LineSegments2";
4
+ declare class Line2 extends LineSegments2 {
5
+ constructor(geometry: LineGeometry, material: LineMaterial);
6
+ }
7
+ export { Line2 };