@realsee/five 6.8.0-alpha.27 → 6.8.0-alpha.29

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 (232) hide show
  1. package/ai_guides/features/load-external-model.md +1 -0
  2. package/ai_guides/release_notes/6.8.md +1 -1
  3. package/docs/assets/hierarchy.js +1 -1
  4. package/docs/assets/main.js +1 -1
  5. package/docs/assets/navigation.js +1 -1
  6. package/docs/assets/search.js +1 -1
  7. package/docs/classes/five.AdaptiveLuminancePass.html +1 -1
  8. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  9. package/docs/classes/five.BoundingMesh.html +1 -1
  10. package/docs/classes/five.Camera.html +3 -3
  11. package/docs/classes/five.EyeDomeLightingPass.html +1 -1
  12. package/docs/classes/five.Five.html +7 -7
  13. package/docs/classes/five.FivePass.html +1 -1
  14. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  15. package/docs/classes/five.Model.html +8 -8
  16. package/docs/classes/five.ModelScene.html +1 -1
  17. package/docs/classes/five.NetworkSubscribe.html +1 -1
  18. package/docs/classes/five.PBMContainer.html +1 -1
  19. package/docs/classes/five.PBMCustomShader.html +1 -1
  20. package/docs/classes/five.PBMGSObject.html +2 -2
  21. package/docs/classes/five.PBMGroup.html +1 -1
  22. package/docs/classes/five.PBMMesh.html +1 -1
  23. package/docs/classes/five.PBMMeshMaterial.html +3 -3
  24. package/docs/classes/five.PBMPanoFilter.html +3 -3
  25. package/docs/classes/five.PBMPointCloud.html +1 -1
  26. package/docs/classes/five.PBMPointCloudMaterial.html +2 -2
  27. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  28. package/docs/classes/five.PBMUpdateable.html +1 -1
  29. package/docs/classes/five.PanoCircleMesh.html +1 -1
  30. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  31. package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
  32. package/docs/classes/five.Parameter.html +8 -8
  33. package/docs/classes/five.Scene.html +1 -1
  34. package/docs/classes/five.Subscribe.html +1 -1
  35. package/docs/classes/five.Tile.html +1 -1
  36. package/docs/classes/five.Tile3D.html +6 -6
  37. package/docs/classes/five.TileNode.html +1 -1
  38. package/docs/classes/five.TrajectoryNode.html +1 -1
  39. package/docs/classes/five.WorkResolvedObserver.html +1 -1
  40. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  41. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  42. package/docs/classes/gltf-loader.GLTFLoader.html +2 -2
  43. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  44. package/docs/classes/gltf-loader.THREEGLTFLoader.html +2 -2
  45. package/docs/classes/line.Line.html +1 -1
  46. package/docs/classes/line.LineGeometry.html +1 -1
  47. package/docs/classes/line.LineMaterial.html +1 -1
  48. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  49. package/docs/classes/line.THREE_Line2.html +1 -1
  50. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  51. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  52. package/docs/classes/plugins.CSS3DObject.html +7 -0
  53. package/docs/classes/plugins.CSS3DSprite.html +7 -0
  54. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  55. package/docs/classes/sticker.Sticker.html +1 -1
  56. package/docs/classes/vfx.Airflow.html +1 -1
  57. package/docs/classes/vfx.Flame.html +1 -1
  58. package/docs/classes/vfx.Particle.html +6 -6
  59. package/docs/classes/vfx.ParticleGPU.html +3 -3
  60. package/docs/classes/vfx.SpotLight.html +1 -1
  61. package/docs/documents/features_load-external-model.html +1 -0
  62. package/docs/documents/release_notes_6.8.html +1 -1
  63. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  64. package/docs/functions/plugins.CSS3DPlugin.html +1 -0
  65. package/docs/functions/react.useFiveCurrentObserver.html +2 -2
  66. package/docs/functions/react.useFiveFloor.html +2 -2
  67. package/docs/functions/react.useFiveProject2d.html +2 -2
  68. package/docs/functions/vue.useFiveCurrentObserver.html +2 -2
  69. package/docs/functions/vue.useFiveFloor.html +2 -2
  70. package/docs/functions/vue.useFiveWorks.html +2 -2
  71. package/docs/hierarchy.html +1 -1
  72. package/docs/interfaces/five.AddableObject.html +1 -1
  73. package/docs/interfaces/five.AjaxOptions.html +1 -1
  74. package/docs/interfaces/five.BaseEvent.html +1 -1
  75. package/docs/interfaces/five.BaseExtendableEvent.html +1 -1
  76. package/docs/interfaces/five.EventCallback.html +7 -7
  77. package/docs/interfaces/five.FiveInitArgs.html +2 -2
  78. package/docs/interfaces/five.GestureEvent.html +2 -2
  79. package/docs/interfaces/five.ImageOptions.html +1 -1
  80. package/docs/interfaces/five.IntersectEvent.html +2 -2
  81. package/docs/interfaces/five.IntersectMesh.html +1 -1
  82. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  83. package/docs/interfaces/five.Intersection.html +1 -1
  84. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +1 -1
  85. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +2 -2
  86. package/docs/interfaces/five.ModeChangeEvent.html +1 -1
  87. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  88. package/docs/interfaces/five.ModelEvent.html +2 -2
  89. package/docs/interfaces/five.ModelSceneEvent.html +1 -1
  90. package/docs/interfaces/five.ModelTileEvent.html +1 -1
  91. package/docs/interfaces/five.MovePanoOptions.html +2 -2
  92. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  93. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  94. package/docs/interfaces/five.NetworkOptions.html +1 -1
  95. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  96. package/docs/interfaces/five.NetworkResourceEvent.html +1 -1
  97. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  98. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  99. package/docs/interfaces/five.ObjectEvent.html +1 -1
  100. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
  101. package/docs/interfaces/five.PBMMaterial.html +1 -1
  102. package/docs/interfaces/five.PBMMeshMaterialParameters.html +2 -2
  103. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -2
  104. package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
  105. package/docs/interfaces/five.PanoCircleMeshInterface.html +2 -2
  106. package/docs/interfaces/five.PanoEvent.html +2 -2
  107. package/docs/interfaces/five.PanoPrepareEvent.html +1 -1
  108. package/docs/interfaces/five.PanoTextureEvent.html +3 -3
  109. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  110. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  111. package/docs/interfaces/five.ParameterMaterialValue.html +8 -8
  112. package/docs/interfaces/five.ParameterTilesetValue.html +1 -1
  113. package/docs/interfaces/five.ParameterValue.html +8 -8
  114. package/docs/interfaces/five.Pose.html +1 -1
  115. package/docs/interfaces/five.RenderEvent.html +1 -1
  116. package/docs/interfaces/five.ResolvedParameterValue.html +8 -8
  117. package/docs/interfaces/five.SplatData.html +2 -2
  118. package/docs/interfaces/five.State.html +1 -1
  119. package/docs/interfaces/five.StateEvent.html +1 -1
  120. package/docs/interfaces/five.TextureOptions.html +1 -1
  121. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  122. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  123. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  124. package/docs/interfaces/five.ViewLayer.html +6 -6
  125. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  126. package/docs/interfaces/five.WorkImage.html +1 -1
  127. package/docs/interfaces/five.WorkObserver.html +1 -1
  128. package/docs/interfaces/five.WorkObserverProto.html +1 -1
  129. package/docs/interfaces/five.WorkTile.html +1 -1
  130. package/docs/interfaces/five.WorksEvent.html +1 -1
  131. package/docs/interfaces/five.XRControllerEvent.html +1 -1
  132. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  133. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  134. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  135. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  136. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  137. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  138. package/docs/interfaces/plugins.CSS3DPluginController.html +50 -0
  139. package/docs/interfaces/plugins.CSS3DPluginType.Config.html +2 -0
  140. package/docs/interfaces/plugins.CSS3DPluginType.CreateCSS3DObjectType.html +10 -0
  141. package/docs/interfaces/plugins.CSS3DPluginType.EventMap.html +10 -0
  142. package/docs/interfaces/plugins.CSS3DPluginType.Params.html +4 -0
  143. package/docs/interfaces/plugins.CSS3DPluginType.State.html +8 -0
  144. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +3 -3
  145. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  146. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  147. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationController.html +2 -2
  148. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.EventMap.html +1 -1
  149. package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.State.html +1 -1
  150. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  151. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  152. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +2 -2
  153. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  154. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  155. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  156. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  157. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  158. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  159. package/docs/interfaces/plugins.PlayingState.html +2 -2
  160. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  161. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  162. package/docs/interfaces/plugins.TrajectoryController.html +8 -8
  163. package/docs/interfaces/react.FiveInjectionTypes.html +7 -7
  164. package/docs/interfaces/sticker.IntersectionLike.html +2 -2
  165. package/docs/interfaces/vfx.ParticleArgs.html +4 -4
  166. package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
  167. package/docs/modules/plugins.CSS3DPluginType.html +1 -0
  168. package/docs/modules/plugins.html +1 -1
  169. package/docs/types/five.LegacyEventType.html +7 -7
  170. package/docs/types/five.ParseOptions.html +1 -1
  171. package/docs/types/five.Works.html +1 -1
  172. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  173. package/docs/types/plugins.CSS3DPluginType.PluginData.html +1 -0
  174. package/docs/types/plugins.CSS3DPluginType.ServerData.html +1 -0
  175. package/five/application/five.d.ts +3 -3
  176. package/five/bvh/bvhObject.d.ts +2 -2
  177. package/five/controllers/model.d.ts +2 -2
  178. package/five/controllers/panorama.d.ts +2 -1
  179. package/five/core/camera.d.ts +1 -1
  180. package/five/gaussian-splatting/util/renderData.d.ts +15 -1
  181. package/five/index.js +137 -112
  182. package/five/index.mjs +1669 -1558
  183. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +1 -1
  184. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +18 -0
  185. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +3 -1
  186. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
  187. package/five/model/loaders/glTF-helpers/index.d.ts +2 -0
  188. package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +4 -0
  189. package/five/model/tile3d/index.d.ts +4 -3
  190. package/five/texture/loader.d.ts +1 -1
  191. package/five/utils/imageURL.d.ts +1 -1
  192. package/five/webxr/motionHelper.d.ts +1 -1
  193. package/gltf-loader/index.js +3 -3
  194. package/gltf-loader/index.mjs +3 -3
  195. package/line/index.js +3 -3
  196. package/line/index.mjs +3 -3
  197. package/package.json +1 -1
  198. package/plugins/CSS3DPlugin/Controller.d.ts +60 -0
  199. package/plugins/CSS3DPlugin/index.d.ts +5 -0
  200. package/plugins/CSS3DPlugin/typing.d.ts +32 -0
  201. package/plugins/TrajectoryPlugin/Controller.d.ts +1 -1
  202. package/plugins/index.d.ts +2 -1
  203. package/plugins/index.js +30 -10
  204. package/plugins/index.mjs +432 -306
  205. package/plugins/utils/uuid.d.ts +1 -4
  206. package/react/context.d.ts +3 -2
  207. package/react/createProvider.d.ts +4 -4
  208. package/react/createStore.d.ts +3 -3
  209. package/react/hooks/useFiveProject2d.d.ts +1 -1
  210. package/react/index.js +2 -2
  211. package/react/index.mjs +2 -2
  212. package/react/rendererPool.d.ts +2 -2
  213. package/shader-lib/index.js +2 -2
  214. package/shader-lib/index.mjs +2 -2
  215. package/sticker/index.js +3 -3
  216. package/sticker/index.mjs +3 -3
  217. package/umd/five-gltf-loader.js +3 -3
  218. package/umd/five-line.js +3 -3
  219. package/umd/five-plugins.js +30 -10
  220. package/umd/five-react.js +2 -2
  221. package/umd/five-shader-lib.js +2 -2
  222. package/umd/five-sticker.js +3 -3
  223. package/umd/five-vfx.js +2 -2
  224. package/umd/five-vue.js +2 -2
  225. package/umd/five.js +102 -77
  226. package/vfx/index.js +2 -2
  227. package/vfx/index.mjs +2 -2
  228. package/vue/index.js +2 -2
  229. package/vue/index.mjs +2 -2
  230. package/vue/rendererPool.d.ts +5 -5
  231. package/work-downloader/index.js +2 -2
  232. package/work-downloader/index.mjs +2 -2
package/docs/functions/vue.useFiveCurrentObserver.html CHANGED
@@ -1,5 +1,5 @@
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>useFiveCurrentObserver | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/vue.html">vue</a></li><li><a href="" aria-current="page">useFiveCurrentObserver</a></li></ul><h1>Function useFiveCurrentObserver</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivecurrentobserver"><span class="tsd-kind-call-signature">useFiveCurrentObserver</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.WorkObserver.html" class="tsd-signature-type tsd-kind-interface">WorkObserver</a><span class="tsd-signature-symbol">&gt;</span><a href="#usefivecurrentobserver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: Five 的当前观测点</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.WorkObserver.html" class="tsd-signature-type tsd-kind-interface">WorkObserver</a><span class="tsd-signature-symbol">&gt;</span></h4><p>当前观测点, 如果 work 未加载则为 null</p>
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>useFiveCurrentObserver | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/vue.html">vue</a></li><li><a href="" aria-current="page">useFiveCurrentObserver</a></li></ul><h1>Function useFiveCurrentObserver</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivecurrentobserver"><span class="tsd-kind-call-signature">useFiveCurrentObserver</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.WorkObserver.html" class="tsd-signature-type tsd-kind-interface">WorkObserver</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#usefivecurrentobserver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: Five 的当前观测点</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.WorkObserver.html" class="tsd-signature-type tsd-kind-interface">WorkObserver</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>当前观测点, 如果 work 未加载则为 null</p>
3
3
  <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">observer</span><span class="hl-1"> = </span><span class="hl-5">useFiveCurrentObserver</span><span class="hl-1">();</span>
4
4
  </code><button>Copy</button></pre>
5
5
 
package/docs/functions/vue.useFiveFloor.html CHANGED
@@ -1,5 +1,5 @@
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>useFiveFloor | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/vue.html">vue</a></li><li><a href="" aria-current="page">useFiveFloor</a></li></ul><h1>Function useFiveFloor</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivefloor"><span class="tsd-kind-call-signature">useFiveFloor</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><br/>    shownFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    totalFloorLength<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    showFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">]</span><a href="#usefivefloor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: Five 楼层</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><br/>    shownFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    totalFloorLength<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    showFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">]</span></h4><p>[ shownFloor: Five 当前显示的楼层， null 为都显示, showFloor: 设置显示楼层，不传参数为都显示 ]</p>
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>useFiveFloor | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/vue.html">vue</a></li><li><a href="" aria-current="page">useFiveFloor</a></li></ul><h1>Function useFiveFloor</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivefloor"><span class="tsd-kind-call-signature">useFiveFloor</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><br/>    shownFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    totalFloorLength<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    showFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">]</span><a href="#usefivefloor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: Five 楼层</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><br/>    shownFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    totalFloorLength<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    showFloor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">]</span></h4><p>[ shownFloor: Five 当前显示的楼层， null 为都显示, showFloor: 设置显示楼层，不传参数为都显示 ]</p>
3
3
  <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-3">const</span><span class="hl-1"> [ </span><span class="hl-4">shownFloor</span><span class="hl-1">, </span><span class="hl-4">showFloor</span><span class="hl-1"> ] = </span><span class="hl-6">useFiveHelper</span><span class="hl-1">;</span>
4
4
  </code><button>Copy</button></pre>
5
5