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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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 +100 -93
  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 +9 -5
  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 +4 -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 +4 -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 +3 -3
  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 +2 -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 +145 -56
  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 +51 -21
  324. package/five/index.js +81 -81
  325. package/five/index.mjs +5731 -5664
  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 +28 -30
  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 +3 -3
  346. package/umd/five.js +52 -52
  347. package/vfx/index.js +2 -2
  348. package/vfx/index.mjs +2 -2
  349. package/vue/index.js +3 -3
  350. package/vue/index.mjs +142 -131
  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/types/five.ControllerEventTypes.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>ControllerEventTypes | 如视 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/five.html">five</a></li><li><a href="five.ControllerEventTypes.html">ControllerEventTypes</a></li></ul><h1>Type alias ControllerEventTypes</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Controller<wbr/>Event<wbr/>Types</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-call-signature">camera.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.momentum</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.mousemove</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.mousewheel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.pan</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.pinch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.press</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.tap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">initAnimation.end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">initAnimation.start</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">intersect.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.arrived</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.cancel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.moveTo</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.moving</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.select</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.abort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.progress</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.success</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">vr.requestExit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.controller.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.buttonDown</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.buttonUp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.press</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.tap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.session.end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">xr.session.start</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">camera.update</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.camera_update.camera_update-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">camera.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.camera_update.camera_update-1" 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>相机改变</p>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ControllerEventTypes | 如视 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/five.html">five</a></li><li><a href="five.ControllerEventTypes.html">ControllerEventTypes</a></li></ul><h1>Type Alias ControllerEventTypes</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Controller<wbr/>Event<wbr/>Types</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-call-signature">camera.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.momentum</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.mousemove</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.mousewheel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.pan</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.pinch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.press</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">gesture.tap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">initAnimation.end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">initAnimation.start</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">intersect.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.IntersectEvent.html" class="tsd-signature-type tsd-kind-interface">IntersectEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.arrived</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.cancel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.moveTo</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.moving</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.select</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.abort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoTextureEvent.html" class="tsd-signature-type tsd-kind-interface">PanoTextureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoTextureEvent.html" class="tsd-signature-type tsd-kind-interface">PanoTextureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoTextureEvent.html" class="tsd-signature-type tsd-kind-interface">PanoTextureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.progress</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoTextureEvent.html" class="tsd-signature-type tsd-kind-interface">PanoTextureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.texture.success</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoTextureEvent.html" class="tsd-signature-type tsd-kind-interface">PanoTextureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">vr.requestExit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.BaseEvent.html" class="tsd-signature-type tsd-kind-interface">BaseEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.controller.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRControllerEvent.html" class="tsd-signature-type tsd-kind-interface">XRControllerEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.buttonDown</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRGestureEvent.html" class="tsd-signature-type tsd-kind-interface">XRGestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.buttonUp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRGestureEvent.html" class="tsd-signature-type tsd-kind-interface">XRGestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.press</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRGestureEvent.html" class="tsd-signature-type tsd-kind-interface">XRGestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.gesture.tap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRGestureEvent.html" class="tsd-signature-type tsd-kind-interface">XRGestureEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.session.end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRSessionEvent.html" class="tsd-signature-type tsd-kind-interface">XRSessionEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">xr.session.start</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.XRSessionEvent.html" class="tsd-signature-type tsd-kind-interface">XRSessionEvent</a><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><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">camera.update</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.camera_update.camera_update-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">camera.update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.camera_update.camera_update-1" 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>相机改变</p>
2
2
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:33</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">error</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.error.error-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.error.error-1" 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>抛出错误</p>
3
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">error</span>: <span class="tsd-signature-type">Error</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:98</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">gesture.momentum</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.gesture_momentum.gesture_momentum-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">gesture.momentum</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.gesture_momentum.gesture_momentum-1" 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>手势 惯性</p>
4
4
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.GestureEvent.html" class="tsd-signature-type tsd-kind-interface">GestureEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:24</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">gesture.mousemove</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.gesture_mousemove.gesture_mousemove-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">gesture.mousemove</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.gesture_mousemove.gesture_mousemove-1" 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>手势 鼠标移动</p>
@@ -29,4 +29,4 @@
29
29
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.XRGestureEvent.html" class="tsd-signature-type tsd-kind-interface">XRGestureEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:86</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">xr.gesture.tap</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.xr_gesture_tap.xr_gesture_tap-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">xr.gesture.tap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.xr_gesture_tap.xr_gesture_tap-1" 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>XR 手势（按钮）</p>
30
30
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.XRGestureEvent.html" class="tsd-signature-type tsd-kind-interface">XRGestureEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:83</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">xr.session.end</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.xr_session_end.xr_session_end-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">xr.session.end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.xr_session_end.xr_session_end-1" 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>XR 退出</p>
31
31
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.XRSessionEvent.html" class="tsd-signature-type tsd-kind-interface">XRSessionEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:77</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">xr.session.start</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="__type.xr_session_start.xr_session_start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">xr.session.start</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#__type.xr_session_start.xr_session_start-1" 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>XR 进入</p>
32
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.XRSessionEvent.html" class="tsd-signature-type tsd-kind-interface">XRSessionEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:80</li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:3</li></ul></aside></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>
32
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.XRSessionEvent.html" class="tsd-signature-type tsd-kind-interface">XRSessionEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:80</li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in lib/five/controllers/events.ts:3</li></ul></aside></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/types/five.EventTypes.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>EventTypes | 如视 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/five.html">five</a></li><li><a href="five.EventTypes.html">EventTypes</a></li></ul><h1>Type alias EventTypes</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Event<wbr/>Types</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="five.ControllerEventTypes.html" class="tsd-signature-type tsd-kind-type-alias">ControllerEventTypes</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/five.PROXY_CONTROLLER_EVENT_NAMES.html" class="tsd-signature-type tsd-kind-variable">PROXY_CONTROLLER_EVENT_NAMES</a><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-symbol"> &amp; </span><a href="five.LegacyEventType.html" class="tsd-signature-type tsd-kind-type-alias">LegacyEventType</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-call-signature">currentState.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">dispose</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><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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><br/><span>    </span><span class="tsd-kind-call-signature">fps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fps</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><br/><span>    </span><span class="tsd-kind-call-signature">helpers.visible</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">mode.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">mode.change.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">model.changeShownFloor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">model.error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">model.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">model.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">models.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">models.refined</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">network.resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">pano.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">render.prepare</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">state.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">state.set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">state.synced</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">works.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">works.ready</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span>    </span><span class="tsd-kind-call-signature">works.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Five 事件列表</p>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EventTypes | 如视 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/five.html">five</a></li><li><a href="five.EventTypes.html">EventTypes</a></li></ul><h1>Type Alias EventTypes</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Event<wbr/>Types</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="five.ControllerEventTypes.html" class="tsd-signature-type tsd-kind-type-alias">ControllerEventTypes</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-keyword">typeof </span><a href="../variables/five.PROXY_CONTROLLER_EVENT_NAMES.html" class="tsd-signature-type tsd-kind-variable">PROXY_CONTROLLER_EVENT_NAMES</a><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-symbol"> &amp; </span><a href="five.LegacyEventType.html" class="tsd-signature-type tsd-kind-type-alias">LegacyEventType</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-call-signature">currentState.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">dispose</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><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</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><br/><span>    </span><span class="tsd-kind-call-signature">fps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fps</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">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-call-signature">helpers.visible</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ObjectEvent.html" class="tsd-signature-type tsd-kind-interface">ObjectEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">mode.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModeChangeEvent.html" class="tsd-signature-type tsd-kind-interface">ModeChangeEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">mode.change.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModeChangeEvent.html" class="tsd-signature-type tsd-kind-interface">ModeChangeEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">model.changeShownFloor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModelEvent.html" class="tsd-signature-type tsd-kind-interface">ModelEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">model.error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModelEvent.html" class="tsd-signature-type tsd-kind-interface">ModelEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">model.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModelEvent.html" class="tsd-signature-type tsd-kind-interface">ModelEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">model.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModelEvent.html" class="tsd-signature-type tsd-kind-interface">ModelEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">models.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModelsEvent.html" class="tsd-signature-type tsd-kind-interface">ModelsEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">models.refined</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.ModelsEvent.html" class="tsd-signature-type tsd-kind-interface">ModelsEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">network.resource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.NetworkResourceEvent.html" class="tsd-signature-type tsd-kind-interface">NetworkResourceEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">pano.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.PanoEvent.html" class="tsd-signature-type tsd-kind-interface">PanoEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">render</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.RenderEvent.html" class="tsd-signature-type tsd-kind-interface">RenderEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">render.prepare</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.RenderEvent.html" class="tsd-signature-type tsd-kind-interface">RenderEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">state.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">state.set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">state.synced</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">works.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">works.ready</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a><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><br/><span>    </span><span class="tsd-kind-call-signature">works.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a><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><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Five 事件列表</p>
2
2
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">current<wbr/>State.change</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a class="tsd-anchor"></a><span class="tsd-kind-call-signature">current<wbr/>State.change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>当前 state 变化</p>
3
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">event</span>: <a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:75</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">dispose</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a class="tsd-anchor"></a><span class="tsd-kind-call-signature">dispose</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></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>five 被析构。 插件中请监听用于自身析构</p>
4
4
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:117</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">error</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a class="tsd-anchor"></a><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>内部错误</p>
@@ -22,5 +22,5 @@
22
22
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.StateEvent.html" class="tsd-signature-type tsd-kind-interface">StateEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:72</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">works.load</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a class="tsd-anchor"></a><span class="tsd-kind-call-signature">works.load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>加载 work</p>
23
23
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:60</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">works.ready</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a class="tsd-anchor"></a><span class="tsd-kind-call-signature">works.ready</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>加载 work 并 controller ready</p>
24
24
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:63</li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">works.request</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a class="tsd-anchor"></a><span class="tsd-kind-call-signature">works.request</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>请求 work数据</p>
25
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:57</li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4>Description</h4><p>具体事件列表 请查看 <a href="../interfaces/five.EventCallback.html" class="tsd-kind-interface">EventCallback</a></p>
26
- </div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:48</li></ul></aside></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>
25
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/five.WorksEvent.html" class="tsd-signature-type tsd-kind-interface">WorksEvent</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:57</li></ul></aside></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description" class="tsd-anchor"></a>Description<a href="#Description" 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>具体事件列表 请查看 <a href="../interfaces/five.EventCallback.html" class="tsd-kind-interface">EventCallback</a></p>
26
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/five/application/events.ts:48</li></ul></aside></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/types/five.FivePlugin.html CHANGED
@@ -1,71 +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>FivePlugin | 如视 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/five.html">five</a></li><li><a href="five.FivePlugin.html">FivePlugin</a></li></ul><h1>Type alias FivePlugin&lt;Parameters, Returns&gt;</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Five<wbr/>Plugin</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Parameters">Parameters</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Returns">Returns</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Parameters">Parameters</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">void</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">five</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Returns">Returns</a><span class="tsd-signature-symbol">)</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">five</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Returns">Returns</a><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Five 插件</p>
2
- <a id="md:插件-plugins" class="tsd-anchor"></a><h1><a href="#md:插件-plugins">插件 Plugins</a></h1><blockquote>
3
- <p>Five 提供了工厂模式的插件机制,
4
- 提供了 FivePlugin FivePluginInstance FivePluginInits 接口来帮助创建和使用插件</p>
5
- </blockquote>
6
- <a id="md:插件的作用" class="tsd-anchor"></a><h2><a href="#md:插件的作用">插件的作用</a></h2><ol>
7
- <li>插件即是将一些通用的对于 five 的操作的一些复用的抽象。</li>
8
- <li>可以通过插件来组织代码，减少逻辑依赖。</li>
9
- </ol>
10
- <a id="md:创建插件" class="tsd-anchor"></a><h2><a href="#md:创建插件">创建插件</a></h2><pre><code><span class="hl-4">mkdir</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1">-</span><span class="hl-4">five</span><span class="hl-1">-</span><span class="hl-4">plugin</span><br/><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-4">init</span><span class="hl-1"> -</span><span class="hl-4">y</span><br/><span class="hl-4">npm</span><span class="hl-1"> </span><span class="hl-4">install</span><span class="hl-1"> @</span><span class="hl-4">realsee</span><span class="hl-1">/</span><span class="hl-4">five</span><br/><span class="hl-4">npx</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1">-</span><span class="hl-4">plugin</span><span class="hl-1">-</span><span class="hl-4">init</span>
11
- </code><button>Copy</button></pre>
12
- <a id="md:项目目录" class="tsd-anchor"></a><h2><a href="#md:项目目录">项目目录</a></h2><pre><code><span class="hl-1">.</span><br/><span class="hl-1">├── </span><span class="hl-7">README</span><span class="hl-1">.</span><span class="hl-4">md</span><br/><span class="hl-1">├── </span><span class="hl-4">devtools</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">external</span><span class="hl-1">-</span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-4">js</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">external</span><span class="hl-1">-</span><span class="hl-4">three</span><span class="hl-1">.</span><span class="hl-4">js</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">tsconfig</span><span class="hl-1">.</span><span class="hl-4">build</span><span class="hl-1">.</span><span class="hl-4">json</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">webpack</span><span class="hl-1">.</span><span class="hl-4">bundle</span><span class="hl-1">.</span><span class="hl-4">js</span><br/><span class="hl-1">│ └── </span><span class="hl-4">webpack</span><span class="hl-1">.</span><span class="hl-4">example</span><span class="hl-1">.</span><span class="hl-4">js</span><br/><span class="hl-1">├── </span><span class="hl-4">docs</span><br/><span class="hl-1">├── </span><span class="hl-4">examples</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">data</span><span class="hl-1">.</span><span class="hl-4">json</span><br/><span class="hl-1">│ ├── </span><span class="hl-4">index</span><span class="hl-1">.</span><span class="hl-4">html</span><br/><span class="hl-1">│ └── </span><span class="hl-4">index</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">├── </span><span class="hl-4">lib</span><br/><span class="hl-1">│ └── </span><span class="hl-4">index</span><span class="hl-1">.</span><span class="hl-4">ts</span><br/><span class="hl-1">├── </span><span class="hl-4">package</span><span class="hl-1">.</span><span class="hl-4">json</span><br/><span class="hl-1">└── </span><span class="hl-4">tsconfig</span><span class="hl-1">.</span><span class="hl-4">json</span>
13
- </code><button>Copy</button></pre>
14
- <a id="md:npm-script" class="tsd-anchor"></a><h2><a href="#md:npm-script">npm script</a></h2><ul>
15
- <li><code>example</code>： 开发环境，编译 example 下的 index.ts, 监听变化，并且开启端口监听，可以通过 <code>localhost:8080</code> 访问</li>
16
- <li><code>build:doc</code>: 通过 typedoc 生成项目文档，生成目标在 <code>docs</code> 目录下</li>
17
- <li><code>build:typescript</code>: 通过 <code>tsc</code> 编译 ts 代码，生成目标在 <code>build</code> 目录下</li>
18
- <li><code>build:bundle</code>: 通过 <code>webpack</code> 编译 unpack 包， 生成目标在 <code>bundle</code> 目录下</li>
19
- <li><code>build:all</code>: <code>npm run build:doc &amp;&amp; npm run build:typescript &amp;&amp; &amp;&amp; npm run build:example &amp;&amp; npm run build:bundle</code></li>
20
- </ul>
21
- <a id="md:编译配置" class="tsd-anchor"></a><h2><a href="#md:编译配置">编译配置</a></h2><p>编译配置均在 devtools 目录下， 可以自行修改配置</p>
22
- <ul>
23
- <li>ts 的编译参数在 <code>devtools/tsconfig.build.json</code> 下</li>
24
- <li>bundle 的 webpack 配置在 <code>devtools/webpack.bundle.js</code> 下</li>
25
- </ul>
26
- <a id="md:发布" class="tsd-anchor"></a><h2><a href="#md:发布">发布</a></h2><ul>
27
- <li>往 npm 发布，默认发布的入口文件在 <code>build/index.js</code>, 即通过 tsc 编译得到的代码。你可以在 <code>package.json</code> 中修改。</li>
28
- <li>bundle 包发布，可以直接使用 <code>build:bundle</code> 生成的结果。</li>
29
- </ul>
30
- <a id="md:类型说明" class="tsd-anchor"></a><h3><a href="#md:类型说明">类型说明</a></h3><pre><code class="language-typescript"><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">FivePlugin</span><span class="hl-1">&lt;</span><span class="hl-8">Parameters</span><span class="hl-1">, </span><span class="hl-8">Returns</span><span class="hl-1">&gt;;</span>
31
- </code><button>Copy</button></pre>
32
- <ul>
33
- <li>Parameters 插件定义的参数</li>
34
- <li>Returns 插件返回的实例</li>
35
- </ul>
36
- <a id="md:简单例子" class="tsd-anchor"></a><h3><a href="#md:简单例子">简单例子</a></h3><blockquote>
37
- <p>这是一个在当five显示界面被点击时 打印 &quot;tap!&quot; 的一个简单插件, 并且可以拉取历史列表</p>
38
- </blockquote>
39
- <pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FivePlugin</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 打印的内容</span><br/><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">TapRecordPluginParameter</span><span class="hl-1"> = </span><span class="hl-8">string</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 实例方法</span><br/><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">TapRecordPluginReturns</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">// 一个返回历史列表的防范</span><br/><span class="hl-1"> </span><span class="hl-0">getHistory</span><span class="hl-1">: () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-8">string</span><span class="hl-1">[]</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">TapRecordPlugin</span><span class="hl-1">: </span><span class="hl-8">FivePlugin</span><span class="hl-1">&lt;</span><br/><span class="hl-1"> </span><span class="hl-8">TapRecordPluginParameter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">TapRecordPluginReturns</span><br/><span class="hl-1">&gt; = (</span><span class="hl-4">five</span><span class="hl-1">, </span><span class="hl-4">message</span><span class="hl-1"> = </span><span class="hl-2">&quot;tap!&quot;</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">list</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">[] = [];</span><br/><br/><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">&quot;tapGesture&quot;</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-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">message</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">list</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-2">`</span><span class="hl-6">${</span><span class="hl-6">new</span><span class="hl-11"> </span><span class="hl-0">Date</span><span class="hl-11">().</span><span class="hl-0">toUTCString</span><span class="hl-11">()</span><span class="hl-6">}</span><span class="hl-2"> </span><span class="hl-6">${</span><span class="hl-4">message</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> { </span><span class="hl-0">getHistory</span><span class="hl-4">:</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">list</span><span class="hl-1">.</span><span class="hl-0">slice</span><span class="hl-1">() };</span><br/><span class="hl-1">};</span><br/>
40
- </code><button>Copy</button></pre>
41
- <ul>
42
- <li>工厂函数的参数是 five 实例 以及对应的插件需要的参数, 参数使用后面在插件初始化中详细说明。</li>
43
- <li>工厂函数的返回将在 five.plugis 中取到，后面会详细说明。</li>
44
- </ul>
45
- <a id="md:插件初始化" class="tsd-anchor"></a><h3><a href="#md:插件初始化">插件初始化</a></h3><a id="md:类型说明-1" class="tsd-anchor"></a><h3><a href="#md:类型说明-1">类型说明</a></h3><pre><code><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">FivePluginInit</span><span class="hl-1">&lt;</span><span class="hl-8">FivePlugin</span><span class="hl-1">&gt;</span>
46
- </code><button>Copy</button></pre>
47
- <a id="md:简单例子-1" class="tsd-anchor"></a><h3><a href="#md:简单例子-1">简单例子</a></h3><blockquote>
48
- <p>就上面 TapRecordPlugin 的例子来初始化插件</p>
49
- </blockquote>
50
- <pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-4">Five</span><span class="hl-1">, { </span><span class="hl-4">FivePluginInits</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">five</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Five</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">plugins:</span><span class="hl-1"> [</span><br/><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-5">// 插件</span><br/><span class="hl-1"> </span><span class="hl-4">TapRecordPlugin</span><span class="hl-1">,</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 插件对象在 five.plugins 中的命名实例名称，</span><br/><span class="hl-1"> </span><span class="hl-5">// 比如这个就是通过 five.plguins.tapRecord 获取到插件实例</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;tapRecord&quot;</span><span class="hl-1">,</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 插件参数，必须符合 TapRecordPluginParameter 的生命</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;tap!&quot;</span><br/><span class="hl-1"> ] </span><span class="hl-3">as</span><span class="hl-1"> </span><span class="hl-8">FivePluginInit</span><span class="hl-1">&lt;</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-4">TapRecordPlugin</span><span class="hl-1">&gt;</span><br/><span class="hl-1"> ]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// five.load(...)</span><br/>
51
- </code><button>Copy</button></pre>
52
- <ul>
53
- <li>需要使用 <code>as FivePluginInit</code> 的方法声明，否则无法约束参数</li>
54
- <li>第一个参数必须唯一的，不要出现插件间冲突</li>
55
- </ul>
56
- <a id="md:使用插件实例" class="tsd-anchor"></a><h2><a href="#md:使用插件实例">使用插件实例</a></h2><pre><code><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">FivePluginInstance</span><span class="hl-1">&lt;</span><span class="hl-8">FivePlugin</span><span class="hl-1">&gt;;</span>
57
- </code><button>Copy</button></pre>
58
- <p>简单例子
59
- 就上面 TapRecordPlugin 的例子来获取历时点击列表</p>
60
- <pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FivePluginInstance</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// five.plugins.tapRecord 可以获取到插件实例 &quot;tapRecord&quot; 是插件初始化声明确定的</span><br/><span class="hl-5">// 通过 FivePluginInstance 在约束类型，否则均为 any</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">tapRecord</span><span class="hl-1">: </span><span class="hl-8">FivePluginInstance</span><span class="hl-1">&lt;</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-4">TapRecordPlugin</span><span class="hl-1">&gt; = </span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-4">plugins</span><span class="hl-1">.</span><span class="hl-4">tapRecord</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 现在就可以获取到历时列表了</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">getHistory</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">[] = </span><span class="hl-4">tapRecord</span><span class="hl-1">.</span><span class="hl-0">getHistory</span><span class="hl-1">();</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">getHistory</span><span class="hl-1">);</span>
61
- </code><button>Copy</button></pre>
62
- <a id="md:回顾整体的例子" class="tsd-anchor"></a><h3><a href="#md:回顾整体的例子">回顾整体的例子</a></h3><pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-4">Five</span><span class="hl-1">, { </span><span class="hl-4">FivePlugin</span><span class="hl-1">, </span><span class="hl-4">FivePluginInit</span><span class="hl-1">, </span><span class="hl-4">FivePluginInstance</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 打印的内容</span><br/><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">TapRecordPluginParameter</span><span class="hl-1"> = </span><span class="hl-8">string</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 实例方法</span><br/><span class="hl-6">type</span><span class="hl-1"> </span><span class="hl-8">TapRecordPluginReturns</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">// 一个返回历史列表的防范</span><br/><span class="hl-1"> </span><span class="hl-0">getHistory</span><span class="hl-1">: () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-8">string</span><span class="hl-1">[]</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">TapRecordPlugin</span><span class="hl-1">: </span><span class="hl-8">FivePlugin</span><span class="hl-1">&lt;</span><br/><span class="hl-1"> </span><span class="hl-8">TapRecordPluginParameter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">TapRecordPluginReturns</span><br/><span class="hl-1">&gt; = (</span><span class="hl-4">five</span><span class="hl-1">, </span><span class="hl-4">message</span><span class="hl-1"> = </span><span class="hl-2">&quot;tap!&quot;</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">list</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">[] = [];</span><br/><br/><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">&quot;tapGesture&quot;</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-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">message</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-4">list</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><span class="hl-2">`</span><span class="hl-6">${</span><span class="hl-6">new</span><span class="hl-11"> </span><span class="hl-0">Date</span><span class="hl-11">().</span><span class="hl-0">toUTCString</span><span class="hl-11">()</span><span class="hl-6">}</span><span class="hl-2"> </span><span class="hl-6">${</span><span class="hl-4">message</span><span class="hl-6">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> { </span><span class="hl-0">getHistory</span><span class="hl-4">:</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">list</span><span class="hl-1">.</span><span class="hl-0">slice</span><span class="hl-1">() };</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">five</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Five</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">plugins:</span><span class="hl-1"> [</span><br/><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-5">// 插件对象在 five.plugins 中的命名实例名称，</span><br/><span class="hl-1"> </span><span class="hl-5">// 比如这个就是通过 five.plguins.tapRecord 获取到插件实例</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;tapRecord&quot;</span><span class="hl-1">,</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 插件</span><br/><span class="hl-1"> </span><span class="hl-4">TapRecordPlugin</span><span class="hl-1">,</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 插件参数，必须符合 TapRecordPluginParameter 的生命</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;tap!&quot;</span><br/><span class="hl-1"> ] </span><span class="hl-3">as</span><span class="hl-1"> </span><span class="hl-8">FivePluginInit</span><span class="hl-1">&lt;</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-4">TapRecordPlugin</span><span class="hl-1">&gt;</span><br/><span class="hl-1"> ]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// five.load(...)</span><br/><br/><span class="hl-5">// five.plugins.tapRecord 可以获取到插件实例 &quot;tapRecord&quot; 是插件初始化声明确定的</span><br/><span class="hl-5">// 通过 FivePluginInstance 在约束类型，否则均为 any</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">tapRecord</span><span class="hl-1">: </span><span class="hl-8">FivePluginInstance</span><span class="hl-1">&lt;</span><span class="hl-6">typeof</span><span class="hl-1"> </span><span class="hl-4">TapRecordPlugin</span><span class="hl-1">&gt; = </span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-4">plugins</span><span class="hl-1">.</span><span class="hl-4">tapRecord</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 现在就可以获取到历时列表了</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">getHistory</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">[] = </span><span class="hl-4">tapRecord</span><span class="hl-1">.</span><span class="hl-0">getHistory</span><span class="hl-1">();</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">getHistory</span><span class="hl-1">);</span>
63
- </code><button>Copy</button></pre>
64
- <a id="md:其他注意的问题" class="tsd-anchor"></a><h2><a href="#md:其他注意的问题">其他注意的问题</a></h2><ol>
65
- <li>插件初始化的时机在 <code>new Five</code> 时，Five 并没有调用 <code>load</code> 来创建VR，请通过监听事件的方式，在合适的时机获取模型。</li>
66
- <li>如果插件内容需要有 five 销毁同时销毁的内容，请监听 <code>five.on(&quot;dispose&quot;)</code> 事件来处理。</li>
67
- <li>不要出现初始化插件同名的现象，会出现插件间冲突。</li>
68
- </ol>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FivePlugin | 如视 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/five.html">five</a></li><li><a href="five.FivePlugin.html">FivePlugin</a></li></ul><h1>Type Alias FivePlugin&lt;Parameters, Returns&gt;</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Five<wbr/>Plugin</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Parameters">Parameters</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Returns">Returns</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Parameters">Parameters</a><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">void</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">five</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Returns">Returns</a><span class="tsd-signature-symbol">)</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">five</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Parameters">Parameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePlugin.html#Returns">Returns</a><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Five 插件</p>
69
2
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="Parameters" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Parameters</span> = <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>插件参数, 没有参数则为 void</p>
70
3
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="Returns" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">Returns</span> = <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>如果有参数则插件暴露的 api，没有参数则不传</p>
71
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/plugin.ts:9</li></ul></aside></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><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:插件-plugins"><span>插件 <wbr/>Plugins</span></a><ul><li><a href="#md:插件的作用"><span>插件的作用</span></a></li><li><a href="#md:创建插件"><span>创建插件</span></a></li><li><a href="#md:项目目录"><span>项目目录</span></a></li><li><a href="#md:npm-script"><span>npm script</span></a></li><li><a href="#md:编译配置"><span>编译配置</span></a></li><li><a href="#md:发布"><span>发布</span></a></li><li><ul><li><a href="#md:类型说明"><span>类型说明</span></a></li><li><a href="#md:简单例子"><span>简单例子</span></a></li><li><a href="#md:插件初始化"><span>插件初始化</span></a></li><li><a href="#md:类型说明-1"><span>类型说明</span></a></li><li><a href="#md:简单例子-1"><span>简单例子</span></a></li></ul></li><li><a href="#md:使用插件实例"><span>使用插件实例</span></a></li><li><ul><li><a href="#md:回顾整体的例子"><span>回顾整体的例子</span></a></li></ul></li><li><a href="#md:其他注意的问题"><span>其他注意的问题</span></a></li></ul></div></details></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><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/plugin.ts:9</li></ul></aside></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/types/five.FivePluginInit.html CHANGED
@@ -1,3 +1,3 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FivePluginInit | 如视 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/five.html">five</a></li><li><a href="five.FivePluginInit.html">FivePluginInit</a></li></ul><h1>Type alias FivePluginInit&lt;T&gt;</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Five<wbr/>Plugin<wbr/>Init</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">[</span>Plugin<span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">, </span>instanceName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>Plugin<span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">, </span>instanceName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span></div><div class="tsd-comment tsd-typography"><p>获取插件在Five中的初始化结构</p>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FivePluginInit | 如视 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/five.html">five</a></li><li><a href="five.FivePluginInit.html">FivePluginInit</a></li></ul><h1>Type Alias FivePluginInit&lt;T&gt;</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Five<wbr/>Plugin<wbr/>Init</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">undefined</span><br/><span>    </span><span class="tsd-signature-symbol">? </span><span class="tsd-signature-symbol">[</span>Plugin<span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">, </span>instanceName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><br/><span>    </span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>Plugin<span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">, </span>instanceName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="five.FivePluginInit.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">]</span></div><div class="tsd-comment tsd-typography"><p>获取插件在Five中的初始化结构</p>
2
2
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="five.FivePlugin.html" class="tsd-signature-type tsd-kind-type-alias">FivePlugin</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Five 插件</p>
3
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/plugin.ts:24</li></ul></aside></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>
3
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/plugin.ts:24</li></ul></aside></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>