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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1138) hide show
  1. package/AGENTS_READ_ME.md +4 -0
  2. package/AI_CONTEXT.md +4 -0
  3. package/README.md +64 -13
  4. package/ai_guides/README.md +122 -0
  5. package/ai_guides/ai-doc-guidelines.md +102 -0
  6. package/ai_guides/api.md +274 -0
  7. package/ai_guides/features/3dtile.md +172 -0
  8. package/ai_guides/features/camera-animation.md +205 -0
  9. package/ai_guides/features/clipper.md +135 -0
  10. package/ai_guides/features/coordinate-system.md +128 -0
  11. package/ai_guides/features/event.md +154 -0
  12. package/ai_guides/features/five.md +184 -0
  13. package/ai_guides/features/flowing-light-2d-pass.md +438 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +420 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/ai_guides/features/gesture.md +180 -0
  17. package/ai_guides/features/get-screen-pixels.md +182 -0
  18. package/ai_guides/features/image-options.md +164 -0
  19. package/ai_guides/features/load-external-model.md +350 -0
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +151 -0
  22. package/ai_guides/features/mode.md +269 -0
  23. package/ai_guides/features/model.md +186 -0
  24. package/ai_guides/features/move-pano-effect.md +145 -0
  25. package/ai_guides/features/multi-work.md +146 -0
  26. package/ai_guides/features/pano-tile.md +132 -0
  27. package/ai_guides/features/pano-uv.md +131 -0
  28. package/ai_guides/features/parameter.md +153 -0
  29. package/ai_guides/features/plugin.md +210 -0
  30. package/ai_guides/features/postprocessing.md +259 -0
  31. package/ai_guides/features/raycast.md +175 -0
  32. package/ai_guides/features/request-proxy.md +112 -0
  33. package/ai_guides/features/screen-project.md +165 -0
  34. package/ai_guides/features/state.md +101 -0
  35. package/ai_guides/features/view-layer.md +187 -0
  36. package/ai_guides/features/work.md +303 -0
  37. package/ai_guides/glossary.md +93 -0
  38. package/ai_guides/intro.md +23 -0
  39. package/ai_guides/quick-start.md +69 -0
  40. package/ai_guides/release_notes/6.6.md +86 -0
  41. package/ai_guides/release_notes/6.7.md +401 -0
  42. package/ai_guides/release_notes/6.8.md +90 -0
  43. package/ai_guides/support.md +23 -0
  44. package/ai_guides/template.md +70 -0
  45. package/docs/00_FOR_AI_AGENTS.md +11 -0
  46. package/docs/README.md +11 -0
  47. package/docs/assets/hierarchy.js +1 -1
  48. package/docs/assets/highlight.css +33 -19
  49. package/docs/assets/navigation.js +1 -1
  50. package/docs/assets/search.js +1 -1
  51. package/docs/classes/five.AdaptiveLuminancePass.html +1 -1
  52. package/docs/classes/five.BoundingMesh.html +1 -1
  53. package/docs/classes/five.Camera.html +1 -1
  54. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  55. package/docs/classes/five.Five.html +75 -81
  56. package/docs/classes/five.FivePass.html +1 -1
  57. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  58. package/docs/classes/five.Model.html +32 -32
  59. package/docs/classes/five.ModelScene.html +1 -1
  60. package/docs/classes/five.NetworkSubscribe.html +2 -2
  61. package/docs/classes/five.PBMContainer.html +1 -1
  62. package/docs/classes/five.PBMGSObject.html +14 -12
  63. package/docs/classes/five.PBMGroup.html +1 -1
  64. package/docs/classes/five.PBMMesh.html +1 -1
  65. package/docs/classes/five.PBMMeshMaterial.html +15 -6
  66. package/docs/classes/five.PBMPointCloud.html +1 -1
  67. package/docs/classes/five.PBMPointCloudMaterial.html +1 -1
  68. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  69. package/docs/classes/five.PanoCircleMesh.html +1 -1
  70. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  71. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  72. package/docs/classes/five.Parameter.html +54 -50
  73. package/docs/classes/five.Scene.html +1 -1
  74. package/docs/classes/five.Subscribe.html +2 -2
  75. package/docs/classes/five.Tile.html +1 -1
  76. package/docs/classes/five.Tile3D.html +30 -26
  77. package/docs/classes/five.TileNode.html +1 -1
  78. package/docs/classes/five.Trajectory.html +1 -1
  79. package/docs/classes/five.TrajectoryNode.html +1 -1
  80. package/docs/classes/five.Work.html +16 -16
  81. package/docs/classes/five.WorkResolvedObserver.html +28 -3
  82. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  83. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  84. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  85. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  86. package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
  87. package/docs/classes/line.Line.html +1 -1
  88. package/docs/classes/line.LineGeometry.html +1 -1
  89. package/docs/classes/line.LineMaterial.html +1 -1
  90. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  91. package/docs/classes/line.THREE_Line2.html +1 -1
  92. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  93. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  94. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  95. package/docs/classes/react.Store.html +1 -1
  96. package/docs/classes/sticker.Sticker.html +2 -2
  97. package/docs/classes/vfx.Airflow.html +1 -1
  98. package/docs/classes/vfx.Flame.html +1 -1
  99. package/docs/classes/vfx.Particle.html +1 -1
  100. package/docs/classes/vfx.ParticleGPU.html +1 -1
  101. package/docs/classes/vfx.SpotLight.html +1 -1
  102. package/docs/documents/README.html +138 -0
  103. package/docs/documents/ai-doc-guidelines.html +117 -0
  104. package/docs/documents/api.html +337 -0
  105. package/docs/documents/features_3dtile.html +216 -0
  106. package/docs/documents/features_camera-animation.html +157 -0
  107. package/docs/documents/features_clipper.html +80 -0
  108. package/docs/documents/features_coordinate-system.html +127 -0
  109. package/docs/documents/features_event.html +104 -0
  110. package/docs/documents/features_five.html +147 -0
  111. package/docs/documents/features_flowing-light-2d-pass.html +356 -0
  112. package/docs/documents/features_flowing-light-3d-pass.html +351 -0
  113. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  114. package/docs/documents/features_gesture.html +120 -0
  115. package/docs/documents/features_get-screen-pixels.html +88 -0
  116. package/docs/documents/features_image-options.html +108 -0
  117. package/docs/documents/features_load-external-model.html +600 -0
  118. package/docs/documents/features_load-progress.html +110 -0
  119. package/docs/documents/features_material.html +334 -0
  120. package/docs/documents/features_mode.html +114 -0
  121. package/docs/documents/features_model.html +141 -0
  122. package/docs/documents/features_move-pano-effect.html +110 -0
  123. package/docs/documents/features_multi-work.html +97 -0
  124. package/docs/documents/features_pano-tile.html +100 -0
  125. package/docs/documents/features_pano-uv.html +82 -0
  126. package/docs/documents/features_parameter.html +101 -0
  127. package/docs/documents/features_plugin.html +105 -0
  128. package/docs/documents/features_postprocessing.html +109 -0
  129. package/docs/documents/features_raycast.html +98 -0
  130. package/docs/documents/features_request-proxy.html +78 -0
  131. package/docs/documents/features_screen-project.html +112 -0
  132. package/docs/documents/features_state.html +71 -0
  133. package/docs/documents/features_view-layer.html +158 -0
  134. package/docs/documents/features_work.html +129 -0
  135. package/docs/documents/glossary.html +94 -0
  136. package/docs/documents/intro.html +24 -6
  137. package/docs/documents/quick-start.html +23 -45
  138. package/docs/documents/release_notes_6.6.html +79 -0
  139. package/docs/documents/release_notes_6.7.html +14 -14
  140. package/docs/documents/release_notes_6.8.html +103 -0
  141. package/docs/documents/support.html +39 -15
  142. package/docs/documents/template.html +80 -0
  143. package/docs/functions/five.loadAt3d.html +1 -1
  144. package/docs/functions/five.loadB3dm.html +1 -1
  145. package/docs/functions/five.loadDome.html +1 -1
  146. package/docs/functions/five.loadDomez.html +1 -1
  147. package/docs/functions/five.loadFbx.html +1 -1
  148. package/docs/functions/five.loadGltf.html +1 -1
  149. package/docs/functions/five.loadPbm.html +1 -1
  150. package/docs/functions/five.loadPly.html +1 -1
  151. package/docs/functions/five.loadPnts.html +1 -1
  152. package/docs/functions/five.loadSplat.html +1 -1
  153. package/docs/functions/five.loadSpz.html +1 -1
  154. package/docs/functions/five.loadX3p.html +1 -1
  155. package/docs/functions/five.parseWork.html +1 -1
  156. package/docs/functions/react.createFiveProvider.html +1 -1
  157. package/docs/functions/react.useFiveAction.html +6 -6
  158. package/docs/functions/react.useFiveCurrentObserver.html +1 -1
  159. package/docs/functions/react.useFiveCurrentState.html +1 -1
  160. package/docs/functions/react.useFiveEventCallback.html +1 -1
  161. package/docs/functions/react.useFiveFloor.html +1 -1
  162. package/docs/functions/react.useFiveHelper.html +1 -1
  163. package/docs/functions/react.useFiveModelIntersectRaycaster.html +2 -2
  164. package/docs/functions/react.useFiveProject2d.html +2 -2
  165. package/docs/functions/react.useFiveSceneEffect.html +1 -1
  166. package/docs/functions/react.useFiveWork.html +2 -2
  167. package/docs/functions/vue.useFiveAction.html +8 -8
  168. package/docs/functions/vue.useFiveCurrentObserver.html +1 -1
  169. package/docs/functions/vue.useFiveCurrentState.html +1 -1
  170. package/docs/functions/vue.useFiveEventCallback.html +1 -1
  171. package/docs/functions/vue.useFiveFloor.html +1 -1
  172. package/docs/functions/vue.useFiveHelper.html +1 -1
  173. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +2 -2
  174. package/docs/functions/vue.useFiveProject2d.html +2 -2
  175. package/docs/functions/vue.useFiveState.html +1 -1
  176. package/docs/functions/vue.useFiveWorks.html +4 -4
  177. package/docs/hierarchy.html +1 -1
  178. package/docs/index.html +135 -34
  179. package/docs/interfaces/five.AddableObject.html +1 -1
  180. package/docs/interfaces/five.AjaxOptions.html +1 -1
  181. package/docs/interfaces/five.BaseEvent.html +2 -2
  182. package/docs/interfaces/five.EventCallback.html +15 -11
  183. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  184. package/docs/interfaces/five.GestureEvent.html +2 -2
  185. package/docs/interfaces/five.ImageOptions.html +1 -1
  186. package/docs/interfaces/five.IntersectEvent.html +2 -2
  187. package/docs/interfaces/five.IntersectMesh.html +1 -1
  188. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  189. package/docs/interfaces/five.Intersection.html +4 -3
  190. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
  191. package/docs/interfaces/five.ModeChangeEvent.html +2 -2
  192. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  193. package/docs/interfaces/five.ModelEvent.html +2 -2
  194. package/docs/interfaces/five.ModelSceneEvent.html +2 -2
  195. package/docs/interfaces/five.ModelTileEvent.html +8 -0
  196. package/docs/interfaces/five.MovePanoOptions.html +4 -4
  197. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  198. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  199. package/docs/interfaces/five.NetworkOptions.html +1 -1
  200. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  201. package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
  202. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  203. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  204. package/docs/interfaces/five.ObjectEvent.html +2 -2
  205. package/docs/interfaces/five.PBMMaterial.html +1 -1
  206. package/docs/interfaces/five.PBMMeshMaterialParameters.html +1 -1
  207. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +1 -1
  208. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  209. package/docs/interfaces/five.PanoEvent.html +2 -2
  210. package/docs/interfaces/five.PanoTextureEvent.html +2 -2
  211. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  212. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  213. package/docs/interfaces/five.ParameterMaterialValue.html +39 -35
  214. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  215. package/docs/interfaces/five.ParameterValue.html +53 -49
  216. package/docs/interfaces/five.Pose.html +6 -7
  217. package/docs/interfaces/five.RenderEvent.html +2 -2
  218. package/docs/interfaces/five.ResolvedParameterValue.html +53 -49
  219. package/docs/interfaces/five.SplatData.html +10 -0
  220. package/docs/interfaces/five.State.html +6 -6
  221. package/docs/interfaces/five.StateEvent.html +2 -2
  222. package/docs/interfaces/five.TextureOptions.html +1 -1
  223. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  224. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  225. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  226. package/docs/interfaces/five.ViewLayer.html +30 -26
  227. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  228. package/docs/interfaces/five.WorkImage.html +1 -1
  229. package/docs/interfaces/five.WorkModel.html +8 -8
  230. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  231. package/docs/interfaces/five.WorkObserver.html +28 -3
  232. package/docs/interfaces/five.WorkTile.html +1 -1
  233. package/docs/interfaces/five.WorksEvent.html +2 -2
  234. package/docs/interfaces/five.XRControllerEvent.html +2 -2
  235. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  236. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  237. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  238. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  239. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  240. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  241. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +1 -1
  242. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  243. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  244. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  245. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  246. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
  247. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  248. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  249. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  250. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  251. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  252. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  253. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  254. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  255. package/docs/interfaces/plugins.TrajectoryController.html +1 -1
  256. package/docs/interfaces/react.FiveInjectionTypes.html +14 -14
  257. package/docs/modules/five.html +1 -1
  258. package/docs/modules.html +1 -1
  259. package/docs/types/five.EventTypes.html +12 -10
  260. package/docs/types/five.FivePlugin.html +1 -1
  261. package/docs/types/five.FivePluginInit.html +1 -1
  262. package/docs/types/five.FivePluginInstance.html +1 -1
  263. package/docs/types/five.NetworkProgressCallback.html +1 -1
  264. package/docs/types/five.ParseOptions.html +6 -6
  265. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  266. package/docs/variables/react.FiveCanvas.html +1 -1
  267. package/docs/variables/react.useFiveScene.html +1 -1
  268. package/docs/variables/vue.FiveCanvas.html +1 -1
  269. package/docs/variables/vue.FiveProvider.html +1 -1
  270. package/five/application/analysis.d.ts +40 -0
  271. package/five/application/controllers.d.ts +41 -0
  272. package/five/application/events-legacy.d.ts +454 -0
  273. package/five/application/events.d.ts +69 -0
  274. package/five/application/five.d.ts +518 -0
  275. package/five/application/fiveInitArgs.d.ts +176 -0
  276. package/five/application/fiveLoadOptions.d.ts +21 -0
  277. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  278. package/five/application/getViewportScale.d.ts +2 -0
  279. package/five/application/initLights.d.ts +3 -0
  280. package/five/application/mode.d.ts +28 -0
  281. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  282. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  283. package/five/assets/gradient-png-data-url.d.ts +2 -0
  284. package/five/assets/loading-png-data-url.d.ts +2 -0
  285. package/five/assets/phone-png-data-url.d.ts +2 -0
  286. package/five/assets/realsee-pmg-data-url.d.ts +2 -0
  287. package/five/bvh/bvhMath.d.ts +33 -0
  288. package/five/bvh/bvhMesh.d.ts +7 -0
  289. package/five/bvh/bvhNode.d.ts +29 -0
  290. package/five/bvh/bvhObject.d.ts +18 -0
  291. package/five/bvh/bvhPoints.d.ts +6 -0
  292. package/five/bvh/index.d.ts +10 -0
  293. package/five/bvh/worker.d.ts +35 -0
  294. package/five/cardboard/helper.d.ts +2 -0
  295. package/five/cardboard/index.d.ts +13 -0
  296. package/five/cardboard/sensor.d.ts +158 -0
  297. package/five/certificates/hardware.d.ts +1 -0
  298. package/five/controllers/base.d.ts +166 -0
  299. package/five/controllers/events.d.ts +69 -0
  300. package/five/controllers/floorplan.d.ts +119 -0
  301. package/five/controllers/mapview.d.ts +138 -0
  302. package/five/controllers/model.d.ts +57 -0
  303. package/five/controllers/panorama.d.ts +143 -0
  304. package/five/controllers/panoramaLike.d.ts +87 -0
  305. package/five/controllers/topview.d.ts +42 -0
  306. package/five/controllers/vrPanorama.d.ts +56 -0
  307. package/five/controllers/xrPanorama.d.ts +81 -0
  308. package/five/core/camera.d.ts +65 -0
  309. package/five/core/internalWebGLRenderer.d.ts +14 -0
  310. package/five/core/panoVideo.d.ts +18 -0
  311. package/five/core/scene.d.ts +10 -0
  312. package/five/core/tiling.d.ts +43 -0
  313. package/five/declare.d.ts +2 -1
  314. package/five/gs/util/renderData.d.ts +32 -0
  315. package/five/gs/wasm/data.d.ts +20 -0
  316. package/five/gs/wasm/sort.d.ts +18 -0
  317. package/five/gs/worker/dataWorker.d.ts +1 -0
  318. package/five/gs/worker/sortWorker.d.ts +1 -0
  319. package/five/index.d.ts +57 -4644
  320. package/five/index.js +503 -78
  321. package/five/index.mjs +6386 -5154
  322. package/five/meshes/boundingMesh.d.ts +12 -0
  323. package/five/meshes/intersectMesh.d.ts +8 -0
  324. package/five/meshes/panoCircleMesh.d.ts +35 -0
  325. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  326. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  327. package/five/meshes/panoSphereMesh.d.ts +27 -0
  328. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  329. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  330. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  331. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  332. package/five/model/index.d.ts +70 -0
  333. package/five/model/intersection.d.ts +18 -0
  334. package/five/model/loaders/at3d.d.ts +12 -0
  335. package/five/model/loaders/b3dm.d.ts +9 -0
  336. package/five/model/loaders/dome.d.ts +22 -0
  337. package/five/model/loaders/domez.d.ts +11 -0
  338. package/five/model/loaders/fbx.d.ts +8 -0
  339. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  340. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  341. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  342. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  343. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  344. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  345. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +9 -0
  346. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  347. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  348. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  349. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  350. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  351. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  352. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  353. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  354. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  355. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  356. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +24 -0
  357. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  358. package/five/model/loaders/glTF-helpers/index.d.ts +47 -0
  359. package/five/model/loaders/glTF-helpers/parser.d.ts +114 -0
  360. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  361. package/five/model/loaders/gltf.d.ts +10 -0
  362. package/five/model/loaders/obj.d.ts +9 -0
  363. package/five/model/loaders/pbm.d.ts +26 -0
  364. package/five/model/loaders/ply.d.ts +24 -0
  365. package/five/model/loaders/pnts.d.ts +8 -0
  366. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  367. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  368. package/five/model/loaders/shared.d.ts +16 -0
  369. package/five/model/loaders/splat.d.ts +8 -0
  370. package/five/model/loaders/spz.d.ts +14 -0
  371. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  372. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  373. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  374. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  375. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  376. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  377. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  378. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  379. package/five/model/loaders/x3p.d.ts +22 -0
  380. package/five/model/materials/pbmMaterial.d.ts +87 -0
  381. package/five/model/materials/pbmMeshMaterial.d.ts +124 -0
  382. package/five/model/materials/pbmPointCloudMaterial.d.ts +72 -0
  383. package/five/model/model-scene.d.ts +172 -0
  384. package/five/model/model.d.ts +209 -0
  385. package/five/model/objects/pbmContainer.d.ts +28 -0
  386. package/five/model/objects/pbmGSObject.d.ts +40 -0
  387. package/five/model/objects/pbmGSRenderMesh.d.ts +32 -0
  388. package/five/model/objects/pbmGroup.d.ts +8 -0
  389. package/five/model/objects/pbmMesh.d.ts +10 -0
  390. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  391. package/five/model/parameter.d.ts +136 -0
  392. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  393. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  394. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  395. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  396. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  397. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  398. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  399. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  400. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  401. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  402. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  403. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  404. package/five/model/tile3d/header.d.ts +88 -0
  405. package/five/model/tile3d/index.d.ts +214 -0
  406. package/five/model/tile3d/tile-cache.d.ts +18 -0
  407. package/five/model/tile3d/tile-content.d.ts +10 -0
  408. package/five/model/tile3d/tile-node.d.ts +24 -0
  409. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  410. package/five/model/tile3d/tile.d.ts +79 -0
  411. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  412. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  413. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  414. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  415. package/five/model/tile3d/tileset.d.ts +69 -0
  416. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  417. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  418. package/five/model/tile3d/trajectory.d.ts +30 -0
  419. package/five/model/tile3d/types.d.ts +33 -0
  420. package/five/model/view-layer.d.ts +20 -0
  421. package/five/renderer/five-renderer.d.ts +17 -0
  422. package/five/renderer/index.d.ts +3 -0
  423. package/five/renderer/postprocessing/composer.d.ts +37 -0
  424. package/five/renderer/postprocessing/index.d.ts +7 -0
  425. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +15 -0
  426. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  427. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  428. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  429. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  430. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  431. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  432. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  433. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  434. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  435. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  436. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  437. package/five/texture/imageBitmap.d.ts +13 -0
  438. package/five/texture/initTexture.d.ts +3 -0
  439. package/five/texture/loader.d.ts +39 -0
  440. package/five/thirdparty/fflate.d.ts +1407 -0
  441. package/five/thirdparty/hammer.d.ts +259 -0
  442. package/five/thirdparty/jsrsasign.d.ts +768 -0
  443. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  444. package/five/three-version-check.d.ts +1 -0
  445. package/five/types/addableObject.d.ts +12 -0
  446. package/five/types/cube.d.ts +1 -0
  447. package/five/types/gestureInput.d.ts +24 -0
  448. package/five/types/imageOptions.d.ts +20 -0
  449. package/five/types/intersectMeshInterface.d.ts +8 -0
  450. package/five/types/movePanoEffect.d.ts +13 -0
  451. package/five/types/movePanoOptions.d.ts +35 -0
  452. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  453. package/five/types/plugin.d.ts +25 -0
  454. package/five/types/pose.d.ts +17 -0
  455. package/five/types/state.d.ts +20 -0
  456. package/five/types/viewport.d.ts +22 -0
  457. package/five/utils/ajax.d.ts +66 -0
  458. package/five/utils/animationFrameLoop.d.ts +45 -0
  459. package/five/utils/array.d.ts +31 -0
  460. package/five/utils/asyncTaskQueue.d.ts +8 -0
  461. package/five/utils/bufferGeometry.d.ts +33 -0
  462. package/five/utils/calculateProgress.d.ts +39 -0
  463. package/five/utils/calculateThreeMouse.d.ts +13 -0
  464. package/five/utils/canplayVideo.d.ts +2 -0
  465. package/five/utils/clamp.d.ts +2 -0
  466. package/five/utils/clock.d.ts +17 -0
  467. package/five/utils/createSymbol.d.ts +5 -0
  468. package/five/utils/decodeText.d.ts +2 -0
  469. package/five/utils/deepEqual.d.ts +2 -0
  470. package/five/utils/deepFreeze.d.ts +2 -0
  471. package/five/utils/defineProperty.d.ts +9 -0
  472. package/five/utils/detector.d.ts +14 -0
  473. package/five/utils/distance.d.ts +10 -0
  474. package/five/utils/draco.d.ts +26 -0
  475. package/five/utils/easing.d.ts +63 -0
  476. package/five/utils/event.d.ts +149 -0
  477. package/five/utils/formatRad.d.ts +7 -0
  478. package/five/utils/imageSupport.d.ts +6 -0
  479. package/five/utils/imageURL.d.ts +42 -0
  480. package/five/utils/isEmptyObject.d.ts +2 -0
  481. package/five/utils/isNil.d.ts +6 -0
  482. package/five/utils/isNumber.d.ts +2 -0
  483. package/five/utils/isPowerOfTwo.d.ts +2 -0
  484. package/five/utils/isPromise.d.ts +2 -0
  485. package/five/utils/isSimilar.d.ts +6 -0
  486. package/five/utils/json.d.ts +7 -0
  487. package/five/utils/ktx2.d.ts +30 -0
  488. package/five/utils/lzma/index.d.ts +2 -0
  489. package/five/utils/lzma/lzma.d.ts +3 -0
  490. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  491. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  492. package/five/utils/memoryUsage.d.ts +29 -0
  493. package/five/utils/motion.d.ts +38 -0
  494. package/five/utils/noop.d.ts +6 -0
  495. package/five/utils/now.d.ts +7 -0
  496. package/five/utils/pano.d.ts +9 -0
  497. package/five/utils/pick.d.ts +3 -0
  498. package/five/utils/poseUtils.d.ts +5 -0
  499. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  500. package/five/utils/renderDepth.d.ts +2 -0
  501. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  502. package/five/utils/requestPermission.d.ts +3 -0
  503. package/five/utils/shaderContentFix.d.ts +7 -0
  504. package/five/utils/shaderMaterial.d.ts +20 -0
  505. package/five/utils/stateUtils.d.ts +5 -0
  506. package/five/utils/string-pattern.d.ts +8 -0
  507. package/five/utils/subscribe.d.ts +67 -0
  508. package/five/utils/tileCube.d.ts +19 -0
  509. package/five/utils/toFastProperties.d.ts +1 -0
  510. package/five/utils/typedCache.d.ts +10 -0
  511. package/five/utils/uniform.d.ts +15 -0
  512. package/five/utils/url.d.ts +35 -0
  513. package/five/utils/uuid.d.ts +5 -0
  514. package/five/utils/values.d.ts +2 -0
  515. package/five/utils/vectorCoordinates.d.ts +29 -0
  516. package/five/utils/volume.d.ts +111 -0
  517. package/five/utils/webglError.d.ts +7 -0
  518. package/five/utils/worker.d.ts +26 -0
  519. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  520. package/five/webxr/motionHelper.d.ts +68 -0
  521. package/five/webxr/xrButton.d.ts +4 -0
  522. package/five/webxr/xrController.d.ts +24 -0
  523. package/five/webxr/xrManager.d.ts +84 -0
  524. package/five/work/_ALLOW_HOST.d.ts +2 -0
  525. package/five/work/index.d.ts +6 -0
  526. package/five/work/keychain.d.ts +5 -0
  527. package/five/work/looseWorkType.d.ts +121 -0
  528. package/five/work/verify.d.ts +7 -0
  529. package/five/work/work.d.ts +236 -0
  530. package/five/work/workFetcher.d.ts +4 -0
  531. package/five/work/workJson.d.ts +3 -0
  532. package/five/work/workJsonType.d.ts +73 -0
  533. package/five/work/workObserverUtils.d.ts +36 -0
  534. package/five/work/workParser.d.ts +6 -0
  535. package/five/work/workResolvedObserver.d.ts +12 -0
  536. package/five/work/workVerify.d.ts +2 -0
  537. package/five/work/works.d.ts +10 -0
  538. package/gltf-loader/gltf-object.d.ts +17 -0
  539. package/gltf-loader/index.d.ts +60 -160
  540. package/gltf-loader/index.js +3 -3
  541. package/gltf-loader/index.mjs +3 -3
  542. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  543. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  544. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  545. package/line/circle_png.d.ts +1 -0
  546. package/line/index.d.ts +19 -69
  547. package/line/index.js +3 -3
  548. package/line/index.mjs +3 -3
  549. package/line/utils/Line2.d.ts +7 -0
  550. package/line/utils/LineGeometry.d.ts +10 -0
  551. package/line/utils/LineMaterial.d.ts +20 -0
  552. package/line/utils/LineSegments2.d.ts +11 -0
  553. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  554. package/llms.txt +65 -0
  555. package/package.json +10 -1
  556. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  557. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  558. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  559. package/plugins/BasePlugin/index.d.ts +119 -0
  560. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  561. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  562. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  563. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  564. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  565. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  566. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  567. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  568. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  569. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  570. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  571. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  572. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  573. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  574. package/plugins/OrientationPlugin/index.d.ts +6 -0
  575. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  576. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  577. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  578. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  579. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  580. package/plugins/PluginTemplate/index.d.ts +5 -0
  581. package/plugins/PluginTemplate/typing.d.ts +21 -0
  582. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  583. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  584. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  585. package/plugins/index.d.ts +9 -1102
  586. package/plugins/index.js +2 -2
  587. package/plugins/index.mjs +2 -2
  588. package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
  589. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  590. package/plugins/utils/absoluteUrl.d.ts +5 -0
  591. package/plugins/utils/clamp.d.ts +2 -0
  592. package/plugins/utils/loadImage.d.ts +1 -0
  593. package/plugins/utils/motion.d.ts +38 -0
  594. package/plugins/utils/now.d.ts +6 -0
  595. package/plugins/utils/uuid.d.ts +5 -0
  596. package/react/canvas.d.ts +19 -0
  597. package/react/context.d.ts +11 -0
  598. package/react/createProvider.d.ts +95 -0
  599. package/react/createStore.d.ts +144 -0
  600. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  601. package/react/hooks/useFiveAction.d.ts +147 -0
  602. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  603. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  604. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  605. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  606. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  607. package/react/hooks/useFiveFloor.d.ts +15 -0
  608. package/react/hooks/useFiveHelper.d.ts +14 -0
  609. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  610. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  611. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  612. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  613. package/react/hooks/useFiveProject2d.d.ts +20 -0
  614. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  615. package/react/hooks/useFiveState.d.ts +6 -0
  616. package/react/hooks/useFiveWork.d.ts +29 -0
  617. package/react/index.d.ts +24 -830
  618. package/react/index.js +2 -2
  619. package/react/index.mjs +2 -2
  620. package/react/rendererPool.d.ts +7 -0
  621. package/react/withFive.d.ts +213 -0
  622. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  623. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  624. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  625. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  626. package/shader-lib/ShineModel/index.d.ts +7 -0
  627. package/shader-lib/SweepModel/index.d.ts +7 -0
  628. package/shader-lib/index.d.ts +5 -86
  629. package/shader-lib/index.js +2 -2
  630. package/shader-lib/index.mjs +2 -2
  631. package/sticker/geometry.d.ts +3 -0
  632. package/sticker/index.d.ts +68 -71
  633. package/sticker/index.js +3 -3
  634. package/sticker/index.mjs +3 -3
  635. package/umd/five-gltf-loader.js +3 -3
  636. package/umd/five-line.js +3 -3
  637. package/umd/five-plugins.js +2 -2
  638. package/umd/five-react.js +2 -2
  639. package/umd/five-shader-lib.js +2 -2
  640. package/umd/five-sticker.js +3 -3
  641. package/umd/five-vfx.js +2 -2
  642. package/umd/five-vue.js +2 -2
  643. package/umd/five.js +503 -78
  644. package/vfx/airflow/airflow.d.ts +18 -0
  645. package/vfx/airflow/fragment-shader.d.ts +2 -0
  646. package/vfx/airflow/vertex-shader.d.ts +2 -0
  647. package/vfx/common/scale-shader.d.ts +2 -0
  648. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  649. package/vfx/frame/fragment-shader.d.ts +2 -0
  650. package/vfx/frame/frame.d.ts +22 -0
  651. package/vfx/frame/vertex-shader.d.ts +2 -0
  652. package/vfx/index.d.ts +7 -363
  653. package/vfx/index.js +2 -2
  654. package/vfx/index.mjs +2 -2
  655. package/vfx/particle/fragment-shader.d.ts +2 -0
  656. package/vfx/particle/instance.d.ts +36 -0
  657. package/vfx/particle/particle.d.ts +205 -0
  658. package/vfx/particle/utils.d.ts +11 -0
  659. package/vfx/particle/vertex-shader.d.ts +2 -0
  660. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  661. package/vfx/particle-gpu/instance.d.ts +36 -0
  662. package/vfx/particle-gpu/particle.d.ts +95 -0
  663. package/vfx/particle-gpu/utils.d.ts +11 -0
  664. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  665. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  666. package/vfx/spotLight/spotLight.d.ts +15 -0
  667. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  668. package/vue/context.d.ts +7 -0
  669. package/vue/hooks/FiveCanvas.d.ts +36 -0
  670. package/vue/hooks/FiveProvider.d.ts +35 -0
  671. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  672. package/vue/hooks/useFiveAction.d.ts +178 -0
  673. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  674. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  675. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  676. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  677. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  678. package/vue/hooks/useFiveFloor.d.ts +16 -0
  679. package/vue/hooks/useFiveHelper.d.ts +15 -0
  680. package/vue/hooks/useFiveModel.d.ts +7 -0
  681. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  682. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  683. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  684. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  685. package/vue/hooks/useFiveScene.d.ts +6 -0
  686. package/vue/hooks/useFiveState.d.ts +16 -0
  687. package/vue/hooks/useFiveWork.d.ts +30 -0
  688. package/vue/index.d.ts +23 -467
  689. package/vue/index.js +2 -2
  690. package/vue/index.mjs +2 -2
  691. package/vue/rendererPool.d.ts +10 -0
  692. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  693. package/work-downloader/components/model.d.ts +3 -0
  694. package/work-downloader/components/observer.d.ts +7 -0
  695. package/work-downloader/download.d.ts +16 -0
  696. package/work-downloader/index.d.ts +2 -33
  697. package/work-downloader/index.js +2 -2
  698. package/work-downloader/index.mjs +2 -2
  699. package/work-downloader/type.d.ts +28 -0
  700. package/work-downloader/utils/download-to-file.d.ts +1 -0
  701. package/work-downloader/utils/image-processing.d.ts +7 -0
  702. package/work-downloader/utils/join-url.d.ts +2 -0
  703. package/work-downloader/utils/log.d.ts +1 -0
  704. package/work-downloader/utils/relative-url.d.ts +1 -0
  705. package/docs/documents/coordinate.html +0 -13
  706. package/docs/documents/five.FivePlugin.plugins.html +0 -92
  707. package/docs/documents/five.Pose.coordinate.html +0 -13
  708. package/docs/documents/mode.html +0 -15
  709. package/docs/documents/plugins.html +0 -92
  710. package/docs/documents/state.html +0 -2
  711. package/docs/documents/work.html +0 -67
  712. package/docs/media/coordinate.jpg +0 -0
  713. package/docs_markdown/README.md +0 -33
  714. package/docs_markdown/_media/coordinate.jpg +0 -0
  715. package/docs_markdown/documents/coordinate.md +0 -29
  716. package/docs_markdown/documents/intro.md +0 -15
  717. package/docs_markdown/documents/mode.md +0 -21
  718. package/docs_markdown/documents/plugins.md +0 -226
  719. package/docs_markdown/documents/quick-start.md +0 -105
  720. package/docs_markdown/documents/release_notes/6.7.md +0 -407
  721. package/docs_markdown/documents/state.md +0 -7
  722. package/docs_markdown/documents/support.md +0 -13
  723. package/docs_markdown/documents/work.md +0 -148
  724. package/docs_markdown/five/README.md +0 -309
  725. package/docs_markdown/five/classes/AdaptiveLuminancePass.md +0 -238
  726. package/docs_markdown/five/classes/AnimationFrameLoop.md +0 -195
  727. package/docs_markdown/five/classes/BoundingMesh.md +0 -75
  728. package/docs_markdown/five/classes/Camera.md +0 -527
  729. package/docs_markdown/five/classes/EffectComposer.md +0 -241
  730. package/docs_markdown/five/classes/EyeDomeLightingPass.md +0 -232
  731. package/docs_markdown/five/classes/Fetcher.md +0 -133
  732. package/docs_markdown/five/classes/Five.md +0 -2231
  733. package/docs_markdown/five/classes/FivePass.md +0 -193
  734. package/docs_markdown/five/classes/FiveRenderer.md +0 -107
  735. package/docs_markdown/five/classes/FullScreenQuad.md +0 -95
  736. package/docs_markdown/five/classes/InternalWebGLRenderer.md +0 -65
  737. package/docs_markdown/five/classes/Model.md +0 -1009
  738. package/docs_markdown/five/classes/ModelScene.md +0 -495
  739. package/docs_markdown/five/classes/Motion.md +0 -235
  740. package/docs_markdown/five/classes/NetworkSubscribe.md +0 -289
  741. package/docs_markdown/five/classes/PBMContainer.md +0 -137
  742. package/docs_markdown/five/classes/PBMCustomShader.md +0 -171
  743. package/docs_markdown/five/classes/PBMGSObject.md +0 -257
  744. package/docs_markdown/five/classes/PBMGroup.md +0 -35
  745. package/docs_markdown/five/classes/PBMMesh.md +0 -43
  746. package/docs_markdown/five/classes/PBMMeshMaterial.md +0 -889
  747. package/docs_markdown/five/classes/PBMPointCloud.md +0 -41
  748. package/docs_markdown/five/classes/PBMPointCloudMaterial.md +0 -371
  749. package/docs_markdown/five/classes/PBMSkinnedMesh.md +0 -67
  750. package/docs_markdown/five/classes/PanoCircleMesh.md +0 -296
  751. package/docs_markdown/five/classes/PanoCircleMeshCustom.md +0 -296
  752. package/docs_markdown/five/classes/PanoCircleMeshSolid.md +0 -296
  753. package/docs_markdown/five/classes/Parameter.md +0 -905
  754. package/docs_markdown/five/classes/Scene.md +0 -109
  755. package/docs_markdown/five/classes/Subscribe.md +0 -271
  756. package/docs_markdown/five/classes/TextureLoader.md +0 -199
  757. package/docs_markdown/five/classes/Tile.md +0 -517
  758. package/docs_markdown/five/classes/Tile3D.md +0 -1287
  759. package/docs_markdown/five/classes/TileCache.md +0 -123
  760. package/docs_markdown/five/classes/TileNode.md +0 -171
  761. package/docs_markdown/five/classes/TileRequestScheduler.md +0 -69
  762. package/docs_markdown/five/classes/Tileset.md +0 -379
  763. package/docs_markdown/five/classes/Trajectory.md +0 -111
  764. package/docs_markdown/five/classes/TrajectoryNode.md +0 -129
  765. package/docs_markdown/five/classes/Work.md +0 -299
  766. package/docs_markdown/five/classes/WorkResolvedObserver.md +0 -302
  767. package/docs_markdown/five/classes/XRButton.md +0 -37
  768. package/docs_markdown/five/enumerations/VolumePlaneIntersect.md +0 -33
  769. package/docs_markdown/five/functions/coordinatesToVector.md +0 -33
  770. package/docs_markdown/five/functions/createDebugBoundingMesh.md +0 -25
  771. package/docs_markdown/five/functions/createWorks.md +0 -21
  772. package/docs_markdown/five/functions/defaultImageURLTransform.md +0 -33
  773. package/docs_markdown/five/functions/getViewportScale.md +0 -15
  774. package/docs_markdown/five/functions/headingToLongitude.md +0 -29
  775. package/docs_markdown/five/functions/imageSupport.md +0 -15
  776. package/docs_markdown/five/functions/isBoundingVolume.md +0 -21
  777. package/docs_markdown/five/functions/isPanoId.md +0 -21
  778. package/docs_markdown/five/functions/loadAt3d.md +0 -47
  779. package/docs_markdown/five/functions/loadB3dm.md +0 -39
  780. package/docs_markdown/five/functions/loadDome.md +0 -43
  781. package/docs_markdown/five/functions/loadDomez.md +0 -43
  782. package/docs_markdown/five/functions/loadFbx.md +0 -35
  783. package/docs_markdown/five/functions/loadGltf.md +0 -39
  784. package/docs_markdown/five/functions/loadPbm.md +0 -47
  785. package/docs_markdown/five/functions/loadPly.md +0 -61
  786. package/docs_markdown/five/functions/loadPnts.md +0 -35
  787. package/docs_markdown/five/functions/loadSplat.md +0 -35
  788. package/docs_markdown/five/functions/loadSpz.md +0 -35
  789. package/docs_markdown/five/functions/loadX3p.md +0 -39
  790. package/docs_markdown/five/functions/longitudeToHeading.md +0 -29
  791. package/docs_markdown/five/functions/makeBoundingVolume.md +0 -21
  792. package/docs_markdown/five/functions/panoEqual.md +0 -25
  793. package/docs_markdown/five/functions/panoParse.md +0 -21
  794. package/docs_markdown/five/functions/panoStringify.md +0 -21
  795. package/docs_markdown/five/functions/parseWork.md +0 -33
  796. package/docs_markdown/five/functions/vectorToCoordinates.md +0 -31
  797. package/docs_markdown/five/functions/workToJson.md +0 -21
  798. package/docs_markdown/five/interfaces/AddableObject.md +0 -77
  799. package/docs_markdown/five/interfaces/AjaxOptions.md +0 -81
  800. package/docs_markdown/five/interfaces/AnimationFrame.md +0 -67
  801. package/docs_markdown/five/interfaces/AnimationFrameContext.md +0 -55
  802. package/docs_markdown/five/interfaces/BaseEvent.md +0 -60
  803. package/docs_markdown/five/interfaces/BoundingVolume.md +0 -241
  804. package/docs_markdown/five/interfaces/BoxBoundingVolume.md +0 -325
  805. package/docs_markdown/five/interfaces/CameraPose.md +0 -49
  806. package/docs_markdown/five/interfaces/CullingVolume.md +0 -141
  807. package/docs_markdown/five/interfaces/Draco.md +0 -219
  808. package/docs_markdown/five/interfaces/EventCallback.md +0 -3374
  809. package/docs_markdown/five/interfaces/FiveInitArgs.md +0 -435
  810. package/docs_markdown/five/interfaces/FiveLoadOptions.md +0 -71
  811. package/docs_markdown/five/interfaces/FloorplanControllerCustomInitArgs.md +0 -93
  812. package/docs_markdown/five/interfaces/GestureEvent.md +0 -233
  813. package/docs_markdown/five/interfaces/ImageOptions.md +0 -147
  814. package/docs_markdown/five/interfaces/ImageURLMappings.md +0 -13
  815. package/docs_markdown/five/interfaces/ImageURLOptions.md +0 -89
  816. package/docs_markdown/five/interfaces/IntersectEvent.md +0 -89
  817. package/docs_markdown/five/interfaces/IntersectMesh.md +0 -33
  818. package/docs_markdown/five/interfaces/IntersectMeshInterface.md +0 -27
  819. package/docs_markdown/five/interfaces/Intersection.md +0 -53
  820. package/docs_markdown/five/interfaces/KTX2.md +0 -131
  821. package/docs_markdown/five/interfaces/LoosePanoWork.md +0 -81
  822. package/docs_markdown/five/interfaces/LooseWork.md +0 -145
  823. package/docs_markdown/five/interfaces/LooseWorkInitial.md +0 -89
  824. package/docs_markdown/five/interfaces/LooseWorkModel.md +0 -113
  825. package/docs_markdown/five/interfaces/LooseWorkObserver.md +0 -153
  826. package/docs_markdown/five/interfaces/LooseWorkPanorama.md +0 -121
  827. package/docs_markdown/five/interfaces/LooseWorkVideo.md +0 -33
  828. package/docs_markdown/five/interfaces/LooseWorkWithExtrinsics.md +0 -93
  829. package/docs_markdown/five/interfaces/MapviewControllerCustomInitArgs.md +0 -96
  830. package/docs_markdown/five/interfaces/ModeChangeEvent.md +0 -105
  831. package/docs_markdown/five/interfaces/ModelControllerCustomInitArgs.md +0 -147
  832. package/docs_markdown/five/interfaces/ModelEvent.md +0 -89
  833. package/docs_markdown/five/interfaces/ModelOptions.md +0 -54
  834. package/docs_markdown/five/interfaces/ModelSceneEvent.md +0 -73
  835. package/docs_markdown/five/interfaces/MotionKeyframe.md +0 -39
  836. package/docs_markdown/five/interfaces/MovePanoOptions.md +0 -192
  837. package/docs_markdown/five/interfaces/NetworkAbortError.md +0 -13
  838. package/docs_markdown/five/interfaces/NetworkFirbiddenError.md +0 -13
  839. package/docs_markdown/five/interfaces/NetworkOptions.md +0 -53
  840. package/docs_markdown/five/interfaces/NetworkProxyError.md +0 -13
  841. package/docs_markdown/five/interfaces/NetworkResourceEvent.md +0 -97
  842. package/docs_markdown/five/interfaces/NetworkResponseError.md +0 -21
  843. package/docs_markdown/five/interfaces/NetworkTimeoutError.md +0 -13
  844. package/docs_markdown/five/interfaces/ObjectEvent.md +0 -73
  845. package/docs_markdown/five/interfaces/PBMClipperParameter.md +0 -25
  846. package/docs_markdown/five/interfaces/PBMCustomShaderInitArgs.md +0 -57
  847. package/docs_markdown/five/interfaces/PBMCustomShaderSlots.md +0 -53
  848. package/docs_markdown/five/interfaces/PBMMaterial.md +0 -18
  849. package/docs_markdown/five/interfaces/PBMMeshMaterialParameters.md +0 -221
  850. package/docs_markdown/five/interfaces/PBMPanoDepth.md +0 -49
  851. package/docs_markdown/five/interfaces/PBMPanoPicture.md +0 -59
  852. package/docs_markdown/five/interfaces/PBMPointCloudMaterialParameters.md +0 -221
  853. package/docs_markdown/five/interfaces/PBMRefinedScreen.md +0 -49
  854. package/docs_markdown/five/interfaces/PanoCircleMeshCustomOptions.md +0 -73
  855. package/docs_markdown/five/interfaces/PanoCircleMeshInterface.md +0 -222
  856. package/docs_markdown/five/interfaces/PanoCircleMeshOptions.md +0 -25
  857. package/docs_markdown/five/interfaces/PanoCircleMeshSolidOptions.md +0 -25
  858. package/docs_markdown/five/interfaces/PanoEvent.md +0 -121
  859. package/docs_markdown/five/interfaces/PanoTextureEvent.md +0 -97
  860. package/docs_markdown/five/interfaces/PanoramaControllerCustomInitArgs.md +0 -260
  861. package/docs_markdown/five/interfaces/PanoramaLikeControllerCustomInitArgs.md +0 -112
  862. package/docs_markdown/five/interfaces/ParameterMaterialValue.md +0 -363
  863. package/docs_markdown/five/interfaces/ParameterTilesetValue.md +0 -161
  864. package/docs_markdown/five/interfaces/ParameterValue.md +0 -715
  865. package/docs_markdown/five/interfaces/Pass.md +0 -100
  866. package/docs_markdown/five/interfaces/Pose.md +0 -69
  867. package/docs_markdown/five/interfaces/RegionBoundingVolume.md +0 -349
  868. package/docs_markdown/five/interfaces/RenderEvent.md +0 -73
  869. package/docs_markdown/five/interfaces/ResolvedParameterValue.md +0 -727
  870. package/docs_markdown/five/interfaces/SphereBoundingVolume.md +0 -317
  871. package/docs_markdown/five/interfaces/State.md +0 -123
  872. package/docs_markdown/five/interfaces/StateEvent.md +0 -87
  873. package/docs_markdown/five/interfaces/TextureOptions.md +0 -157
  874. package/docs_markdown/five/interfaces/Tile3DOptions.md +0 -83
  875. package/docs_markdown/five/interfaces/TileCoordinateSystem.md +0 -25
  876. package/docs_markdown/five/interfaces/TileHeader.md +0 -89
  877. package/docs_markdown/five/interfaces/TilesetHeader.md +0 -209
  878. package/docs_markdown/five/interfaces/TilesetOptions.md +0 -205
  879. package/docs_markdown/five/interfaces/TopviewControllerCustomInitArgs.md +0 -101
  880. package/docs_markdown/five/interfaces/TrajectoryHeader.md +0 -41
  881. package/docs_markdown/five/interfaces/VRPanoramaControllerCustomInitArgs.md +0 -264
  882. package/docs_markdown/five/interfaces/ViewLayer.md +0 -1505
  883. package/docs_markdown/five/interfaces/Viewport.md +0 -57
  884. package/docs_markdown/five/interfaces/WebXRAxesParams.md +0 -57
  885. package/docs_markdown/five/interfaces/WebXRControllerParams.md +0 -25
  886. package/docs_markdown/five/interfaces/WorkCubeImage.md +0 -86
  887. package/docs_markdown/five/interfaces/WorkImage.md +0 -117
  888. package/docs_markdown/five/interfaces/WorkInitial.md +0 -89
  889. package/docs_markdown/five/interfaces/WorkInitialJson.md +0 -65
  890. package/docs_markdown/five/interfaces/WorkJson.md +0 -89
  891. package/docs_markdown/five/interfaces/WorkModel.md +0 -113
  892. package/docs_markdown/five/interfaces/WorkModelJson.md +0 -49
  893. package/docs_markdown/five/interfaces/WorkModelLayer.md +0 -59
  894. package/docs_markdown/five/interfaces/WorkModelLayerJson.md +0 -41
  895. package/docs_markdown/five/interfaces/WorkObserver.md +0 -184
  896. package/docs_markdown/five/interfaces/WorkObserverJson.md +0 -97
  897. package/docs_markdown/five/interfaces/WorkPanoramaJson.md +0 -125
  898. package/docs_markdown/five/interfaces/WorkPanoramasJson.md +0 -25
  899. package/docs_markdown/five/interfaces/WorkTile.md +0 -115
  900. package/docs_markdown/five/interfaces/WorkVideo.md +0 -49
  901. package/docs_markdown/five/interfaces/WorksEvent.md +0 -89
  902. package/docs_markdown/five/interfaces/XRControllerEvent.md +0 -177
  903. package/docs_markdown/five/interfaces/XRGestureEvent.md +0 -125
  904. package/docs_markdown/five/interfaces/XRPanoramaControllerCustomInitArgs.md +0 -264
  905. package/docs_markdown/five/interfaces/XRSessionEvent.md +0 -81
  906. package/docs_markdown/five/interfaces/documents/coordinate.md +0 -29
  907. package/docs_markdown/five/type-aliases/AjaxResponseType.md +0 -11
  908. package/docs_markdown/five/type-aliases/AjaxResponseTypeMapping.md +0 -17
  909. package/docs_markdown/five/type-aliases/AnimationFrameLoopType.md +0 -11
  910. package/docs_markdown/five/type-aliases/BoundingVolumeJson.md +0 -11
  911. package/docs_markdown/five/type-aliases/BoxBoundingVolumeJson.md +0 -19
  912. package/docs_markdown/five/type-aliases/ControllerCustomInitTypes.md +0 -67
  913. package/docs_markdown/five/type-aliases/ControllerEventTypes.md +0 -669
  914. package/docs_markdown/five/type-aliases/CubeFace.md +0 -11
  915. package/docs_markdown/five/type-aliases/EventTypes.md +0 -381
  916. package/docs_markdown/five/type-aliases/FivePlugin.md +0 -31
  917. package/docs_markdown/five/type-aliases/FivePluginInit.md +0 -21
  918. package/docs_markdown/five/type-aliases/FivePluginInstance.md +0 -21
  919. package/docs_markdown/five/type-aliases/GestureTypes.md +0 -11
  920. package/docs_markdown/five/type-aliases/LegacyEventType.md +0 -1852
  921. package/docs_markdown/five/type-aliases/LoadResultType.md +0 -109
  922. package/docs_markdown/five/type-aliases/Mode.md +0 -19
  923. package/docs_markdown/five/type-aliases/Models.md +0 -121
  924. package/docs_markdown/five/type-aliases/MotionCircle.md +0 -13
  925. package/docs_markdown/five/type-aliases/MotionConfig.md +0 -17
  926. package/docs_markdown/five/type-aliases/MotionInitalValue.md +0 -17
  927. package/docs_markdown/five/type-aliases/MotionValue.md +0 -17
  928. package/docs_markdown/five/type-aliases/MovePanoEffect.md +0 -24
  929. package/docs_markdown/five/type-aliases/NetWorkMeta.md +0 -71
  930. package/docs_markdown/five/type-aliases/NetworkError.md +0 -11
  931. package/docs_markdown/five/type-aliases/NetworkErrorCallback.md +0 -21
  932. package/docs_markdown/five/type-aliases/NetworkProgressCallback.md +0 -21
  933. package/docs_markdown/five/type-aliases/NetworkResponse.md +0 -37
  934. package/docs_markdown/five/type-aliases/NetworkState.md +0 -11
  935. package/docs_markdown/five/type-aliases/NetworkSuccessCallback.md +0 -27
  936. package/docs_markdown/five/type-aliases/NetworkType.md +0 -11
  937. package/docs_markdown/five/type-aliases/PBMAlphaMode.md +0 -11
  938. package/docs_markdown/five/type-aliases/PBMColorStyle.md +0 -11
  939. package/docs_markdown/five/type-aliases/PBMFloorStyle.md +0 -11
  940. package/docs_markdown/five/type-aliases/PBMMeshShaderType.md +0 -11
  941. package/docs_markdown/five/type-aliases/PBMPointBack.md +0 -11
  942. package/docs_markdown/five/type-aliases/PBMPointCloudShaderType.md +0 -11
  943. package/docs_markdown/five/type-aliases/PBMPointShape.md +0 -11
  944. package/docs_markdown/five/type-aliases/PBMPointSize.md +0 -11
  945. package/docs_markdown/five/type-aliases/PBMTransition.md +0 -11
  946. package/docs_markdown/five/type-aliases/Pano.md +0 -27
  947. package/docs_markdown/five/type-aliases/PanoId.md +0 -11
  948. package/docs_markdown/five/type-aliases/ParseOptions.md +0 -65
  949. package/docs_markdown/five/type-aliases/PostProcessingType.md +0 -11
  950. package/docs_markdown/five/type-aliases/RegionBoundingVolumeJson.md +0 -19
  951. package/docs_markdown/five/type-aliases/RequestAnimationFrameArgs.md +0 -17
  952. package/docs_markdown/five/type-aliases/Scissor.md +0 -15
  953. package/docs_markdown/five/type-aliases/SphereBoundingVolumeJson.md +0 -19
  954. package/docs_markdown/five/type-aliases/SubscribeEventMap.md +0 -15
  955. package/docs_markdown/five/type-aliases/TileCacheOptions.md +0 -47
  956. package/docs_markdown/five/type-aliases/TileContentData.md +0 -51
  957. package/docs_markdown/five/type-aliases/TileRequestOrder.md +0 -11
  958. package/docs_markdown/five/type-aliases/TileRequestSchedulerOptions.md +0 -69
  959. package/docs_markdown/five/type-aliases/TilesetFrameState.md +0 -199
  960. package/docs_markdown/five/type-aliases/TrajectoryContentData.md +0 -59
  961. package/docs_markdown/five/type-aliases/WebXRControllerKey.md +0 -11
  962. package/docs_markdown/five/type-aliases/WebXRControllerType.md +0 -11
  963. package/docs_markdown/five/type-aliases/Works.md +0 -59
  964. package/docs_markdown/five/type-aliases/documents/plugins.md +0 -226
  965. package/docs_markdown/five/variables/PROXY_CONTROLLER_EVENT_NAMES.md +0 -11
  966. package/docs_markdown/five/variables/controllersDefaultInitArgs.md +0 -41
  967. package/docs_markdown/five/variables/draco.md +0 -11
  968. package/docs_markdown/five/variables/ktx2.md +0 -11
  969. package/docs_markdown/gltf-loader/README.md +0 -23
  970. package/docs_markdown/gltf-loader/classes/DDSLoader.md +0 -57
  971. package/docs_markdown/gltf-loader/classes/DRACOLoader.md +0 -143
  972. package/docs_markdown/gltf-loader/classes/GLTFLoader.md +0 -208
  973. package/docs_markdown/gltf-loader/classes/GLTFObject.md +0 -76
  974. package/docs_markdown/gltf-loader/classes/GLTFParser.md +0 -75
  975. package/docs_markdown/gltf-loader/classes/THREEGLTFLoader.md +0 -151
  976. package/docs_markdown/gltf-loader/interfaces/DDS.md +0 -57
  977. package/docs_markdown/gltf-loader/interfaces/GLTF.md +0 -98
  978. package/docs_markdown/gltf-loader/interfaces/GLTFReference.md +0 -25
  979. package/docs_markdown/gltf-loader/interfaces/THREEGLTF.md +0 -89
  980. package/docs_markdown/line/README.md +0 -20
  981. package/docs_markdown/line/classes/Line.md +0 -151
  982. package/docs_markdown/line/classes/LineGeometry.md +0 -273
  983. package/docs_markdown/line/classes/LineMaterial.md +0 -83
  984. package/docs_markdown/line/classes/LineSegmentsGeometry.md +0 -219
  985. package/docs_markdown/line/classes/THREE_Line2.md +0 -81
  986. package/docs_markdown/line/classes/THREE_LineSegments2.md +0 -81
  987. package/docs_markdown/line/type-aliases/LineMaterialParameters.md +0 -67
  988. package/docs_markdown/modules.md +0 -28
  989. package/docs_markdown/plugins/README.md +0 -43
  990. package/docs_markdown/plugins/classes/CSS3DRenderer.md +0 -93
  991. package/docs_markdown/plugins/classes/OrbitControls.md +0 -461
  992. package/docs_markdown/plugins/classes/RoundedBoxGeometry.md +0 -79
  993. package/docs_markdown/plugins/functions/BackgroundPlugin.md +0 -25
  994. package/docs_markdown/plugins/functions/DynamicPathLinePlugin.md +0 -25
  995. package/docs_markdown/plugins/functions/ItemMaskPlugin.md +0 -25
  996. package/docs_markdown/plugins/functions/OrientationPlugin.md +0 -25
  997. package/docs_markdown/plugins/functions/PanoAnimePlugin.md +0 -25
  998. package/docs_markdown/plugins/functions/TrajectoryPlugin.md +0 -25
  999. package/docs_markdown/plugins/interfaces/BackgroundPluginController.md +0 -313
  1000. package/docs_markdown/plugins/interfaces/DynamicPathLinePluginController.md +0 -755
  1001. package/docs_markdown/plugins/interfaces/ItemMaskController.md +0 -393
  1002. package/docs_markdown/plugins/interfaces/Keyframe.md +0 -25
  1003. package/docs_markdown/plugins/interfaces/OrientationPluginController.md +0 -491
  1004. package/docs_markdown/plugins/interfaces/PanoAnimeController.md +0 -365
  1005. package/docs_markdown/plugins/interfaces/PlayingState.md +0 -25
  1006. package/docs_markdown/plugins/interfaces/TrajectoryController.md +0 -609
  1007. package/docs_markdown/plugins/namespaces/BackgroundPluginType/README.md +0 -25
  1008. package/docs_markdown/plugins/namespaces/BackgroundPluginType/enumerations/WarningCodeType.md +0 -17
  1009. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/Config.md +0 -9
  1010. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/EventMap.md +0 -205
  1011. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/Params.md +0 -25
  1012. package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/PluginDataItem.md +0 -9
  1013. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/Mirror.md +0 -17
  1014. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/Mode.md +0 -11
  1015. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/PluginData.md +0 -11
  1016. package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/State.md +0 -19
  1017. package/docs_markdown/plugins/namespaces/BasePlugin/README.md +0 -22
  1018. package/docs_markdown/plugins/namespaces/BasePlugin/classes/Controller.md +0 -318
  1019. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/BaseOptions.md +0 -19
  1020. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/Config.md +0 -39
  1021. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/State.md +0 -49
  1022. package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/StateChangeParams.md +0 -45
  1023. package/docs_markdown/plugins/namespaces/BasePlugin/type-aliases/EventMap.md +0 -110
  1024. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/README.md +0 -20
  1025. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/Config.md +0 -181
  1026. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/EventMap.md +0 -261
  1027. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/Params.md +0 -37
  1028. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/PathConfig.md +0 -141
  1029. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/State.md +0 -67
  1030. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/type-aliases/PluginData.md +0 -21
  1031. package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/type-aliases/ServerData.md +0 -73
  1032. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/README.md +0 -21
  1033. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/Config.md +0 -11
  1034. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/EventMap.md +0 -109
  1035. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/ItemType.md +0 -121
  1036. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/MaskType.md +0 -33
  1037. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/Params.md +0 -27
  1038. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/State.md +0 -87
  1039. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/type-aliases/PluginData.md +0 -27
  1040. package/docs_markdown/plugins/namespaces/ItemMaskPluginType/type-aliases/ServerData.md +0 -27
  1041. package/docs_markdown/plugins/namespaces/OrientationPluginType/README.md +0 -19
  1042. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/Config.md +0 -27
  1043. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/EventMap.md +0 -109
  1044. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/Params.md +0 -27
  1045. package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/State.md +0 -67
  1046. package/docs_markdown/plugins/namespaces/OrientationPluginType/type-aliases/PluginData.md +0 -11
  1047. package/docs_markdown/plugins/namespaces/OrientationPluginType/type-aliases/ServerData.md +0 -11
  1048. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/README.md +0 -20
  1049. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/Config.md +0 -19
  1050. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/ConfigChangeEvent.md +0 -39
  1051. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/EventMap.md +0 -157
  1052. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/Params.md +0 -27
  1053. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/State.md +0 -57
  1054. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/type-aliases/PluginData.md +0 -11
  1055. package/docs_markdown/plugins/namespaces/PanoAnimePluginType/type-aliases/ServerData.md +0 -11
  1056. package/docs_markdown/plugins/namespaces/PluginTemplateType/README.md +0 -19
  1057. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/Config.md +0 -19
  1058. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/EventMap.md +0 -109
  1059. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/Params.md +0 -27
  1060. package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/State.md +0 -57
  1061. package/docs_markdown/plugins/namespaces/PluginTemplateType/type-aliases/PluginData.md +0 -11
  1062. package/docs_markdown/plugins/namespaces/PluginTemplateType/type-aliases/ServerData.md +0 -19
  1063. package/docs_markdown/react/README.md +0 -58
  1064. package/docs_markdown/react/classes/Store.md +0 -184
  1065. package/docs_markdown/react/functions/createFiveFeature.md +0 -27
  1066. package/docs_markdown/react/functions/createFiveProvider.md +0 -42
  1067. package/docs_markdown/react/functions/createStore.md +0 -158
  1068. package/docs_markdown/react/functions/unsafe__useFiveInstance.md +0 -27
  1069. package/docs_markdown/react/functions/useFiveAction.md +0 -82
  1070. package/docs_markdown/react/functions/useFiveCameraDirection.md +0 -19
  1071. package/docs_markdown/react/functions/useFiveCameraRaycaster.md +0 -19
  1072. package/docs_markdown/react/functions/useFiveCurrentObserver.md +0 -25
  1073. package/docs_markdown/react/functions/useFiveCurrentState.md +0 -25
  1074. package/docs_markdown/react/functions/useFiveEventCallback.md +0 -44
  1075. package/docs_markdown/react/functions/useFiveFloor.md +0 -25
  1076. package/docs_markdown/react/functions/useFiveHelper.md +0 -25
  1077. package/docs_markdown/react/functions/useFiveModelIntersectRaycaster.md +0 -45
  1078. package/docs_markdown/react/functions/useFiveModelReadyState.md +0 -20
  1079. package/docs_markdown/react/functions/useFiveProject2d.md +0 -49
  1080. package/docs_markdown/react/functions/useFiveSceneEffect.md +0 -39
  1081. package/docs_markdown/react/functions/useFiveState.md +0 -15
  1082. package/docs_markdown/react/functions/useFiveWork.md +0 -39
  1083. package/docs_markdown/react/functions/withFive.md +0 -47
  1084. package/docs_markdown/react/interfaces/FiveActionReactCallbacks.md +0 -270
  1085. package/docs_markdown/react/interfaces/FiveCanvasProps.md +0 -29
  1086. package/docs_markdown/react/interfaces/FiveInjectionTypes.md +0 -1075
  1087. package/docs_markdown/react/interfaces/PropTypeOfFiveFeatures.md +0 -23
  1088. package/docs_markdown/react/type-aliases/FiveInjectionActionFeature.md +0 -11
  1089. package/docs_markdown/react/type-aliases/FiveInjectionDataFeature.md +0 -11
  1090. package/docs_markdown/react/type-aliases/FiveInjectionFeature.md +0 -11
  1091. package/docs_markdown/react/type-aliases/FiveProviderPropTypes.md +0 -139
  1092. package/docs_markdown/react/type-aliases/FiveProviderType.md +0 -11
  1093. package/docs_markdown/react/type-aliases/StoreActionMapHanlder.md +0 -25
  1094. package/docs_markdown/react/type-aliases/StoreActionMapType.md +0 -15
  1095. package/docs_markdown/react/type-aliases/StoreProviderType.md +0 -11
  1096. package/docs_markdown/react/type-aliases/StoreValueMapType.md +0 -11
  1097. package/docs_markdown/react/variables/FiveCanvas.md +0 -25
  1098. package/docs_markdown/react/variables/INJECTION_PROPNAME.md +0 -11
  1099. package/docs_markdown/react/variables/useFiveScene.md +0 -43
  1100. package/docs_markdown/sticker/README.md +0 -15
  1101. package/docs_markdown/sticker/classes/Sticker.md +0 -208
  1102. package/docs_markdown/sticker/interfaces/IntersectionLike.md +0 -39
  1103. package/docs_markdown/vfx/README.md +0 -27
  1104. package/docs_markdown/vfx/classes/Airflow.md +0 -175
  1105. package/docs_markdown/vfx/classes/Flame.md +0 -241
  1106. package/docs_markdown/vfx/classes/Particle.md +0 -488
  1107. package/docs_markdown/vfx/classes/ParticleGPU.md +0 -195
  1108. package/docs_markdown/vfx/classes/SpotLight.md +0 -159
  1109. package/docs_markdown/vfx/interfaces/ParticleArgs.md +0 -338
  1110. package/docs_markdown/vfx/interfaces/ParticleGPUArgs.md +0 -301
  1111. package/docs_markdown/vfx/interfaces/ParticleGPUTweenKeyframe.md +0 -31
  1112. package/docs_markdown/vfx/interfaces/ParticleTweenKeyframe.md +0 -31
  1113. package/docs_markdown/vfx/type-aliases/ParticleGPUType.md +0 -11
  1114. package/docs_markdown/vfx/type-aliases/ParticleType.md +0 -11
  1115. package/docs_markdown/vue/README.md +0 -42
  1116. package/docs_markdown/vue/functions/unsafe__useFiveInject.md +0 -27
  1117. package/docs_markdown/vue/functions/useFiveAction.md +0 -104
  1118. package/docs_markdown/vue/functions/useFiveCameraDirection.md +0 -19
  1119. package/docs_markdown/vue/functions/useFiveCameraRaycaster.md +0 -19
  1120. package/docs_markdown/vue/functions/useFiveCurrentObserver.md +0 -25
  1121. package/docs_markdown/vue/functions/useFiveCurrentState.md +0 -25
  1122. package/docs_markdown/vue/functions/useFiveEventCallback.md +0 -40
  1123. package/docs_markdown/vue/functions/useFiveFloor.md +0 -25
  1124. package/docs_markdown/vue/functions/useFiveHelper.md +0 -25
  1125. package/docs_markdown/vue/functions/useFiveModel.md +0 -17
  1126. package/docs_markdown/vue/functions/useFiveModelBounding.md +0 -17
  1127. package/docs_markdown/vue/functions/useFiveModelIntersectRaycaster.md +0 -35
  1128. package/docs_markdown/vue/functions/useFiveModelReadyState.md +0 -20
  1129. package/docs_markdown/vue/functions/useFiveProject2d.md +0 -38
  1130. package/docs_markdown/vue/functions/useFiveScene.md +0 -17
  1131. package/docs_markdown/vue/functions/useFiveState.md +0 -25
  1132. package/docs_markdown/vue/functions/useFiveWorks.md +0 -39
  1133. package/docs_markdown/vue/interfaces/FiveActionVueCallbacks.md +0 -301
  1134. package/docs_markdown/vue/type-aliases/FiveModelIntersectRaycaster.md +0 -21
  1135. package/docs_markdown/vue/type-aliases/FiveProviderComponent.md +0 -11
  1136. package/docs_markdown/vue/type-aliases/Project2d.md +0 -25
  1137. package/docs_markdown/vue/variables/FiveCanvas.md +0 -37
  1138. package/docs_markdown/vue/variables/FiveProvider.md +0 -32
@@ -0,0 +1,210 @@
1
+ # 插件系统 (Plugin System)
2
+
3
+ - **Summary**: Five 插件系统基于 `BasePlugin` 命名空间构建,提供了一套标准化的状态管理、生命周期控制和事件通信机制。
4
+ - **Schema**: 核心类型定义位于 `BasePlugin` 命名空间。
5
+ - **Concepts**: BasePlugin, State, Lifecycle, Controller.
6
+ - **Configuration**: 插件特定的参数配置。
7
+ - **Examples**: 标准插件开发示例。
8
+
9
+ ## Schema
10
+
11
+ > **Definition**: [BasePlugin](../../plugins/BasePlugin/index.d.ts)
12
+
13
+ `BasePlugin` 是一个命名空间,包含 `Controller` (抽象基类), `State` (状态接口), `EventMap` (事件映射) 等核心定义。
14
+
15
+ ```typescript
16
+ export namespace BasePlugin {
17
+ export interface State {
18
+ enabled: boolean
19
+ visible?: boolean
20
+ config?: unknown
21
+ }
22
+ export abstract class Controller<PluginState, PluginEventMap, PluginServerData, PluginData> {
23
+ public five: Five
24
+ public abstract state: PluginState
25
+ public hooks: Subscribe<PluginEventMap>
26
+ // ...
27
+ }
28
+ }
29
+ ```
30
+
31
+ ## Concepts
32
+
33
+ ### Directory Structure (目录结构)
34
+
35
+ 一个标准的插件通常包含以下文件:
36
+
37
+ ```text
38
+ PluginName/
39
+ ├── index.ts # 插件入口,导出工厂函数和类型
40
+ ├── Controller.ts # 插件控制器,核心逻辑实现
41
+ └── typing.ts # 类型定义
42
+ ```
43
+
44
+ ### BasePlugin
45
+
46
+ 所有插件推荐继承 `BasePlugin.Controller`。它定义了规范的泛型接口:
47
+
48
+ - `PluginState`: 插件状态类型,继承自 `BasePlugin.State`。
49
+ - `PluginEventMap`: 插件事件类型,继承自 `BasePlugin.EventMap`。
50
+ - `PluginServerData`: 服务端原始数据类型。
51
+ - `PluginData`: 解析后的插件数据类型。
52
+
53
+ ### State (状态)
54
+
55
+ 插件的状态驱动其行为。`BasePlugin.State` 定义了最基本的状态:
56
+
57
+ - `enabled`: 是否启用。
58
+ - `visible`: UI 是否可见。
59
+ - `config`: 配置项。
60
+
61
+ ### Lifecycle (生命周期)
62
+
63
+ 插件的主要生命周期方法:
64
+
65
+ - **constructor**: 初始化配置和初始状态。
66
+ - **load**: 加载和解析数据。
67
+ - **enable**: 启用插件,注册事件监听,添加副作用。
68
+ - **disable**: 禁用插件,移除事件监听,清理副作用。
69
+ - **dispose**: 销毁插件,彻底清理资源。
70
+
71
+ ## Configuration
72
+
73
+ ### BasePlugin Configuration
74
+
75
+ `BasePlugin` 控制器构造函数接受可选的配置对象:
76
+
77
+ | Parameter | Type | Default | Description |
78
+ | :--- | :--- | :--- | :--- |
79
+ | `staticPrefix` | `string` | `'//vr-image-4.realsee-cdn.cn'` | 静态资源前缀。 |
80
+ | `i18n` | `(key: string) => string` | `undefined` | 国际化转换函数。 |
81
+
82
+ ## Examples
83
+
84
+ ### Plugin Development Walkthrough (插件开发指南)
85
+
86
+ 以创建一个 `MyPlugin` 为例。
87
+
88
+ #### 1. 定义类型 (typing.ts)
89
+
90
+ 定义插件所需的参数、状态、数据和事件类型。
91
+
92
+ ```typescript
93
+ import { BasePlugin } from '../BasePlugin'
94
+
95
+ // 1. 定义参数
96
+ export interface Params extends BasePlugin.Config {
97
+ initialState?: Partial<State>
98
+ config?: Config
99
+ }
100
+
101
+ // 2. 定义配置
102
+ export interface Config {
103
+ color?: string
104
+ }
105
+
106
+ // 3. 定义状态 (继承 BasePlugin.State)
107
+ export interface State extends BasePlugin.State {
108
+ activeId?: string
109
+ }
110
+
111
+ // 4. 定义数据类型
112
+ export interface ServerData { /* 服务端数据结构 */ }
113
+ export interface PluginData { /* 解析后的数据结构 */ }
114
+
115
+ // 5. 定义事件 (继承 BasePlugin.EventMap)
116
+ export interface EventMap extends BasePlugin.EventMap<State, PluginData> {
117
+ click: (id: string) => void
118
+ }
119
+ ```
120
+
121
+ #### 2. 实现控制器 (Controller.ts)
122
+
123
+ 继承 `BasePlugin.Controller` 并实现核心逻辑。
124
+
125
+ ```typescript
126
+ import { Five } from '@realsee/five'
127
+ import { BasePlugin } from '../BasePlugin'
128
+ import * as MyPluginType from './typing'
129
+
130
+ export class Controller extends BasePlugin.Controller<
131
+ MyPluginType.State,
132
+ MyPluginType.EventMap,
133
+ MyPluginType.ServerData,
134
+ MyPluginType.PluginData
135
+ > {
136
+ public state: MyPluginType.State
137
+
138
+ constructor(five: Five, params?: MyPluginType.Params) {
139
+ super(five)
140
+ this.state = {
141
+ enabled: true,
142
+ visible: true,
143
+ ...params?.initialState
144
+ }
145
+ if (this.state.enabled) {
146
+ this._enable()
147
+ }
148
+ }
149
+
150
+ public async load(serverData: MyPluginType.ServerData) {
151
+ // 解析数据
152
+ }
153
+
154
+ public enable() {
155
+ if (this.state.enabled) return
156
+ this.state.enabled = true
157
+ this._enable()
158
+ this.hooks.emit('stateChange', { state: this.state, userAction: true })
159
+ }
160
+
161
+ public disable() {
162
+ if (!this.state.enabled) return
163
+ this.state.enabled = false
164
+ this._disable()
165
+ this.hooks.emit('stateChange', { state: this.state, userAction: true })
166
+ }
167
+
168
+ public dispose = () => {
169
+ this.disable()
170
+ this.hooks.emit('dispose')
171
+ }
172
+
173
+ private _enable() {
174
+ // five.scene.add(...)
175
+ // five.on('tap', this.onTap)
176
+ }
177
+
178
+ private _disable() {
179
+ // five.scene.remove(...)
180
+ // five.off('tap', this.onTap)
181
+ }
182
+ }
183
+ ```
184
+
185
+ #### 3. 导出插件 (index.ts)
186
+
187
+ 提供一个工厂函数。
188
+
189
+ ```typescript
190
+ import { Five } from '@realsee/five'
191
+ import { Controller } from './Controller'
192
+ import * as MyPluginType from './typing'
193
+
194
+ export const MyPlugin = (five: Five, params?: MyPluginType.Params) =>
195
+ new Controller(five, params)
196
+
197
+ export type { MyPluginType, Controller as MyPluginController }
198
+ ```
199
+
200
+ ## Common Pitfalls (最佳实践)
201
+
202
+ 1. **状态驱动**: 始终通过修改 `state` 来驱动插件行为,而不是直接操作 DOM 或 3D 对象。
203
+ 2. **清理资源**: 在 `disable` 和 `dispose` 中务必清理所有事件监听和副作用,防止内存泄漏。
204
+ 3. **类型安全**: 充分利用 TypeScript 泛型,确保事件和状态的类型安全。
205
+
206
+ ---
207
+
208
+ ```yaml
209
+ tags: [plugin, baseplugin, development, guide]
210
+ ```
@@ -0,0 +1,259 @@
1
+ # 后处理 (Post Processing)
2
+
3
+ - **Summary**: Five 提供了基于 EffectComposer 的后处理机制,默认挂载了自适应亮度 (Auto Exposure) 和眼球穹顶光照 (EDL) 两种效果,同时提供多种可选内置 Pass,并支持开发者编写自定义 Pass。
4
+ - **Schema**: `FivePass` 类及 `Pass` 接口。
5
+ - **Concepts**: EffectComposer, G-Buffer, Pass, AdaptiveLuminance, EyeDomeLighting。
6
+ - **Configuration**: 开启内置 Pass 的开关及参数配置。
7
+ - **Examples**: 开启内置 Pass 示例,自定义黑白滤镜 Pass 示例。
8
+
9
+ ## Schema
10
+
11
+ > **Definition**: [FivePass](../../five/renderer/postprocessing/passes/pass.d.ts)
12
+
13
+ ```typescript
14
+ /**
15
+ * Pass 接口 (兼容 three.js EffectComposer)
16
+ */
17
+ export interface Pass {
18
+ enabled: boolean;
19
+ needsSwap: boolean;
20
+ clear: boolean;
21
+ renderToScreen: boolean;
22
+ setSize(width: number, height: number): void;
23
+ render(
24
+ renderer: THREE.WebGLRenderer,
25
+ writeBuffer: THREE.WebGLRenderTarget,
26
+ readBuffer: THREE.WebGLRenderTarget,
27
+ deltaTime?: number,
28
+ maskActive?: boolean
29
+ ): void;
30
+ }
31
+
32
+ /**
33
+ * FivePass 基类
34
+ * 支持 G-Buffer 注入 (depth, normal, color)
35
+ */
36
+ export class FivePass implements Pass {
37
+ public enabled: boolean = true;
38
+ public needsSwap: boolean = true;
39
+ public clear: boolean = false;
40
+ public renderToScreen: boolean = true;
41
+ public dependencies: ('depth' | 'normal' | 'color')[];
42
+
43
+ // 由 EffectComposer 在 render 时注入
44
+ public gbuffer!: Map<'depth' | 'normal' | 'color', THREE.Texture>;
45
+
46
+ constructor(dependencies?: ('depth' | 'normal' | 'color')[]);
47
+ // ... render method implementation
48
+ }
49
+ ```
50
+
51
+ ## Concepts
52
+
53
+ - **EffectComposer**: 后处理管理器,负责按顺序执行 Pass,管理渲染目标 (RenderTarget) 和 G-Buffer。
54
+ - **FivePass**: Five 引擎优化的 Pass 基类。相比普通 Pass,它声明了 `dependencies`,Five 会在渲染 Pass 之前准备好所需的 G-Buffer (如深度图、法线图),避免在每个 Pass 中重复渲染场景。
55
+ - **AdaptiveLuminancePass (自适应亮度)**: 模拟人眼对光线的适应过程。当场景亮度变化时,会自动平滑调整曝光度,使画面保持在舒适的亮度范围内。
56
+ - **EyeDomeLightingPass (EDL)**: 一种非真实感渲染技术,主要用于增强点云模型的深度感知。通过屏幕空间的深度差计算遮蔽效果,让点云看起来更有轮廓感。
57
+
58
+ ## Built-in Passes (内置 Pass)
59
+
60
+ Five 默认挂载了两个 Pass 实例,挂载在 `five` 实例上,默认是关闭状态。
61
+
62
+ ### 1. AdaptiveLuminancePass
63
+
64
+ 位于 `five.adaptiveLuminancePass`。
65
+
66
+ * **作用**: 自动调整画面曝光。
67
+ * **开启方式**: `five.adaptiveLuminancePass.enabled = true`。
68
+ * **配置项**:
69
+ * `luminanceScale` (number): 亮度缩放系数,影响最终画面的整体亮度。
70
+ * `luminanceStep` (number): 亮度适应步长,影响适应速度。
71
+
72
+ ### 2. EyeDomeLightingPass
73
+
74
+ 位于 `five.eyeDomeLightingPass`。
75
+
76
+ * **作用**: 增强点云的轮廓和深度感。
77
+ * **开启方式**: `five.eyeDomeLightingPass.enabled = true`。
78
+ * **配置项**:
79
+ * `strength` (number): 增强强度,值越大轮廓越明显。
80
+ * `radius` (number): 采样半径,影响阴影的范围。
81
+ * **注意**: 这是一个基于屏幕空间深度的算法,依赖 Depth Buffer。
82
+
83
+ ### 3. Optional Built-in Passes (可选内置 Pass)
84
+
85
+ Five 新增了三个可选使用的内置 Pass,这些 Pass 没有预先挂载在 `five` 实例上,需手动导入并添加到渲染链中:
86
+
87
+ * **[GaussianBlurPass](gaussian-blur-pass.md)**: 高斯模糊效果。
88
+ * **[FlowingLight2DPass](flowing-light-2d-pass.md)**: 2D 流光效果(通常用于平面路线流光)。
89
+ * **[FlowingLight3DPass](flowing-light-3d-pass.md)**: 3D 流光效果(通常用于空间路径流光)。
90
+
91
+ #### GaussianBlurPass 使用示例
92
+
93
+ ```typescript
94
+ import { GaussianBlurPass } from '@realsee/five';
95
+
96
+ // 1. 创建 GaussianBlurPass 实例 (需要传入 camera)
97
+ const gaussianBlurPass = new GaussianBlurPass(five.camera);
98
+
99
+ // 2. 配置参数
100
+ // 设置模糊半径 (默认 4.0)
101
+ gaussianBlurPass.setRadius(6);
102
+
103
+ // 3. 将 Pass 添加到渲染链
104
+ five.addPass(gaussianBlurPass);
105
+
106
+ // 4. (可选) 动态开关
107
+ // gaussianBlurPass.enabled = false;
108
+
109
+ // 5. (可选) 移除 Pass
110
+ // five.removePass(gaussianBlurPass);
111
+ ```
112
+
113
+ ## Custom Pass (自定义 Pass)
114
+
115
+ 如果需要实现自定义的后处理效果(如景深、色彩校正、描边等),建议继承 `FivePass`。
116
+
117
+ ### 步骤
118
+
119
+ 1. **创建类**: 继承 `FivePass`。
120
+ 2. **声明依赖**: 在 `super()` 中传入需要的 G-Buffer 依赖 (如 `['depth']`)。
121
+ 3. **实现 render**: 使用 `readBuffer` 作为输入,将结果渲染到 `writeBuffer` (或直接渲染到屏幕)。
122
+ 4. **挂载**: 使用 `five.addPass(pass)` 将其实例添加到渲染链中。
123
+
124
+ ## Examples
125
+
126
+ ### 开启内置 Pass
127
+
128
+ ```typescript
129
+ import { Five } from '@realsee/five';
130
+
131
+ const five = new Five();
132
+
133
+ // 开启自适应亮度
134
+ five.adaptiveLuminancePass.enabled = true;
135
+ five.adaptiveLuminancePass.luminanceScale = 0.5; // 调整目标亮度
136
+
137
+ // 开启 EDL (通常用于点云模式)
138
+ five.eyeDomeLightingPass.enabled = true;
139
+ five.eyeDomeLightingPass.strength = 1.5; // 增强轮廓感
140
+
141
+ five.needsRender = true;
142
+ ```
143
+
144
+ ### 自定义 Pass (黑白滤镜)
145
+
146
+ ```typescript
147
+ import * as THREE from 'three';
148
+ import { Five, FivePass } from '@realsee/five';
149
+ import { FullScreenQuad } from '@realsee/five/lib/five/tools/full-screen-quad'; // 需根据实际路径引用
150
+
151
+ // 1. 定义 Shader
152
+ const grayscaleVertexShader = `
153
+ varying vec2 vUv;
154
+ void main() {
155
+ vUv = uv;
156
+ gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);
157
+ }
158
+ `;
159
+
160
+ const grayscaleFragmentShader = `
161
+ uniform sampler2D tDiffuse;
162
+ varying vec2 vUv;
163
+ void main() {
164
+ vec4 color = texture2D(tDiffuse, vUv);
165
+ float gray = dot(color.rgb, vec3(0.299, 0.587, 0.114));
166
+ gl_FragColor = vec4(vec3(gray), color.a);
167
+ }
168
+ `;
169
+
170
+ // 2. 创建 Pass 类
171
+ class GrayscalePass extends FivePass {
172
+ private material: THREE.ShaderMaterial;
173
+ private fsQuad: FullScreenQuad;
174
+
175
+ constructor() {
176
+ super(); // 不需要额外的 G-Buffer 依赖,只需要前一个 Pass 的颜色结果
177
+ this.material = new THREE.ShaderMaterial({
178
+ uniforms: {
179
+ tDiffuse: { value: null }
180
+ },
181
+ vertexShader: grayscaleVertexShader,
182
+ fragmentShader: grayscaleFragmentShader
183
+ });
184
+ this.fsQuad = new FullScreenQuad(this.material);
185
+ }
186
+
187
+ render(renderer, writeBuffer, readBuffer) {
188
+ // 将上一个 Pass 的结果 (readBuffer) 传给 Shader
189
+ this.material.uniforms.tDiffuse.value = readBuffer.texture;
190
+
191
+ if (this.renderToScreen) {
192
+ // 如果是最后一个 Pass,直接渲染到屏幕
193
+ renderer.setRenderTarget(null);
194
+ this.fsQuad.render(renderer);
195
+ } else {
196
+ // 否则渲染到 writeBuffer,供下一个 Pass 使用
197
+ renderer.setRenderTarget(writeBuffer);
198
+ if (this.clear) renderer.clear();
199
+ this.fsQuad.render(renderer);
200
+ }
201
+ }
202
+ }
203
+
204
+ // 3. 挂载到 Five
205
+ const grayPass = new GrayscalePass();
206
+ five.addPass(grayPass);
207
+
208
+ // 触发重绘
209
+ five.needsRender = true;
210
+ ```
211
+
212
+ ### 使用 G-Buffer (深度图示例)
213
+
214
+ 如果你的 Pass 需要使用场景的深度信息(例如雾效),可以在构造函数中声明依赖。
215
+
216
+ ```typescript
217
+ class FogPass extends FivePass {
218
+ constructor() {
219
+ super(['depth']); // 声明需要深度图
220
+ }
221
+
222
+ render(renderer, writeBuffer, readBuffer) {
223
+ // 获取深度图
224
+ const depthTexture = this.gbuffer.get('depth');
225
+
226
+ // 在 Shader 中使用 depthTexture ...
227
+ // this.material.uniforms.tDepth.value = depthTexture;
228
+
229
+ // ... 渲染逻辑
230
+ }
231
+ }
232
+ ```
233
+
234
+ ## Debugging
235
+
236
+ * **查看 Pass 列表**: 检查 `five.fiveRenderer.composer.passes` 数组,确认 Pass 是否已添加以及顺序是否正确。
237
+ * **检查 Enabled 状态**: 确保 Pass 实例的 `.enabled` 属性为 `true`。
238
+ * **G-Buffer 调试**: 如果自定义 Pass 依赖 G-Buffer 但效果不对,检查 `this.gbuffer` 是否包含预期的纹理。
239
+
240
+ ## Common Pitfalls
241
+
242
+ 1. **Pass 顺序**: 后处理是按顺序执行的。如果添加了多个 Pass,要注意它们的添加顺序。`addPass` 会添加到末尾,`insertPass` 可以插入到指定位置。
243
+ 2. **renderToScreen**: 只有链中的最后一个 Pass (且 `renderToScreen` 为 true) 才会渲染到屏幕。EffectComposer 会自动管理这个标志,但自定义 Pass 必须在 `render` 方法中正确处理 `this.renderToScreen` 逻辑。
244
+ 3. **Performance**: 过多的后处理 Pass 会显著降低帧率,尤其是在高分辨率屏幕上。尽量合并 Shader 逻辑,避免频繁的 Buffer 拷贝。
245
+ 4. **Dependencies**: 只有继承 `FivePass` 并声明了 `dependencies`,`this.gbuffer` 才会有值。普通 `Pass` 实现无法自动获取 G-Buffer。
246
+
247
+ ## Related
248
+
249
+ * [Gaussian Blur Pass](gaussian-blur-pass.md): 高斯模糊 Pass 文档。
250
+ * [Flowing Light 2D Pass](flowing-light-2d-pass.md): 2D 流光 Pass 文档。
251
+ * [Flowing Light 3D Pass](flowing-light-3d-pass.md): 3D 流光 Pass 文档。
252
+ * [five.ts](../../five/application/five.d.ts): 查看 `addPass` 方法的实现。
253
+ * [pass.ts](../../five/renderer/postprocessing/passes/pass.d.ts): 查看 `FivePass` 基类定义。
254
+
255
+ ---
256
+
257
+ ```yaml
258
+ tags: [postprocessing, shader, effect, adaptive-luminance, edl]
259
+ ```
@@ -0,0 +1,175 @@
1
+ # Raycast (射线检测)
2
+
3
+ - **Summary**: Five 提供了增强版的射线检测机制,内置 BVH 加速,并扩展了 Three.js Raycaster 以支持更灵活的过滤和性能优化。
4
+ - **Schema**: 参见下方 `Three.js Raycaster Extensions`。
5
+ - **Concepts**: BVH, IntersectRaycaster, Raycaster Extensions。
6
+ - **Examples**: 提供基础检测与性能优化示例。
7
+
8
+ ## Schema: Three.js Raycaster Extensions
9
+
10
+ > **Definition**: [Raycaster](../../five/declare.d.ts)
11
+
12
+ Five 对 Three.js 的 `Raycaster` 进行了扩展,在 `declare module 'three'` 中增加了以下属性:
13
+
14
+ ```typescript
15
+ // defined in five/declare.d.ts
16
+ declare module 'three' {
17
+ export interface Raycaster {
18
+ /**
19
+ * 只捕获第一个焦点 (性能优化)
20
+ * - true: 找到第一个交点后立即停止检测,返回结果。
21
+ * - false (默认): 检测所有可能的交点。
22
+ */
23
+ firstHitOnly?: boolean;
24
+
25
+ /**
26
+ * 自定义交点过滤器
27
+ * - 回调函数,返回 boolean。
28
+ * - true: 保留该交点。
29
+ * - false: 丢弃该交点。
30
+ */
31
+ hitFilter?: (intersect: THREE.Intersection) => boolean;
32
+
33
+ /**
34
+ * 是否由近及远排序
35
+ * - true (默认): 返回的结果数组按距离摄像机从近到远排序。
36
+ * - false: 结果顺序不确定(通常按遍历顺序)。
37
+ */
38
+ sortByDistance?: boolean;
39
+
40
+ /**
41
+ * 作用楼层 (Five 特有逻辑)
42
+ * - 用于多楼层场景过滤。
43
+ */
44
+ floorIndex?: number;
45
+ }
46
+
47
+ export interface Intersection {
48
+ /** 命中的具体 Tile 对象 (仅 3DTiles) */
49
+ tile?: Tile;
50
+ /** 命中的 ViewLayer 对象 */
51
+ viewLayer?: ViewLayer;
52
+ /** 命中的 Model 对象 */
53
+ model?: Model;
54
+ }
55
+ }
56
+ ```
57
+
58
+ ## Concepts
59
+
60
+ ### 1. Five 内置 BVH (Bounding Volume Hierarchy)
61
+ Five 内置了一套高效的 BVH 实现,用于优化 `Mesh` 和 `Points` 的射线检测。
62
+ * **作用**: 在进行射线检测时,不直接遍历所有三角形或点,而是先与构建好的 BVH 树(包围盒层次结构)进行相交测试。只有当射线穿过包围盒时,才进一步检测内部的几何体。
63
+ * **优势**: 极大提升了复杂模型(如数十万面的 Mesh 或百万级 Points)的碰撞检测性能。
64
+ * **透明性**: 开发者通常无需手动操作 BVH,Five 在加载模型时会自动构建,并在调用 `intersectRaycaster` 时自动应用。
65
+
66
+ ### 2. models.intersectRaycaster / model.intersectRaycaster vs 原生 intersectObject
67
+
68
+ Five 提供了 `model.intersectRaycaster` 方法,与 Three.js 原生的 `raycaster.intersectObject` 有显著区别:
69
+
70
+ | 特性 | `five.model.intersectRaycaster` | `raycaster.intersectObject` (Three.js 原生) |
71
+ | :--- | :--- | :--- |
72
+ | **检测范围** | 聚合检测 `five.model.shownModels` 中所有可见模型。 | 仅检测指定的单个 Object3D 及其子节点。 |
73
+ | **结果排序** | 自动合并所有模型的检测结果,并根据 `raycaster.sortByDistance` 排序。 | 仅对当前 Object 及其子节点的结果排序。 |
74
+ | **扩展支持** | **支持** `firstHitOnly`, `hitFilter`, `sortByDistance` 等扩展属性。 | 不支持 Five 的扩展属性(需手动实现)。 |
75
+ | **内部优化** | 自动调用模型内部的优化逻辑(如 BVH, Tile3D 的空间索引)。 | 仅进行标准的场景图遍历检测。 |
76
+ | **使用场景** | **推荐**。适用于全局点击、地板检测、物体拾取等业务场景。 | 仅在需要检测特定原生 Object3D 时使用。 |
77
+
78
+ ## Examples
79
+
80
+ ### 基础用法:检测点击位置
81
+
82
+ 最常见的场景是将鼠标点击的屏幕坐标转换为 3D 空间中的点。
83
+
84
+ ```typescript
85
+ import * as THREE from 'three';
86
+ import { Five } from '@realsee/five';
87
+
88
+ const five = new Five();
89
+ // ... 初始化 ...
90
+
91
+ const raycaster = new THREE.Raycaster();
92
+ const vector = new THREE.Vector2();
93
+
94
+ // 假设 onTap 是点击事件处理函数
95
+ function onTap(event: { x: number, y: number }) {
96
+ // 1. 将屏幕坐标转换为归一化设备坐标 (NDC)
97
+ // 注意:five.getElement() 获取 canvas 容器
98
+ const element = five.getElement();
99
+ if (!element) return;
100
+
101
+ const rect = element.getBoundingClientRect();
102
+ vector.x = ((event.x - rect.left) / rect.width) * 2 - 1;
103
+ vector.y = -((event.y - rect.top) / rect.height) * 2 + 1;
104
+
105
+ // 2. 设置射线
106
+ raycaster.setFromCamera(vector, five.camera);
107
+
108
+ // 3. 调用 Five 的检测方法
109
+ const intersects = five.model.intersectRaycaster(raycaster);
110
+
111
+ if (intersects.length > 0) {
112
+ const firstHit = intersects[0];
113
+ console.log('点击到了模型:', firstHit.object);
114
+ console.log('交点坐标 (世界坐标):', firstHit.point);
115
+ }
116
+ }
117
+ ```
118
+
119
+ ### 性能优化:只获取第一个交点
120
+
121
+ 在进行如“地面检测”或“视线遮挡检测”时,通常只需要知道最近的交点。此时开启 `firstHitOnly` 可以显著提升性能。
122
+
123
+ ```typescript
124
+ const raycaster = new THREE.Raycaster();
125
+ raycaster.setFromCamera(mouseVector, five.camera);
126
+
127
+ // 开启性能优化:找到最近的一个交点后立即停止
128
+ raycaster.firstHitOnly = true;
129
+
130
+ // 结果数组长度最多为 1
131
+ const intersects = five.model.intersectRaycaster(raycaster);
132
+
133
+ if (intersects.length > 0) {
134
+ // 处理最近的交点
135
+ }
136
+ ```
137
+
138
+ ### 高级用法:使用过滤器
139
+
140
+ 如果你只想检测特定类型的物体(例如只检测地板,忽略天花板),可以使用 `hitFilter`。
141
+
142
+ ```typescript
143
+ raycaster.hitFilter = (intersect) => {
144
+ // 示例:假设地板的法线是向上的 (0, 1, 0)
145
+ // 只保留法线朝上的交点(地板)
146
+ if (intersect.face && intersect.face.normal.y > 0.5) {
147
+ return true; // 保留
148
+ }
149
+ return false; // 丢弃
150
+ };
151
+
152
+ const intersects = five.model.intersectRaycaster(raycaster);
153
+ ```
154
+
155
+ ## Debugging
156
+
157
+ * **验证交点**: 在开发阶段,可以在交点处添加一个临时的红色小球 `THREE.Mesh`,直观地确认检测位置是否正确。
158
+ * **检查模型可见性**: `intersectRaycaster` 只会检测 `visible = true` 的模型。如果检测不到,请检查模型的可见性状态。
159
+ * **Performance**: 如果射线检测导致掉帧,检查是否频繁调用了全场景检测。尝试使用 `firstHitOnly` 或减小检测频率(如节流)。
160
+
161
+ ## Common Pitfalls
162
+
163
+ 1. **混淆 API**: 错误地使用 `raycaster.intersectObject(five.scene)`。虽然这也能工作,但会失去 Five 的 BVH 优化和多模型聚合能力,导致性能下降或漏检。请始终优先使用 `five.model.intersectRaycaster(raycaster)`。
164
+ 2. **忽略坐标系**: `raycaster.setFromCamera` 需要 NDC 坐标(-1 到 1),而不是像素坐标。务必进行正确的坐标转换。
165
+ 3. **Tile3D 模型的特殊性**: 对于大型 Tile3D 场景,射线检测可能涉及动态加载的瓦片。Five 内部已处理这些逻辑,外部调用方式不变,但返回的 `object` 可能是某个具体的 Tile 节点。
166
+
167
+ ## Related
168
+
169
+ * [parameter.md](./parameter.md): 了解模型参数配置。
170
+
171
+ ---
172
+
173
+ ```yaml
174
+ tags: [raycast, bvh, interaction, performance]
175
+ ```