@realsee/five 6.2.0-alpha.1 → 6.2.0-alpha.10

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 (390) hide show
  1. package/docs/assets/icons.js +17 -14
  2. package/docs/assets/icons.svg +1 -1
  3. package/docs/assets/main.js +5 -4
  4. package/docs/assets/navigation.js +1 -1
  5. package/docs/assets/search.js +1 -1
  6. package/docs/assets/style.css +67 -31
  7. package/docs/classes/five.AnimationFrameLoop.html +5 -5
  8. package/docs/classes/five.BoxBoundingVolume.html +2 -2
  9. package/docs/classes/five.Camera.html +6 -6
  10. package/docs/classes/five.CullingVolume.html +2 -2
  11. package/docs/classes/five.Fetcher.html +2 -2
  12. package/docs/classes/five.Five.html +107 -96
  13. package/docs/classes/five.InternalWebGLRenderer.html +2 -2
  14. package/docs/classes/five.IntersectMesh.html +3 -3
  15. package/docs/classes/five.Model.html +25 -22
  16. package/docs/classes/five.ModelViewLayer.html +6 -6
  17. package/docs/classes/five.NetworkAbortError.html +2 -2
  18. package/docs/classes/five.NetworkFirbiddenError.html +2 -2
  19. package/docs/classes/five.NetworkResponseError.html +2 -2
  20. package/docs/classes/five.NetworkSubscribe.html +16 -15
  21. package/docs/classes/five.NetworkTimeoutError.html +2 -2
  22. package/docs/classes/five.PBMContainer.html +5 -5
  23. package/docs/classes/five.PBMGroup.html +3 -3
  24. package/docs/classes/five.PBMMesh.html +3 -3
  25. package/docs/classes/five.PBMMeshMaterial.html +31 -27
  26. package/docs/classes/five.PanoCircleMesh.html +5 -5
  27. package/docs/classes/five.PanoCircleMeshCustom.html +5 -5
  28. package/docs/classes/five.PanoCircleMeshSolid.html +5 -5
  29. package/docs/classes/five.RegionBoundingVolume.html +2 -2
  30. package/docs/classes/five.Scene.html +5 -3
  31. package/docs/classes/five.SphereBoundingVolume.html +2 -2
  32. package/docs/classes/five.Subscribe.html +14 -13
  33. package/docs/classes/five.TextureLoader.html +2 -2
  34. package/docs/classes/five.Tile.html +3 -2
  35. package/docs/classes/five.Tile3DModel.html +5 -2
  36. package/docs/classes/five.TileCache.html +2 -2
  37. package/docs/classes/five.TileCubeTextureTarget.html +5 -3
  38. package/docs/classes/five.TileNode.html +2 -2
  39. package/docs/classes/five.TileRequestScheduler.html +6 -9
  40. package/docs/classes/five.Tileset.html +5 -4
  41. package/docs/classes/five.Work.html +17 -11
  42. package/docs/classes/five.XRButton.html +2 -2
  43. package/docs/classes/gltf_loader.DDSLoader.html +2 -2
  44. package/docs/classes/gltf_loader.DRACOLoader.html +2 -2
  45. package/docs/classes/gltf_loader.GLTFLoader.html +10 -9
  46. package/docs/classes/gltf_loader.GLTFObject.html +5 -5
  47. package/docs/classes/gltf_loader.GLTFParser.html +2 -2
  48. package/docs/classes/gltf_loader.THREEGLTFLoader.html +2 -2
  49. package/docs/classes/line.Line.html +2 -2
  50. package/docs/classes/line.LineGeometry.html +7 -2
  51. package/docs/classes/line.LineMaterial.html +2 -2
  52. package/docs/classes/line.LineSegmentsGeometry.html +7 -2
  53. package/docs/classes/line.THREE_Line2.html +2 -2
  54. package/docs/classes/line.THREE_LineSegments2.html +2 -2
  55. package/docs/classes/plugins-1.BackgroundPluginController.html +38 -0
  56. package/docs/classes/plugins-1.BasePlugin.Controller.html +39 -0
  57. package/docs/classes/plugins-1.ItemMaskController.html +36 -0
  58. package/docs/classes/plugins-1.OrientationPluginController.html +47 -0
  59. package/docs/classes/plugins-1.RoundedBoxGeometry.html +3 -0
  60. package/docs/classes/react.Store.html +9 -8
  61. package/docs/classes/sticker.Sticker.html +9 -8
  62. package/docs/classes/vfx.Airflow.html +2 -2
  63. package/docs/classes/vfx.Flame.html +2 -2
  64. package/docs/classes/vfx.Particle.html +10 -10
  65. package/docs/classes/vfx.SpotLight.html +2 -2
  66. package/docs/documents/coordinate.html +9 -0
  67. package/docs/documents/five.FivePlugin.plugins.html +77 -0
  68. package/docs/documents/five.Pose.coordinate.html +9 -0
  69. package/docs/documents/plugins.html +77 -0
  70. package/docs/documents/react_component.html +32 -0
  71. package/docs/enums/five.VolumePlaneIntersect.html +2 -2
  72. package/docs/enums/plugins-1.BackgroundPluginType.WarningCodeType.html +2 -0
  73. package/docs/functions/five.defaultImageURLTransform.html +2 -2
  74. package/docs/functions/five.getViewportScale.html +1 -1
  75. package/docs/functions/five.imageSupport.html +1 -1
  76. package/docs/functions/five.isPanoId.html +1 -1
  77. package/docs/functions/five.loadAt3d.html +1 -1
  78. package/docs/functions/five.loadB3dm.html +1 -1
  79. package/docs/functions/five.loadDome.html +1 -1
  80. package/docs/functions/five.loadDomez.html +1 -1
  81. package/docs/functions/five.loadGlb.html +1 -1
  82. package/docs/functions/five.loadPbm.html +1 -1
  83. package/docs/functions/five.loadPnts.html +1 -1
  84. package/docs/functions/five.panoEqual.html +1 -1
  85. package/docs/functions/five.panoParse.html +1 -1
  86. package/docs/functions/five.panoStringify.html +1 -1
  87. package/docs/functions/five.parseWork.html +3 -3
  88. package/docs/functions/plugins-1.BackgroundPlugin.html +1 -0
  89. package/docs/functions/plugins-1.ItemMaskPlugin.html +1 -0
  90. package/docs/functions/plugins-1.OrientationPlugin.html +1 -0
  91. package/docs/functions/react.FiveCanvas.html +6 -6
  92. package/docs/functions/react.createFiveFeature.html +1 -1
  93. package/docs/functions/react.createFiveProvider.html +4 -3
  94. package/docs/functions/react.createStore.html +8 -8
  95. package/docs/functions/react.unsafe__useFiveInstance.html +4 -4
  96. package/docs/functions/react.useFiveAction.html +14 -8
  97. package/docs/functions/react.useFiveCameraDirection.html +2 -2
  98. package/docs/functions/react.useFiveCameraRaycaster.html +2 -2
  99. package/docs/functions/react.useFiveCurrentObserver.html +4 -3
  100. package/docs/functions/react.useFiveCurrentState.html +5 -4
  101. package/docs/functions/react.useFiveEventCallback.html +4 -3
  102. package/docs/functions/react.useFiveFloor.html +5 -4
  103. package/docs/functions/react.useFiveHelper.html +5 -4
  104. package/docs/functions/react.useFiveModelIntersectRaycaster.html +6 -4
  105. package/docs/functions/react.useFiveModelReadyState.html +2 -2
  106. package/docs/functions/react.useFiveProject2d.html +6 -4
  107. package/docs/functions/react.useFiveScene.html +7 -2
  108. package/docs/functions/react.useFiveSceneEffect.html +5 -4
  109. package/docs/functions/react.useFiveState.html +1 -1
  110. package/docs/functions/react.useFiveWork.html +7 -5
  111. package/docs/functions/react.withFive.html +1 -1
  112. package/docs/functions/vue.unsafe__useFiveInject.html +4 -4
  113. package/docs/functions/vue.useFiveAction.html +18 -10
  114. package/docs/functions/vue.useFiveCameraDirection.html +2 -2
  115. package/docs/functions/vue.useFiveCameraRaycaster.html +2 -2
  116. package/docs/functions/vue.useFiveCurrentObserver.html +4 -3
  117. package/docs/functions/vue.useFiveCurrentState.html +5 -4
  118. package/docs/functions/vue.useFiveEventCallback.html +4 -3
  119. package/docs/functions/vue.useFiveFloor.html +5 -4
  120. package/docs/functions/vue.useFiveHelper.html +5 -4
  121. package/docs/functions/vue.useFiveModel.html +2 -2
  122. package/docs/functions/vue.useFiveModelBounding.html +2 -2
  123. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +6 -4
  124. package/docs/functions/vue.useFiveModelReadyState.html +2 -2
  125. package/docs/functions/vue.useFiveProject2d.html +6 -4
  126. package/docs/functions/vue.useFiveScene.html +2 -2
  127. package/docs/functions/vue.useFiveState.html +5 -4
  128. package/docs/functions/vue.useFiveWorks.html +7 -5
  129. package/docs/hierarchy.html +1 -1
  130. package/docs/index.html +91 -65
  131. package/docs/interfaces/five.AddableObject.html +6 -6
  132. package/docs/interfaces/five.AjaxOptions.html +7 -7
  133. package/docs/interfaces/five.AnimationFrame.html +2 -2
  134. package/docs/interfaces/five.BaseEvent.html +2 -2
  135. package/docs/interfaces/five.BoundingVolume.html +2 -2
  136. package/docs/interfaces/five.CameraPose.html +2 -2
  137. package/docs/interfaces/five.ClipperParameter.html +2 -2
  138. package/docs/interfaces/five.EventCallback.html +70 -63
  139. package/docs/interfaces/five.FiveInitArgs.html +58 -52
  140. package/docs/interfaces/five.FiveLoadOptions.html +25 -25
  141. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +14 -10
  142. package/docs/interfaces/five.GestureEvent.html +2 -2
  143. package/docs/interfaces/five.ImageOptions.html +9 -9
  144. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  145. package/docs/interfaces/five.ImageURLOptions.html +8 -8
  146. package/docs/interfaces/five.IntersectEvent.html +2 -2
  147. package/docs/interfaces/five.IntersectMeshInterface.html +3 -3
  148. package/docs/interfaces/five.Intersection.html +3 -3
  149. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +16 -9
  150. package/docs/interfaces/five.ModeChangeEvent.html +2 -2
  151. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +11 -11
  152. package/docs/interfaces/five.ModelEvent.html +2 -2
  153. package/docs/interfaces/five.ModelsEvent.html +2 -2
  154. package/docs/interfaces/five.MotionKeyframe.html +2 -2
  155. package/docs/interfaces/five.MovePanoOptions.html +15 -15
  156. package/docs/interfaces/five.NetworkOptions.html +6 -6
  157. package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
  158. package/docs/interfaces/five.ObjectEvent.html +2 -2
  159. package/docs/interfaces/five.PBMPanoPicture.html +3 -3
  160. package/docs/interfaces/five.PBMParameters.html +4 -4
  161. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +2 -2
  162. package/docs/interfaces/five.PanoCircleMeshInterface.html +6 -6
  163. package/docs/interfaces/five.PanoCircleMeshOptions.html +2 -2
  164. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +2 -2
  165. package/docs/interfaces/five.PanoEvent.html +2 -2
  166. package/docs/interfaces/five.PanoTextureEvent.html +2 -2
  167. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +22 -20
  168. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +11 -11
  169. package/docs/interfaces/five.Pose.html +5 -12
  170. package/docs/interfaces/five.RenderEvent.html +2 -2
  171. package/docs/interfaces/five.Scissor.html +5 -5
  172. package/docs/interfaces/five.State.html +7 -6
  173. package/docs/interfaces/five.StateEvent.html +2 -2
  174. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
  175. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
  176. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
  177. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
  178. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
  179. package/docs/interfaces/five.SubscribeMixinType.waitUnitl.html +1 -1
  180. package/docs/interfaces/five.TextureOptions.html +10 -10
  181. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +4 -4
  182. package/docs/interfaces/five.TileCubeNode.html +2 -2
  183. package/docs/interfaces/five.TileCubeTree.html +2 -2
  184. package/docs/interfaces/five.TileHeader.html +2 -2
  185. package/docs/interfaces/five.TilesetHeader.html +2 -2
  186. package/docs/interfaces/five.TilesetOptions.html +3 -2
  187. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +10 -6
  188. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +20 -18
  189. package/docs/interfaces/five.WebXRAxesParams.html +2 -2
  190. package/docs/interfaces/five.WebXRControllerParams.html +2 -2
  191. package/docs/interfaces/five.WorkCubeImage.html +4 -4
  192. package/docs/interfaces/five.WorkImage.html +8 -8
  193. package/docs/interfaces/five.WorkInitial.html +10 -10
  194. package/docs/interfaces/five.WorkModel.html +6 -6
  195. package/docs/interfaces/five.WorkObserver.html +7 -7
  196. package/docs/interfaces/five.WorkResolvedObserver.html +7 -7
  197. package/docs/interfaces/five.WorkTile.html +2 -2
  198. package/docs/interfaces/five.WorkVideo.html +4 -4
  199. package/docs/interfaces/five.WorksEvent.html +2 -2
  200. package/docs/interfaces/five.XRControllerEvent.html +2 -2
  201. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  202. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +20 -18
  203. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  204. package/docs/interfaces/gltf_loader.DDS.html +2 -2
  205. package/docs/interfaces/gltf_loader.GLTF.html +4 -4
  206. package/docs/interfaces/gltf_loader.GLTFReference.html +2 -2
  207. package/docs/interfaces/gltf_loader.THREEGLTF.html +2 -2
  208. package/docs/interfaces/plugins-1.BackgroundPluginType.Config.html +1 -0
  209. package/docs/interfaces/plugins-1.BackgroundPluginType.EventMap.html +20 -0
  210. package/docs/interfaces/plugins-1.BackgroundPluginType.Params.html +3 -0
  211. package/docs/interfaces/plugins-1.BackgroundPluginType.PluginDataItem.html +1 -0
  212. package/docs/interfaces/plugins-1.BasePlugin.BaseOptions.html +3 -0
  213. package/docs/interfaces/plugins-1.BasePlugin.Config.html +5 -0
  214. package/docs/interfaces/plugins-1.BasePlugin.State.html +8 -0
  215. package/docs/interfaces/plugins-1.BasePlugin.StateChangeParams.html +7 -0
  216. package/docs/interfaces/plugins-1.ItemMaskPluginType.Config.html +2 -0
  217. package/docs/interfaces/plugins-1.ItemMaskPluginType.EventMap.html +10 -0
  218. package/docs/interfaces/plugins-1.ItemMaskPluginType.ItemType.html +13 -0
  219. package/docs/interfaces/plugins-1.ItemMaskPluginType.MaskType.html +4 -0
  220. package/docs/interfaces/plugins-1.ItemMaskPluginType.Params.html +4 -0
  221. package/docs/interfaces/plugins-1.ItemMaskPluginType.State.html +14 -0
  222. package/docs/interfaces/plugins-1.OrientationPluginType.Config.html +4 -0
  223. package/docs/interfaces/plugins-1.OrientationPluginType.EventMap.html +10 -0
  224. package/docs/interfaces/plugins-1.OrientationPluginType.Params.html +4 -0
  225. package/docs/interfaces/plugins-1.OrientationPluginType.State.html +10 -0
  226. package/docs/interfaces/react.FiveActionReactCallbacks.html +11 -10
  227. package/docs/interfaces/react.FiveCanvasProps.html +5 -0
  228. package/docs/interfaces/react.FiveInjectionTypes.html +148 -57
  229. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +2 -2
  230. package/docs/interfaces/sticker.IntersectionLike.html +6 -6
  231. package/docs/interfaces/vfx.ParticleArgs.html +9 -9
  232. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +2 -2
  233. package/docs/interfaces/vue.FiveActionVueCallbacks.html +11 -11
  234. package/docs/modules/five.SubscribeMixinType.html +2 -2
  235. package/docs/modules/five.html +2 -2
  236. package/docs/modules/gltf_loader.html +2 -2
  237. package/docs/modules/line.html +2 -2
  238. package/docs/modules/plugins-1.BackgroundPluginType.html +10 -0
  239. package/docs/modules/plugins-1.BasePlugin.html +7 -0
  240. package/docs/modules/plugins-1.ItemMaskPluginType.html +9 -0
  241. package/docs/modules/plugins-1.OrientationPluginType.html +7 -0
  242. package/docs/modules/plugins-1.html +12 -0
  243. package/docs/modules/react.html +3 -2
  244. package/docs/modules/sticker.html +2 -2
  245. package/docs/modules/vfx.html +2 -2
  246. package/docs/modules/vue.html +2 -2
  247. package/docs/types/five.AjaxResponseType.html +1 -1
  248. package/docs/types/five.AjaxResponseTypeMapping.html +1 -1
  249. package/docs/types/five.BoundingVolumeJson.html +1 -1
  250. package/docs/types/five.BoxBoundingVolumeJson.html +1 -1
  251. package/docs/types/five.ControllerCustomInitTypes.html +1 -1
  252. package/docs/types/five.ControllerEventTypes.html +2 -2
  253. package/docs/types/five.EventTypes.html +3 -3
  254. package/docs/types/five.FivePlugin.html +2 -69
  255. package/docs/types/five.FivePluginInit.html +2 -2
  256. package/docs/types/five.FivePluginInstance.html +2 -2
  257. package/docs/types/five.GestureTypes.html +1 -1
  258. package/docs/types/five.LegacyEventType.html +66 -59
  259. package/docs/types/five.LooseWork.html +1 -1
  260. package/docs/types/five.LooseWorkInitial.html +1 -1
  261. package/docs/types/five.LooseWorkModel.html +1 -1
  262. package/docs/types/five.LooseWorkObserver.html +1 -1
  263. package/docs/types/five.LooseWorkPanorama.html +1 -1
  264. package/docs/types/five.LooseWorkVideo.html +1 -1
  265. package/docs/types/five.LooseWorkWithExtrinsics.html +2 -2
  266. package/docs/types/five.Mirror.html +1 -1
  267. package/docs/types/five.Mode.html +9 -2
  268. package/docs/types/five.ModelMaterialValues.html +1 -1
  269. package/docs/types/five.Models.html +6 -6
  270. package/docs/types/five.MotionValue.html +1 -1
  271. package/docs/types/five.MovePanoEffect.html +3 -3
  272. package/docs/types/five.NetWorkMeta.html +1 -1
  273. package/docs/types/five.NetworkError.html +1 -1
  274. package/docs/types/five.NetworkErrorCallback.html +1 -1
  275. package/docs/types/five.NetworkProgressCallback.html +1 -1
  276. package/docs/types/five.NetworkResponse.html +1 -1
  277. package/docs/types/five.NetworkState.html +1 -1
  278. package/docs/types/five.NetworkSuccessCallback.html +1 -1
  279. package/docs/types/five.NetworkType.html +1 -1
  280. package/docs/types/five.Pano.html +1 -1
  281. package/docs/types/five.PanoId.html +1 -1
  282. package/docs/types/five.ParseWorkOptions.html +6 -6
  283. package/docs/types/five.ParsedResultType.html +1 -1
  284. package/docs/types/five.PostProcessingType.html +1 -1
  285. package/docs/types/five.RegionBoundingVolumeJson.html +1 -1
  286. package/docs/types/five.SphereBoundingVolumeJson.html +1 -1
  287. package/docs/types/five.SubscribeEventMap.html +1 -1
  288. package/docs/types/five.TileContentData.html +1 -1
  289. package/docs/types/five.TileRequest.html +2 -2
  290. package/docs/types/five.TileRequestResult.html +1 -1
  291. package/docs/types/five.TilesetFrameState.html +1 -1
  292. package/docs/types/five.WebXRControllerKey.html +1 -1
  293. package/docs/types/five.WebXRControllerType.html +1 -1
  294. package/docs/types/five.Works.html +1 -1
  295. package/docs/types/line.LineMaterialParameters.html +1 -1
  296. package/docs/types/plugins-1.BackgroundPluginType.Mirror.html +1 -0
  297. package/docs/types/plugins-1.BackgroundPluginType.Mode.html +1 -0
  298. package/docs/types/plugins-1.BackgroundPluginType.PluginData.html +1 -0
  299. package/docs/types/plugins-1.BackgroundPluginType.State.html +1 -0
  300. package/docs/types/plugins-1.BasePlugin.EventMap.html +6 -0
  301. package/docs/types/plugins-1.ItemMaskPluginType.PluginData.html +1 -0
  302. package/docs/types/plugins-1.ItemMaskPluginType.ServerData.html +1 -0
  303. package/docs/types/{plugins.OrientationPluginType.PluginData.html → plugins-1.OrientationPluginType.PluginData.html} +1 -1
  304. package/docs/types/{plugins.OrientationPluginType.ServerData.html → plugins-1.OrientationPluginType.ServerData.html} +1 -1
  305. package/docs/types/react.FiveInjectionActionFeature.html +1 -1
  306. package/docs/types/react.FiveInjectionDataFeature.html +1 -1
  307. package/docs/types/react.FiveInjectionFeature.html +1 -1
  308. package/docs/types/react.FiveProviderPropTypes.html +1 -1
  309. package/docs/types/react.FiveProviderType.html +1 -1
  310. package/docs/types/react.StoreActionMapHanlder.html +1 -1
  311. package/docs/types/react.StoreActionMapType.html +1 -1
  312. package/docs/types/react.StoreProviderType.html +1 -1
  313. package/docs/types/react.StoreValueMapType.html +1 -1
  314. package/docs/types/vfx.ParticleType.html +1 -1
  315. package/docs/types/vue.FiveModelIntersectRaycaster.html +1 -1
  316. package/docs/types/vue.FiveProviderComponent.html +1 -1
  317. package/docs/types/vue.Project2d.html +1 -1
  318. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  319. package/docs/variables/five.defaultPbmParameters.html +1 -1
  320. package/docs/variables/react.INJECTION_PROPNAME.html +1 -1
  321. package/docs/variables/vue.FiveCanvas.html +9 -8
  322. package/docs/variables/vue.FiveProvider.html +7 -6
  323. package/five/index.d.ts +73 -28
  324. package/five/index.js +91 -91
  325. package/five/index.mjs +6177 -5970
  326. package/gltf-loader/index.js +3 -3
  327. package/gltf-loader/index.mjs +3 -3
  328. package/line/index.js +3 -3
  329. package/line/index.mjs +3 -3
  330. package/package.json +2 -2
  331. package/plugins/index.d.ts +14 -17
  332. package/plugins/index.js +3 -3
  333. package/plugins/index.mjs +4 -4
  334. package/react/index.d.ts +9 -8
  335. package/react/index.js +3 -3
  336. package/react/index.mjs +3 -3
  337. package/sticker/index.js +3 -3
  338. package/sticker/index.mjs +3 -3
  339. package/umd/five-gltf-loader.js +3 -3
  340. package/umd/five-line.js +3 -3
  341. package/umd/five-plugins.js +3 -3
  342. package/umd/five-react.js +3 -3
  343. package/umd/five-sticker.js +3 -3
  344. package/umd/five-vfx.js +2 -2
  345. package/umd/five-vue.js +2 -2
  346. package/umd/five.js +49 -49
  347. package/vfx/index.js +2 -2
  348. package/vfx/index.mjs +2 -2
  349. package/vue/index.js +2 -2
  350. package/vue/index.mjs +2 -2
  351. package/docs/classes/plugins.BackgroundPluginController.html +0 -37
  352. package/docs/classes/plugins.BasePlugin.Controller.html +0 -38
  353. package/docs/classes/plugins.ItemMaskController.html +0 -37
  354. package/docs/classes/plugins.OrientationPluginController.html +0 -49
  355. package/docs/classes/plugins.RoundedBoxGeometry.html +0 -3
  356. package/docs/enums/plugins.BackgroundPluginType.WarningCodeType.html +0 -2
  357. package/docs/functions/plugins.BackgroundPlugin.html +0 -1
  358. package/docs/functions/plugins.ItemMaskPlugin.html +0 -1
  359. package/docs/functions/plugins.OrientationPlugin.html +0 -1
  360. package/docs/interfaces/plugins.BackgroundPluginType.Config.html +0 -1
  361. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +0 -20
  362. package/docs/interfaces/plugins.BackgroundPluginType.Params.html +0 -3
  363. package/docs/interfaces/plugins.BackgroundPluginType.PluginDataItem.html +0 -1
  364. package/docs/interfaces/plugins.BasePlugin.BaseOptions.html +0 -3
  365. package/docs/interfaces/plugins.BasePlugin.Config.html +0 -5
  366. package/docs/interfaces/plugins.BasePlugin.State.html +0 -8
  367. package/docs/interfaces/plugins.ItemMaskPluginType.Config.html +0 -2
  368. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +0 -10
  369. package/docs/interfaces/plugins.ItemMaskPluginType.ItemType.html +0 -13
  370. package/docs/interfaces/plugins.ItemMaskPluginType.MaskType.html +0 -4
  371. package/docs/interfaces/plugins.ItemMaskPluginType.Params.html +0 -4
  372. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +0 -14
  373. package/docs/interfaces/plugins.OrientationPluginType.Config.html +0 -4
  374. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +0 -10
  375. package/docs/interfaces/plugins.OrientationPluginType.Params.html +0 -4
  376. package/docs/interfaces/plugins.OrientationPluginType.State.html +0 -10
  377. package/docs/media/topview.jpg +0 -0
  378. package/docs/media/typescript.jpg +0 -0
  379. package/docs/modules/plugins.BackgroundPluginType.html +0 -10
  380. package/docs/modules/plugins.BasePlugin.html +0 -6
  381. package/docs/modules/plugins.ItemMaskPluginType.html +0 -9
  382. package/docs/modules/plugins.OrientationPluginType.html +0 -7
  383. package/docs/modules/plugins.html +0 -12
  384. package/docs/types/plugins.BackgroundPluginType.Mirror.html +0 -1
  385. package/docs/types/plugins.BackgroundPluginType.Mode.html +0 -1
  386. package/docs/types/plugins.BackgroundPluginType.PluginData.html +0 -1
  387. package/docs/types/plugins.BackgroundPluginType.State.html +0 -1
  388. package/docs/types/plugins.BasePlugin.EventMap.html +0 -6
  389. package/docs/types/plugins.ItemMaskPluginType.PluginData.html +0 -1
  390. package/docs/types/plugins.ItemMaskPluginType.ServerData.html +0 -1
package/docs/functions/react.useFiveCurrentState.html CHANGED
@@ -1,5 +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/react.html">react</a></li><li><a href="react.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><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><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-kind-parameter">immediately</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</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 React Hooks: Five 的实时状态</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>currentState<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>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-kind-parameter">immediately</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</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>Example</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"><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/react.html">react</a></li><li><a href="react.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><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><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 React Hooks: Five 的实时状态</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>currentState<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>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>
4
4
  </code><button>Copy</button></pre>
5
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/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-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
5
+
6
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/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>
package/docs/functions/react.useFiveEventCallback.html CHANGED
@@ -1,5 +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/react.html">react</a></li><li><a href="react.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="react.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-kind-parameter">deps</span><span class="tsd-signature-symbol">?</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 React Hooks: Five 事件监听
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/react.html">react</a></li><li><a href="react.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="react.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-kind-parameter">deps</span><span class="tsd-signature-symbol">?</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 React 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="react.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="react.useFiveEventCallback.html#useFiveEventCallback.T">T</a><span class="tsd-signature-symbol">]</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</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>Example</h4><pre><code><span class="hl-0">useFiveEvent</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><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="react.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="react.useFiveEventCallback.html#useFiveEventCallback.T">T</a><span class="tsd-signature-symbol">]</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</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">useFiveEvent</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
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/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-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
5
+
6
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/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>
package/docs/functions/react.useFiveFloor.html CHANGED
@@ -1,5 +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/react.html">react</a></li><li><a href="react.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">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span>totalFloorLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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-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 React 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">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span>totalFloorLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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-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>Example</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">useFiveFloor</span><span class="hl-1">;</span>
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/react.html">react</a></li><li><a href="react.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">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span>totalFloorLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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 React 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">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span>totalFloorLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">useFiveFloor</span><span class="hl-1">;</span>
4
4
  </code><button>Copy</button></pre>
5
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveFloor.ts:15</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
5
+
6
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveFloor.ts:15</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>
package/docs/functions/react.useFiveHelper.html CHANGED
@@ -1,5 +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>useFiveHelper | 如视 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/react.html">react</a></li><li><a href="react.useFiveHelper.html">useFiveHelper</a></li></ul><h1>Function useFiveHelper</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveHelper" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Helper</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>helperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>toggleHelperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</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="#useFiveHelper" 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 React Hooks: Five 帮助元素的隐藏/显示</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>helperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>toggleHelperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</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>[ helperVisible: Five 帮助元素是否显示显示, toggleHelperVisible: 设置 帮助元素的隐藏/显示 ]</p>
3
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code><span class="hl-6">const</span><span class="hl-1"> [ </span><span class="hl-7">helperVisible</span><span class="hl-1">, </span><span class="hl-7">toggleHelperVisible</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"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveHelper | 如视 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/react.html">react</a></li><li><a href="react.useFiveHelper.html">useFiveHelper</a></li></ul><h1>Function useFiveHelper</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveHelper" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Helper</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>helperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>toggleHelperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</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="#useFiveHelper" 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 React Hooks: Five 帮助元素的隐藏/显示</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>helperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>toggleHelperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</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>[ helperVisible: Five 帮助元素是否显示显示, toggleHelperVisible: 设置 帮助元素的隐藏/显示 ]</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">helperVisible</span><span class="hl-1">, </span><span class="hl-7">toggleHelperVisible</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
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveHelper.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-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
5
+
6
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveHelper.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>
package/docs/functions/react.useFiveModelIntersectRaycaster.html CHANGED
@@ -1,7 +1,9 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveModelIntersectRaycaster | 如视 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/react.html">react</a></li><li><a href="react.useFiveModelIntersectRaycaster.html">useFiveModelIntersectRaycaster</a></li></ul><h1>Function useFiveModelIntersectRaycaster</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveModelIntersectRaycaster" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Model<wbr/>Intersect<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-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><a href="#useFiveModelIntersectRaycaster" 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 React Hooks: 获取当前模型碰撞检测方法</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useFiveModelIntersectRaycaster.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">raycaster</span>: <span class="tsd-signature-type">Raycaster</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Function</h4><p>fiveModelIntersectRaycaster</p>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveModelIntersectRaycaster | 如视 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/react.html">react</a></li><li><a href="react.useFiveModelIntersectRaycaster.html">useFiveModelIntersectRaycaster</a></li></ul><h1>Function useFiveModelIntersectRaycaster</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveModelIntersectRaycaster" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Model<wbr/>Intersect<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-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><a href="#useFiveModelIntersectRaycaster" 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 React Hooks: 获取当前模型碰撞检测方法</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useFiveModelIntersectRaycaster.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">raycaster</span>: <span class="tsd-signature-type">Raycaster</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul><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>fiveModelIntersectRaycaster</p>
3
3
  <pre><code><span class="hl-4">计算模型射线碰撞检测</span><br/><span class="hl-5">// param raycaster THREE 射线对象</span><br/><span class="hl-5">// param floors 和某一楼层做碰撞检测， 不传为和所有楼层做碰撞检测</span><br/><span class="hl-5">// returns 返回碰撞</span><br/><span class="hl-0">intersectRaycaster</span><span class="hl-1">(</span><span class="hl-4">raycaster</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-4">Raycaster</span><span class="hl-1">, </span><span class="hl-4">floors</span><span class="hl-1">?: </span><span class="hl-4">number</span><span class="hl-1"> | </span><span class="hl-4">number</span><span class="hl-1">[]): </span><span class="hl-4">Intersection</span><span class="hl-1">[]</span>
4
4
  </code><button>Copy</button></pre>
5
- <h4>Example</h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">fiveModelIntersectRaycaster</span><span class="hl-1"> = </span><span class="hl-0">useFiveModelIntersectRaycaster</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">intersects</span><span class="hl-1"> = </span><span class="hl-0">fiveModelIntersectRaycaster</span><span class="hl-1">(</span><span class="hl-4">raycaster</span><span class="hl-1">);</span>
5
+
6
+ <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">fiveModelIntersectRaycaster</span><span class="hl-1"> = </span><span class="hl-0">useFiveModelIntersectRaycaster</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">intersects</span><span class="hl-1"> = </span><span class="hl-0">fiveModelIntersectRaycaster</span><span class="hl-1">(</span><span class="hl-4">raycaster</span><span class="hl-1">);</span>
6
7
  </code><button>Copy</button></pre>
7
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveModelIntersectRaycaster.ts:24</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
8
+
9
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveModelIntersectRaycaster.ts:24</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>
package/docs/functions/react.useFiveModelReadyState.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveModelReadyState | 如视 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/react.html">react</a></li><li><a href="react.useFiveModelReadyState.html">useFiveModelReadyState</a></li></ul><h1>Function useFiveModelReadyState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveModelReadyState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Model<wbr/>Ready<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-type">&quot;Loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Empty&quot;</span><a href="#useFiveModelReadyState" 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 React Hooks: 获取当前模型加载状态</p>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveModelReadyState | 如视 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/react.html">react</a></li><li><a href="react.useFiveModelReadyState.html">useFiveModelReadyState</a></li></ul><h1>Function useFiveModelReadyState</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveModelReadyState" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Model<wbr/>Ready<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-type">&quot;Loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Empty&quot;</span><a href="#useFiveModelReadyState" 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 React Hooks: 获取当前模型加载状态</p>
2
2
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;Loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Empty&quot;</span></h4><p>&quot;Loaded&quot;: 加载完成
3
3
  &quot;Empty&quot; 加载未完成</p>
4
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveModelReadyState.ts:15</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
4
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveModelReadyState.ts:15</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>
package/docs/functions/react.useFiveProject2d.html CHANGED
@@ -1,7 +1,9 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveProject2d | 如视 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/react.html">react</a></li><li><a href="react.useFiveProject2d.html">useFiveProject2d</a></li></ul><h1>Function useFiveProject2d</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveProject2d" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Project2d</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><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">)</span><a href="#useFiveProject2d" 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 React Hooks: 将三维的坐标对应到而为屏幕</p>
2
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useFiveProject2d.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector2</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">vector</span>: <span class="tsd-signature-type">Vector3</span></span></li><li><span><span class="tsd-kind-parameter">testModel</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><h4>Function</h4><p>preject2d</p>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveProject2d | 如视 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/react.html">react</a></li><li><a href="react.useFiveProject2d.html">useFiveProject2d</a></li></ul><h1>Function useFiveProject2d</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveProject2d" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Project2d</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><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, <span class="tsd-kind-parameter">testModel</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">Vector2</span><span class="tsd-signature-symbol">)</span><a href="#useFiveProject2d" 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 React Hooks: 将三维的坐标对应到而为屏幕</p>
2
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, <span class="tsd-kind-parameter">testModel</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">Vector2</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="useFiveProject2d.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector2</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">vector</span>: <span class="tsd-signature-type">Vector3</span></span></li><li><span><span class="tsd-kind-parameter">testModel</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2</span></h4></li></ul></li></ul><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>preject2d</p>
3
3
  <pre><code><span class="hl-4">计算模型射线碰撞检测</span><br/><span class="hl-5">// param vector 三维的坐标</span><br/><span class="hl-5">// param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null</span><br/><span class="hl-5">// returns 三维的坐标 或者 null</span><br/><span class="hl-0">preject2d</span><span class="hl-1">(</span><span class="hl-4">vector</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><span class="hl-1"> ｜ </span><span class="hl-6">null</span>
4
4
  </code><button>Copy</button></pre>
5
- <h4>Example</h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">preject2d</span><span class="hl-1"> = </span><span class="hl-0">useFiveProject2d</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-4">x</span><span class="hl-1">: </span><span class="hl-7">width</span><span class="hl-1">, </span><span class="hl-4">y</span><span class="hl-1">: </span><span class="hl-7">height</span><span class="hl-1"> } = </span><span class="hl-0">preject2d</span><span class="hl-1">(</span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-0">Vector3</span><span class="hl-1">(</span><span class="hl-13">0</span><span class="hl-1">, </span><span class="hl-13">0</span><span class="hl-1">, </span><span class="hl-13">0</span><span class="hl-1">));</span>
5
+
6
+ <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">preject2d</span><span class="hl-1"> = </span><span class="hl-0">useFiveProject2d</span><span class="hl-1">();</span><br/><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-4">x</span><span class="hl-1">: </span><span class="hl-7">width</span><span class="hl-1">, </span><span class="hl-4">y</span><span class="hl-1">: </span><span class="hl-7">height</span><span class="hl-1"> } = </span><span class="hl-0">preject2d</span><span class="hl-1">(</span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-0">Vector3</span><span class="hl-1">(</span><span class="hl-13">0</span><span class="hl-1">, </span><span class="hl-13">0</span><span class="hl-1">, </span><span class="hl-13">0</span><span class="hl-1">));</span>
6
7
  </code><button>Copy</button></pre>
7
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveProject2d.ts:22</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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>
8
+
9
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveProject2d.ts:22</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>
package/docs/functions/react.useFiveScene.html CHANGED
@@ -1,2 +1,7 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveScene | 如视 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/react.html">react</a></li><li><a href="react.useFiveScene.html">useFiveScene</a></li></ul><h1 class="deprecated">Function useFiveScene</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveScene" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Scene</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#useFiveScene" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</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><span class="tsd-signature-symbol">(</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></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="../classes/five.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</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>Deprecated</h4><p>请使用 <code>useFiveSceneEffect</code> 替代</p>
2
- </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveSceneEffect.ts:30</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveScene | 如视 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/react.html">react</a></li><li><a href="react.useFiveScene.html">useFiveScene</a></li></ul><h1 class="deprecated">Function useFiveScene</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" 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>请使用 <code>useFiveSceneEffect</code> 替代</p>
2
+ </div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useFiveScene" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Five<wbr/>Scene</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#useFiveScene" 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 React Hooks: 操作 Five 的 Scene</p>
3
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a><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><span class="tsd-signature-symbol">(</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></span><div class="tsd-comment tsd-typography"><p>获取 Five 的 Scene 的回调函数</p>
4
+ </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="../classes/five.Scene.html" class="tsd-signature-type tsd-kind-class">Scene</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">deps</span>: <span class="tsd-signature-type">DependencyList</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">useFiveSceneEffect</span><span class="hl-1">(</span><span class="hl-4">scene</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">// object is a THREE.Object3D</span><br/><span class="hl-1"> </span><span class="hl-4">scene</span><span class="hl-1">.</span><span class="hl-0">add</span><span class="hl-1">(</span><span class="hl-4">object</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">scene</span><span class="hl-1">.</span><span class="hl-0">remove</span><span class="hl-1">(</span><span class="hl-4">object</span><span class="hl-1">); </span><span class="hl-5">// 析构函数</span><br/><span class="hl-1">});</span>
5
+ </code><button>Copy</button></pre>
6
+
7
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveSceneEffect.ts:30</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>