@realsee/five-webgpu 1.0.0-alpha.1

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 (674) hide show
  1. package/AGENTS_READ_ME.md +9 -0
  2. package/AI_CONTEXT.md +9 -0
  3. package/README.md +80 -0
  4. package/TERMS.txt +54 -0
  5. package/ai_guides/README.md +118 -0
  6. package/ai_guides/ai-doc-guidelines.md +102 -0
  7. package/ai_guides/api.md +274 -0
  8. package/ai_guides/features/3dtile.md +172 -0
  9. package/ai_guides/features/camera-animation.md +205 -0
  10. package/ai_guides/features/clipper.md +135 -0
  11. package/ai_guides/features/coordinate-system.md +128 -0
  12. package/ai_guides/features/event.md +154 -0
  13. package/ai_guides/features/five.md +184 -0
  14. package/ai_guides/features/gesture.md +181 -0
  15. package/ai_guides/features/get-screen-pixels.md +182 -0
  16. package/ai_guides/features/image-options.md +164 -0
  17. package/ai_guides/features/load-external-model.md +350 -0
  18. package/ai_guides/features/load-progress.md +140 -0
  19. package/ai_guides/features/material.md +153 -0
  20. package/ai_guides/features/mode.md +269 -0
  21. package/ai_guides/features/model.md +186 -0
  22. package/ai_guides/features/move-pano-effect.md +145 -0
  23. package/ai_guides/features/multi-work.md +146 -0
  24. package/ai_guides/features/pano-filter.md +144 -0
  25. package/ai_guides/features/pano-tile.md +132 -0
  26. package/ai_guides/features/pano-uv.md +131 -0
  27. package/ai_guides/features/parameter.md +153 -0
  28. package/ai_guides/features/raycast.md +175 -0
  29. package/ai_guides/features/request-proxy.md +112 -0
  30. package/ai_guides/features/screen-project.md +165 -0
  31. package/ai_guides/features/state.md +101 -0
  32. package/ai_guides/features/ultra-hdr.md +204 -0
  33. package/ai_guides/features/view-layer.md +187 -0
  34. package/ai_guides/features/work.md +303 -0
  35. package/ai_guides/glossary.md +93 -0
  36. package/ai_guides/intro.md +23 -0
  37. package/ai_guides/quick-start.md +69 -0
  38. package/ai_guides/release_notes/6.6.md +86 -0
  39. package/ai_guides/release_notes/6.7.md +401 -0
  40. package/ai_guides/release_notes/6.8.md +208 -0
  41. package/ai_guides/support.md +23 -0
  42. package/ai_guides/template.md +70 -0
  43. package/docs/.nojekyll +1 -0
  44. package/docs/00_FOR_AI_AGENTS.md +12 -0
  45. package/docs/README.md +12 -0
  46. package/docs/assets/hierarchy.js +1 -0
  47. package/docs/assets/highlight.css +134 -0
  48. package/docs/assets/icons.js +18 -0
  49. package/docs/assets/icons.svg +1 -0
  50. package/docs/assets/main.js +60 -0
  51. package/docs/assets/navigation.js +1 -0
  52. package/docs/assets/search.js +1 -0
  53. package/docs/assets/style.css +1633 -0
  54. package/docs/classes/index.AdaptiveLuminancePass.html +23 -0
  55. package/docs/classes/index.AnimationFrameLoop.html +18 -0
  56. package/docs/classes/index.BoundingMesh.html +4 -0
  57. package/docs/classes/index.Camera.html +42 -0
  58. package/docs/classes/index.EffectComposer.html +25 -0
  59. package/docs/classes/index.EyeDomeLightingPass.html +20 -0
  60. package/docs/classes/index.Fetcher.html +5 -0
  61. package/docs/classes/index.Five.html +311 -0
  62. package/docs/classes/index.FivePass.html +17 -0
  63. package/docs/classes/index.FiveRenderer.html +8 -0
  64. package/docs/classes/index.FlowingFireworks3DPass.html +22 -0
  65. package/docs/classes/index.FlowingLight2DPass.html +21 -0
  66. package/docs/classes/index.FlowingLight3DPass.html +23 -0
  67. package/docs/classes/index.FullScreenQuad.html +7 -0
  68. package/docs/classes/index.GaussianBlurPass.html +19 -0
  69. package/docs/classes/index.Histogram.html +19 -0
  70. package/docs/classes/index.InternalWebGPURenderer.html +4 -0
  71. package/docs/classes/index.Model.html +93 -0
  72. package/docs/classes/index.ModelScene.html +40 -0
  73. package/docs/classes/index.Motion.html +17 -0
  74. package/docs/classes/index.NetworkSubscribe.html +41 -0
  75. package/docs/classes/index.PBMGaussianSplattingNodeMaterial.html +37 -0
  76. package/docs/classes/index.PBMGaussianSplattingObject.html +32 -0
  77. package/docs/classes/index.PBMGaussianSplattingRenderMesh.html +19 -0
  78. package/docs/classes/index.PBMGroup.html +5 -0
  79. package/docs/classes/index.PBMMesh.html +2 -0
  80. package/docs/classes/index.PBMMeshBasicMaterial.html +70 -0
  81. package/docs/classes/index.PBMMeshBasicNodeMaterial.html +74 -0
  82. package/docs/classes/index.PBMMeshPanoOnlyMaterial.html +70 -0
  83. package/docs/classes/index.PBMMeshPanoOnlyNodeMaterial.html +74 -0
  84. package/docs/classes/index.PBMMeshPhongMaterial.html +69 -0
  85. package/docs/classes/index.PBMMeshPhongNodeMaterial.html +73 -0
  86. package/docs/classes/index.PBMMeshPhysicalMaterial.html +69 -0
  87. package/docs/classes/index.PBMMeshPhysicalNodeMaterial.html +73 -0
  88. package/docs/classes/index.PBMPanoFilter.html +61 -0
  89. package/docs/classes/index.PBMPointCloud.html +50 -0
  90. package/docs/classes/index.PBMSkinnedMesh.html +8 -0
  91. package/docs/classes/index.PBMUpdateable.html +41 -0
  92. package/docs/classes/index.PanoCircleMesh.html +30 -0
  93. package/docs/classes/index.PanoCircleMeshCustom.html +30 -0
  94. package/docs/classes/index.PanoCircleMeshSolid.html +30 -0
  95. package/docs/classes/index.Parameter.html +114 -0
  96. package/docs/classes/index.Scene.html +18 -0
  97. package/docs/classes/index.Subscribe.html +43 -0
  98. package/docs/classes/index.TextureLoader.html +4 -0
  99. package/docs/classes/index.Tile.html +34 -0
  100. package/docs/classes/index.Tile3D.html +98 -0
  101. package/docs/classes/index.TileCache.html +8 -0
  102. package/docs/classes/index.TileNode.html +14 -0
  103. package/docs/classes/index.TileRequestScheduler.html +4 -0
  104. package/docs/classes/index.Tileset.html +38 -0
  105. package/docs/classes/index.Trajectory.html +8 -0
  106. package/docs/classes/index.TrajectoryNode.html +8 -0
  107. package/docs/classes/index.Work.html +52 -0
  108. package/docs/classes/index.WorkResolvedObserver.html +68 -0
  109. package/docs/documents/README.html +134 -0
  110. package/docs/documents/ai-doc-guidelines.html +117 -0
  111. package/docs/documents/api.html +337 -0
  112. package/docs/documents/features_3dtile.html +216 -0
  113. package/docs/documents/features_camera-animation.html +157 -0
  114. package/docs/documents/features_clipper.html +80 -0
  115. package/docs/documents/features_coordinate-system.html +127 -0
  116. package/docs/documents/features_event.html +104 -0
  117. package/docs/documents/features_five.html +147 -0
  118. package/docs/documents/features_gesture.html +121 -0
  119. package/docs/documents/features_get-screen-pixels.html +88 -0
  120. package/docs/documents/features_image-options.html +108 -0
  121. package/docs/documents/features_load-external-model.html +600 -0
  122. package/docs/documents/features_load-progress.html +110 -0
  123. package/docs/documents/features_material.html +341 -0
  124. package/docs/documents/features_mode.html +114 -0
  125. package/docs/documents/features_model.html +141 -0
  126. package/docs/documents/features_move-pano-effect.html +110 -0
  127. package/docs/documents/features_multi-work.html +97 -0
  128. package/docs/documents/features_pano-filter.html +119 -0
  129. package/docs/documents/features_pano-tile.html +100 -0
  130. package/docs/documents/features_pano-uv.html +82 -0
  131. package/docs/documents/features_parameter.html +101 -0
  132. package/docs/documents/features_raycast.html +98 -0
  133. package/docs/documents/features_request-proxy.html +78 -0
  134. package/docs/documents/features_screen-project.html +112 -0
  135. package/docs/documents/features_state.html +71 -0
  136. package/docs/documents/features_ultra-hdr.html +188 -0
  137. package/docs/documents/features_view-layer.html +158 -0
  138. package/docs/documents/features_work.html +129 -0
  139. package/docs/documents/glossary.html +94 -0
  140. package/docs/documents/intro.html +24 -0
  141. package/docs/documents/quick-start.html +32 -0
  142. package/docs/documents/release_notes_6.6.html +79 -0
  143. package/docs/documents/release_notes_6.7.html +209 -0
  144. package/docs/documents/release_notes_6.8.html +189 -0
  145. package/docs/documents/support.html +49 -0
  146. package/docs/documents/template.html +80 -0
  147. package/docs/enums/index.VolumePlaneIntersect.html +4 -0
  148. package/docs/functions/index.coordinatesToVector.html +2 -0
  149. package/docs/functions/index.createDebugBoundingMesh.html +1 -0
  150. package/docs/functions/index.createWorks.html +1 -0
  151. package/docs/functions/index.defaultImageURLTransform.html +5 -0
  152. package/docs/functions/index.getViewportScale.html +1 -0
  153. package/docs/functions/index.headingToLongitude.html +4 -0
  154. package/docs/functions/index.imageSupport.html +1 -0
  155. package/docs/functions/index.isBoundingVolume.html +1 -0
  156. package/docs/functions/index.isPanoId.html +1 -0
  157. package/docs/functions/index.loadAt3d.html +1 -0
  158. package/docs/functions/index.loadDome.html +1 -0
  159. package/docs/functions/index.loadDomez.html +1 -0
  160. package/docs/functions/index.loadGltf.html +1 -0
  161. package/docs/functions/index.loadPbm.html +1 -0
  162. package/docs/functions/index.loadPly.html +1 -0
  163. package/docs/functions/index.longitudeToHeading.html +4 -0
  164. package/docs/functions/index.makeBoundingVolume.html +1 -0
  165. package/docs/functions/index.panoEqual.html +1 -0
  166. package/docs/functions/index.panoParse.html +1 -0
  167. package/docs/functions/index.panoStringify.html +1 -0
  168. package/docs/functions/index.parseWork.html +7 -0
  169. package/docs/functions/index.registerPBMMaterials.html +3 -0
  170. package/docs/functions/index.vectorToCoordinates.html +2 -0
  171. package/docs/functions/index.workToJson.html +1 -0
  172. package/docs/hierarchy.html +1 -0
  173. package/docs/index.html +134 -0
  174. package/docs/interfaces/index.AddableObject.html +9 -0
  175. package/docs/interfaces/index.AjaxOptions.html +9 -0
  176. package/docs/interfaces/index.AnimationFrame.html +6 -0
  177. package/docs/interfaces/index.AnimationFrameContext.html +3 -0
  178. package/docs/interfaces/index.BaseEvent.html +5 -0
  179. package/docs/interfaces/index.BoundingVolume.html +15 -0
  180. package/docs/interfaces/index.BoxBoundingVolume.html +18 -0
  181. package/docs/interfaces/index.CameraPose.html +6 -0
  182. package/docs/interfaces/index.CullingVolume.html +9 -0
  183. package/docs/interfaces/index.Draco.html +12 -0
  184. package/docs/interfaces/index.EventCallback.html +394 -0
  185. package/docs/interfaces/index.FiveInitArgs.html +104 -0
  186. package/docs/interfaces/index.FiveLoadOptions.html +12 -0
  187. package/docs/interfaces/index.FloorplanControllerCustomInitArgs.html +17 -0
  188. package/docs/interfaces/index.GestureEvent.html +19 -0
  189. package/docs/interfaces/index.IPBMMaterial.html +64 -0
  190. package/docs/interfaces/index.ImageOptions.html +21 -0
  191. package/docs/interfaces/index.ImageURLMappings.html +1 -0
  192. package/docs/interfaces/index.ImageURLOptions.html +17 -0
  193. package/docs/interfaces/index.IntersectEvent.html +8 -0
  194. package/docs/interfaces/index.IntersectMesh.html +2 -0
  195. package/docs/interfaces/index.IntersectMeshInterface.html +3 -0
  196. package/docs/interfaces/index.Intersection.html +9 -0
  197. package/docs/interfaces/index.LoosePanoWork.html +10 -0
  198. package/docs/interfaces/index.LooseWork.html +15 -0
  199. package/docs/interfaces/index.LooseWorkInitial.html +11 -0
  200. package/docs/interfaces/index.LooseWorkModel.html +8 -0
  201. package/docs/interfaces/index.LooseWorkObserver.html +17 -0
  202. package/docs/interfaces/index.LooseWorkPanorama.html +22 -0
  203. package/docs/interfaces/index.LooseWorkVideo.html +4 -0
  204. package/docs/interfaces/index.LooseWorkWithExtrinsics.html +15 -0
  205. package/docs/interfaces/index.MapviewControllerCustomInitArgs.html +20 -0
  206. package/docs/interfaces/index.ModeChangeEvent.html +9 -0
  207. package/docs/interfaces/index.ModelControllerCustomInitArgs.html +20 -0
  208. package/docs/interfaces/index.ModelEvent.html +8 -0
  209. package/docs/interfaces/index.ModelOptions.html +11 -0
  210. package/docs/interfaces/index.ModelSceneEvent.html +6 -0
  211. package/docs/interfaces/index.ModelTileEvent.html +8 -0
  212. package/docs/interfaces/index.MotionKeyframe.html +4 -0
  213. package/docs/interfaces/index.MovePanoOptions.html +35 -0
  214. package/docs/interfaces/index.NetworkAbortError.html +1 -0
  215. package/docs/interfaces/index.NetworkFirbiddenError.html +1 -0
  216. package/docs/interfaces/index.NetworkOptions.html +7 -0
  217. package/docs/interfaces/index.NetworkProxyError.html +1 -0
  218. package/docs/interfaces/index.NetworkResourceEvent.html +9 -0
  219. package/docs/interfaces/index.NetworkResponseError.html +2 -0
  220. package/docs/interfaces/index.NetworkTimeoutError.html +1 -0
  221. package/docs/interfaces/index.ObjectEvent.html +6 -0
  222. package/docs/interfaces/index.PBMClipperParameter.html +3 -0
  223. package/docs/interfaces/index.PBMHDRConfig.html +12 -0
  224. package/docs/interfaces/index.PBMPanoDepth.html +9 -0
  225. package/docs/interfaces/index.PBMPanoFilterValue.html +6 -0
  226. package/docs/interfaces/index.PBMPanoPicture.html +14 -0
  227. package/docs/interfaces/index.PBMRefinedScreen.html +6 -0
  228. package/docs/interfaces/index.PanoCircleMeshCustomOptions.html +9 -0
  229. package/docs/interfaces/index.PanoCircleMeshInterface.html +30 -0
  230. package/docs/interfaces/index.PanoCircleMeshOptions.html +3 -0
  231. package/docs/interfaces/index.PanoCircleMeshSolidOptions.html +3 -0
  232. package/docs/interfaces/index.PanoEvent.html +11 -0
  233. package/docs/interfaces/index.PanoTextureEvent.html +9 -0
  234. package/docs/interfaces/index.PanoramaControllerCustomInitArgs.html +41 -0
  235. package/docs/interfaces/index.PanoramaLikeControllerCustomInitArgs.html +20 -0
  236. package/docs/interfaces/index.ParameterMaterialValue.html +74 -0
  237. package/docs/interfaces/index.ParameterTilesetValue.html +30 -0
  238. package/docs/interfaces/index.ParameterValue.html +103 -0
  239. package/docs/interfaces/index.Pass.html +9 -0
  240. package/docs/interfaces/index.PointCloudData.html +6 -0
  241. package/docs/interfaces/index.Pose.html +12 -0
  242. package/docs/interfaces/index.RegionBoundingVolume.html +21 -0
  243. package/docs/interfaces/index.RenderEvent.html +6 -0
  244. package/docs/interfaces/index.ResolvedParameterValue.html +104 -0
  245. package/docs/interfaces/index.RgbaData.html +7 -0
  246. package/docs/interfaces/index.SphereBoundingVolume.html +17 -0
  247. package/docs/interfaces/index.SplatData.html +10 -0
  248. package/docs/interfaces/index.State.html +23 -0
  249. package/docs/interfaces/index.StateEvent.html +7 -0
  250. package/docs/interfaces/index.TextureOptions.html +23 -0
  251. package/docs/interfaces/index.Tile3DOptions.html +11 -0
  252. package/docs/interfaces/index.TileCoordinateSystem.html +3 -0
  253. package/docs/interfaces/index.TileHeader.html +9 -0
  254. package/docs/interfaces/index.TilesetHeader.html +20 -0
  255. package/docs/interfaces/index.TilesetOptions.html +7 -0
  256. package/docs/interfaces/index.TopviewControllerCustomInitArgs.html +13 -0
  257. package/docs/interfaces/index.TrajectoryHeader.html +5 -0
  258. package/docs/interfaces/index.ViewLayer.html +97 -0
  259. package/docs/interfaces/index.Viewport.html +13 -0
  260. package/docs/interfaces/index.WebXRAxesParams.html +4 -0
  261. package/docs/interfaces/index.WebXRControllerParams.html +2 -0
  262. package/docs/interfaces/index.WorkCubeImage.html +15 -0
  263. package/docs/interfaces/index.WorkImage.html +22 -0
  264. package/docs/interfaces/index.WorkInitial.html +17 -0
  265. package/docs/interfaces/index.WorkInitialJson.html +8 -0
  266. package/docs/interfaces/index.WorkJson.html +11 -0
  267. package/docs/interfaces/index.WorkModel.html +16 -0
  268. package/docs/interfaces/index.WorkModelJson.html +6 -0
  269. package/docs/interfaces/index.WorkModelLayer.html +11 -0
  270. package/docs/interfaces/index.WorkModelLayerJson.html +5 -0
  271. package/docs/interfaces/index.WorkObserver.html +63 -0
  272. package/docs/interfaces/index.WorkObserverJson.html +10 -0
  273. package/docs/interfaces/index.WorkPanoramaJson.html +14 -0
  274. package/docs/interfaces/index.WorkPanoramasJson.html +3 -0
  275. package/docs/interfaces/index.WorkTile.html +21 -0
  276. package/docs/interfaces/index.WorkVideo.html +9 -0
  277. package/docs/interfaces/index.WorksEvent.html +8 -0
  278. package/docs/interfaces/index.XRControllerEvent.html +8 -0
  279. package/docs/interfaces/index.XRGestureEvent.html +11 -0
  280. package/docs/interfaces/index.XRSessionEvent.html +7 -0
  281. package/docs/modules/index.html +1 -0
  282. package/docs/modules.html +1 -0
  283. package/docs/types/index.AjaxResponseType.html +1 -0
  284. package/docs/types/index.AjaxResponseTypeMapping.html +1 -0
  285. package/docs/types/index.AnimationFrameLoopType.html +1 -0
  286. package/docs/types/index.BoundingVolumeJson.html +1 -0
  287. package/docs/types/index.BoxBoundingVolumeJson.html +2 -0
  288. package/docs/types/index.ControllerCustomInitTypes.html +6 -0
  289. package/docs/types/index.ControllerEventTypes.html +68 -0
  290. package/docs/types/index.CubeFace.html +1 -0
  291. package/docs/types/index.EasingFunction.html +1 -0
  292. package/docs/types/index.EventTypes.html +28 -0
  293. package/docs/types/index.FivePlugin.html +4 -0
  294. package/docs/types/index.FivePluginInit.html +3 -0
  295. package/docs/types/index.FivePluginInstance.html +3 -0
  296. package/docs/types/index.FlowingFireworks3DPassLine.html +16 -0
  297. package/docs/types/index.FlowingLight2DPassLine.html +10 -0
  298. package/docs/types/index.FlowingLight3DPassLine.html +10 -0
  299. package/docs/types/index.GestureTypes.html +1 -0
  300. package/docs/types/index.LegacyEventType.html +282 -0
  301. package/docs/types/index.LoadResultType.html +12 -0
  302. package/docs/types/index.Mode.html +15 -0
  303. package/docs/types/index.Models.html +11 -0
  304. package/docs/types/index.MotionCircle.html +2 -0
  305. package/docs/types/index.MotionConfig.html +1 -0
  306. package/docs/types/index.MotionInitalValue.html +1 -0
  307. package/docs/types/index.MotionValue.html +1 -0
  308. package/docs/types/index.MovePanoEffect.html +12 -0
  309. package/docs/types/index.NetWorkMeta.html +8 -0
  310. package/docs/types/index.NetworkError.html +1 -0
  311. package/docs/types/index.NetworkErrorCallback.html +1 -0
  312. package/docs/types/index.NetworkProgressCallback.html +1 -0
  313. package/docs/types/index.NetworkResponse.html +3 -0
  314. package/docs/types/index.NetworkState.html +1 -0
  315. package/docs/types/index.NetworkSuccessCallback.html +1 -0
  316. package/docs/types/index.NetworkType.html +1 -0
  317. package/docs/types/index.OutputTextureDataType.html +1 -0
  318. package/docs/types/index.PBMAlphaMode.html +1 -0
  319. package/docs/types/index.PBMColorStyle.html +1 -0
  320. package/docs/types/index.PBMFloorStyle.html +1 -0
  321. package/docs/types/index.PBMMeshMaterial.html +1 -0
  322. package/docs/types/index.PBMPointBack.html +1 -0
  323. package/docs/types/index.PBMPointCloudShaderType.html +1 -0
  324. package/docs/types/index.PBMPointShape.html +1 -0
  325. package/docs/types/index.PBMPointSize.html +1 -0
  326. package/docs/types/index.PBMTransition.html +1 -0
  327. package/docs/types/index.Pano.html +3 -0
  328. package/docs/types/index.PanoId.html +1 -0
  329. package/docs/types/index.ParseOptions.html +13 -0
  330. package/docs/types/index.PostProcessingType.html +1 -0
  331. package/docs/types/index.RegionBoundingVolumeJson.html +2 -0
  332. package/docs/types/index.RequestAnimationFrameArgs.html +1 -0
  333. package/docs/types/index.Scissor.html +2 -0
  334. package/docs/types/index.SphereBoundingVolumeJson.html +2 -0
  335. package/docs/types/index.SubscribeEventMap.html +1 -0
  336. package/docs/types/index.TileCacheOptions.html +3 -0
  337. package/docs/types/index.TileContentData.html +6 -0
  338. package/docs/types/index.TileRequestOrder.html +1 -0
  339. package/docs/types/index.TileRequestSchedulerOptions.html +4 -0
  340. package/docs/types/index.TilesetFrameState.html +21 -0
  341. package/docs/types/index.TrajectoryContentData.html +7 -0
  342. package/docs/types/index.WebXRControllerKey.html +1 -0
  343. package/docs/types/index.WebXRControllerType.html +1 -0
  344. package/docs/types/index.Works.html +1 -0
  345. package/docs/variables/index.PROXY_CONTROLLER_EVENT_NAMES.html +1 -0
  346. package/docs/variables/index.controllersDefaultInitArgs.html +1 -0
  347. package/docs/variables/index.draco.html +1 -0
  348. package/five/application/analysis.d.ts +40 -0
  349. package/five/application/controllers.d.ts +33 -0
  350. package/five/application/events-legacy.d.ts +454 -0
  351. package/five/application/events.d.ts +69 -0
  352. package/five/application/five.d.ts +498 -0
  353. package/five/application/fiveInitArgs.d.ts +173 -0
  354. package/five/application/fiveLoadOptions.d.ts +21 -0
  355. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  356. package/five/application/getViewportScale.d.ts +2 -0
  357. package/five/application/initLights.d.ts +3 -0
  358. package/five/application/mode.d.ts +24 -0
  359. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  360. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  361. package/five/assets/gradient-png-data-url.d.ts +2 -0
  362. package/five/assets/loading-png-data-url.d.ts +2 -0
  363. package/five/assets/phone-png-data-url.d.ts +2 -0
  364. package/five/assets/realsee-pmg-data-url.d.ts +2 -0
  365. package/five/bvh/bvhMath.d.ts +33 -0
  366. package/five/bvh/bvhMesh.d.ts +7 -0
  367. package/five/bvh/bvhNode.d.ts +29 -0
  368. package/five/bvh/bvhObject.d.ts +19 -0
  369. package/five/bvh/bvhPoints.d.ts +6 -0
  370. package/five/bvh/index.d.ts +14 -0
  371. package/five/bvh/type.d.ts +1 -0
  372. package/five/bvh/worker.d.ts +36 -0
  373. package/five/certificates/hardware.d.ts +1 -0
  374. package/five/controllers/base.d.ts +166 -0
  375. package/five/controllers/events.d.ts +71 -0
  376. package/five/controllers/floorplan.d.ts +119 -0
  377. package/five/controllers/mapview.d.ts +138 -0
  378. package/five/controllers/model.d.ts +57 -0
  379. package/five/controllers/panorama.d.ts +143 -0
  380. package/five/controllers/panoramaLike.d.ts +87 -0
  381. package/five/controllers/topview.d.ts +42 -0
  382. package/five/core/camera.d.ts +65 -0
  383. package/five/core/internalWebGPURenderer.d.ts +13 -0
  384. package/five/core/panoVideo.d.ts +18 -0
  385. package/five/core/scene.d.ts +10 -0
  386. package/five/core/tiling.d.ts +56 -0
  387. package/five/declare.d.ts +35 -0
  388. package/five/gaussian-splatting/util/renderData.d.ts +66 -0
  389. package/five/gaussian-splatting/wasm/data.d.ts +20 -0
  390. package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
  391. package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
  392. package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
  393. package/five/index.d.ts +58 -0
  394. package/five/index.js +1179 -0
  395. package/five/index.mjs +25111 -0
  396. package/five/meshes/boundingMesh.d.ts +12 -0
  397. package/five/meshes/intersectMesh.d.ts +8 -0
  398. package/five/meshes/panoCircleMesh.d.ts +36 -0
  399. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  400. package/five/meshes/panoCircleMeshSolid.d.ts +35 -0
  401. package/five/meshes/panoSphereMesh.d.ts +29 -0
  402. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  403. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  404. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  405. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  406. package/five/model/index.d.ts +55 -0
  407. package/five/model/intersection.d.ts +18 -0
  408. package/five/model/loaders/at3d.d.ts +12 -0
  409. package/five/model/loaders/b3dm.d.ts +10 -0
  410. package/five/model/loaders/dome.d.ts +22 -0
  411. package/five/model/loaders/domez.d.ts +11 -0
  412. package/five/model/loaders/fbx.d.ts +8 -0
  413. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  414. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  415. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  416. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  417. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  418. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  419. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +26 -0
  420. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +11 -0
  421. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
  422. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  423. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  424. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  425. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  426. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +12 -0
  427. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  428. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  429. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  430. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  431. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  432. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +25 -0
  433. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  434. package/five/model/loaders/glTF-helpers/index.d.ts +51 -0
  435. package/five/model/loaders/glTF-helpers/parser.d.ts +115 -0
  436. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  437. package/five/model/loaders/gltf.d.ts +10 -0
  438. package/five/model/loaders/obj.d.ts +9 -0
  439. package/five/model/loaders/pbm.d.ts +26 -0
  440. package/five/model/loaders/ply.d.ts +24 -0
  441. package/five/model/loaders/pnts.d.ts +8 -0
  442. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  443. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  444. package/five/model/loaders/shared.d.ts +16 -0
  445. package/five/model/loaders/splat.d.ts +8 -0
  446. package/five/model/loaders/spz.d.ts +14 -0
  447. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  448. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  449. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  450. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  451. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  452. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  453. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  454. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +36 -0
  455. package/five/model/loaders/x3p.d.ts +22 -0
  456. package/five/model/materials/nodes/pbmMeshBasicNodeMaterial.d.ts +14 -0
  457. package/five/model/materials/nodes/pbmMeshPanoOnlyNodeMaterial.d.ts +14 -0
  458. package/five/model/materials/nodes/pbmMeshPhongNodeMaterial.d.ts +14 -0
  459. package/five/model/materials/nodes/pbmMeshPhysicalNodeMaterial.d.ts +14 -0
  460. package/five/model/materials/nodes/pbmPointCloudNodeMaterial.d.ts +22 -0
  461. package/five/model/materials/pbmGaussianSplattingNodeMaterial.d.ts +78 -0
  462. package/five/model/materials/pbmMaterial.d.ts +171 -0
  463. package/five/model/materials/pbmMaterialRegister.d.ts +6 -0
  464. package/five/model/materials/pbmMeshMaterial.d.ts +57 -0
  465. package/five/model/materials/pbmPointCloudMaterial.d.ts +20 -0
  466. package/five/model/materials/pbmPointCloudNodeMaterial.d.ts +46 -0
  467. package/five/model/materials/tsl/colorFilter.d.ts +9 -0
  468. package/five/model/materials/tsl/defines.d.ts +68 -0
  469. package/five/model/materials/tsl/nodeTypes.d.ts +12 -0
  470. package/five/model/materials/tsl/outputBuilder.d.ts +26 -0
  471. package/five/model/materials/tsl/panoColor.d.ts +17 -0
  472. package/five/model/materials/tsl/panoTransition.d.ts +8 -0
  473. package/five/model/materials/tsl/utils.d.ts +11 -0
  474. package/five/model/model-scene.d.ts +172 -0
  475. package/five/model/model.d.ts +203 -0
  476. package/five/model/objects/pbmGaussianSplattingObject.d.ts +47 -0
  477. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +73 -0
  478. package/five/model/objects/pbmGroup.d.ts +8 -0
  479. package/five/model/objects/pbmMesh.d.ts +10 -0
  480. package/five/model/objects/pbmPointCloud.d.ts +89 -0
  481. package/five/model/objects/pbmPointCloudObject.d.ts +81 -0
  482. package/five/model/parameter.d.ts +138 -0
  483. package/five/model/tile3d/header.d.ts +88 -0
  484. package/five/model/tile3d/index.d.ts +213 -0
  485. package/five/model/tile3d/tile-cache.d.ts +18 -0
  486. package/five/model/tile3d/tile-content.d.ts +10 -0
  487. package/five/model/tile3d/tile-node.d.ts +26 -0
  488. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  489. package/five/model/tile3d/tile.d.ts +79 -0
  490. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  491. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  492. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  493. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  494. package/five/model/tile3d/tileset.d.ts +65 -0
  495. package/five/model/tile3d/trajectory-content.d.ts +0 -0
  496. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  497. package/five/model/tile3d/trajectory.d.ts +30 -0
  498. package/five/model/tile3d/types.d.ts +33 -0
  499. package/five/model/view-layer.d.ts +20 -0
  500. package/five/renderer/compute-renderers/pointcloud-compute-renderer.d.ts +154 -0
  501. package/five/renderer/compute-renderers/rgb565.d.ts +45 -0
  502. package/five/renderer/compute-renderers/shaders/clear.d.ts +2 -0
  503. package/five/renderer/compute-renderers/shaders/fullscreenQuad.d.ts +2 -0
  504. package/five/renderer/compute-renderers/shaders/rasterize.d.ts +2 -0
  505. package/five/renderer/five-renderer.d.ts +33 -0
  506. package/five/renderer/index.d.ts +3 -0
  507. package/five/renderer/postprocessing/composer.d.ts +45 -0
  508. package/five/renderer/postprocessing/index.d.ts +8 -0
  509. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +27 -0
  510. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +31 -0
  511. package/five/renderer/postprocessing/passes/flowing-fireworks-3d-pass.d.ts +71 -0
  512. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +26 -0
  513. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +75 -0
  514. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +22 -0
  515. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  516. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  517. package/five/renderer/tools/full-screen-quad.d.ts +17 -0
  518. package/five/renderer/tools/postprocess-uv.d.ts +11 -0
  519. package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
  520. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  521. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  522. package/five/texture/histogram.d.ts +54 -0
  523. package/five/texture/imageBitmap.d.ts +13 -0
  524. package/five/texture/initTexture.d.ts +3 -0
  525. package/five/texture/loader.d.ts +39 -0
  526. package/five/texture/textureData.d.ts +11 -0
  527. package/five/thirdparty/fflate.d.ts +1407 -0
  528. package/five/thirdparty/hammer.d.ts +375 -0
  529. package/five/thirdparty/jsrsasign.d.ts +753 -0
  530. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  531. package/five/three-version-check.d.ts +1 -0
  532. package/five/types/addableObject.d.ts +12 -0
  533. package/five/types/cube.d.ts +2 -0
  534. package/five/types/gestureInput.d.ts +24 -0
  535. package/five/types/imageOptions.d.ts +20 -0
  536. package/five/types/intersectMeshInterface.d.ts +8 -0
  537. package/five/types/movePanoEffect.d.ts +13 -0
  538. package/five/types/movePanoOptions.d.ts +36 -0
  539. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  540. package/five/types/plugin.d.ts +25 -0
  541. package/five/types/pose.d.ts +17 -0
  542. package/five/types/state.d.ts +20 -0
  543. package/five/types/viewport.d.ts +22 -0
  544. package/five/utils/ajax.d.ts +66 -0
  545. package/five/utils/animationFrameLoop.d.ts +45 -0
  546. package/five/utils/array.d.ts +31 -0
  547. package/five/utils/asyncTaskQueue.d.ts +8 -0
  548. package/five/utils/bufferGeometry.d.ts +33 -0
  549. package/five/utils/calculateProgress.d.ts +39 -0
  550. package/five/utils/calculateThreeMouse.d.ts +13 -0
  551. package/five/utils/canplayVideo.d.ts +2 -0
  552. package/five/utils/clamp.d.ts +2 -0
  553. package/five/utils/clock.d.ts +30 -0
  554. package/five/utils/createSymbol.d.ts +5 -0
  555. package/five/utils/decodeText.d.ts +2 -0
  556. package/five/utils/deepEqual.d.ts +2 -0
  557. package/five/utils/deepFreeze.d.ts +2 -0
  558. package/five/utils/defineProperty.d.ts +9 -0
  559. package/five/utils/detector.d.ts +14 -0
  560. package/five/utils/distance.d.ts +10 -0
  561. package/five/utils/draco.d.ts +26 -0
  562. package/five/utils/easing.d.ts +63 -0
  563. package/five/utils/event.d.ts +159 -0
  564. package/five/utils/face3.d.ts +12 -0
  565. package/five/utils/formatRad.d.ts +7 -0
  566. package/five/utils/hdr-data.d.ts +13 -0
  567. package/five/utils/imageSupport.d.ts +6 -0
  568. package/five/utils/imageURL.d.ts +42 -0
  569. package/five/utils/isEmptyObject.d.ts +2 -0
  570. package/five/utils/isNil.d.ts +6 -0
  571. package/five/utils/isNumber.d.ts +2 -0
  572. package/five/utils/isPowerOfTwo.d.ts +2 -0
  573. package/five/utils/isPromise.d.ts +2 -0
  574. package/five/utils/isSimilar.d.ts +6 -0
  575. package/five/utils/json.d.ts +7 -0
  576. package/five/utils/ktx2.d.ts +30 -0
  577. package/five/utils/lzma/index.d.ts +2 -0
  578. package/five/utils/lzma/lzma.d.ts +3 -0
  579. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  580. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  581. package/five/utils/memoryUsage.d.ts +37 -0
  582. package/five/utils/motion.d.ts +38 -0
  583. package/five/utils/noop.d.ts +6 -0
  584. package/five/utils/now.d.ts +7 -0
  585. package/five/utils/pano.d.ts +9 -0
  586. package/five/utils/pick.d.ts +3 -0
  587. package/five/utils/poseUtils.d.ts +5 -0
  588. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  589. package/five/utils/renderDepth.d.ts +2 -0
  590. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  591. package/five/utils/requestPermission.d.ts +3 -0
  592. package/five/utils/shaderContentFix.d.ts +7 -0
  593. package/five/utils/shaderMaterial.d.ts +20 -0
  594. package/five/utils/stateUtils.d.ts +5 -0
  595. package/five/utils/string-pattern.d.ts +8 -0
  596. package/five/utils/subscribe.d.ts +67 -0
  597. package/five/utils/tileCube.d.ts +19 -0
  598. package/five/utils/toFastProperties.d.ts +1 -0
  599. package/five/utils/typedCache.d.ts +10 -0
  600. package/five/utils/uniform.d.ts +15 -0
  601. package/five/utils/url.d.ts +35 -0
  602. package/five/utils/uuid.d.ts +5 -0
  603. package/five/utils/values.d.ts +2 -0
  604. package/five/utils/vectorCoordinates.d.ts +29 -0
  605. package/five/utils/volume.d.ts +111 -0
  606. package/five/utils/worker.d.ts +26 -0
  607. package/five/work/_ALLOW_HOST.d.ts +2 -0
  608. package/five/work/index.d.ts +6 -0
  609. package/five/work/keychain.d.ts +5 -0
  610. package/five/work/looseWorkType.d.ts +128 -0
  611. package/five/work/verify.d.ts +7 -0
  612. package/five/work/work.d.ts +246 -0
  613. package/five/work/workFetcher.d.ts +4 -0
  614. package/five/work/workJson.d.ts +3 -0
  615. package/five/work/workJsonType.d.ts +73 -0
  616. package/five/work/workObserverUtils.d.ts +36 -0
  617. package/five/work/workParser.d.ts +6 -0
  618. package/five/work/workResolvedObserver.d.ts +12 -0
  619. package/five/work/workVerify.d.ts +2 -0
  620. package/five/work/works.d.ts +10 -0
  621. package/llms.txt +66 -0
  622. package/package.json +56 -0
  623. package/plugins/BasePlugin/index.d.ts +96 -0
  624. package/plugins/GaussianSplattingEntranceAnimationPlugin/Controller.d.ts +66 -0
  625. package/plugins/GaussianSplattingEntranceAnimationPlugin/index.d.ts +5 -0
  626. package/plugins/GaussianSplattingEntranceAnimationPlugin/typing.d.ts +32 -0
  627. package/plugins/index.d.ts +2 -0
  628. package/plugins/index.js +255 -0
  629. package/plugins/index.mjs +539 -0
  630. package/plugins/utils/absoluteUrl.d.ts +5 -0
  631. package/react/autoCanvas.d.ts +9 -0
  632. package/react/canvas.d.ts +19 -0
  633. package/react/context.d.ts +12 -0
  634. package/react/createProvider.d.ts +98 -0
  635. package/react/createStore.d.ts +144 -0
  636. package/react/fiveApp.d.ts +22 -0
  637. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  638. package/react/hooks/useFiveAction.d.ts +147 -0
  639. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  640. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  641. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  642. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  643. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  644. package/react/hooks/useFiveFloor.d.ts +15 -0
  645. package/react/hooks/useFiveHelper.d.ts +14 -0
  646. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  647. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  648. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  649. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  650. package/react/hooks/useFivePlugin.d.ts +22 -0
  651. package/react/hooks/useFiveProject2d.d.ts +21 -0
  652. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  653. package/react/hooks/useFiveState.d.ts +6 -0
  654. package/react/hooks/useFiveWork.d.ts +29 -0
  655. package/react/index.d.ts +28 -0
  656. package/react/index.js +255 -0
  657. package/react/index.mjs +896 -0
  658. package/react/withFive.d.ts +213 -0
  659. package/resource/basis/1.16/basis_transcoder.js +22 -0
  660. package/resource/basis/1.16/basis_transcoder.wasm +0 -0
  661. package/resource/basis/README.md +5 -0
  662. package/resource/draco/1.5.6/draco_decoder.js +34 -0
  663. package/resource/draco/1.5.6/draco_decoder.wasm +0 -0
  664. package/resource/draco/1.5.6/draco_decoder_gltf.js +33 -0
  665. package/resource/draco/1.5.6/draco_decoder_gltf.wasm +0 -0
  666. package/resource/draco/1.5.6/draco_encoder.js +35 -0
  667. package/resource/draco/1.5.6/draco_encoder.wasm +0 -0
  668. package/resource/draco/1.5.6/draco_encoder_wrapper.js +97 -0
  669. package/resource/draco/1.5.6/draco_wasm_wrapper.js +117 -0
  670. package/resource/draco/1.5.6/draco_wasm_wrapper_gltf.js +116 -0
  671. package/resource/draco/README.md +5 -0
  672. package/umd/five-plugins.js +255 -0
  673. package/umd/five-react.js +255 -0
  674. package/umd/five.js +1579 -0
package/docs/documents/README.html ADDED
@@ -0,0 +1,134 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>README | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">README</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="five-sdk-documentation" class="tsd-anchor-link">Five SDK Documentation<a href="#five-sdk-documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
2
+ <p><a href="https://www.npmjs.com/package/@realsee/five"><img src="https://img.shields.io/npm/v/@realsee/five.svg?style=flat-square&amp;logo=npm&amp;label=npm%20install%20@realsee/five" alt="npm version"></a></p>
3
+ <ul>
4
+ <li><strong>Summary</strong>: Five SDK 的文档索引与阅读指南，旨在帮助开发者与 AI 助手快速定位所需信息。</li>
5
+ <li><strong>Audience</strong>: 开发者、AI 辅助编程工具。</li>
6
+ </ul>
7
+ <h2 id="context-for-ai-agents" class="tsd-anchor-link">Context for AI Agents<a href="#context-for-ai-agents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
8
+ <p><strong>Five</strong> 是贝壳如视 (Realsee) 提供的三维空间渲染 SDK。</p>
9
+ <h3 id="1-documentation-maintenance-文档维护" class="tsd-anchor-link">1. Documentation Maintenance (文档维护)<a href="#1-documentation-maintenance-文档维护" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
10
+ <div class="tsd-alert tsd-alert-important"><div class="tsd-alert-title"><svg width="16" height="16" viewBox="0 0 16 16" aria-hidden="true"><use href="../assets/icons.svg#icon-alertImportant"></use></svg><span>Important</span></div><p>
11
+ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guidelines.html">AI Documentation Guidelines</a>.
12
+ 在书写文档时，务必遵循 <a href="ai-doc-guidelines.html">AI Documentation Guidelines</a> 中的规范。</p>
13
+ </div>
14
+ <h3 id="2-application-development-strategy-应用开发建议" class="tsd-anchor-link">2. Application Development Strategy (应用开发建议)<a href="#2-application-development-strategy-应用开发建议" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
15
+ <p>当协助用户编写代码或构建 Five 应用时，请遵循以下阅读与检索策略：</p>
16
+ <ul>
17
+ <li><strong>Initialization (初始化)</strong>:
18
+ <ul>
19
+ <li>阅读 <a href="quick-start.html">Quick Start</a> 掌握最小化启动流程。</li>
20
+ <li>查阅 <a href="features_parameter.html">Parameter</a> 获取 <code>new Five(config)</code> 的完整配置项（如 canvas 尺寸、资源路径、纹理压缩设置）。</li>
21
+ </ul>
22
+ </li>
23
+ <li><strong>Data Handling (数据加载)</strong>:
24
+ <ul>
25
+ <li>核心 VR 数据：深入理解 <a href="features_work.html">Work</a> 结构，它是 Five 渲染的基础。</li>
26
+ <li>外部模型：参考 <a href="features_load-external-model.html">Load External Model</a> 加载 GLTF/OBJ 等格式。</li>
27
+ <li>多场景/沙盘：参考 <a href="features_multi-work.html">Multi-Work (Sandbox)</a> 处理复杂场景切换。</li>
28
+ </ul>
29
+ </li>
30
+ <li><strong>Interaction &amp; Logic (交互逻辑)</strong>:
31
+ <ul>
32
+ <li>事件监听：查阅 <a href="features_event.html">Event</a> 处理用户点击 (Tap)、手势 (Gesture) 及状态变更 (StateChange)。</li>
33
+ <li>空间操作：使用 <a href="features_raycast.html">Raycast</a> 实现物体拾取，使用 <a href="features_screen-project.html">Screen &amp; Space Projection</a> 实现 3D 标签挂载。</li>
34
+ <li>动画控制：参考 <a href="features_camera-animation.html">Camera Animation</a> 和 <a href="features_move-pano-effect.html">Move Pano Effect</a> 实现平滑运镜。</li>
35
+ </ul>
36
+ </li>
37
+ <li><strong>State Management (状态管理)</strong>:
38
+ <ul>
39
+ <li>保存/恢复场景：<strong>必须</strong> 深刻理解 <a href="features_state.html">State</a>。它是 Five 的核心快照机制，包含 Pose、Mode 和 PanoIndex。不要尝试手动管理零散的相机参数，应统一使用 State。</li>
40
+ </ul>
41
+ </li>
42
+ <li><strong>Coding Standards (代码规范)</strong>:
43
+ <ul>
44
+ <li>优先使用 TypeScript 类型提示。</li>
45
+ <li>确保从 <code>@realsee/five</code> 导入核心类与类型 (e.g., <code>import { Five, Mode, Work, State } from &quot;@realsee/five&quot;</code>).</li>
46
+ </ul>
47
+ </li>
48
+ </ul>
49
+ <h3 id="3-general-retrieval-通用检索" class="tsd-anchor-link">3. General Retrieval (通用检索)<a href="#3-general-retrieval-通用检索" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
50
+ <ul>
51
+ <li><strong>API Signatures</strong>: <a href="api.html">API Reference</a> 是最权威的接口定义来源，包含方法的参数与返回值。</li>
52
+ <li><strong>Terminology</strong>: 遇到不确定的术语 (e.g., Pose vs State, Observer) 时，务必查阅 <a href="glossary.html">Glossary</a>。</li>
53
+ <li><strong>Core Relationships</strong>: 理解 <a href="features_five.html">Five</a> (渲染器) 与 <a href="features_work.html">Work</a> (数据) 的分离设计。</li>
54
+ </ul>
55
+ <h2 id="documentation-map" class="tsd-anchor-link">Documentation Map<a href="#documentation-map" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
56
+ <h3 id="1-essential-reference-必读速查" class="tsd-anchor-link">1. Essential Reference (必读/速查)<a href="#1-essential-reference-必读速查" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
57
+ <p>最常用的入口文档。</p>
58
+ <ul>
59
+ <li><a href="intro.html">Intro</a>: Five SDK 简介与能力概览。</li>
60
+ <li><a href="quick-start.html">Quick Start</a>: 快速集成指南。</li>
61
+ <li><a href="api.html">API Reference</a>: <strong>核心 API 索引</strong> (Five 类, State, Events, Methods)。</li>
62
+ <li><a href="glossary.html">Glossary</a>: <strong>术语表</strong> (Work, Observer, Pose, etc.)。</li>
63
+ </ul>
64
+ <h3 id="2-core-concepts-核心概念" class="tsd-anchor-link">2. Core Concepts (核心概念)<a href="#2-core-concepts-核心概念" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
65
+ <p>基础架构与生命周期管理。</p>
66
+ <ul>
67
+ <li><a href="features_five.html">Five</a>: 核心类 <code>Five</code>，管理渲染循环与全局状态。</li>
68
+ <li><a href="features_work.html">Work</a>: 数据载体，描述三维空间的数据结构 (VR 看房数据)。</li>
69
+ <li><a href="features_pano-uv.html">Panorama UV</a>: 全景图 UV 与空间方向转换工具。</li>
70
+ <li><a href="features_mode.html">Mode</a>: 五种核心浏览模式 (Panorama, Floorplan, Topview, Model, Map)。</li>
71
+ <li><a href="features_state.html">State</a>: 状态管理 (Pose, Mode, PanoIndex)，用于复原场景。</li>
72
+ <li><a href="features_coordinate-system.html">Coordinate System</a>: 坐标系定义 (右手坐标系, Y轴向上)。</li>
73
+ </ul>
74
+ <h3 id="3-data-resource-数据与资源" class="tsd-anchor-link">3. Data &amp; Resource (数据与资源)<a href="#3-data-resource-数据与资源" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
75
+ <p>数据加载与资源管理配置。</p>
76
+ <ul>
77
+ <li><a href="features_load-external-model.html">Load External Model</a>: 加载外部 3D 模型 (GLTF, OBJ 等)。</li>
78
+ <li><a href="features_load-progress.html">Load Progress</a>: 监控模型与全景图的加载进度 (Loaded/Refined)。</li>
79
+ <li><a href="features_multi-work.html">Multi-Work (Sandbox)</a>: 多 Work 加载与沙盘场景管理。</li>
80
+ <li><a href="features_request-proxy.html">Request Proxy</a>: 请求拦截与代理 (CDN 替换、鉴权)。</li>
81
+ <li><a href="features_image-options.html">Image Options</a>: 图片资源配置 (CDN, 格式, 尺寸)。</li>
82
+ </ul>
83
+ <h3 id="4-rendering-visuals-渲染与视觉" class="tsd-anchor-link">4. Rendering &amp; Visuals (渲染与视觉)<a href="#4-rendering-visuals-渲染与视觉" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
84
+ <p>画面表现与渲染管线配置。</p>
85
+ <ul>
86
+ <li><a href="features_pano-tile.html">Pano Tile</a>: 全景瓦片渲染机制（高分辨率分片加载）。</li>
87
+ <li><a href="features_model.html">Model</a>: 内置模型渲染 (Mesh/Geometry)。</li>
88
+ <li><a href="features_material.html">Material</a>: 材质参数配置 (透明度、点云大小、顶点标记)。</li>
89
+ <li><a href="features_pano-filter.html">Pano Filter</a>: 全景图滤镜 (亮度、对比度、色温调节)。</li>
90
+ <li><a href="features_get-screen-pixels.html">Get Screen Pixels</a>: 获取屏幕像素 (放大镜/截图)。</li>
91
+ <li><a href="features_move-pano-effect.html">Move Pano Effect</a>: 全景点位切换的过渡效果。</li>
92
+ <li><a href="features_clipper.html">Clipper</a>: 模型裁切功能 (房屋剖面)。</li>
93
+ <li><a href="features_3dtile.html">3D Tile</a>: 大场景 3D Tile 渲染策略。</li>
94
+ </ul>
95
+ <h3 id="5-interaction-control-交互与控制" class="tsd-anchor-link">5. Interaction &amp; Control (交互与控制)<a href="#5-interaction-control-交互与控制" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
96
+ <p>用户输入与相机控制。</p>
97
+ <ul>
98
+ <li><a href="features_event.html">Event</a>: 事件系统 (Tap, Gesture, StateChange)。</li>
99
+ <li><a href="features_gesture.html">Gesture</a>: 手势交互详解。</li>
100
+ <li><a href="features_screen-project.html">Screen &amp; Space Projection</a>: 屏幕坐标与空间坐标转换 (标签/射线)。</li>
101
+ <li><a href="features_raycast.html">Raycast</a>: 射线检测 (点击拾取物体)。</li>
102
+ <li><a href="features_camera-animation.html">Camera Animation</a>: 相机动画控制 API。</li>
103
+ </ul>
104
+ <h3 id="6-advanced-extensions-进阶与扩展" class="tsd-anchor-link">6. Advanced &amp; Extensions (进阶与扩展)<a href="#6-advanced-extensions-进阶与扩展" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
105
+ <p>复杂配置与功能扩展。</p>
106
+ <ul>
107
+ <li><a href="features_view-layer.html">ViewLayer</a>: 视图层。</li>
108
+ <li><a href="features_parameter.html">Parameter</a>: Five 初始化详细参数配置。</li>
109
+ </ul>
110
+ <h3 id="7-meta-support-其他" class="tsd-anchor-link">7. Meta &amp; Support (其他)<a href="#7-meta-support-其他" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
111
+ <ul>
112
+ <li><a href="support.html">Support</a>: 浏览器兼容性。</li>
113
+ <li><a href="ai-doc-guidelines.html">AI Documentation Guidelines</a>: AI 文档编写与维护规范 (必读)。</li>
114
+ <li>Release Notes: 版本更新记录。
115
+ <ul>
116
+ <li><a href="release_notes_6.8.html">6.8</a></li>
117
+ <li><a href="release_notes_6.7.html">6.7</a></li>
118
+ <li><a href="release_notes_6.6.html">6.6</a></li>
119
+ </ul>
120
+ </li>
121
+ </ul>
122
+ <h2 id="terminology-summary" class="tsd-anchor-link">Terminology Summary<a href="#terminology-summary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
123
+ <ul>
124
+ <li><strong>Work</strong>: 包含全景图、模型、户型数据的 JSON 对象。</li>
125
+ <li><strong>Observer</strong>: 观察点，通常对应一个全景拍摄点位。</li>
126
+ <li><strong>PanoIndex</strong>: 全景点位的索引下标。</li>
127
+ <li><strong>Pose</strong>: 相机位姿 (Longitude, Latitude, Fov)。</li>
128
+ <li><strong>Mode</strong>: 浏览模式 (Panorama, Model, etc.)。</li>
129
+ </ul>
130
+ <hr>
131
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">index</span><span class="hl-1">, </span><span class="hl-2">readme</span><span class="hl-1">, </span><span class="hl-2">guide</span><span class="hl-1">, </span><span class="hl-2">map</span><span class="hl-1">]</span>
132
+ </code><button type="button">Copy</button></pre>
133
+
134
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-sdk-documentation"><span>Five <wbr/>SDK <wbr/>Documentation</span></a><ul><li><a href="#context-for-ai-agents"><span>Context for <wbr/>AI <wbr/>Agents</span></a></li><li><ul><li><a href="#1-documentation-maintenance-文档维护"><span>1. <wbr/>Documentation <wbr/>Maintenance (文档维护)</span></a></li><li><a href="#2-application-development-strategy-应用开发建议"><span>2. <wbr/>Application <wbr/>Development <wbr/>Strategy (应用开发建议)</span></a></li><li><a href="#3-general-retrieval-通用检索"><span>3. <wbr/>General <wbr/>Retrieval (通用检索)</span></a></li></ul></li><li><a href="#documentation-map"><span>Documentation <wbr/>Map</span></a></li><li><ul><li><a href="#1-essential-reference-必读速查"><span>1. <wbr/>Essential <wbr/>Reference (必读/速查)</span></a></li><li><a href="#2-core-concepts-核心概念"><span>2. <wbr/>Core <wbr/>Concepts (核心概念)</span></a></li><li><a href="#3-data-resource-数据与资源"><span>3. <wbr/>Data &amp; <wbr/>Resource (数据与资源)</span></a></li><li><a href="#4-rendering-visuals-渲染与视觉"><span>4. <wbr/>Rendering &amp; <wbr/>Visuals (渲染与视觉)</span></a></li><li><a href="#5-interaction-control-交互与控制"><span>5. <wbr/>Interaction &amp; <wbr/>Control (交互与控制)</span></a></li><li><a href="#6-advanced-extensions-进阶与扩展"><span>6. <wbr/>Advanced &amp; <wbr/>Extensions (进阶与扩展)</span></a></li><li><a href="#7-meta-support-其他"><span>7. <wbr/>Meta &amp; <wbr/>Support (其他)</span></a></li></ul></li><li><a href="#terminology-summary"><span>Terminology <wbr/>Summary</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/documents/ai-doc-guidelines.html ADDED
@@ -0,0 +1,117 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ai-doc-guidelines | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ai-doc-guidelines</a></li></ul></div><div class="tsd-panel tsd-typography"><!-- AI-friendly guide template for `ai_guides/` -->
2
+ <h1 id="ai-文档与维护指南-ai-documentation-maintenance-guide" class="tsd-anchor-link">AI 文档与维护指南 (AI Documentation &amp; Maintenance Guide)<a href="#ai-文档与维护指南-ai-documentation-maintenance-guide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
3
+ <h2 id="summary" class="tsd-anchor-link">Summary<a href="#summary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
4
+ <p>本文档包含两部分内容：</p>
5
+ <ol>
6
+ <li><strong>Writing Guide</strong>: 供 AI 和人类编写新文档时的标准模板与风格规范。</li>
7
+ <li><strong>Maintenance Guide</strong>: 供 AI 维护者进行文档更新、同步与体检的操作指南。</li>
8
+ </ol>
9
+ <hr>
10
+ <h1 id="part-1-writing-guide-编写指南" class="tsd-anchor-link">Part 1: Writing Guide (编写指南)<a href="#part-1-writing-guide-编写指南" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
11
+ <h2 id="目的" class="tsd-anchor-link">目的<a href="#目的" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
12
+ <p>提供统一、结构化的 Markdown 模板，便于 AI 自动解析、索引与生成功能性示例。</p>
13
+ <h2 id="建议风格" class="tsd-anchor-link">建议风格<a href="#建议风格" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
14
+ <ul>
15
+ <li>使用中文为主，代码示例使用 TypeScript。</li>
16
+ <li><strong>受众意识</strong>: 文档面向 SDK 的<strong>外部使用者</strong>。避免暴露无用的内部实现细节（如私有属性、临时状态），除非对调试有帮助。</li>
17
+ <li><strong>结构规范</strong>: 严格使用二级标题 (<code>##</code>) 作为主要段落分割（如 <code>## Schema</code>, <code>## Concepts</code>），避免使用中文标题（如 <code>## 格式说明</code>）。</li>
18
+ <li><strong>代码缩进</strong>: 强制使用 <strong>两个空格</strong> 缩进。</li>
19
+ <li><strong>相对路径</strong>: 内部文档链接必须使用 <strong>相对路径</strong>（如 <code>./state.md</code>）。</li>
20
+ <li><strong>Schema</strong>: 必须提供 TypeScript Interface 定义，并保留关键字段的注释（JSDoc）。
21
+ <ul>
22
+ <li><strong>精简原则</strong>: 仅展示核心与常用字段，避免列出所有内部或废弃字段。</li>
23
+ </ul>
24
+ </li>
25
+ <li><strong>Configuration</strong>: 对于参数较多的配置项，建议按 <strong>“常用 (Common)”</strong>、<strong>“进阶 (Advanced)”</strong>、<strong>“内部 (Internal)”</strong> 进行分类表格展示，并在内部参数处添加“不建议修改”的警告。</li>
26
+ <li><strong>Source Link</strong>: 引用源码文件时，请在 <code>## Schema</code> 章节中使用 <code>&gt; **Definition**: [InterfaceName](../../path/to/source.ts)</code> 的格式。<strong>支持多个链接</strong>（如 <code>[Five](...), [EventTypes](...)</code>），以便完整覆盖相关类型。<strong>必须</strong> 指向 <code>lib/</code> 目录下的 <code>.ts</code> 文件。构建脚本会自动将其转换为发布包中的 <code>.d.ts</code> 链接。</li>
27
+ <li><strong>Related</strong>: 文档末尾建议包含 <code>## Related</code> 章节，提供相关文档的<strong>相对路径链接</strong>。
28
+ <ul>
29
+ <li><strong>语义化</strong>: 链接文字应准确反映目标文档的主题（如 <code>[Coordinate System](./coordinate.md)</code>）。</li>
30
+ </ul>
31
+ </li>
32
+ <li><strong>Metadata</strong>: 结尾必须包含 YAML 格式的 <code>tags</code>。</li>
33
+ <li><strong>文档拆分与审查</strong>: 单个文档应保持精简。若内容过多需拆分为新专题，<strong>必须</strong>在创建新文件前向用户确认并获得批准，严禁擅自创建新文件。</li>
34
+ </ul>
35
+ <h2 id="最佳实践-best-practices" class="tsd-anchor-link">最佳实践 (Best Practices)<a href="#最佳实践-best-practices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
36
+ <h3 id="1-变量命名语义化-semantic-variable-naming" class="tsd-anchor-link">1. 变量命名语义化 (Semantic Variable Naming)<a href="#1-变量命名语义化-semantic-variable-naming" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
37
+ <p>在示例代码中，变量名应准确反映其通用性或特定上下文。</p>
38
+ <ul>
39
+ <li><strong>Good</strong>: <code>parentParameter</code> (暗示可用于 Model, ViewLayer 等多种父级)</li>
40
+ <li><strong>Bad</strong>: <code>modelParam</code> (若该逻辑同样适用于 ViewLayer，则会误导用户)</li>
41
+ </ul>
42
+ <h3 id="2-区分属性与方法-property-vs-method" class="tsd-anchor-link">2. 区分属性与方法 (Property vs Method)<a href="#2-区分属性与方法-property-vs-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
43
+ <p>明确区分“直接访问属性”与“调用方法计算”。</p>
44
+ <ul>
45
+ <li>若 API 设计为 Getter (如 <code>parameter.opacity</code>)，文档应引导用户直接访问属性，避免混淆使用 <code>get()</code> 方法。</li>
46
+ <li>对于涉及计算或继承的逻辑 (如 <code>resolveValue()</code>)，应显式说明其与直接访问的区别。</li>
47
+ </ul>
48
+ <h3 id="3-显式说明默认行为-explicit-default-behavior" class="tsd-anchor-link">3. 显式说明默认行为 (Explicit Default Behavior)<a href="#3-显式说明默认行为-explicit-default-behavior" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
49
+ <p>对于有默认值或继承逻辑的方法，务必说明“不传参”时的行为。</p>
50
+ <ul>
51
+ <li>例如：<code>resolveValue()</code> 不传参时仅计算默认值；传入 <code>upstream</code> 时会包含继承逻辑。</li>
52
+ </ul>
53
+ <h2 id="标准模板结构-standard-template-structure" class="tsd-anchor-link">标准模板结构 (Standard Template Structure)<a href="#标准模板结构-standard-template-structure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
54
+ <p>无论是<strong>新建文档</strong>还是<strong>维护现有文档</strong>，都请参考独立模板文件：<a href="template.html">template.md</a>。</p>
55
+ <ul>
56
+ <li><strong>新建文档</strong>: 直接复制模板内容开始编写。</li>
57
+ <li><strong>维护文档</strong>: 在修改现有文档时，请检查其结构是否符合模板要求（如 Schema 的 Definition 引用、Configuration 的分类等）。如果发现结构过时，请顺手将其标准化。</li>
58
+ <li><strong>特殊说明 (Special Notes)</strong>:
59
+ <ul>
60
+ <li><strong>模板链接格式 (Template Link Format)</strong>:
61
+ <ul>
62
+ <li>模板(<code>template.md</code>)中所有的占位符链接（如 <code>Definition</code> 处的 <code>[InterfaceName](...)</code> 或 <code>Related</code> 处的 <code>[RelatedConcept](...)</code>）均使用了<strong>代码块</strong>包裹，以避免构建时因路径不存在而报错。</li>
63
+ <li><strong>AI 操作</strong>: 在编写正式文档时，<strong>必须将其还原为可点击的标准 Markdown 链接</strong>（即去掉反引号），并确保路径指向真实存在的文件。</li>
64
+ </ul>
65
+ </li>
66
+ </ul>
67
+ </li>
68
+ </ul>
69
+ <p>请严格遵循该模板的结构，以保证文档风格一致性。</p>
70
+ <hr>
71
+ <h1 id="part-2-maintenance-guide-维护指南" class="tsd-anchor-link">Part 2: Maintenance Guide (维护指南)<a href="#part-2-maintenance-guide-维护指南" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
72
+ <h2 id="核心原则-core-principles" class="tsd-anchor-link">核心原则 (Core Principles)<a href="#核心原则-core-principles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
73
+ <p>为了防止文档与代码脱节，我们遵循 <strong>“代码变更驱动文档更新”</strong> 的原则。</p>
74
+ <h2 id="1-语义化检索-semantic-retrieval" class="tsd-anchor-link">1. 语义化检索 (Semantic Retrieval)<a href="#1-语义化检索-semantic-retrieval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
75
+ <p>不再维护硬编码的“源码-文档”映射表。AI 维护者在修改代码后，应利用自身的语义搜索能力（如 <code>SearchCodebase</code> 或 <code>Grep</code>）来定位需要更新的文档。</p>
76
+ <p><strong>推荐策略</strong>:</p>
77
+ <ul>
78
+ <li>搜索<strong>类名/方法名</strong>: 如修改了 <code>five.load</code>，搜索 <code>five.load</code> 或 <code>load</code>。</li>
79
+ <li>搜索<strong>概念关键词</strong>: 如修改了射线检测逻辑，搜索 <code>Raycast</code> 或 <code>project2d</code>。</li>
80
+ </ul>
81
+ <h2 id="2-单一事实来源-single-source-of-truth" class="tsd-anchor-link">2. 单一事实来源 (Single Source of Truth)<a href="#2-单一事实来源-single-source-of-truth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
82
+ <ul>
83
+ <li><strong>API 签名</strong>: 以 <code>package/five/index.d.ts</code> 和代码中的 TSDoc 为准。</li>
84
+ <li><strong>ai_guides/api.md</strong>: 仅作为 <strong>索引 (Index)</strong> 和 <strong>摘要 (Summary)</strong>。不要试图复制所有参数细节，除非是核心参数。</li>
85
+ <li><strong>ai_guides/features/*.md</strong>: 重点解释 <strong>“为什么”</strong> 和 <strong>“怎么用”</strong>，避免机械复制类型定义。</li>
86
+ </ul>
87
+ <h2 id="3-维护工作流-maintenance-workflow" class="tsd-anchor-link">3. 维护工作流 (Maintenance Workflow)<a href="#3-维护工作流-maintenance-workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
88
+ <h3 id="场景-a：代码功能迭代后-post-coding" class="tsd-anchor-link">场景 A：代码功能迭代后 (Post-Coding)<a href="#场景-a：代码功能迭代后-post-coding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
89
+ <p>当修改了 SDK 源码后，请执行以下检查：</p>
90
+ <ol>
91
+ <li><strong>反向查找</strong>: 利用工具搜索关键词（API 名称、Feature 名称），找到 <code>ai_guides/</code> 下相关的文档。</li>
92
+ <li><strong>更新文档</strong>:
93
+ <ul>
94
+ <li>如果修改了 API 签名 -&gt; 更新对应的 <code>Schema</code> 和 <code>Examples</code>。</li>
95
+ <li>如果废弃了功能 -&gt; 在文档中添加 <code>&gt; [!WARNING] Deprecated</code> 提示。</li>
96
+ </ul>
97
+ </li>
98
+ <li><strong>更新索引</strong>: 如果是新功能，确保将其添加到 <code>ai_guides/README.md</code> 的合适章节中。</li>
99
+ <li><strong>同步 llms.txt</strong>: 若新增了文档或修改了文档路径，<strong>必须</strong>同步更新项目根目录下的 <code>llms.txt</code>，确保外部索引与 <code>ai_guides/</code> 保持一致。</li>
100
+ </ol>
101
+ <h3 id="场景-b：api-文档同步-sync-api-doc" class="tsd-anchor-link">场景 B：API 文档同步 (Sync API Doc)<a href="#场景-b：api-文档同步-sync-api-doc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
102
+ <p>定期检查 <code>ai_guides/api.md</code> 的完整性：</p>
103
+ <ol>
104
+ <li>读取 <code>package/five/index.d.ts</code> 获取最新公开 API。</li>
105
+ <li>对比 <code>ai_guides/api.md</code>，找出缺失的高频 API 或已删除的 API。</li>
106
+ <li><strong>注意</strong>: 只收录高频/核心 API，低频 API 应引导用户查看源码或专门的 Feature 文档。</li>
107
+ </ol>
108
+ <h2 id="目录结构说明" class="tsd-anchor-link">目录结构说明<a href="#目录结构说明" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
109
+ <ul>
110
+ <li><code>ai_guides/</code>: 文档根目录。</li>
111
+ <li><code>ai_guides/features/</code>: 功能性文档 (Features)。</li>
112
+ <li><code>ai_guides/release_notes/</code>: 版本更新记录。</li>
113
+ <li><code>ai_guides/api.md</code>: 核心 API 索引。</li>
114
+ <li><code>ai_guides/README.md</code>: 文档总索引。</li>
115
+ <li><code>package/five/index.d.ts</code>: <strong>API 签名的真理来源</strong>。</li>
116
+ </ul>
117
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ai-文档与维护指南-ai-documentation-maintenance-guide"><span>AI 文档与维护指南 (<wbr/>AI <wbr/>Documentation &amp; <wbr/>Maintenance <wbr/>Guide)</span></a><ul><li><a href="#summary"><span>Summary</span></a></li></ul><a href="#part-1-writing-guide-编写指南"><span>Part 1: <wbr/>Writing <wbr/>Guide (编写指南)</span></a><ul><li><a href="#目的"><span>目的</span></a></li><li><a href="#建议风格"><span>建议风格</span></a></li><li><a href="#最佳实践-best-practices"><span>最佳实践 (<wbr/>Best <wbr/>Practices)</span></a></li><li><ul><li><a href="#1-变量命名语义化-semantic-variable-naming"><span>1. 变量命名语义化 (<wbr/>Semantic <wbr/>Variable <wbr/>Naming)</span></a></li><li><a href="#2-区分属性与方法-property-vs-method"><span>2. 区分属性与方法 (<wbr/>Property vs <wbr/>Method)</span></a></li><li><a href="#3-显式说明默认行为-explicit-default-behavior"><span>3. 显式说明默认行为 (<wbr/>Explicit <wbr/>Default <wbr/>Behavior)</span></a></li></ul></li><li><a href="#标准模板结构-standard-template-structure"><span>标准模板结构 (<wbr/>Standard <wbr/>Template <wbr/>Structure)</span></a></li></ul><a href="#part-2-maintenance-guide-维护指南"><span>Part 2: <wbr/>Maintenance <wbr/>Guide (维护指南)</span></a><ul><li><a href="#核心原则-core-principles"><span>核心原则 (<wbr/>Core <wbr/>Principles)</span></a></li><li><a href="#1-语义化检索-semantic-retrieval"><span>1. 语义化检索 (<wbr/>Semantic <wbr/>Retrieval)</span></a></li><li><a href="#2-单一事实来源-single-source-of-truth"><span>2. 单一事实来源 (<wbr/>Single <wbr/>Source of <wbr/>Truth)</span></a></li><li><a href="#3-维护工作流-maintenance-workflow"><span>3. 维护工作流 (<wbr/>Maintenance <wbr/>Workflow)</span></a></li><li><ul><li><a href="#场景-a：代码功能迭代后-post-coding"><span>场景 <wbr/>A：代码功能迭代后 (<wbr/>Post-<wbr/>Coding)</span></a></li><li><a href="#场景-b：api-文档同步-sync-api-doc"><span>场景 <wbr/>B：<wbr/>API 文档同步 (<wbr/>Sync <wbr/>API <wbr/>Doc)</span></a></li></ul></li><li><a href="#目录结构说明"><span>目录结构说明</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>