@realsee/five 6.6.0-alpha.0 → 6.6.0-alpha.2

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 (531) hide show
  1. package/docs/assets/hierarchy.js +1 -0
  2. package/docs/assets/icons.js +1 -1
  3. package/docs/assets/icons.svg +1 -1
  4. package/docs/assets/main.js +5 -5
  5. package/docs/assets/navigation.js +1 -1
  6. package/docs/assets/search.js +1 -1
  7. package/docs/assets/style.css +1440 -1255
  8. package/docs/classes/five.AnimationFrameLoop.html +16 -16
  9. package/docs/classes/five.Camera.html +41 -41
  10. package/docs/classes/five.Fetcher.html +5 -5
  11. package/docs/classes/five.Five.html +211 -211
  12. package/docs/classes/five.InternalWebGLRenderer.html +2 -2
  13. package/docs/classes/five.Model.html +72 -72
  14. package/docs/classes/five.ModelScene.html +34 -34
  15. package/docs/classes/five.Motion.html +17 -17
  16. package/docs/classes/five.NetworkSubscribe.html +35 -35
  17. package/docs/classes/five.PBMContainer.html +17 -17
  18. package/docs/classes/five.PBMCustomShader.html +11 -11
  19. package/docs/classes/five.PBMGroup.html +4 -4
  20. package/docs/classes/five.PBMMesh.html +2 -2
  21. package/docs/classes/five.PBMMeshMaterial.html +84 -84
  22. package/docs/classes/five.PBMPointCloud.html +3 -3
  23. package/docs/classes/five.PBMPointCloudMaterial.html +40 -40
  24. package/docs/classes/five.PBMSkinnedMesh.html +4 -4
  25. package/docs/classes/five.PanoCircleMesh.html +20 -20
  26. package/docs/classes/five.PanoCircleMeshCustom.html +20 -20
  27. package/docs/classes/five.PanoCircleMeshSolid.html +20 -20
  28. package/docs/classes/five.Parameter.html +114 -114
  29. package/docs/classes/five.Scene.html +9 -9
  30. package/docs/classes/five.Subscribe.html +37 -37
  31. package/docs/classes/five.TextureLoader.html +4 -4
  32. package/docs/classes/five.Tile.html +34 -34
  33. package/docs/classes/five.Tile3DModel.html +91 -91
  34. package/docs/classes/five.TileCache.html +8 -8
  35. package/docs/classes/five.TileNode.html +9 -9
  36. package/docs/classes/five.TileRequestScheduler.html +4 -4
  37. package/docs/classes/five.Tileset.html +37 -37
  38. package/docs/classes/five.Trajectory.html +8 -8
  39. package/docs/classes/five.TrajectoryNode.html +7 -7
  40. package/docs/classes/five.Work.html +42 -42
  41. package/docs/classes/five.WorkResolvedObserver.html +40 -40
  42. package/docs/classes/five.XRButton.html +3 -3
  43. package/docs/classes/gltf-loader.DDSLoader.html +3 -0
  44. package/docs/classes/gltf-loader.DRACOLoader.html +8 -0
  45. package/docs/classes/gltf-loader.GLTFLoader.html +19 -0
  46. package/docs/classes/gltf-loader.GLTFObject.html +9 -0
  47. package/docs/classes/gltf-loader.GLTFParser.html +6 -0
  48. package/docs/classes/gltf-loader.THREEGLTFLoader.html +8 -0
  49. package/docs/classes/line.Line.html +10 -10
  50. package/docs/classes/line.LineGeometry.html +17 -17
  51. package/docs/classes/line.LineMaterial.html +8 -8
  52. package/docs/classes/line.LineSegmentsGeometry.html +15 -15
  53. package/docs/classes/line.THREE_Line2.html +4 -4
  54. package/docs/classes/line.THREE_LineSegments2.html +4 -4
  55. package/docs/classes/plugins.BasePlugin.Controller.html +39 -0
  56. package/docs/classes/plugins.CSS3DRenderer.html +6 -0
  57. package/docs/classes/plugins.OrbitControls.html +41 -0
  58. package/docs/classes/plugins.RoundedBoxGeometry.html +3 -0
  59. package/docs/classes/react.Store.html +20 -20
  60. package/docs/classes/sticker.Sticker.html +17 -17
  61. package/docs/classes/vfx.Airflow.html +8 -8
  62. package/docs/classes/vfx.Flame.html +10 -10
  63. package/docs/classes/vfx.Particle.html +78 -78
  64. package/docs/classes/vfx.SpotLight.html +7 -7
  65. package/docs/documents/coordinate.html +4 -4
  66. package/docs/documents/five.FivePlugin.plugins.html +15 -15
  67. package/docs/documents/five.Pose.coordinate.html +4 -4
  68. package/docs/documents/plugins.html +15 -15
  69. package/docs/documents/react-component.html +32 -0
  70. package/docs/enums/five.VolumePlaneIntersect.html +4 -4
  71. package/docs/enums/plugins.BackgroundPluginType.WarningCodeType.html +2 -0
  72. package/docs/functions/five.coordinatesToVector.html +2 -0
  73. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  74. package/docs/functions/five.createWorks.html +1 -1
  75. package/docs/functions/five.defaultImageURLTransform.html +2 -2
  76. package/docs/functions/five.getViewportScale.html +1 -1
  77. package/docs/functions/five.headingToLongitude.html +4 -0
  78. package/docs/functions/five.imageSupport.html +1 -1
  79. package/docs/functions/five.isBoundingVolume.html +1 -1
  80. package/docs/functions/five.isPanoId.html +1 -1
  81. package/docs/functions/five.loadAt3d.html +1 -1
  82. package/docs/functions/five.loadB3dm.html +1 -1
  83. package/docs/functions/five.loadDome.html +1 -1
  84. package/docs/functions/five.loadDomez.html +1 -1
  85. package/docs/functions/five.loadFbx.html +1 -1
  86. package/docs/functions/five.loadGltf.html +1 -1
  87. package/docs/functions/five.loadPbm.html +1 -1
  88. package/docs/functions/five.loadPly.html +1 -1
  89. package/docs/functions/five.loadPnts.html +1 -1
  90. package/docs/functions/five.loadX3p.html +1 -1
  91. package/docs/functions/five.longitudeToHeading.html +4 -0
  92. package/docs/functions/five.makeBoundingVolume.html +1 -1
  93. package/docs/functions/five.panoEqual.html +1 -1
  94. package/docs/functions/five.panoParse.html +1 -1
  95. package/docs/functions/five.panoStringify.html +1 -1
  96. package/docs/functions/five.parseWork.html +2 -2
  97. package/docs/functions/five.vectorToCoordinates.html +2 -0
  98. package/docs/functions/five.workToJson.html +1 -1
  99. package/docs/functions/plugins.BackgroundPlugin.html +1 -0
  100. package/docs/functions/plugins.ItemMaskPlugin.html +1 -0
  101. package/docs/functions/plugins.OrientationPlugin.html +1 -0
  102. package/docs/functions/plugins.PanoAnimePlugin.html +1 -0
  103. package/docs/functions/plugins.TrajectoryPlugin.html +1 -0
  104. package/docs/functions/react.createFiveFeature.html +1 -1
  105. package/docs/functions/react.createFiveProvider.html +5 -5
  106. package/docs/functions/react.createStore.html +12 -12
  107. package/docs/functions/react.unsafe__useFiveInstance.html +4 -4
  108. package/docs/functions/react.useFiveAction.html +8 -8
  109. package/docs/functions/react.useFiveCameraDirection.html +3 -3
  110. package/docs/functions/react.useFiveCameraRaycaster.html +3 -3
  111. package/docs/functions/react.useFiveCurrentObserver.html +4 -4
  112. package/docs/functions/react.useFiveCurrentState.html +4 -4
  113. package/docs/functions/react.useFiveEventCallback.html +3 -3
  114. package/docs/functions/react.useFiveFloor.html +4 -4
  115. package/docs/functions/react.useFiveHelper.html +4 -4
  116. package/docs/functions/react.useFiveModelIntersectRaycaster.html +4 -4
  117. package/docs/functions/react.useFiveModelReadyState.html +3 -3
  118. package/docs/functions/react.useFiveProject2d.html +4 -4
  119. package/docs/functions/react.useFiveSceneEffect.html +4 -4
  120. package/docs/functions/react.useFiveState.html +1 -1
  121. package/docs/functions/react.useFiveWork.html +5 -5
  122. package/docs/functions/react.withFive.html +1 -1
  123. package/docs/functions/vue.unsafe__useFiveInject.html +4 -4
  124. package/docs/functions/vue.useFiveAction.html +10 -10
  125. package/docs/functions/vue.useFiveCameraDirection.html +3 -3
  126. package/docs/functions/vue.useFiveCameraRaycaster.html +3 -3
  127. package/docs/functions/vue.useFiveCurrentObserver.html +4 -4
  128. package/docs/functions/vue.useFiveCurrentState.html +4 -4
  129. package/docs/functions/vue.useFiveEventCallback.html +3 -3
  130. package/docs/functions/vue.useFiveFloor.html +4 -4
  131. package/docs/functions/vue.useFiveHelper.html +4 -4
  132. package/docs/functions/vue.useFiveModel.html +2 -2
  133. package/docs/functions/vue.useFiveModelBounding.html +2 -2
  134. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +4 -4
  135. package/docs/functions/vue.useFiveModelReadyState.html +3 -3
  136. package/docs/functions/vue.useFiveProject2d.html +4 -4
  137. package/docs/functions/vue.useFiveScene.html +2 -2
  138. package/docs/functions/vue.useFiveState.html +4 -4
  139. package/docs/functions/vue.useFiveWorks.html +5 -5
  140. package/docs/hierarchy.html +1 -1
  141. package/docs/index.html +17 -17
  142. package/docs/interfaces/five.AddableObject.html +9 -9
  143. package/docs/interfaces/five.AjaxOptions.html +9 -9
  144. package/docs/interfaces/five.AnimationFrame.html +5 -5
  145. package/docs/interfaces/five.AnimationFrameContext.html +3 -3
  146. package/docs/interfaces/five.BaseEvent.html +5 -5
  147. package/docs/interfaces/five.BoundingVolume.html +15 -15
  148. package/docs/interfaces/five.BoxBoundingVolume.html +18 -0
  149. package/docs/interfaces/five.CameraPose.html +6 -6
  150. package/docs/interfaces/five.CullingVolume.html +9 -0
  151. package/docs/interfaces/five.Draco.html +12 -0
  152. package/docs/interfaces/five.EventCallback.html +255 -255
  153. package/docs/interfaces/five.FiveInitArgs.html +85 -85
  154. package/docs/interfaces/five.FiveLoadOptions.html +13 -13
  155. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +17 -17
  156. package/docs/interfaces/five.GestureEvent.html +19 -19
  157. package/docs/interfaces/five.ImageOptions.html +14 -14
  158. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  159. package/docs/interfaces/five.ImageURLOptions.html +15 -15
  160. package/docs/interfaces/five.IntersectEvent.html +8 -8
  161. package/docs/interfaces/five.IntersectMesh.html +2 -0
  162. package/docs/interfaces/five.IntersectMeshInterface.html +3 -3
  163. package/docs/interfaces/five.Intersection.html +5 -5
  164. package/docs/interfaces/five.KTX2.html +9 -0
  165. package/docs/interfaces/five.LoosePanoWork.html +10 -10
  166. package/docs/interfaces/five.LooseWork.html +15 -0
  167. package/docs/interfaces/five.LooseWorkInitial.html +11 -0
  168. package/docs/interfaces/five.LooseWorkModel.html +6 -0
  169. package/docs/interfaces/five.LooseWorkObserver.html +16 -0
  170. package/docs/interfaces/five.LooseWorkPanorama.html +13 -0
  171. package/docs/interfaces/five.LooseWorkVideo.html +4 -0
  172. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +13 -0
  173. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +17 -17
  174. package/docs/interfaces/five.ModeChangeEvent.html +9 -9
  175. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +18 -18
  176. package/docs/interfaces/five.ModelEvent.html +8 -8
  177. package/docs/interfaces/five.ModelLike.html +3 -3
  178. package/docs/interfaces/five.ModelSceneEvent.html +6 -6
  179. package/docs/interfaces/five.MotionKeyframe.html +4 -4
  180. package/docs/interfaces/five.MovePanoOptions.html +24 -24
  181. package/docs/interfaces/five.NetworkAbortError.html +1 -0
  182. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -0
  183. package/docs/interfaces/five.NetworkOptions.html +7 -7
  184. package/docs/interfaces/five.NetworkProxyError.html +1 -0
  185. package/docs/interfaces/five.NetworkResourceEvent.html +9 -9
  186. package/docs/interfaces/five.NetworkResponseError.html +2 -0
  187. package/docs/interfaces/five.NetworkTimeoutError.html +1 -0
  188. package/docs/interfaces/five.ObjectEvent.html +6 -6
  189. package/docs/interfaces/five.PBMClipperParameter.html +3 -3
  190. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +6 -6
  191. package/docs/interfaces/five.PBMCustomShaderSlots.html +3 -3
  192. package/docs/interfaces/five.PBMMaterial.html +1 -0
  193. package/docs/interfaces/five.PBMMeshMaterialParameters.html +28 -28
  194. package/docs/interfaces/five.PBMPanoDepth.html +9 -9
  195. package/docs/interfaces/five.PBMPanoPicture.html +11 -11
  196. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +28 -28
  197. package/docs/interfaces/five.PBMRefinedScreen.html +6 -6
  198. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +9 -9
  199. package/docs/interfaces/five.PanoCircleMeshInterface.html +20 -20
  200. package/docs/interfaces/five.PanoCircleMeshOptions.html +3 -3
  201. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +3 -3
  202. package/docs/interfaces/five.PanoEvent.html +11 -11
  203. package/docs/interfaces/five.PanoTextureEvent.html +9 -9
  204. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +38 -38
  205. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +18 -18
  206. package/docs/interfaces/five.ParameterMaterialValue.html +73 -73
  207. package/docs/interfaces/five.ParameterTilesetValue.html +31 -31
  208. package/docs/interfaces/five.ParameterValue.html +103 -103
  209. package/docs/interfaces/five.Pose.html +13 -13
  210. package/docs/interfaces/five.RegionBoundingVolume.html +21 -0
  211. package/docs/interfaces/five.RenderEvent.html +6 -6
  212. package/docs/interfaces/five.ResolvedParameterValue.html +105 -105
  213. package/docs/interfaces/five.SphereBoundingVolume.html +17 -0
  214. package/docs/interfaces/five.State.html +19 -19
  215. package/docs/interfaces/five.StateEvent.html +7 -7
  216. package/docs/interfaces/five.TextureOptions.html +16 -16
  217. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +12 -12
  218. package/docs/interfaces/five.TileHeader.html +9 -9
  219. package/docs/interfaces/five.TilesetHeader.html +20 -20
  220. package/docs/interfaces/five.TilesetOptions.html +12 -12
  221. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +9 -9
  222. package/docs/interfaces/five.TrajectoryHeader.html +5 -5
  223. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +34 -34
  224. package/docs/interfaces/five.ViewLayer.html +90 -90
  225. package/docs/interfaces/five.Viewport.html +11 -11
  226. package/docs/interfaces/five.WebXRAxesParams.html +4 -4
  227. package/docs/interfaces/five.WebXRControllerParams.html +2 -2
  228. package/docs/interfaces/five.WorkCubeImage.html +8 -14
  229. package/docs/interfaces/five.WorkImage.html +13 -19
  230. package/docs/interfaces/five.WorkInitial.html +17 -17
  231. package/docs/interfaces/five.WorkInitialJson.html +8 -8
  232. package/docs/interfaces/five.WorkJson.html +12 -12
  233. package/docs/interfaces/five.WorkModel.html +12 -12
  234. package/docs/interfaces/five.WorkModelJson.html +5 -5
  235. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  236. package/docs/interfaces/five.WorkModelLayerJson.html +5 -5
  237. package/docs/interfaces/five.WorkObserver.html +34 -34
  238. package/docs/interfaces/five.WorkObserverJson.html +8 -8
  239. package/docs/interfaces/five.WorkPanoramaJson.html +14 -14
  240. package/docs/interfaces/five.WorkPanoramasJson.html +3 -3
  241. package/docs/interfaces/five.WorkTile.html +14 -20
  242. package/docs/interfaces/five.WorkVideo.html +9 -9
  243. package/docs/interfaces/five.WorksEvent.html +9 -9
  244. package/docs/interfaces/five.XRControllerEvent.html +8 -8
  245. package/docs/interfaces/five.XRGestureEvent.html +11 -11
  246. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +34 -34
  247. package/docs/interfaces/five.XRSessionEvent.html +7 -7
  248. package/docs/interfaces/gltf-loader.DDS.html +7 -0
  249. package/docs/interfaces/gltf-loader.GLTF.html +13 -0
  250. package/docs/interfaces/gltf-loader.GLTFReference.html +3 -0
  251. package/docs/interfaces/gltf-loader.THREEGLTF.html +8 -0
  252. package/docs/interfaces/plugins.BackgroundPluginController.html +37 -0
  253. package/docs/interfaces/plugins.BackgroundPluginType.Config.html +1 -0
  254. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +20 -0
  255. package/docs/interfaces/plugins.BackgroundPluginType.Params.html +3 -0
  256. package/docs/interfaces/plugins.BackgroundPluginType.PluginDataItem.html +1 -0
  257. package/docs/interfaces/plugins.BasePlugin.BaseOptions.html +3 -0
  258. package/docs/interfaces/plugins.BasePlugin.Config.html +5 -0
  259. package/docs/interfaces/plugins.BasePlugin.State.html +8 -0
  260. package/docs/interfaces/plugins.BasePlugin.StateChangeParams.html +7 -0
  261. package/docs/interfaces/plugins.ItemMaskController.html +35 -0
  262. package/docs/interfaces/plugins.ItemMaskPluginType.Config.html +2 -0
  263. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +10 -0
  264. package/docs/interfaces/plugins.ItemMaskPluginType.ItemType.html +13 -0
  265. package/docs/interfaces/plugins.ItemMaskPluginType.MaskType.html +4 -0
  266. package/docs/interfaces/plugins.ItemMaskPluginType.Params.html +4 -0
  267. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +14 -0
  268. package/docs/interfaces/plugins.Keyframe.html +3 -0
  269. package/docs/interfaces/plugins.OrientationPluginController.html +46 -0
  270. package/docs/interfaces/plugins.OrientationPluginType.Config.html +4 -0
  271. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +10 -0
  272. package/docs/interfaces/plugins.OrientationPluginType.Params.html +4 -0
  273. package/docs/interfaces/plugins.OrientationPluginType.State.html +10 -0
  274. package/docs/interfaces/plugins.PanoAnimeController.html +32 -0
  275. package/docs/interfaces/plugins.PanoAnimePluginType.Config.html +2 -0
  276. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +11 -0
  277. package/docs/interfaces/plugins.PanoAnimePluginType.Params.html +4 -0
  278. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +8 -0
  279. package/docs/interfaces/plugins.PlayingState.html +3 -0
  280. package/docs/interfaces/plugins.PluginTemplateType.Config.html +3 -0
  281. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +10 -0
  282. package/docs/interfaces/plugins.PluginTemplateType.Params.html +4 -0
  283. package/docs/interfaces/plugins.PluginTemplateType.State.html +8 -0
  284. package/docs/interfaces/plugins.TrajectoryController.html +50 -0
  285. package/docs/interfaces/react.FiveActionReactCallbacks.html +27 -27
  286. package/docs/interfaces/react.FiveCanvasProps.html +5 -5
  287. package/docs/interfaces/react.FiveInjectionTypes.html +152 -144
  288. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +2 -2
  289. package/docs/interfaces/sticker.IntersectionLike.html +7 -7
  290. package/docs/interfaces/vfx.ParticleArgs.html +67 -67
  291. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +3 -3
  292. package/docs/interfaces/vue.FiveActionVueCallbacks.html +30 -30
  293. package/docs/modules/five.html +1 -231
  294. package/docs/modules/gltf-loader.html +1 -0
  295. package/docs/modules/line.html +1 -8
  296. package/docs/modules/plugins.BackgroundPluginType.html +1 -0
  297. package/docs/modules/plugins.BasePlugin.html +1 -0
  298. package/docs/modules/plugins.ItemMaskPluginType.html +1 -0
  299. package/docs/modules/plugins.OrientationPluginType.html +1 -0
  300. package/docs/modules/plugins.PanoAnimePluginType.html +1 -0
  301. package/docs/modules/plugins.PluginTemplateType.html +1 -0
  302. package/docs/modules/plugins.html +1 -0
  303. package/docs/modules/react.html +1 -37
  304. package/docs/modules/sticker.html +1 -3
  305. package/docs/modules/vfx.html +1 -8
  306. package/docs/modules/vue.html +1 -24
  307. package/docs/modules.html +1 -0
  308. package/docs/types/five.AjaxResponseType.html +1 -1
  309. package/docs/types/five.AjaxResponseTypeMapping.html +1 -1
  310. package/docs/types/five.AnimationFrameLoopType.html +1 -1
  311. package/docs/types/five.BoundingVolumeJson.html +1 -1
  312. package/docs/types/five.BoxBoundingVolumeJson.html +2 -1
  313. package/docs/types/five.ControllerCustomInitTypes.html +8 -1
  314. package/docs/types/five.ControllerEventTypes.html +66 -33
  315. package/docs/types/five.CubeFace.html +1 -0
  316. package/docs/types/five.EventTypes.html +26 -26
  317. package/docs/types/five.FivePlugin.html +4 -4
  318. package/docs/types/five.FivePluginInit.html +3 -3
  319. package/docs/types/five.FivePluginInstance.html +3 -3
  320. package/docs/types/five.GestureTypes.html +1 -1
  321. package/docs/types/five.LegacyEventType.html +149 -86
  322. package/docs/types/five.LoadResultType.html +12 -1
  323. package/docs/types/five.Mode.html +9 -9
  324. package/docs/types/five.Models.html +11 -11
  325. package/docs/types/five.MotionCircle.html +2 -2
  326. package/docs/types/five.MotionConfig.html +1 -1
  327. package/docs/types/five.MotionInitalValue.html +1 -1
  328. package/docs/types/five.MotionValue.html +1 -1
  329. package/docs/types/five.MovePanoEffect.html +3 -3
  330. package/docs/types/five.NetWorkMeta.html +8 -1
  331. package/docs/types/five.NetworkError.html +1 -1
  332. package/docs/types/five.NetworkErrorCallback.html +1 -1
  333. package/docs/types/five.NetworkProgressCallback.html +1 -1
  334. package/docs/types/five.NetworkResponse.html +3 -1
  335. package/docs/types/five.NetworkState.html +1 -1
  336. package/docs/types/five.NetworkSuccessCallback.html +1 -1
  337. package/docs/types/five.NetworkType.html +1 -1
  338. package/docs/types/five.PBMAlphaMode.html +1 -1
  339. package/docs/types/five.PBMColorStyle.html +1 -1
  340. package/docs/types/five.PBMFloorStyle.html +1 -1
  341. package/docs/types/five.PBMMeshShaderType.html +1 -1
  342. package/docs/types/five.PBMPointBack.html +1 -1
  343. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  344. package/docs/types/five.PBMPointShape.html +1 -1
  345. package/docs/types/five.PBMPointSize.html +1 -1
  346. package/docs/types/five.PBMTransition.html +1 -1
  347. package/docs/types/five.Pano.html +3 -1
  348. package/docs/types/five.PanoId.html +1 -1
  349. package/docs/types/five.ParseOptions.html +11 -6
  350. package/docs/types/five.PostProcessingType.html +1 -1
  351. package/docs/types/five.RegionBoundingVolumeJson.html +2 -1
  352. package/docs/types/five.Scissor.html +2 -2
  353. package/docs/types/five.SphereBoundingVolumeJson.html +2 -1
  354. package/docs/types/five.SubscribeEventMap.html +1 -1
  355. package/docs/types/five.Tile3dOptions.html +1 -1
  356. package/docs/types/five.TileCacheOptions.html +3 -1
  357. package/docs/types/five.TileContentData.html +6 -1
  358. package/docs/types/five.TileRequestOrder.html +1 -1
  359. package/docs/types/five.TileRequestSchedulerOptions.html +4 -1
  360. package/docs/types/five.TilesetFrameState.html +22 -1
  361. package/docs/types/five.TrajectoryContentData.html +7 -1
  362. package/docs/types/five.WebXRControllerKey.html +1 -1
  363. package/docs/types/five.WebXRControllerType.html +1 -1
  364. package/docs/types/five.Works.html +1 -1
  365. package/docs/types/line.LineMaterialParameters.html +8 -1
  366. package/docs/types/plugins.BackgroundPluginType.Mirror.html +1 -0
  367. package/docs/types/plugins.BackgroundPluginType.Mode.html +1 -0
  368. package/docs/types/plugins.BackgroundPluginType.PluginData.html +1 -0
  369. package/docs/types/plugins.BackgroundPluginType.State.html +2 -0
  370. package/docs/types/plugins.BasePlugin.EventMap.html +10 -0
  371. package/docs/types/plugins.ItemMaskPluginType.PluginData.html +3 -0
  372. package/docs/types/plugins.ItemMaskPluginType.ServerData.html +3 -0
  373. package/docs/types/plugins.OrientationPluginType.PluginData.html +1 -0
  374. package/docs/types/plugins.OrientationPluginType.ServerData.html +1 -0
  375. package/docs/types/plugins.PanoAnimePluginType.PluginData.html +1 -0
  376. package/docs/types/plugins.PanoAnimePluginType.ServerData.html +1 -0
  377. package/docs/types/plugins.PluginTemplateType.PluginData.html +1 -0
  378. package/docs/types/plugins.PluginTemplateType.ServerData.html +2 -0
  379. package/docs/types/react.FiveInjectionActionFeature.html +1 -1
  380. package/docs/types/react.FiveInjectionDataFeature.html +1 -1
  381. package/docs/types/react.FiveInjectionFeature.html +1 -1
  382. package/docs/types/react.FiveProviderPropTypes.html +11 -1
  383. package/docs/types/react.FiveProviderType.html +1 -1
  384. package/docs/types/react.StoreActionMapHanlder.html +1 -1
  385. package/docs/types/react.StoreActionMapType.html +1 -1
  386. package/docs/types/react.StoreProviderType.html +1 -1
  387. package/docs/types/react.StoreValueMapType.html +1 -1
  388. package/docs/types/vfx.ParticleType.html +1 -1
  389. package/docs/types/vue.FiveModelIntersectRaycaster.html +1 -1
  390. package/docs/types/vue.FiveProviderComponent.html +1 -1
  391. package/docs/types/vue.Project2d.html +1 -1
  392. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  393. package/docs/variables/five.controllersDefaultInitArgs.html +1 -1
  394. package/docs/variables/five.draco.html +1 -0
  395. package/docs/variables/five.ktx2.html +1 -0
  396. package/docs/variables/react.FiveCanvas.html +6 -0
  397. package/docs/variables/react.INJECTION_PROPNAME.html +1 -1
  398. package/docs/variables/react.useFiveScene.html +7 -0
  399. package/docs/variables/vue.FiveCanvas.html +7 -7
  400. package/docs/variables/vue.FiveProvider.html +5 -5
  401. package/five/index.d.ts +53 -57
  402. package/five/index.js +93 -91
  403. package/five/index.mjs +4247 -4193
  404. package/gltf-loader/index.js +5 -5
  405. package/gltf-loader/index.mjs +160 -172
  406. package/line/index.js +4 -4
  407. package/line/index.mjs +15 -15
  408. package/package.json +4 -7
  409. package/plugins/index.js +10 -10
  410. package/plugins/index.mjs +42 -42
  411. package/react/index.d.ts +46 -37
  412. package/react/index.js +3 -3
  413. package/react/index.mjs +8 -8
  414. package/shader-lib/index.js +7 -7
  415. package/shader-lib/index.mjs +14 -14
  416. package/sticker/index.js +3 -3
  417. package/sticker/index.mjs +9 -9
  418. package/umd/five-gltf-loader.js +5 -5
  419. package/umd/five-line.js +4 -4
  420. package/umd/five-plugins.js +10 -10
  421. package/umd/five-react.js +3 -3
  422. package/umd/five-shader-lib.js +8 -8
  423. package/umd/five-sticker.js +3 -3
  424. package/umd/five-vfx.js +7 -7
  425. package/umd/five-vue.js +3 -3
  426. package/umd/five.js +94 -92
  427. package/vfx/index.js +6 -6
  428. package/vfx/index.mjs +12 -12
  429. package/vue/index.js +2 -2
  430. package/vue/index.mjs +2 -2
  431. package/work-downloader/index.js +3 -3
  432. package/work-downloader/index.mjs +4 -4
  433. package/docs/classes/five.BoxBoundingVolume.html +0 -19
  434. package/docs/classes/five.CullingVolume.html +0 -13
  435. package/docs/classes/five.Draco.html +0 -13
  436. package/docs/classes/five.IntersectMesh.html +0 -4
  437. package/docs/classes/five.KTX2.html +0 -10
  438. package/docs/classes/five.NetworkAbortError.html +0 -2
  439. package/docs/classes/five.NetworkFirbiddenError.html +0 -2
  440. package/docs/classes/five.NetworkProxyError.html +0 -2
  441. package/docs/classes/five.NetworkResponseError.html +0 -3
  442. package/docs/classes/five.NetworkTimeoutError.html +0 -2
  443. package/docs/classes/five.PBMMaterial.html +0 -2
  444. package/docs/classes/five.RegionBoundingVolume.html +0 -22
  445. package/docs/classes/five.SphereBoundingVolume.html +0 -18
  446. package/docs/classes/gltf_loader.DDSLoader.html +0 -3
  447. package/docs/classes/gltf_loader.DRACOLoader.html +0 -8
  448. package/docs/classes/gltf_loader.GLTFLoader.html +0 -19
  449. package/docs/classes/gltf_loader.GLTFObject.html +0 -9
  450. package/docs/classes/gltf_loader.GLTFParser.html +0 -6
  451. package/docs/classes/gltf_loader.THREEGLTFLoader.html +0 -8
  452. package/docs/classes/plugins-1.BackgroundPluginController.html +0 -38
  453. package/docs/classes/plugins-1.BasePlugin.Controller.html +0 -39
  454. package/docs/classes/plugins-1.CSS3DRenderer.html +0 -6
  455. package/docs/classes/plugins-1.ItemMaskController.html +0 -36
  456. package/docs/classes/plugins-1.OrbitControls.html +0 -41
  457. package/docs/classes/plugins-1.OrientationPluginController.html +0 -47
  458. package/docs/classes/plugins-1.PanoAnimeController.html +0 -33
  459. package/docs/classes/plugins-1.RoundedBoxGeometry.html +0 -3
  460. package/docs/classes/plugins-1.TrajectoryController.html +0 -51
  461. package/docs/documents/react_component.html +0 -32
  462. package/docs/enums/plugins-1.BackgroundPluginType.WarningCodeType.html +0 -2
  463. package/docs/functions/plugins-1.BackgroundPlugin.html +0 -1
  464. package/docs/functions/plugins-1.ItemMaskPlugin.html +0 -1
  465. package/docs/functions/plugins-1.OrientationPlugin.html +0 -1
  466. package/docs/functions/plugins-1.PanoAnimePlugin.html +0 -1
  467. package/docs/functions/plugins-1.TrajectoryPlugin.html +0 -1
  468. package/docs/functions/react.FiveCanvas.html +0 -6
  469. package/docs/functions/react.useFiveScene.html +0 -7
  470. package/docs/interfaces/gltf_loader.DDS.html +0 -7
  471. package/docs/interfaces/gltf_loader.GLTF.html +0 -13
  472. package/docs/interfaces/gltf_loader.GLTFReference.html +0 -3
  473. package/docs/interfaces/gltf_loader.THREEGLTF.html +0 -8
  474. package/docs/interfaces/plugins-1.BackgroundPluginType.Config.html +0 -1
  475. package/docs/interfaces/plugins-1.BackgroundPluginType.EventMap.html +0 -20
  476. package/docs/interfaces/plugins-1.BackgroundPluginType.Params.html +0 -3
  477. package/docs/interfaces/plugins-1.BackgroundPluginType.PluginDataItem.html +0 -1
  478. package/docs/interfaces/plugins-1.BasePlugin.BaseOptions.html +0 -3
  479. package/docs/interfaces/plugins-1.BasePlugin.Config.html +0 -5
  480. package/docs/interfaces/plugins-1.BasePlugin.State.html +0 -8
  481. package/docs/interfaces/plugins-1.BasePlugin.StateChangeParams.html +0 -7
  482. package/docs/interfaces/plugins-1.ItemMaskPluginType.Config.html +0 -2
  483. package/docs/interfaces/plugins-1.ItemMaskPluginType.EventMap.html +0 -10
  484. package/docs/interfaces/plugins-1.ItemMaskPluginType.ItemType.html +0 -13
  485. package/docs/interfaces/plugins-1.ItemMaskPluginType.MaskType.html +0 -4
  486. package/docs/interfaces/plugins-1.ItemMaskPluginType.Params.html +0 -4
  487. package/docs/interfaces/plugins-1.ItemMaskPluginType.State.html +0 -14
  488. package/docs/interfaces/plugins-1.Keyframe.html +0 -3
  489. package/docs/interfaces/plugins-1.OrientationPluginType.Config.html +0 -4
  490. package/docs/interfaces/plugins-1.OrientationPluginType.EventMap.html +0 -10
  491. package/docs/interfaces/plugins-1.OrientationPluginType.Params.html +0 -4
  492. package/docs/interfaces/plugins-1.OrientationPluginType.State.html +0 -10
  493. package/docs/interfaces/plugins-1.PanoAnimePluginType.Config.html +0 -2
  494. package/docs/interfaces/plugins-1.PanoAnimePluginType.EventMap.html +0 -11
  495. package/docs/interfaces/plugins-1.PanoAnimePluginType.Params.html +0 -4
  496. package/docs/interfaces/plugins-1.PanoAnimePluginType.State.html +0 -8
  497. package/docs/interfaces/plugins-1.PlayingState.html +0 -3
  498. package/docs/interfaces/plugins-1.PluginTemplateType.Config.html +0 -3
  499. package/docs/interfaces/plugins-1.PluginTemplateType.EventMap.html +0 -10
  500. package/docs/interfaces/plugins-1.PluginTemplateType.Params.html +0 -4
  501. package/docs/interfaces/plugins-1.PluginTemplateType.State.html +0 -8
  502. package/docs/modules/gltf_loader.html +0 -11
  503. package/docs/modules/plugins-1.BackgroundPluginType.html +0 -10
  504. package/docs/modules/plugins-1.BasePlugin.html +0 -7
  505. package/docs/modules/plugins-1.ItemMaskPluginType.html +0 -9
  506. package/docs/modules/plugins-1.OrientationPluginType.html +0 -7
  507. package/docs/modules/plugins-1.PanoAnimePluginType.html +0 -7
  508. package/docs/modules/plugins-1.PluginTemplateType.html +0 -7
  509. package/docs/modules/plugins-1.html +0 -22
  510. package/docs/types/five.LooseWork.html +0 -1
  511. package/docs/types/five.LooseWorkInitial.html +0 -1
  512. package/docs/types/five.LooseWorkModel.html +0 -1
  513. package/docs/types/five.LooseWorkObserver.html +0 -1
  514. package/docs/types/five.LooseWorkPanorama.html +0 -1
  515. package/docs/types/five.LooseWorkVideo.html +0 -1
  516. package/docs/types/five.LooseWorkWithExtrinsics.html +0 -2
  517. package/docs/types/plugins-1.BackgroundPluginType.Mirror.html +0 -1
  518. package/docs/types/plugins-1.BackgroundPluginType.Mode.html +0 -1
  519. package/docs/types/plugins-1.BackgroundPluginType.PluginData.html +0 -1
  520. package/docs/types/plugins-1.BackgroundPluginType.State.html +0 -1
  521. package/docs/types/plugins-1.BasePlugin.EventMap.html +0 -6
  522. package/docs/types/plugins-1.ItemMaskPluginType.PluginData.html +0 -1
  523. package/docs/types/plugins-1.ItemMaskPluginType.ServerData.html +0 -1
  524. package/docs/types/plugins-1.OrientationPluginType.PluginData.html +0 -1
  525. package/docs/types/plugins-1.OrientationPluginType.ServerData.html +0 -1
  526. package/docs/types/plugins-1.PanoAnimePluginType.PluginData.html +0 -1
  527. package/docs/types/plugins-1.PanoAnimePluginType.ServerData.html +0 -1
  528. package/docs/types/plugins-1.PluginTemplateType.PluginData.html +0 -1
  529. package/docs/types/plugins-1.PluginTemplateType.ServerData.html +0 -1
  530. package/docs/variables/five.draco-1.html +0 -1
  531. package/docs/variables/five.ktx2-1.html +0 -1
package/docs/functions/vue.useFiveAction.html CHANGED
@@ -1,33 +1,33 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveAction | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveAction.html">useFiveAction</a></li></ul><h1>Function useFiveAction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveAction" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Action</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a><a href="#useFiveAction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: 使用 Five 的命令</p>
2
- </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Function" class="tsd-anchor"></a>Function<a href="#Function" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>updateCamera</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>useFiveAction | 如视 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">useFiveAction</a></li></ul><h1>Function useFiveAction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefiveaction"><span class="tsd-kind-call-signature">useFiveAction</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a><a href="#usefiveaction" 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"><code class="tsd-tag">Function</code><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: 使用 Five 的命令</p>
2
+ <p>updateCamera</p>
3
3
  <pre><code><span class="hl-4">移动相机</span><span class="hl-1">。（</span><span class="hl-4">不触发点位移动</span><span class="hl-1">）</span><br/><span class="hl-4">如果动画中途被打断</span><span class="hl-1">（</span><span class="hl-4">用户触发行为</span><span class="hl-1">，</span><span class="hl-4">或者调用</span><span class="hl-1"> </span><span class="hl-4">setState</span><span class="hl-1">, </span><span class="hl-4">load</span><span class="hl-1">, </span><span class="hl-4">changeMode</span><span class="hl-1">）</span><span class="hl-4">的等</span><br/><span class="hl-4">会</span><span class="hl-1"> </span><span class="hl-8">Promise</span><span class="hl-1">.</span><span class="hl-4">reject</span><span class="hl-1">。</span><span class="hl-4">运动完成则</span><span class="hl-1"> </span><span class="hl-8">Promise</span><span class="hl-1">.</span><span class="hl-4">resolve</span><br/><br/><span class="hl-5">// params pose - 相机目标位置</span><br/><span class="hl-5">// params duration - 动画触发的时常</span><br/><span class="hl-5">// params Promise - 是否移动成功</span><br/><span class="hl-0">updateCamera</span><span class="hl-1">(</span><span class="hl-4">pose</span><span class="hl-1">: </span><span class="hl-4">Pose</span><span class="hl-1">, </span><span class="hl-4">duration</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">): </span><span class="hl-8">Promise</span><span class="hl-1">&lt;</span><span class="hl-6">void</span><span class="hl-1">&gt;</span>
4
4
  </code><button>Copy</button></pre>
5
5
 
6
- <h4 class="tsd-anchor-link"><a id="Function-1" class="tsd-anchor"></a>Function<a href="#Function-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>initBasisLoader</p>
6
+ <p>initBasisLoader</p>
7
7
  <pre><code><span class="hl-4">初始化</span><span class="hl-1"> </span><span class="hl-4">initBasisLoader</span><br/><span class="hl-4">同初始化的</span><span class="hl-1"> </span><span class="hl-4">initBasisLoader</span><span class="hl-1"> </span><span class="hl-4">参数</span><span class="hl-1">。</span><span class="hl-4">用于初始化</span><span class="hl-1"> </span><span class="hl-4">basisLoader</span><span class="hl-1">。</span><br/><span class="hl-4">basisLoader</span><span class="hl-1"> </span><span class="hl-4">只会初始化一次</span><span class="hl-1">，</span><span class="hl-4">一旦初始化则不会再修改</span><span class="hl-1">。</span><br/><br/><span class="hl-5">// param transcoderResourcePath</span><br/><span class="hl-5">// 如果不设置，使用默认解析器 basis 解析器。</span><br/><span class="hl-5">// 可以传入解析器的 `resourcePath`, 则使用指定的解析器</span><br/><span class="hl-0">initBasisLoader</span><span class="hl-1">(</span><span class="hl-4">transcoderResourcePath</span><span class="hl-1">?: </span><span class="hl-4">string</span><span class="hl-1">): </span><span class="hl-6">void</span><span class="hl-1">,</span>
8
8
  </code><button>Copy</button></pre>
9
9
 
10
- <h4 class="tsd-anchor-link"><a id="Function-2" class="tsd-anchor"></a>Function<a href="#Function-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>getPixels</p>
10
+ <p>getPixels</p>
11
11
  <pre><code><span class="hl-4">获取画面中的像素颜色</span><br/><span class="hl-5">// param x - 获取像素区域的起始坐标 x</span><br/><span class="hl-5">// param y - 获取像素区域的起始坐标 y</span><br/><span class="hl-5">// param width - 获取像素区域的宽度</span><br/><span class="hl-5">// param height - 获取像素区域的高度</span><br/><span class="hl-5">// param pixelRatio - 获取区域的像素比</span><br/><span class="hl-5">// returns rgba颜色平铺的 Uint8Array</span><br/><span class="hl-0">getPixels</span><span class="hl-1">(</span><span class="hl-4">x</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">y</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">width</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">height</span><span class="hl-1">: </span><span class="hl-4">number</span><span class="hl-1">, </span><span class="hl-4">pixelRatio</span><span class="hl-1">?: </span><span class="hl-4">number</span><span class="hl-1">): </span><span class="hl-4">Uint8Array</span><span class="hl-1">,</span>
12
12
  </code><button>Copy</button></pre>
13
13
 
14
- <h4 class="tsd-anchor-link"><a id="Function-3" class="tsd-anchor"></a>Function<a href="#Function-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>render</p>
14
+ <p>render</p>
15
15
  <pre><code><span class="hl-4">强制渲染</span><br/><span class="hl-4">调用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">和</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">均可在按需渲染时</span><span class="hl-1">，</span><span class="hl-4">使得画面渲染一次</span><br/><span class="hl-4">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">为在下帧渲染画面</span><br/><span class="hl-1">- </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">在当前帧渲染画面</span><br/><span class="hl-4">推荐使用</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">(), </span><span class="hl-4">可以更加流畅</span><span class="hl-1">。</span><span class="hl-4">但是如果需要截图等同步操作</span><span class="hl-1">，</span><span class="hl-4">可以使用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">()</span><br/><br/><span class="hl-5">// param callback 渲染完成回调</span><br/><span class="hl-0">render</span><span class="hl-1">(</span><span class="hl-4">callback</span><span class="hl-1">?: () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-6">void</span><span class="hl-1">): </span><span class="hl-6">void</span><span class="hl-1">,</span>
16
16
  </code><button>Copy</button></pre>
17
17
 
18
- <h4 class="tsd-anchor-link"><a id="Function-4" class="tsd-anchor"></a>Function<a href="#Function-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>needsRender</p>
18
+ <p>needsRender</p>
19
19
  <pre><code><span class="hl-4">下一帧渲染</span><br/><span class="hl-4">调用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">和</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">均可在按需渲染时</span><span class="hl-1">，</span><span class="hl-4">使得画面渲染一次</span><br/><span class="hl-4">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-0">needsRender</span><span class="hl-1">() </span><span class="hl-4">为在下帧渲染画面</span><br/><span class="hl-1">- </span><span class="hl-0">render</span><span class="hl-1">() </span><span class="hl-4">在当前帧渲染画面</span><br/><span class="hl-4">推荐使用</span><span class="hl-1"> </span><span class="hl-0">needsRender</span><span class="hl-1">(), </span><span class="hl-4">可以更加流畅</span><span class="hl-1">。</span><span class="hl-4">但是如果需要截图等同步操作</span><span class="hl-1">，</span><span class="hl-4">可以使用</span><span class="hl-1"> </span><span class="hl-0">render</span><span class="hl-1">()</span><br/><span class="hl-0">needsRender</span><span class="hl-1">(): </span><span class="hl-6">void</span><span class="hl-1">,</span>
20
20
  </code><button>Copy</button></pre>
21
21
 
22
- <h4 class="tsd-anchor-link"><a id="Function-5" class="tsd-anchor"></a>Function<a href="#Function-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>preloadPano</p>
22
+ <p>preloadPano</p>
23
23
  <pre><code><span class="hl-4">预加载点位图片资源</span><br/><span class="hl-5">// param panoId - 观察点</span><br/><span class="hl-5">// param callback - 加载完成回调, 并传递加载用时。</span><br/><span class="hl-5">// returns 加载完成的 Promise 参数同 callback</span><br/><span class="hl-0">preloadPano</span><span class="hl-1">(</span><span class="hl-4">panoId</span><span class="hl-1">: </span><span class="hl-4">WorkPanoId</span><span class="hl-1">, </span><span class="hl-4">callback</span><span class="hl-1">?: (</span><span class="hl-4">costs</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-6">void</span><span class="hl-1">): </span><span class="hl-8">Promise</span><span class="hl-1">&lt;</span><span class="hl-4">number</span><span class="hl-1">&gt;</span>
24
24
  </code><button>Copy</button></pre>
25
25
 
26
- <h4 class="tsd-anchor-link"><a id="Function-6" class="tsd-anchor"></a>Function<a href="#Function-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>project2d</p>
26
+ <p>project2d</p>
27
27
  <pre><code><span class="hl-4">计算三维空间的点对应到屏幕的二维坐标</span><br/><span class="hl-4">调用</span><span class="hl-1"> </span><span class="hl-2">`project2d()`</span><span class="hl-1"> </span><span class="hl-4">和</span><span class="hl-1"> </span><span class="hl-2">`useFiveProject2d()`</span><span class="hl-1"> </span><span class="hl-4">均可用于计算三维空间的点对应到屏幕的二维坐标</span><br/><span class="hl-4">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-2">`project2d()`</span><span class="hl-1"> </span><span class="hl-4">只计算一次</span><span class="hl-1">，</span><span class="hl-4">入参改变或</span><span class="hl-1"> </span><span class="hl-4">cameraUpdate</span><span class="hl-1"> </span><span class="hl-4">时</span><span class="hl-1"> </span><span class="hl-4">不会更新值</span><br/><span class="hl-1">- </span><span class="hl-2">`useFiveProject2d()`</span><span class="hl-1"> </span><span class="hl-4">通过</span><span class="hl-1"> </span><span class="hl-4">watch</span><span class="hl-1"> </span><span class="hl-4">监听入参和</span><span class="hl-1"> </span><span class="hl-4">cameraUpdate</span><span class="hl-1"> </span><span class="hl-4">变化</span><span class="hl-1">，</span><span class="hl-4">自动更新返回值</span><br/><span class="hl-0">project2d</span><span class="hl-1">(</span><span class="hl-4">vector3</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-4">Vector3</span><span class="hl-1">, </span><span class="hl-4">testModel</span><span class="hl-1">?: </span><span class="hl-4">boolean</span><span class="hl-1"> ): </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-4">Vector2</span>
28
28
  </code><button>Copy</button></pre>
29
29
 
30
- <h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">updateCamera</span><span class="hl-1">, </span><span class="hl-7">initBasisLoader</span><span class="hl-1">, </span><span class="hl-7">getPixels</span><span class="hl-1">, </span><span class="hl-7">render</span><span class="hl-1">, </span><span class="hl-7">needsRender</span><span class="hl-1">, </span><span class="hl-7">preloadPano</span><span class="hl-1">, </span><span class="hl-7">project2d</span><span class="hl-1"> } = </span><span class="hl-0">useFiveAction</span><span class="hl-1">();</span>
30
+ </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionVueCallbacks</a></h4><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-6">const</span><span class="hl-1"> { </span><span class="hl-7">updateCamera</span><span class="hl-1">, </span><span class="hl-7">initBasisLoader</span><span class="hl-1">, </span><span class="hl-7">getPixels</span><span class="hl-1">, </span><span class="hl-7">render</span><span class="hl-1">, </span><span class="hl-7">needsRender</span><span class="hl-1">, </span><span class="hl-7">preloadPano</span><span class="hl-1">, </span><span class="hl-7">project2d</span><span class="hl-1"> } = </span><span class="hl-0">useFiveAction</span><span class="hl-1">();</span>
31
31
  </code><button>Copy</button></pre>
32
32
 
33
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveAction.ts:203</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
33
+ </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveAction.ts:203</li></ul></aside></div></li></ul></section></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></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/functions/vue.useFiveCameraDirection.html CHANGED
@@ -1,3 +1,3 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveCameraDirection | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveCameraDirection.html">useFiveCameraDirection</a></li></ul><h1>Function useFiveCameraDirection</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveCameraDirection" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Camera<wbr/>Direction</span><span class="tsd-signature-symbol">(</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><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span><a href="#useFiveCameraDirection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: 得到当前相机的方向（单位向量）</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span></h4><p>当前相机方向的单位向量</p>
3
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCameraDirection.ts:14</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
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>useFiveCameraDirection | 如视 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">useFiveCameraDirection</a></li></ul><h1>Function useFiveCameraDirection</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivecameradirection"><span class="tsd-kind-call-signature">useFiveCameraDirection</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><span class="tsd-signature-type">Vector3</span><span class="tsd-signature-symbol">&gt;</span><a href="#usefivecameradirection" 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: 得到当前相机的方向（单位向量）</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Vector3</span><span class="tsd-signature-symbol">&gt;</span></h4><p>当前相机方向的单位向量</p>
3
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCameraDirection.ts:14</li></ul></aside></div></li></ul></section></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></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/functions/vue.useFiveCameraRaycaster.html CHANGED
@@ -1,3 +1,3 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveCameraRaycaster | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveCameraRaycaster.html">useFiveCameraRaycaster</a></li></ul><h1>Function useFiveCameraRaycaster</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveCameraRaycaster" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</span><span class="tsd-signature-symbol">(</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><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><a href="#useFiveCameraRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: 得到当前相机的方向（射线对象）</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span></h4><p>当前相机方向的射线对象</p>
3
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCameraRaycaster.ts:16</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
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>useFiveCameraRaycaster | 如视 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">useFiveCameraRaycaster</a></li></ul><h1>Function useFiveCameraRaycaster</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivecameraraycaster"><span class="tsd-kind-call-signature">useFiveCameraRaycaster</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><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">&gt;</span><a href="#usefivecameraraycaster" 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: 得到当前相机的方向（射线对象）</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">&gt;</span></h4><p>当前相机方向的射线对象</p>
3
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCameraRaycaster.ts:16</li></ul></aside></div></li></ul></section></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></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/functions/vue.useFiveCurrentObserver.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveCurrentObserver.html">useFiveCurrentObserver</a></li></ul><h1>Function useFiveCurrentObserver</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveCurrentObserver" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Current<wbr/>Observer</span><span class="tsd-signature-symbol">(</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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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
- <div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">observer</span><span class="hl-1"> = </span><span class="hl-0">useFiveCurrentObserver</span><span class="hl-1">();</span>
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>
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-6">const</span><span class="hl-1"> </span><span class="hl-7">observer</span><span class="hl-1"> = </span><span class="hl-0">useFiveCurrentObserver</span><span class="hl-1">();</span>
4
4
  </code><button>Copy</button></pre>
5
5
 
6
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCurrentObserver.ts:13</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
6
+ </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCurrentObserver.ts:13</li></ul></aside></div></li></ul></section></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></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/functions/vue.useFiveCurrentState.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveCurrentState | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveCurrentState.html">useFiveCurrentState</a></li></ul><h1>Function useFiveCurrentState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveCurrentState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Current<wbr/>State</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>currentState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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><span class="tsd-signature-symbol">]</span><a href="#useFiveCurrentState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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>currentState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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><span class="tsd-signature-symbol">]</span></h4><p>[ currentState: Five 的实时状态, setState: 设置 Five 的状态 ]</p>
3
- <div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> [ </span><span class="hl-7">currentState</span><span class="hl-1">, </span><span class="hl-7">setState</span><span class="hl-1"> ] = </span><span class="hl-4">useFiveCurrentState</span><span class="hl-1">;</span>
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>useFiveCurrentState | 如视 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">useFiveCurrentState</a></li></ul><h1>Function useFiveCurrentState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefivecurrentstate"><span class="tsd-kind-call-signature">useFiveCurrentState</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><br/>    currentState<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    setState<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span>)<span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <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="#usefivecurrentstate" 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/>    currentState<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    setState<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">&gt;</span>)<span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <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>[ currentState: Five 的实时状态, setState: 设置 Five 的状态 ]</p>
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-6">const</span><span class="hl-1"> [ </span><span class="hl-7">currentState</span><span class="hl-1">, </span><span class="hl-7">setState</span><span class="hl-1"> ] = </span><span class="hl-4">useFiveCurrentState</span><span class="hl-1">;</span>
4
4
  </code><button>Copy</button></pre>
5
5
 
6
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCurrentState.ts:14</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
6
+ </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCurrentState.ts:14</li></ul></aside></div></li></ul></section></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></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/functions/vue.useFiveEventCallback.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveEventCallback | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveEventCallback.html">useFiveEventCallback</a></li></ul><h1>Function useFiveEventCallback</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveEventCallback" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Event<wbr/>Callback</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="vue.useFiveEventCallback.html#useFiveEventCallback.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#useFiveEventCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Five Vue Hooks: Five 事件监听
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>useFiveEventCallback | 如视 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">useFiveEventCallback</a></li></ul><h1>Function useFiveEventCallback</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefiveeventcallback"><span class="tsd-kind-call-signature">useFiveEventCallback</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#usefiveeventcallbackt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../interfaces/five.EventCallback.html" class="tsd-signature-type tsd-kind-interface">EventCallback</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usefiveeventcallbackt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.EventCallback.html" class="tsd-signature-type tsd-kind-interface">EventCallback</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#usefiveeventcallbackt">T</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#usefiveeventcallback" 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 事件监听
2
2
  具体事件列表 请查看 Five.EventCallback</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useFiveEventCallback.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">keyof </span><a href="../interfaces/five.EventCallback.html" class="tsd-signature-type tsd-kind-interface">EventCallback</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="vue.useFiveEventCallback.html#useFiveEventCallback.T">T</a></span></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../interfaces/five.EventCallback.html" class="tsd-signature-type tsd-kind-interface">EventCallback</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="vue.useFiveEventCallback.html#useFiveEventCallback.T">T</a><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-0">useFiveEventCallback</span><span class="hl-1">(</span><span class="hl-2">&quot;cameraUpdate&quot;</span><span class="hl-1">, </span><span class="hl-4">pose</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> {});</span>
3
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="usefiveeventcallbackt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-keyword">keyof</span> <a href="../interfaces/five.EventCallback.html" class="tsd-signature-type tsd-kind-interface">EventCallback</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#usefiveeventcallbackt">T</a></span></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../interfaces/five.EventCallback.html" class="tsd-signature-type tsd-kind-interface">EventCallback</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#usefiveeventcallbackt">T</a><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><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-0">useFiveEventCallback</span><span class="hl-1">(</span><span class="hl-2">&quot;cameraUpdate&quot;</span><span class="hl-1">, </span><span class="hl-4">pose</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> {});</span>
4
4
  </code><button>Copy</button></pre>
5
5
 
6
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveEventCallback.ts:13</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
6
+ </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveEventCallback.ts:13</li></ul></aside></div></li></ul></section></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></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/functions/vue.useFiveFloor.html CHANGED
@@ -1,6 +1,6 @@
1
- <!DOCTYPE html><html class="default" lang="en"><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/vue.html">vue</a></li><li><a href="vue.useFiveFloor.html">useFiveFloor</a></li></ul><h1>Function useFiveFloor</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveFloor" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Floor</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>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">&gt;</span><span class="tsd-signature-symbol">, </span>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">&gt;</span><span class="tsd-signature-symbol">, </span>showFloor<span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-symbol">]</span><a href="#useFiveFloor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li 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>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">&gt;</span><span class="tsd-signature-symbol">, </span>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">&gt;</span><span class="tsd-signature-symbol">, </span>showFloor<span class="tsd-signature-symbol">: </span><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><span class="tsd-signature-symbol">]</span></h4><p>[ shownFloor: Five 当前显示的楼层， null 为都显示, showFloor: 设置显示楼层，不传参数为都显示 ]</p>
3
- <div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> [ </span><span class="hl-7">shownFloor</span><span class="hl-1">, </span><span class="hl-7">showFloor</span><span class="hl-1"> ] = </span><span class="hl-4">useFiveHelper</span><span class="hl-1">;</span>
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>
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-6">const</span><span class="hl-1"> [ </span><span class="hl-7">shownFloor</span><span class="hl-1">, </span><span class="hl-7">showFloor</span><span class="hl-1"> ] = </span><span class="hl-4">useFiveHelper</span><span class="hl-1">;</span>
4
4
  </code><button>Copy</button></pre>
5
5
 
6
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveFloor.ts:14</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
6
+ </div></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveFloor.ts:14</li></ul></aside></div></li></ul></section></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></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>