@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
package/docs/documents/features_get-screen-pixels.html ADDED
@@ -0,0 +1,88 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/get-screen-pixels | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/get-screen-pixels</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="获取屏幕像素-get-screen-pixels" class="tsd-anchor-link">获取屏幕像素 (Get Screen Pixels)<a href="#获取屏幕像素-get-screen-pixels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
2
+ <ul>
3
+ <li><strong>Summary</strong>: <code>five.getPixels</code> 方法用于获取 Five 画布指定区域的像素数据（RGBA），常用于实现放大镜、取色器或截图功能。</li>
4
+ <li><strong>Schema</strong>: <code>GetPixelsOptions</code>。</li>
5
+ <li><strong>Concepts</strong>: <code>WebGLRenderTarget</code>, <code>gl.readPixels</code>, <code>Magnifier</code>。</li>
6
+ <li><strong>Examples</strong>: 放大镜实现、获取中心点颜色。</li>
7
+ </ul>
8
+ <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
9
+ <blockquote>
10
+ <p><strong>Definition</strong>: <a href="../../five/application/five.d.ts">GetPixelsOptions</a></p>
11
+ </blockquote>
12
+ <p><code>five.getPixels</code> 支持两种调用方式：参数列表（旧版）和对象参数（推荐）。</p>
13
+ <h3 id="推荐调用方式" class="tsd-anchor-link">推荐调用方式<a href="#推荐调用方式" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
14
+ <pre><code class="typescript"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">getPixels</span><span class="hl-1">(</span><span class="hl-6">options</span><span class="hl-1">: </span><span class="hl-6">GetPixelsOptions</span><span class="hl-1">): </span><span class="hl-6">Uint8Array</span><span class="hl-1"> | </span><span class="hl-6">Uint8ClampedArray</span><span class="hl-1">;</span><br/><br/><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">GetPixelsOptions</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 获取像素区域的起始坐标 x (基于 Canvas 左下角，除非 flipY 为 true) */</span><br/><span class="hl-1"> </span><span class="hl-6">x</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 获取像素区域的起始坐标 y */</span><br/><span class="hl-1"> </span><span class="hl-6">y</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 获取像素区域的宽度 */</span><br/><span class="hl-1"> </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 获取像素区域的高度 */</span><br/><span class="hl-1"> </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 获取区域的像素比 (默认 1) */</span><br/><span class="hl-1"> </span><span class="hl-6">pixelRatio</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否显示辅助元素 (默认 false) */</span><br/><span class="hl-1"> </span><span class="hl-6">helperVisible</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否跳过全景图渲染 (仅渲染模型) */</span><br/><span class="hl-1"> </span><span class="hl-6">skipPanorama</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否 Y 轴翻转 (通常设为 true 以匹配 Canvas 2D 坐标系) */</span><br/><span class="hl-1"> </span><span class="hl-6">flipY</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 存储数组 (可选，复用数组以提升性能) */</span><br/><span class="hl-1"> </span><span class="hl-6">buffer</span><span class="hl-1">?: </span><span class="hl-7">Uint8Array</span><span class="hl-1"> | </span><span class="hl-7">Uint8ClampedArray</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
15
+ </code><button type="button">Copy</button></pre>
16
+
17
+ <h3 id="简写调用方式-不推荐" class="tsd-anchor-link">简写调用方式 (不推荐)<a href="#简写调用方式-不推荐" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
18
+ <pre><code class="typescript"><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">getPixels</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-6">x</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">y</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">pixelRatio</span><span class="hl-1">?: </span><span class="hl-6">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">flipY</span><span class="hl-1">?: </span><span class="hl-6">boolean</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">buffer</span><span class="hl-1">?: </span><span class="hl-6">Uint8Array</span><span class="hl-1"> | </span><span class="hl-6">Uint8ClampedArray</span><br/><span class="hl-1">): </span><span class="hl-6">Uint8Array</span><span class="hl-1"> | </span><span class="hl-6">Uint8ClampedArray</span><span class="hl-1">;</span>
19
+ </code><button type="button">Copy</button></pre>
20
+
21
+ <h2 id="concepts" class="tsd-anchor-link">Concepts<a href="#concepts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
22
+ <h3 id="坐标系统-coordinate-system" class="tsd-anchor-link">坐标系统 (Coordinate System)<a href="#坐标系统-coordinate-system" 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>
23
+ <ul>
24
+ <li><strong>WebGL 坐标系</strong>: 原点在左下角。</li>
25
+ <li><strong>Canvas 2D 坐标系</strong>: 原点在左上角。</li>
26
+ <li><strong>flipY 参数</strong>: 当你需要将数据绘制到 Canvas 2D Context (<code>putImageData</code>) 时，通常需要将 <code>flipY</code> 设置为 <code>true</code>，否则图像是倒置的。</li>
27
+ </ul>
28
+ <h3 id="性能注意事项-performance" class="tsd-anchor-link">性能注意事项 (Performance)<a href="#性能注意事项-performance" 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>
29
+ <ul>
30
+ <li><code>five.getPixels</code> 会触发 WebGL 的 <code>readPixels</code> 操作，这是一个同步且耗时的操作（会阻塞 GPU 流水线）。</li>
31
+ <li><strong>优化建议</strong>:
32
+ <ul>
33
+ <li>避免在每一帧都调用。</li>
34
+ <li>尽量复用 <code>buffer</code> 数组，避免频繁创建新的 <code>Uint8Array</code>。</li>
35
+ <li>仅获取需要的区域（<code>width</code> 和 <code>height</code> 越小越好）。</li>
36
+ </ul>
37
+ </li>
38
+ </ul>
39
+ <h2 id="examples" class="tsd-anchor-link">Examples<a href="#examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
40
+ <h3 id="放大镜-magnifier" class="tsd-anchor-link">放大镜 (Magnifier)<a href="#放大镜-magnifier" 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>
41
+ <p>这是一个经典的放大镜实现示例。通过获取鼠标周围的像素，并以更高的 <code>pixelRatio</code> 重新渲染，从而获得清晰的放大效果。</p>
42
+ <pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> </span><span class="hl-3">*</span><span class="hl-1"> </span><span class="hl-10">as</span><span class="hl-1"> </span><span class="hl-6">THREE</span><span class="hl-1"> </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&#39;three&#39;</span><span class="hl-1">;</span><br/><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&#39;@realsee/five&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// 假设有一个用于显示的 canvas</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">magnifierCanvas</span><span class="hl-1"> = </span><span class="hl-6">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-9">&#39;magnifier-canvas&#39;</span><span class="hl-1">) </span><span class="hl-10">as</span><span class="hl-1"> </span><span class="hl-7">HTMLCanvasElement</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ctx</span><span class="hl-1"> = </span><span class="hl-6">magnifierCanvas</span><span class="hl-1">.</span><span class="hl-5">getContext</span><span class="hl-1">(</span><span class="hl-9">&#39;2d&#39;</span><span class="hl-1">)!;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">magnifierSize</span><span class="hl-1"> = </span><span class="hl-11">200</span><span class="hl-1">; </span><span class="hl-8">// 放大镜尺寸 200px</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">scale</span><span class="hl-1"> = </span><span class="hl-11">2</span><span class="hl-1">; </span><span class="hl-8">// 放大倍数</span><br/><br/><span class="hl-8">// 预先创建 Buffer 以提升性能</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">pixelWidth</span><span class="hl-1"> = </span><span class="hl-6">magnifierSize</span><span class="hl-1"> * </span><span class="hl-6">scale</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">pixelHeight</span><span class="hl-1"> = </span><span class="hl-6">magnifierSize</span><span class="hl-1"> * </span><span class="hl-6">scale</span><span class="hl-1">;</span><br/><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-6">magnifierImageData</span><span class="hl-1"> = </span><span class="hl-6">ctx</span><span class="hl-1">.</span><span class="hl-5">createImageData</span><span class="hl-1">(</span><span class="hl-6">pixelWidth</span><span class="hl-1">, </span><span class="hl-6">pixelHeight</span><span class="hl-1">);</span><br/><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&#39;gesture.mousemove&#39;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">// 1. 获取鼠标在 Canvas 上的坐标</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">mouse</span><span class="hl-1"> = </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-6">pointers</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">]?.</span><span class="hl-6">coords</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-10">if</span><span class="hl-1"> (!</span><span class="hl-6">mouse</span><span class="hl-1">) </span><span class="hl-10">return</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// 转换归一化坐标 (-1 到 1) 到 像素坐标</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">renderSize</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">getSize</span><span class="hl-1">(</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-4">THREE</span><span class="hl-1">.</span><span class="hl-5">Vector2</span><span class="hl-1">());</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">x</span><span class="hl-1"> = (</span><span class="hl-6">mouse</span><span class="hl-1">.</span><span class="hl-6">x</span><span class="hl-1"> + </span><span class="hl-11">1</span><span class="hl-1">) / </span><span class="hl-11">2</span><span class="hl-1"> * </span><span class="hl-6">renderSize</span><span class="hl-1">.</span><span class="hl-6">x</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">y</span><span class="hl-1"> = (</span><span class="hl-6">mouse</span><span class="hl-1">.</span><span class="hl-6">y</span><span class="hl-1"> + </span><span class="hl-11">1</span><span class="hl-1">) / </span><span class="hl-11">2</span><span class="hl-1"> * </span><span class="hl-6">renderSize</span><span class="hl-1">.</span><span class="hl-6">y</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// 2. 获取像素数据</span><br/><span class="hl-1"> </span><span class="hl-8">// 注意：我们以更高的分辨率 (pixelRatio * scale) 渲染小区域，从而获得“无损”放大效果</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">pixelRatio</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-6">renderer</span><span class="hl-1">?.</span><span class="hl-5">getPixelRatio</span><span class="hl-1">() ?? </span><span class="hl-11">1</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">targetPixelRatio</span><span class="hl-1"> = </span><span class="hl-6">Math</span><span class="hl-1">.</span><span class="hl-5">ceil</span><span class="hl-1">(</span><span class="hl-6">pixelRatio</span><span class="hl-1"> * </span><span class="hl-6">scale</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">getPixels</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">x:</span><span class="hl-1"> </span><span class="hl-6">x</span><span class="hl-1"> - </span><span class="hl-6">magnifierSize</span><span class="hl-1"> / </span><span class="hl-11">2</span><span class="hl-1">, </span><span class="hl-8">// 居中</span><br/><span class="hl-1"> </span><span class="hl-6">y:</span><span class="hl-1"> </span><span class="hl-6">y</span><span class="hl-1"> - </span><span class="hl-6">magnifierSize</span><span class="hl-1"> / </span><span class="hl-11">2</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">width:</span><span class="hl-1"> </span><span class="hl-6">magnifierSize</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">height:</span><span class="hl-1"> </span><span class="hl-6">magnifierSize</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">pixelRatio:</span><span class="hl-1"> </span><span class="hl-6">targetPixelRatio</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">flipY:</span><span class="hl-1"> </span><span class="hl-3">true</span><span class="hl-1">, </span><span class="hl-8">// 翻转以适配 Canvas 2D</span><br/><span class="hl-1"> </span><span class="hl-6">buffer:</span><span class="hl-1"> </span><span class="hl-6">magnifierImageData</span><span class="hl-1">.</span><span class="hl-6">data</span><span class="hl-1">, </span><span class="hl-8">// 复用 buffer</span><br/><span class="hl-1"> </span><span class="hl-6">helperVisible:</span><span class="hl-1"> </span><span class="hl-3">false</span><span class="hl-1">, </span><span class="hl-8">// 隐藏辅助线等干扰元素</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// 3. 将数据绘制到放大镜 Canvas 上</span><br/><span class="hl-1"> </span><span class="hl-8">// 需要调整 Canvas 尺寸以匹配数据</span><br/><span class="hl-1"> </span><span class="hl-6">magnifierCanvas</span><span class="hl-1">.</span><span class="hl-6">width</span><span class="hl-1"> = </span><span class="hl-6">pixelWidth</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">magnifierCanvas</span><span class="hl-1">.</span><span class="hl-6">height</span><span class="hl-1"> = </span><span class="hl-6">pixelHeight</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">ctx</span><span class="hl-1">.</span><span class="hl-5">putImageData</span><span class="hl-1">(</span><span class="hl-6">magnifierImageData</span><span class="hl-1">, </span><span class="hl-11">0</span><span class="hl-1">, </span><span class="hl-11">0</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// 4. 更新放大镜位置 (CSS)</span><br/><span class="hl-1"> </span><span class="hl-6">magnifierCanvas</span><span class="hl-1">.</span><span class="hl-6">style</span><span class="hl-1">.</span><span class="hl-6">left</span><span class="hl-1"> = </span><span class="hl-9">`</span><span class="hl-3">${</span><span class="hl-6">x</span><span class="hl-12"> </span><span class="hl-1">-</span><span class="hl-12"> </span><span class="hl-6">magnifierSize</span><span class="hl-12"> </span><span class="hl-1">/</span><span class="hl-12"> </span><span class="hl-11">2</span><span class="hl-3">}</span><span class="hl-9">px`</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">magnifierCanvas</span><span class="hl-1">.</span><span class="hl-6">style</span><span class="hl-1">.</span><span class="hl-6">top</span><span class="hl-1"> = </span><span class="hl-9">`</span><span class="hl-3">${</span><span class="hl-6">renderSize</span><span class="hl-12">.</span><span class="hl-6">y</span><span class="hl-12"> </span><span class="hl-1">-</span><span class="hl-12"> </span><span class="hl-6">y</span><span class="hl-12"> </span><span class="hl-1">-</span><span class="hl-12"> </span><span class="hl-6">magnifierSize</span><span class="hl-12"> </span><span class="hl-1">/</span><span class="hl-12"> </span><span class="hl-11">2</span><span class="hl-3">}</span><span class="hl-9">px`</span><span class="hl-1">; </span><span class="hl-8">// 注意 Y 轴方向</span><br/><span class="hl-1">});</span>
43
+ </code><button type="button">Copy</button></pre>
44
+
45
+ <h3 id="获取中心点颜色-color-picker" class="tsd-anchor-link">获取中心点颜色 (Color Picker)<a href="#获取中心点颜色-color-picker" 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>
46
+ <p>获取屏幕中心点的颜色。</p>
47
+ <pre><code class="typescript"><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">getCenterColor</span><span class="hl-1">(</span><span class="hl-6">five</span><span class="hl-1">: </span><span class="hl-7">Five</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">size</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">getSize</span><span class="hl-1">(</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-4">THREE</span><span class="hl-1">.</span><span class="hl-5">Vector2</span><span class="hl-1">());</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">x</span><span class="hl-1"> = </span><span class="hl-6">size</span><span class="hl-1">.</span><span class="hl-6">x</span><span class="hl-1"> / </span><span class="hl-11">2</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">y</span><span class="hl-1"> = </span><span class="hl-6">size</span><span class="hl-1">.</span><span class="hl-6">y</span><span class="hl-1"> / </span><span class="hl-11">2</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">pixels</span><span class="hl-1"> = </span><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">getPixels</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">x:</span><span class="hl-1"> </span><span class="hl-6">x</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">y:</span><span class="hl-1"> </span><span class="hl-6">y</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">width:</span><span class="hl-1"> </span><span class="hl-11">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">height:</span><span class="hl-1"> </span><span class="hl-11">1</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">flipY:</span><span class="hl-1"> </span><span class="hl-3">true</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">r</span><span class="hl-1"> = </span><span class="hl-6">pixels</span><span class="hl-1">[</span><span class="hl-11">0</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">g</span><span class="hl-1"> = </span><span class="hl-6">pixels</span><span class="hl-1">[</span><span class="hl-11">1</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">b</span><span class="hl-1"> = </span><span class="hl-6">pixels</span><span class="hl-1">[</span><span class="hl-11">2</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> = </span><span class="hl-6">pixels</span><span class="hl-1">[</span><span class="hl-11">3</span><span class="hl-1">];</span><br/><br/><span class="hl-1"> </span><span class="hl-10">return</span><span class="hl-1"> </span><span class="hl-9">`rgba(</span><span class="hl-3">${</span><span class="hl-6">r</span><span class="hl-3">}</span><span class="hl-9">, </span><span class="hl-3">${</span><span class="hl-6">g</span><span class="hl-3">}</span><span class="hl-9">, </span><span class="hl-3">${</span><span class="hl-6">b</span><span class="hl-3">}</span><span class="hl-9">, </span><span class="hl-3">${</span><span class="hl-6">a</span><span class="hl-12"> </span><span class="hl-1">/</span><span class="hl-12"> </span><span class="hl-11">255</span><span class="hl-3">}</span><span class="hl-9">)`</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
48
+ </code><button type="button">Copy</button></pre>
49
+
50
+ <h2 id="common-pitfalls" class="tsd-anchor-link">Common Pitfalls<a href="#common-pitfalls" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
51
+ <ol>
52
+ <li>
53
+ <p><strong>坑点1: 图像倒置</strong>:</p>
54
+ <ul>
55
+ <li><strong>现象</strong>: 获取到的图像是上下颠倒的。</li>
56
+ <li><strong>解决</strong>: 检查 <code>flipY</code> 参数。如果直接用于 Canvas 2D <code>putImageData</code>，通常需要 <code>flipY: true</code>。</li>
57
+ </ul>
58
+ </li>
59
+ <li>
60
+ <p><strong>坑点2: 性能卡顿</strong>:</p>
61
+ <ul>
62
+ <li><strong>现象</strong>: 开启放大镜后，页面帧率显著下降。</li>
63
+ <li><strong>解决</strong>:
64
+ <ul>
65
+ <li>确保使用了 <code>buffer</code> 参数复用内存。</li>
66
+ <li>检查 <code>width</code> 和 <code>height</code> 是否过大。</li>
67
+ <li>确保 <code>pixelRatio</code> 不要设置得过高（例如不要超过 4）。</li>
68
+ </ul>
69
+ </li>
70
+ </ul>
71
+ </li>
72
+ <li>
73
+ <p><strong>坑点3: 渲染内容不全</strong>:</p>
74
+ <ul>
75
+ <li><strong>现象</strong>: 放大镜里只有背景，没有模型。</li>
76
+ <li><strong>解决</strong>: 检查 <code>skipPanorama</code> 参数。如果需要看全景图，确保设为 <code>false</code>（默认）。如果只想看模型细节（如在 Floorplan 模式），可以设为 <code>true</code>。</li>
77
+ </ul>
78
+ </li>
79
+ </ol>
80
+ <h2 id="related" class="tsd-anchor-link">Related<a href="#related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
81
+ <ul>
82
+ <li><a href="api.html">api.md</a>: Five 核心 API 说明。</li>
83
+ </ul>
84
+ <hr>
85
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">getPixels</span><span class="hl-1">, </span><span class="hl-2">magnifier</span><span class="hl-1">, </span><span class="hl-2">screenshot</span><span class="hl-1">, </span><span class="hl-2">pixel</span><span class="hl-1">, </span><span class="hl-2">canvas</span><span class="hl-1">]</span>
86
+ </code><button type="button">Copy</button></pre>
87
+
88
+ </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="#获取屏幕像素-get-screen-pixels"><span>获取屏幕像素 (<wbr/>Get <wbr/>Screen <wbr/>Pixels)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#推荐调用方式"><span>推荐调用方式</span></a></li><li><a href="#简写调用方式-不推荐"><span>简写调用方式 (不推荐)</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#坐标系统-coordinate-system"><span>坐标系统 (<wbr/>Coordinate <wbr/>System)</span></a></li><li><a href="#性能注意事项-performance"><span>性能注意事项 (<wbr/>Performance)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#放大镜-magnifier"><span>放大镜 (<wbr/>Magnifier)</span></a></li><li><a href="#获取中心点颜色-color-picker"><span>获取中心点颜色 (<wbr/>Color <wbr/>Picker)</span></a></li></ul></li><li><a href="#common-pitfalls"><span>Common <wbr/>Pitfalls</span></a></li><li><a href="#related"><span>Related</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/documents/features_image-options.html ADDED
@@ -0,0 +1,108 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/image-options | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/image-options</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="imageoptions-图片配置" class="tsd-anchor-link">ImageOptions (图片配置)<a href="#imageoptions-图片配置" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
2
+ <ul>
3
+ <li><strong>Summary</strong>: <code>Five</code> 初始化参数 <code>imageOptions</code> 用于全局配置全景图与资源的加载策略，支持多云/私有化部署映射、图片格式自适应、质量控制及内部瓦片裁剪。</li>
4
+ <li><strong>Schema</strong>: <code>ImageOptions</code> 接口定义及相关配置。</li>
5
+ <li><strong>Concepts</strong>: CDN Mapping, Format Adaptation, Tile Cutting.</li>
6
+ <li><strong>Configuration</strong>: <code>imageOptions</code> 参数详解。</li>
7
+ <li><strong>Examples</strong>: 基础优化、多云部署映射、瓦片裁剪调用。</li>
8
+ </ul>
9
+ <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
10
+ <h3 id="imageoptions" class="tsd-anchor-link">ImageOptions<a href="#imageoptions" 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>
11
+ <blockquote>
12
+ <p><strong>Definition</strong>: <a href="../../five/types/imageOptions.d.ts">ImageOptions</a></p>
13
+ </blockquote>
14
+ <p>全局图片加载配置接口。</p>
15
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">ImageOptions</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 图片类型标识 (内部使用，如 &quot;pano.front&quot;) */</span><br/><span class="hl-1"> </span><span class="hl-6">key</span><span class="hl-1">?: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 图片尺寸参数 (例如 512, 1024...) */</span><br/><span class="hl-1"> </span><span class="hl-6">size</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 图片质量参数 (0-100) */</span><br/><span class="hl-1"> </span><span class="hl-6">quality</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 图片格式参数</span><br/><span class="hl-8"> * 自动降级逻辑：如果指定格式（如 avif/webp）当前浏览器不支持，会自动降级为 jpg</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">format</span><span class="hl-1">?: </span><span class="hl-9">&quot;jpg&quot;</span><span class="hl-1"> | </span><span class="hl-9">&quot;jpeg&quot;</span><span class="hl-1"> | </span><span class="hl-9">&quot;png&quot;</span><span class="hl-1"> | </span><span class="hl-9">&quot;heif&quot;</span><span class="hl-1"> | </span><span class="hl-9">&quot;heic&quot;</span><span class="hl-1"> | </span><span class="hl-9">&quot;webp&quot;</span><span class="hl-1"> | </span><span class="hl-9">&quot;avif&quot;</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 图片裁切 [x, y, width, height]</span><br/><span class="hl-8"> * 通常用于内部工具获取局部图片，初始化 Five 时一般不设置此项</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">cut</span><span class="hl-1">?: [</span><span class="hl-13">x</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">, </span><span class="hl-13">y</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">, </span><span class="hl-13">width</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">, </span><span class="hl-13">height</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-8">/** 锐化参数 (仅部分 CDN 支持) */</span><br/><span class="hl-1"> </span><span class="hl-6">sharpen</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 域名匹配规则，用于多云或私有化部署 */</span><br/><span class="hl-1"> </span><span class="hl-6">mappings</span><span class="hl-1">?: </span><span class="hl-7">ImageURLMappings</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 自定义 URL 转换函数 */</span><br/><span class="hl-1"> </span><span class="hl-5">transform</span><span class="hl-1">?: (</span><span class="hl-6">url</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-6">options</span><span class="hl-1">: </span><span class="hl-7">ImageURLOptions</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
16
+ </code><button type="button">Copy</button></pre>
17
+
18
+ <h3 id="imageurlmappings" class="tsd-anchor-link">ImageURLMappings<a href="#imageurlmappings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
19
+ <p>域名映射规则配置，用于支持多云存储或私有化部署。</p>
20
+ <pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">ImageURLMappings</span><span class="hl-1"> {</span><br/><span class="hl-1"> [</span><span class="hl-6">publicDomain</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">]: {</span><br/><span class="hl-1"> </span><span class="hl-8">/** CDN 类型，目前支持 &#39;tencentCloud&#39; | &#39;aliyun&#39; 用于区分特定云厂商的图片处理参数 */</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;type&quot;</span><span class="hl-1">?: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 全景图域名映射列表 */</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;pano&quot;</span><span class="hl-1">: [</span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-7">string</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-8">/** 全景图瓦片域名映射列表 */</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;tile&quot;</span><span class="hl-1">: [</span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-7">string</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-8">/** 3D Tile 模型域名映射列表 */</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;model&quot;</span><span class="hl-1">: [</span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-7">string</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-8">/** AT3D 材质域名映射列表 */</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;texture&quot;</span><span class="hl-1">: [</span><span class="hl-7">string</span><span class="hl-1">];</span><br/><span class="hl-1"> </span><span class="hl-8">/** 默认域名映射列表 */</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;default&quot;</span><span class="hl-1">: [</span><span class="hl-7">string</span><span class="hl-1">];</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
21
+ </code><button type="button">Copy</button></pre>
22
+
23
+ <h2 id="concepts" class="tsd-anchor-link">Concepts<a href="#concepts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
24
+ <h3 id="cdn-mapping-多云部署与私有化" class="tsd-anchor-link">CDN Mapping (多云部署与私有化)<a href="#cdn-mapping-多云部署与私有化" 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>
25
+ <p>通过 <code>mappings</code> 字段，可以将原始数据中的 <strong>初始域名</strong>（<code>publicDomain</code>，即数据中尚未进行资源分流的统一地址）映射到不同用途的具体域名下。</p>
26
+ <ul>
27
+ <li><strong>资源分流</strong>: 针对不同资源类型配置不同域名：
28
+ <ul>
29
+ <li><code>pano</code>: 全景图</li>
30
+ <li><code>tile</code>: 全景图瓦片</li>
31
+ <li><code>model</code>: 3D Tile 模型</li>
32
+ <li><code>texture</code>: AT3D 材质</li>
33
+ </ul>
34
+ </li>
35
+ <li><strong>负载均衡</strong>: 每个资源类型支持配置多个域名（如 <code>[domain1, domain2]</code>），SDK 会自动进行轮询负载均衡。</li>
36
+ <li><strong>私有化支持</strong>: 将初始数据中的通用域名映射到内网或私有 OSS 域名。</li>
37
+ <li><strong>CDN 适配</strong>: 指定 <code>type</code> ('tencentCloud' | 'aliyun') 可启用特定云厂商的图片处理参数（如缩放、裁剪、格式转换）。</li>
38
+ </ul>
39
+ <h3 id="format-adaptation-浏览器兼容性" class="tsd-anchor-link">Format Adaptation (浏览器兼容性)<a href="#format-adaptation-浏览器兼容性" 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>
40
+ <p>SDK 内置了图片格式兼容性检测（<code>imageSupport</code>）。</p>
41
+ <ul>
42
+ <li><strong>自动降级</strong>: 当配置 <code>format: 'webp'</code> 或 <code>format: 'avif'</code> 时，SDK 会检测当前浏览器是否支持该格式。如果不支持，自动降级请求 <code>jpg</code> 格式，确保图片能正常显示。</li>
43
+ <li><strong>性能优化</strong>: 推荐默认开启 <code>avif</code>，在支持的浏览器上大幅减小流量消耗。</li>
44
+ </ul>
45
+ <h3 id="tile-cutting-内部瓦片裁剪" class="tsd-anchor-link">Tile Cutting (内部瓦片裁剪)<a href="#tile-cutting-内部瓦片裁剪" 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>
46
+ <p>利用云厂商的图片处理能力（如腾讯云 ImageMogr2 或阿里云 OSS Process），可以通过 <code>cut</code> 参数获取大图的局部区域。</p>
47
+ <ul>
48
+ <li><strong>应用场景</strong>: 内部工具调用、生成特定视角的缩略图、动态获取全景图的某一部分。</li>
49
+ <li><strong>调用方式</strong>: 通常配合 <code>imageURL</code> 工具函数使用。</li>
50
+ </ul>
51
+ <h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
52
+ <p>在 <code>new Five()</code> 时传入 <code>imageOptions</code>。</p>
53
+ <table>
54
+ <thead>
55
+ <tr>
56
+ <th style="text-align:left">参数</th>
57
+ <th style="text-align:left">类型</th>
58
+ <th style="text-align:left">说明</th>
59
+ </tr>
60
+ </thead>
61
+ <tbody>
62
+ <tr>
63
+ <td style="text-align:left"><code>format</code></td>
64
+ <td style="text-align:left">string</td>
65
+ <td style="text-align:left">推荐设置为 <code>&quot;avif&quot;</code>，SDK 会自动处理兼容性。</td>
66
+ </tr>
67
+ <tr>
68
+ <td style="text-align:left"><code>quality</code></td>
69
+ <td style="text-align:left">number</td>
70
+ <td style="text-align:left">图片质量 (0-100)，非必要不设置。</td>
71
+ </tr>
72
+ <tr>
73
+ <td style="text-align:left"><code>mappings</code></td>
74
+ <td style="text-align:left">object</td>
75
+ <td style="text-align:left">域名映射表，用于替换数据中的原始域名，非必要不设置。</td>
76
+ </tr>
77
+ <tr>
78
+ <td style="text-align:left"><code>size</code></td>
79
+ <td style="text-align:left">number</td>
80
+ <td style="text-align:left">全景图初始尺寸，推荐设置为 <code>512</code>，可根据场景调整。</td>
81
+ </tr>
82
+ </tbody>
83
+ </table>
84
+ <h2 id="examples" class="tsd-anchor-link">Examples<a href="#examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
85
+ <h3 id="基础优化配置-推荐" class="tsd-anchor-link">基础优化配置 (推荐)<a href="#基础优化配置-推荐" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
86
+ <p>启用 AVIF 格式并设置初始尺寸为 <code>512</code>，适用于大多数场景。</p>
87
+ <pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Five</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">imageOptions:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">format:</span><span class="hl-1"> </span><span class="hl-9">&quot;avif&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">size:</span><span class="hl-1"> </span><span class="hl-11">512</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
88
+ </code><button type="button">Copy</button></pre>
89
+
90
+ <h3 id="多云私有化部署配置" class="tsd-anchor-link">多云/私有化部署配置<a href="#多云私有化部署配置" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
91
+ <p>将数据中的 <code>custom-oss-public.ljcdn.com</code> 域名映射到对应的资源专用 OSS 域名。</p>
92
+ <pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Five</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">imageOptions:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">mappings:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">&quot;custom-oss-public.ljcdn.com&quot;</span><span class="hl-6">:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">type:</span><span class="hl-1"> </span><span class="hl-9">&quot;tencentCloud&quot;</span><span class="hl-1">, </span><span class="hl-8">// 指定使用腾讯云图片处理协议</span><br/><span class="hl-1"> </span><span class="hl-6">pano:</span><span class="hl-1"> [</span><span class="hl-9">&quot;custom-oss-image-1.com&quot;</span><span class="hl-1">, </span><span class="hl-9">&quot;custom-oss-image-2.com&quot;</span><span class="hl-1">], </span><span class="hl-8">// 双域名负载均衡</span><br/><span class="hl-1"> </span><span class="hl-6">tile:</span><span class="hl-1"> [</span><span class="hl-9">&quot;custom-oss-tile-1.com&quot;</span><span class="hl-1">, </span><span class="hl-9">&quot;custom-oss-tile-2.com&quot;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-6">model:</span><span class="hl-1"> [</span><span class="hl-9">&quot;custom-oss-model-1.com&quot;</span><span class="hl-1">, </span><span class="hl-9">&quot;custom-oss-model-2.com&quot;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-6">texture:</span><span class="hl-1"> [</span><span class="hl-9">&quot;custom-oss-image-3.com&quot;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-6">default:</span><span class="hl-1"> [</span><span class="hl-9">&quot;custom-oss-image-4.com&quot;</span><span class="hl-1">]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
93
+ </code><button type="button">Copy</button></pre>
94
+
95
+ <h3 id="内部调用：获取全景图局部裁剪" class="tsd-anchor-link">内部调用：获取全景图局部裁剪<a href="#内部调用：获取全景图局部裁剪" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
96
+ <p>使用 SDK 提供的 <code>defaultImageURLTransform</code> 工具函数（通常导出为 <code>defaultImageURLTransform</code>，可重命名为 <code>imageURL</code>），结合 <code>cut</code> 参数获取全景图特定区域（例如获取前方图片的中心 512x512 区域）。</p>
97
+ <pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">defaultImageURLTransform</span><span class="hl-1"> </span><span class="hl-10">as</span><span class="hl-1"> </span><span class="hl-6">imageURL</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">originalUrl</span><span class="hl-1"> = </span><span class="hl-9">&quot;https://vr-public.realsee-cdn.com/.../pano_f.jpg&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">cutUrl</span><span class="hl-1"> = </span><span class="hl-5">imageURL</span><span class="hl-1">(</span><span class="hl-6">originalUrl</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-6">cut:</span><span class="hl-1"> [</span><span class="hl-11">256</span><span class="hl-1">, </span><span class="hl-11">256</span><span class="hl-1">, </span><span class="hl-11">512</span><span class="hl-1">, </span><span class="hl-11">512</span><span class="hl-1">], </span><span class="hl-8">// x, y, width, height</span><br/><span class="hl-1"> </span><span class="hl-6">format:</span><span class="hl-1"> </span><span class="hl-9">&quot;webp&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">quality:</span><span class="hl-1"> </span><span class="hl-11">80</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">cutUrl</span><span class="hl-1">);</span><br/><span class="hl-8">// 输出示例: https://vr-image-4.realsee-cdn.com/.../pano_f.jpg?imageMogr2/format/webp/cut/512x512x256x256/quality/80</span>
98
+ </code><button type="button">Copy</button></pre>
99
+
100
+ <h2 id="related" class="tsd-anchor-link">Related<a href="#related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
101
+ <ul>
102
+ <li><a href="features_pano-tile.html">pano-tile.md</a>: 全景图瓦片加载策略与 WorkTile 数据结构说明。</li>
103
+ </ul>
104
+ <hr>
105
+ <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">imageOptions</span><span class="hl-1">, </span><span class="hl-2">configuration</span><span class="hl-1">, </span><span class="hl-2">optimization</span><span class="hl-1">, </span><span class="hl-2">cdn</span><span class="hl-1">, </span><span class="hl-2">private-deployment</span><span class="hl-1">]</span>
106
+ </code><button type="button">Copy</button></pre>
107
+
108
+ </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="#imageoptions-图片配置"><span>Image<wbr/>Options (图片配置)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#imageoptions"><span>Image<wbr/>Options</span></a></li><li><a href="#imageurlmappings"><span>Image<wbr/>URL<wbr/>Mappings</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#cdn-mapping-多云部署与私有化"><span>CDN <wbr/>Mapping (多云部署与私有化)</span></a></li><li><a href="#format-adaptation-浏览器兼容性"><span>Format <wbr/>Adaptation (浏览器兼容性)</span></a></li><li><a href="#tile-cutting-内部瓦片裁剪"><span>Tile <wbr/>Cutting (内部瓦片裁剪)</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#基础优化配置-推荐"><span>基础优化配置 (推荐)</span></a></li><li><a href="#多云私有化部署配置"><span>多云/私有化部署配置</span></a></li><li><a href="#内部调用：获取全景图局部裁剪"><span>内部调用：获取全景图局部裁剪</span></a></li></ul></li><li><a href="#related"><span>Related</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>