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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (531) hide show
  1. package/docs/assets/hierarchy.js +1 -0
  2. package/docs/assets/icons.js +1 -1
  3. package/docs/assets/icons.svg +1 -1
  4. package/docs/assets/main.js +5 -5
  5. package/docs/assets/navigation.js +1 -1
  6. package/docs/assets/search.js +1 -1
  7. package/docs/assets/style.css +1440 -1255
  8. package/docs/classes/five.AnimationFrameLoop.html +16 -16
  9. package/docs/classes/five.Camera.html +41 -41
  10. package/docs/classes/five.Fetcher.html +5 -5
  11. package/docs/classes/five.Five.html +211 -211
  12. package/docs/classes/five.InternalWebGLRenderer.html +2 -2
  13. package/docs/classes/five.Model.html +72 -72
  14. package/docs/classes/five.ModelScene.html +34 -34
  15. package/docs/classes/five.Motion.html +17 -17
  16. package/docs/classes/five.NetworkSubscribe.html +35 -35
  17. package/docs/classes/five.PBMContainer.html +17 -17
  18. package/docs/classes/five.PBMCustomShader.html +11 -11
  19. package/docs/classes/five.PBMGroup.html +4 -4
  20. package/docs/classes/five.PBMMesh.html +2 -2
  21. package/docs/classes/five.PBMMeshMaterial.html +84 -84
  22. package/docs/classes/five.PBMPointCloud.html +3 -3
  23. package/docs/classes/five.PBMPointCloudMaterial.html +40 -40
  24. package/docs/classes/five.PBMSkinnedMesh.html +4 -4
  25. package/docs/classes/five.PanoCircleMesh.html +20 -20
  26. package/docs/classes/five.PanoCircleMeshCustom.html +20 -20
  27. package/docs/classes/five.PanoCircleMeshSolid.html +20 -20
  28. package/docs/classes/five.Parameter.html +114 -114
  29. package/docs/classes/five.Scene.html +9 -9
  30. package/docs/classes/five.Subscribe.html +37 -37
  31. package/docs/classes/five.TextureLoader.html +4 -4
  32. package/docs/classes/five.Tile.html +34 -34
  33. package/docs/classes/five.Tile3DModel.html +91 -91
  34. package/docs/classes/five.TileCache.html +8 -8
  35. package/docs/classes/five.TileNode.html +9 -9
  36. package/docs/classes/five.TileRequestScheduler.html +4 -4
  37. package/docs/classes/five.Tileset.html +37 -37
  38. package/docs/classes/five.Trajectory.html +8 -8
  39. package/docs/classes/five.TrajectoryNode.html +7 -7
  40. package/docs/classes/five.Work.html +42 -42
  41. package/docs/classes/five.WorkResolvedObserver.html +40 -40
  42. package/docs/classes/five.XRButton.html +3 -3
  43. package/docs/classes/gltf-loader.DDSLoader.html +3 -0
  44. package/docs/classes/gltf-loader.DRACOLoader.html +8 -0
  45. package/docs/classes/gltf-loader.GLTFLoader.html +19 -0
  46. package/docs/classes/gltf-loader.GLTFObject.html +9 -0
  47. package/docs/classes/gltf-loader.GLTFParser.html +6 -0
  48. package/docs/classes/gltf-loader.THREEGLTFLoader.html +8 -0
  49. package/docs/classes/line.Line.html +10 -10
  50. package/docs/classes/line.LineGeometry.html +17 -17
  51. package/docs/classes/line.LineMaterial.html +8 -8
  52. package/docs/classes/line.LineSegmentsGeometry.html +15 -15
  53. package/docs/classes/line.THREE_Line2.html +4 -4
  54. package/docs/classes/line.THREE_LineSegments2.html +4 -4
  55. package/docs/classes/plugins.BasePlugin.Controller.html +39 -0
  56. package/docs/classes/plugins.CSS3DRenderer.html +6 -0
  57. package/docs/classes/plugins.OrbitControls.html +41 -0
  58. package/docs/classes/plugins.RoundedBoxGeometry.html +3 -0
  59. package/docs/classes/react.Store.html +20 -20
  60. package/docs/classes/sticker.Sticker.html +17 -17
  61. package/docs/classes/vfx.Airflow.html +8 -8
  62. package/docs/classes/vfx.Flame.html +10 -10
  63. package/docs/classes/vfx.Particle.html +78 -78
  64. package/docs/classes/vfx.SpotLight.html +7 -7
  65. package/docs/documents/coordinate.html +4 -4
  66. package/docs/documents/five.FivePlugin.plugins.html +15 -15
  67. package/docs/documents/five.Pose.coordinate.html +4 -4
  68. package/docs/documents/plugins.html +15 -15
  69. package/docs/documents/react-component.html +32 -0
  70. package/docs/enums/five.VolumePlaneIntersect.html +4 -4
  71. package/docs/enums/plugins.BackgroundPluginType.WarningCodeType.html +2 -0
  72. package/docs/functions/five.coordinatesToVector.html +2 -0
  73. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  74. package/docs/functions/five.createWorks.html +1 -1
  75. package/docs/functions/five.defaultImageURLTransform.html +2 -2
  76. package/docs/functions/five.getViewportScale.html +1 -1
  77. package/docs/functions/five.headingToLongitude.html +4 -0
  78. package/docs/functions/five.imageSupport.html +1 -1
  79. package/docs/functions/five.isBoundingVolume.html +1 -1
  80. package/docs/functions/five.isPanoId.html +1 -1
  81. package/docs/functions/five.loadAt3d.html +1 -1
  82. package/docs/functions/five.loadB3dm.html +1 -1
  83. package/docs/functions/five.loadDome.html +1 -1
  84. package/docs/functions/five.loadDomez.html +1 -1
  85. package/docs/functions/five.loadFbx.html +1 -1
  86. package/docs/functions/five.loadGltf.html +1 -1
  87. package/docs/functions/five.loadPbm.html +1 -1
  88. package/docs/functions/five.loadPly.html +1 -1
  89. package/docs/functions/five.loadPnts.html +1 -1
  90. package/docs/functions/five.loadX3p.html +1 -1
  91. package/docs/functions/five.longitudeToHeading.html +4 -0
  92. package/docs/functions/five.makeBoundingVolume.html +1 -1
  93. package/docs/functions/five.panoEqual.html +1 -1
  94. package/docs/functions/five.panoParse.html +1 -1
  95. package/docs/functions/five.panoStringify.html +1 -1
  96. package/docs/functions/five.parseWork.html +2 -2
  97. package/docs/functions/five.vectorToCoordinates.html +2 -0
  98. package/docs/functions/five.workToJson.html +1 -1
  99. package/docs/functions/plugins.BackgroundPlugin.html +1 -0
  100. package/docs/functions/plugins.ItemMaskPlugin.html +1 -0
  101. package/docs/functions/plugins.OrientationPlugin.html +1 -0
  102. package/docs/functions/plugins.PanoAnimePlugin.html +1 -0
  103. package/docs/functions/plugins.TrajectoryPlugin.html +1 -0
  104. package/docs/functions/react.createFiveFeature.html +1 -1
  105. package/docs/functions/react.createFiveProvider.html +5 -5
  106. package/docs/functions/react.createStore.html +12 -12
  107. package/docs/functions/react.unsafe__useFiveInstance.html +4 -4
  108. package/docs/functions/react.useFiveAction.html +8 -8
  109. package/docs/functions/react.useFiveCameraDirection.html +3 -3
  110. package/docs/functions/react.useFiveCameraRaycaster.html +3 -3
  111. package/docs/functions/react.useFiveCurrentObserver.html +4 -4
  112. package/docs/functions/react.useFiveCurrentState.html +4 -4
  113. package/docs/functions/react.useFiveEventCallback.html +3 -3
  114. package/docs/functions/react.useFiveFloor.html +4 -4
  115. package/docs/functions/react.useFiveHelper.html +4 -4
  116. package/docs/functions/react.useFiveModelIntersectRaycaster.html +4 -4
  117. package/docs/functions/react.useFiveModelReadyState.html +3 -3
  118. package/docs/functions/react.useFiveProject2d.html +4 -4
  119. package/docs/functions/react.useFiveSceneEffect.html +4 -4
  120. package/docs/functions/react.useFiveState.html +1 -1
  121. package/docs/functions/react.useFiveWork.html +5 -5
  122. package/docs/functions/react.withFive.html +1 -1
  123. package/docs/functions/vue.unsafe__useFiveInject.html +4 -4
  124. package/docs/functions/vue.useFiveAction.html +10 -10
  125. package/docs/functions/vue.useFiveCameraDirection.html +3 -3
  126. package/docs/functions/vue.useFiveCameraRaycaster.html +3 -3
  127. package/docs/functions/vue.useFiveCurrentObserver.html +4 -4
  128. package/docs/functions/vue.useFiveCurrentState.html +4 -4
  129. package/docs/functions/vue.useFiveEventCallback.html +3 -3
  130. package/docs/functions/vue.useFiveFloor.html +4 -4
  131. package/docs/functions/vue.useFiveHelper.html +4 -4
  132. package/docs/functions/vue.useFiveModel.html +2 -2
  133. package/docs/functions/vue.useFiveModelBounding.html +2 -2
  134. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +4 -4
  135. package/docs/functions/vue.useFiveModelReadyState.html +3 -3
  136. package/docs/functions/vue.useFiveProject2d.html +4 -4
  137. package/docs/functions/vue.useFiveScene.html +2 -2
  138. package/docs/functions/vue.useFiveState.html +4 -4
  139. package/docs/functions/vue.useFiveWorks.html +5 -5
  140. package/docs/hierarchy.html +1 -1
  141. package/docs/index.html +17 -17
  142. package/docs/interfaces/five.AddableObject.html +9 -9
  143. package/docs/interfaces/five.AjaxOptions.html +9 -9
  144. package/docs/interfaces/five.AnimationFrame.html +5 -5
  145. package/docs/interfaces/five.AnimationFrameContext.html +3 -3
  146. package/docs/interfaces/five.BaseEvent.html +5 -5
  147. package/docs/interfaces/five.BoundingVolume.html +15 -15
  148. package/docs/interfaces/five.BoxBoundingVolume.html +18 -0
  149. package/docs/interfaces/five.CameraPose.html +6 -6
  150. package/docs/interfaces/five.CullingVolume.html +9 -0
  151. package/docs/interfaces/five.Draco.html +12 -0
  152. package/docs/interfaces/five.EventCallback.html +255 -255
  153. package/docs/interfaces/five.FiveInitArgs.html +85 -85
  154. package/docs/interfaces/five.FiveLoadOptions.html +13 -13
  155. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +17 -17
  156. package/docs/interfaces/five.GestureEvent.html +19 -19
  157. package/docs/interfaces/five.ImageOptions.html +14 -14
  158. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  159. package/docs/interfaces/five.ImageURLOptions.html +15 -15
  160. package/docs/interfaces/five.IntersectEvent.html +8 -8
  161. package/docs/interfaces/five.IntersectMesh.html +2 -0
  162. package/docs/interfaces/five.IntersectMeshInterface.html +3 -3
  163. package/docs/interfaces/five.Intersection.html +5 -5
  164. package/docs/interfaces/five.KTX2.html +9 -0
  165. package/docs/interfaces/five.LoosePanoWork.html +10 -10
  166. package/docs/interfaces/five.LooseWork.html +15 -0
  167. package/docs/interfaces/five.LooseWorkInitial.html +11 -0
  168. package/docs/interfaces/five.LooseWorkModel.html +6 -0
  169. package/docs/interfaces/five.LooseWorkObserver.html +16 -0
  170. package/docs/interfaces/five.LooseWorkPanorama.html +13 -0
  171. package/docs/interfaces/five.LooseWorkVideo.html +4 -0
  172. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +13 -0
  173. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +17 -17
  174. package/docs/interfaces/five.ModeChangeEvent.html +9 -9
  175. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +18 -18
  176. package/docs/interfaces/five.ModelEvent.html +8 -8
  177. package/docs/interfaces/five.ModelLike.html +3 -3
  178. package/docs/interfaces/five.ModelSceneEvent.html +6 -6
  179. package/docs/interfaces/five.MotionKeyframe.html +4 -4
  180. package/docs/interfaces/five.MovePanoOptions.html +24 -24
  181. package/docs/interfaces/five.NetworkAbortError.html +1 -0
  182. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -0
  183. package/docs/interfaces/five.NetworkOptions.html +7 -7
  184. package/docs/interfaces/five.NetworkProxyError.html +1 -0
  185. package/docs/interfaces/five.NetworkResourceEvent.html +9 -9
  186. package/docs/interfaces/five.NetworkResponseError.html +2 -0
  187. package/docs/interfaces/five.NetworkTimeoutError.html +1 -0
  188. package/docs/interfaces/five.ObjectEvent.html +6 -6
  189. package/docs/interfaces/five.PBMClipperParameter.html +3 -3
  190. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +6 -6
  191. package/docs/interfaces/five.PBMCustomShaderSlots.html +3 -3
  192. package/docs/interfaces/five.PBMMaterial.html +1 -0
  193. package/docs/interfaces/five.PBMMeshMaterialParameters.html +28 -28
  194. package/docs/interfaces/five.PBMPanoDepth.html +9 -9
  195. package/docs/interfaces/five.PBMPanoPicture.html +11 -11
  196. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +28 -28
  197. package/docs/interfaces/five.PBMRefinedScreen.html +6 -6
  198. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +9 -9
  199. package/docs/interfaces/five.PanoCircleMeshInterface.html +20 -20
  200. package/docs/interfaces/five.PanoCircleMeshOptions.html +3 -3
  201. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +3 -3
  202. package/docs/interfaces/five.PanoEvent.html +11 -11
  203. package/docs/interfaces/five.PanoTextureEvent.html +9 -9
  204. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +38 -38
  205. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +18 -18
  206. package/docs/interfaces/five.ParameterMaterialValue.html +73 -73
  207. package/docs/interfaces/five.ParameterTilesetValue.html +31 -31
  208. package/docs/interfaces/five.ParameterValue.html +103 -103
  209. package/docs/interfaces/five.Pose.html +13 -13
  210. package/docs/interfaces/five.RegionBoundingVolume.html +21 -0
  211. package/docs/interfaces/five.RenderEvent.html +6 -6
  212. package/docs/interfaces/five.ResolvedParameterValue.html +105 -105
  213. package/docs/interfaces/five.SphereBoundingVolume.html +17 -0
  214. package/docs/interfaces/five.State.html +19 -19
  215. package/docs/interfaces/five.StateEvent.html +7 -7
  216. package/docs/interfaces/five.TextureOptions.html +16 -16
  217. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +12 -12
  218. package/docs/interfaces/five.TileHeader.html +9 -9
  219. package/docs/interfaces/five.TilesetHeader.html +20 -20
  220. package/docs/interfaces/five.TilesetOptions.html +12 -12
  221. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +9 -9
  222. package/docs/interfaces/five.TrajectoryHeader.html +5 -5
  223. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +34 -34
  224. package/docs/interfaces/five.ViewLayer.html +90 -90
  225. package/docs/interfaces/five.Viewport.html +11 -11
  226. package/docs/interfaces/five.WebXRAxesParams.html +4 -4
  227. package/docs/interfaces/five.WebXRControllerParams.html +2 -2
  228. package/docs/interfaces/five.WorkCubeImage.html +8 -14
  229. package/docs/interfaces/five.WorkImage.html +13 -19
  230. package/docs/interfaces/five.WorkInitial.html +17 -17
  231. package/docs/interfaces/five.WorkInitialJson.html +8 -8
  232. package/docs/interfaces/five.WorkJson.html +12 -12
  233. package/docs/interfaces/five.WorkModel.html +12 -12
  234. package/docs/interfaces/five.WorkModelJson.html +5 -5
  235. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  236. package/docs/interfaces/five.WorkModelLayerJson.html +5 -5
  237. package/docs/interfaces/five.WorkObserver.html +34 -34
  238. package/docs/interfaces/five.WorkObserverJson.html +8 -8
  239. package/docs/interfaces/five.WorkPanoramaJson.html +14 -14
  240. package/docs/interfaces/five.WorkPanoramasJson.html +3 -3
  241. package/docs/interfaces/five.WorkTile.html +14 -20
  242. package/docs/interfaces/five.WorkVideo.html +9 -9
  243. package/docs/interfaces/five.WorksEvent.html +9 -9
  244. package/docs/interfaces/five.XRControllerEvent.html +8 -8
  245. package/docs/interfaces/five.XRGestureEvent.html +11 -11
  246. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +34 -34
  247. package/docs/interfaces/five.XRSessionEvent.html +7 -7
  248. package/docs/interfaces/gltf-loader.DDS.html +7 -0
  249. package/docs/interfaces/gltf-loader.GLTF.html +13 -0
  250. package/docs/interfaces/gltf-loader.GLTFReference.html +3 -0
  251. package/docs/interfaces/gltf-loader.THREEGLTF.html +8 -0
  252. package/docs/interfaces/plugins.BackgroundPluginController.html +37 -0
  253. package/docs/interfaces/plugins.BackgroundPluginType.Config.html +1 -0
  254. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +20 -0
  255. package/docs/interfaces/plugins.BackgroundPluginType.Params.html +3 -0
  256. package/docs/interfaces/plugins.BackgroundPluginType.PluginDataItem.html +1 -0
  257. package/docs/interfaces/plugins.BasePlugin.BaseOptions.html +3 -0
  258. package/docs/interfaces/plugins.BasePlugin.Config.html +5 -0
  259. package/docs/interfaces/plugins.BasePlugin.State.html +8 -0
  260. package/docs/interfaces/plugins.BasePlugin.StateChangeParams.html +7 -0
  261. package/docs/interfaces/plugins.ItemMaskController.html +35 -0
  262. package/docs/interfaces/plugins.ItemMaskPluginType.Config.html +2 -0
  263. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +10 -0
  264. package/docs/interfaces/plugins.ItemMaskPluginType.ItemType.html +13 -0
  265. package/docs/interfaces/plugins.ItemMaskPluginType.MaskType.html +4 -0
  266. package/docs/interfaces/plugins.ItemMaskPluginType.Params.html +4 -0
  267. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +14 -0
  268. package/docs/interfaces/plugins.Keyframe.html +3 -0
  269. package/docs/interfaces/plugins.OrientationPluginController.html +46 -0
  270. package/docs/interfaces/plugins.OrientationPluginType.Config.html +4 -0
  271. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +10 -0
  272. package/docs/interfaces/plugins.OrientationPluginType.Params.html +4 -0
  273. package/docs/interfaces/plugins.OrientationPluginType.State.html +10 -0
  274. package/docs/interfaces/plugins.PanoAnimeController.html +32 -0
  275. package/docs/interfaces/plugins.PanoAnimePluginType.Config.html +2 -0
  276. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +11 -0
  277. package/docs/interfaces/plugins.PanoAnimePluginType.Params.html +4 -0
  278. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +8 -0
  279. package/docs/interfaces/plugins.PlayingState.html +3 -0
  280. package/docs/interfaces/plugins.PluginTemplateType.Config.html +3 -0
  281. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +10 -0
  282. package/docs/interfaces/plugins.PluginTemplateType.Params.html +4 -0
  283. package/docs/interfaces/plugins.PluginTemplateType.State.html +8 -0
  284. package/docs/interfaces/plugins.TrajectoryController.html +50 -0
  285. package/docs/interfaces/react.FiveActionReactCallbacks.html +27 -27
  286. package/docs/interfaces/react.FiveCanvasProps.html +5 -5
  287. package/docs/interfaces/react.FiveInjectionTypes.html +152 -144
  288. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +2 -2
  289. package/docs/interfaces/sticker.IntersectionLike.html +7 -7
  290. package/docs/interfaces/vfx.ParticleArgs.html +67 -67
  291. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +3 -3
  292. package/docs/interfaces/vue.FiveActionVueCallbacks.html +30 -30
  293. package/docs/modules/five.html +1 -231
  294. package/docs/modules/gltf-loader.html +1 -0
  295. package/docs/modules/line.html +1 -8
  296. package/docs/modules/plugins.BackgroundPluginType.html +1 -0
  297. package/docs/modules/plugins.BasePlugin.html +1 -0
  298. package/docs/modules/plugins.ItemMaskPluginType.html +1 -0
  299. package/docs/modules/plugins.OrientationPluginType.html +1 -0
  300. package/docs/modules/plugins.PanoAnimePluginType.html +1 -0
  301. package/docs/modules/plugins.PluginTemplateType.html +1 -0
  302. package/docs/modules/plugins.html +1 -0
  303. package/docs/modules/react.html +1 -37
  304. package/docs/modules/sticker.html +1 -3
  305. package/docs/modules/vfx.html +1 -8
  306. package/docs/modules/vue.html +1 -24
  307. package/docs/modules.html +1 -0
  308. package/docs/types/five.AjaxResponseType.html +1 -1
  309. package/docs/types/five.AjaxResponseTypeMapping.html +1 -1
  310. package/docs/types/five.AnimationFrameLoopType.html +1 -1
  311. package/docs/types/five.BoundingVolumeJson.html +1 -1
  312. package/docs/types/five.BoxBoundingVolumeJson.html +2 -1
  313. package/docs/types/five.ControllerCustomInitTypes.html +8 -1
  314. package/docs/types/five.ControllerEventTypes.html +66 -33
  315. package/docs/types/five.CubeFace.html +1 -0
  316. package/docs/types/five.EventTypes.html +26 -26
  317. package/docs/types/five.FivePlugin.html +4 -4
  318. package/docs/types/five.FivePluginInit.html +3 -3
  319. package/docs/types/five.FivePluginInstance.html +3 -3
  320. package/docs/types/five.GestureTypes.html +1 -1
  321. package/docs/types/five.LegacyEventType.html +149 -86
  322. package/docs/types/five.LoadResultType.html +12 -1
  323. package/docs/types/five.Mode.html +9 -9
  324. package/docs/types/five.Models.html +11 -11
  325. package/docs/types/five.MotionCircle.html +2 -2
  326. package/docs/types/five.MotionConfig.html +1 -1
  327. package/docs/types/five.MotionInitalValue.html +1 -1
  328. package/docs/types/five.MotionValue.html +1 -1
  329. package/docs/types/five.MovePanoEffect.html +3 -3
  330. package/docs/types/five.NetWorkMeta.html +8 -1
  331. package/docs/types/five.NetworkError.html +1 -1
  332. package/docs/types/five.NetworkErrorCallback.html +1 -1
  333. package/docs/types/five.NetworkProgressCallback.html +1 -1
  334. package/docs/types/five.NetworkResponse.html +3 -1
  335. package/docs/types/five.NetworkState.html +1 -1
  336. package/docs/types/five.NetworkSuccessCallback.html +1 -1
  337. package/docs/types/five.NetworkType.html +1 -1
  338. package/docs/types/five.PBMAlphaMode.html +1 -1
  339. package/docs/types/five.PBMColorStyle.html +1 -1
  340. package/docs/types/five.PBMFloorStyle.html +1 -1
  341. package/docs/types/five.PBMMeshShaderType.html +1 -1
  342. package/docs/types/five.PBMPointBack.html +1 -1
  343. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  344. package/docs/types/five.PBMPointShape.html +1 -1
  345. package/docs/types/five.PBMPointSize.html +1 -1
  346. package/docs/types/five.PBMTransition.html +1 -1
  347. package/docs/types/five.Pano.html +3 -1
  348. package/docs/types/five.PanoId.html +1 -1
  349. package/docs/types/five.ParseOptions.html +11 -6
  350. package/docs/types/five.PostProcessingType.html +1 -1
  351. package/docs/types/five.RegionBoundingVolumeJson.html +2 -1
  352. package/docs/types/five.Scissor.html +2 -2
  353. package/docs/types/five.SphereBoundingVolumeJson.html +2 -1
  354. package/docs/types/five.SubscribeEventMap.html +1 -1
  355. package/docs/types/five.Tile3dOptions.html +1 -1
  356. package/docs/types/five.TileCacheOptions.html +3 -1
  357. package/docs/types/five.TileContentData.html +6 -1
  358. package/docs/types/five.TileRequestOrder.html +1 -1
  359. package/docs/types/five.TileRequestSchedulerOptions.html +4 -1
  360. package/docs/types/five.TilesetFrameState.html +22 -1
  361. package/docs/types/five.TrajectoryContentData.html +7 -1
  362. package/docs/types/five.WebXRControllerKey.html +1 -1
  363. package/docs/types/five.WebXRControllerType.html +1 -1
  364. package/docs/types/five.Works.html +1 -1
  365. package/docs/types/line.LineMaterialParameters.html +8 -1
  366. package/docs/types/plugins.BackgroundPluginType.Mirror.html +1 -0
  367. package/docs/types/plugins.BackgroundPluginType.Mode.html +1 -0
  368. package/docs/types/plugins.BackgroundPluginType.PluginData.html +1 -0
  369. package/docs/types/plugins.BackgroundPluginType.State.html +2 -0
  370. package/docs/types/plugins.BasePlugin.EventMap.html +10 -0
  371. package/docs/types/plugins.ItemMaskPluginType.PluginData.html +3 -0
  372. package/docs/types/plugins.ItemMaskPluginType.ServerData.html +3 -0
  373. package/docs/types/plugins.OrientationPluginType.PluginData.html +1 -0
  374. package/docs/types/plugins.OrientationPluginType.ServerData.html +1 -0
  375. package/docs/types/plugins.PanoAnimePluginType.PluginData.html +1 -0
  376. package/docs/types/plugins.PanoAnimePluginType.ServerData.html +1 -0
  377. package/docs/types/plugins.PluginTemplateType.PluginData.html +1 -0
  378. package/docs/types/plugins.PluginTemplateType.ServerData.html +2 -0
  379. package/docs/types/react.FiveInjectionActionFeature.html +1 -1
  380. package/docs/types/react.FiveInjectionDataFeature.html +1 -1
  381. package/docs/types/react.FiveInjectionFeature.html +1 -1
  382. package/docs/types/react.FiveProviderPropTypes.html +11 -1
  383. package/docs/types/react.FiveProviderType.html +1 -1
  384. package/docs/types/react.StoreActionMapHanlder.html +1 -1
  385. package/docs/types/react.StoreActionMapType.html +1 -1
  386. package/docs/types/react.StoreProviderType.html +1 -1
  387. package/docs/types/react.StoreValueMapType.html +1 -1
  388. package/docs/types/vfx.ParticleType.html +1 -1
  389. package/docs/types/vue.FiveModelIntersectRaycaster.html +1 -1
  390. package/docs/types/vue.FiveProviderComponent.html +1 -1
  391. package/docs/types/vue.Project2d.html +1 -1
  392. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  393. package/docs/variables/five.controllersDefaultInitArgs.html +1 -1
  394. package/docs/variables/five.draco.html +1 -0
  395. package/docs/variables/five.ktx2.html +1 -0
  396. package/docs/variables/react.FiveCanvas.html +6 -0
  397. package/docs/variables/react.INJECTION_PROPNAME.html +1 -1
  398. package/docs/variables/react.useFiveScene.html +7 -0
  399. package/docs/variables/vue.FiveCanvas.html +7 -7
  400. package/docs/variables/vue.FiveProvider.html +5 -5
  401. package/five/index.d.ts +53 -57
  402. package/five/index.js +93 -91
  403. package/five/index.mjs +4247 -4193
  404. package/gltf-loader/index.js +5 -5
  405. package/gltf-loader/index.mjs +160 -172
  406. package/line/index.js +4 -4
  407. package/line/index.mjs +15 -15
  408. package/package.json +4 -7
  409. package/plugins/index.js +10 -10
  410. package/plugins/index.mjs +42 -42
  411. package/react/index.d.ts +46 -37
  412. package/react/index.js +3 -3
  413. package/react/index.mjs +8 -8
  414. package/shader-lib/index.js +7 -7
  415. package/shader-lib/index.mjs +14 -14
  416. package/sticker/index.js +3 -3
  417. package/sticker/index.mjs +9 -9
  418. package/umd/five-gltf-loader.js +5 -5
  419. package/umd/five-line.js +4 -4
  420. package/umd/five-plugins.js +10 -10
  421. package/umd/five-react.js +3 -3
  422. package/umd/five-shader-lib.js +8 -8
  423. package/umd/five-sticker.js +3 -3
  424. package/umd/five-vfx.js +7 -7
  425. package/umd/five-vue.js +3 -3
  426. package/umd/five.js +94 -92
  427. package/vfx/index.js +6 -6
  428. package/vfx/index.mjs +12 -12
  429. package/vue/index.js +2 -2
  430. package/vue/index.mjs +2 -2
  431. package/work-downloader/index.js +3 -3
  432. package/work-downloader/index.mjs +4 -4
  433. package/docs/classes/five.BoxBoundingVolume.html +0 -19
  434. package/docs/classes/five.CullingVolume.html +0 -13
  435. package/docs/classes/five.Draco.html +0 -13
  436. package/docs/classes/five.IntersectMesh.html +0 -4
  437. package/docs/classes/five.KTX2.html +0 -10
  438. package/docs/classes/five.NetworkAbortError.html +0 -2
  439. package/docs/classes/five.NetworkFirbiddenError.html +0 -2
  440. package/docs/classes/five.NetworkProxyError.html +0 -2
  441. package/docs/classes/five.NetworkResponseError.html +0 -3
  442. package/docs/classes/five.NetworkTimeoutError.html +0 -2
  443. package/docs/classes/five.PBMMaterial.html +0 -2
  444. package/docs/classes/five.RegionBoundingVolume.html +0 -22
  445. package/docs/classes/five.SphereBoundingVolume.html +0 -18
  446. package/docs/classes/gltf_loader.DDSLoader.html +0 -3
  447. package/docs/classes/gltf_loader.DRACOLoader.html +0 -8
  448. package/docs/classes/gltf_loader.GLTFLoader.html +0 -19
  449. package/docs/classes/gltf_loader.GLTFObject.html +0 -9
  450. package/docs/classes/gltf_loader.GLTFParser.html +0 -6
  451. package/docs/classes/gltf_loader.THREEGLTFLoader.html +0 -8
  452. package/docs/classes/plugins-1.BackgroundPluginController.html +0 -38
  453. package/docs/classes/plugins-1.BasePlugin.Controller.html +0 -39
  454. package/docs/classes/plugins-1.CSS3DRenderer.html +0 -6
  455. package/docs/classes/plugins-1.ItemMaskController.html +0 -36
  456. package/docs/classes/plugins-1.OrbitControls.html +0 -41
  457. package/docs/classes/plugins-1.OrientationPluginController.html +0 -47
  458. package/docs/classes/plugins-1.PanoAnimeController.html +0 -33
  459. package/docs/classes/plugins-1.RoundedBoxGeometry.html +0 -3
  460. package/docs/classes/plugins-1.TrajectoryController.html +0 -51
  461. package/docs/documents/react_component.html +0 -32
  462. package/docs/enums/plugins-1.BackgroundPluginType.WarningCodeType.html +0 -2
  463. package/docs/functions/plugins-1.BackgroundPlugin.html +0 -1
  464. package/docs/functions/plugins-1.ItemMaskPlugin.html +0 -1
  465. package/docs/functions/plugins-1.OrientationPlugin.html +0 -1
  466. package/docs/functions/plugins-1.PanoAnimePlugin.html +0 -1
  467. package/docs/functions/plugins-1.TrajectoryPlugin.html +0 -1
  468. package/docs/functions/react.FiveCanvas.html +0 -6
  469. package/docs/functions/react.useFiveScene.html +0 -7
  470. package/docs/interfaces/gltf_loader.DDS.html +0 -7
  471. package/docs/interfaces/gltf_loader.GLTF.html +0 -13
  472. package/docs/interfaces/gltf_loader.GLTFReference.html +0 -3
  473. package/docs/interfaces/gltf_loader.THREEGLTF.html +0 -8
  474. package/docs/interfaces/plugins-1.BackgroundPluginType.Config.html +0 -1
  475. package/docs/interfaces/plugins-1.BackgroundPluginType.EventMap.html +0 -20
  476. package/docs/interfaces/plugins-1.BackgroundPluginType.Params.html +0 -3
  477. package/docs/interfaces/plugins-1.BackgroundPluginType.PluginDataItem.html +0 -1
  478. package/docs/interfaces/plugins-1.BasePlugin.BaseOptions.html +0 -3
  479. package/docs/interfaces/plugins-1.BasePlugin.Config.html +0 -5
  480. package/docs/interfaces/plugins-1.BasePlugin.State.html +0 -8
  481. package/docs/interfaces/plugins-1.BasePlugin.StateChangeParams.html +0 -7
  482. package/docs/interfaces/plugins-1.ItemMaskPluginType.Config.html +0 -2
  483. package/docs/interfaces/plugins-1.ItemMaskPluginType.EventMap.html +0 -10
  484. package/docs/interfaces/plugins-1.ItemMaskPluginType.ItemType.html +0 -13
  485. package/docs/interfaces/plugins-1.ItemMaskPluginType.MaskType.html +0 -4
  486. package/docs/interfaces/plugins-1.ItemMaskPluginType.Params.html +0 -4
  487. package/docs/interfaces/plugins-1.ItemMaskPluginType.State.html +0 -14
  488. package/docs/interfaces/plugins-1.Keyframe.html +0 -3
  489. package/docs/interfaces/plugins-1.OrientationPluginType.Config.html +0 -4
  490. package/docs/interfaces/plugins-1.OrientationPluginType.EventMap.html +0 -10
  491. package/docs/interfaces/plugins-1.OrientationPluginType.Params.html +0 -4
  492. package/docs/interfaces/plugins-1.OrientationPluginType.State.html +0 -10
  493. package/docs/interfaces/plugins-1.PanoAnimePluginType.Config.html +0 -2
  494. package/docs/interfaces/plugins-1.PanoAnimePluginType.EventMap.html +0 -11
  495. package/docs/interfaces/plugins-1.PanoAnimePluginType.Params.html +0 -4
  496. package/docs/interfaces/plugins-1.PanoAnimePluginType.State.html +0 -8
  497. package/docs/interfaces/plugins-1.PlayingState.html +0 -3
  498. package/docs/interfaces/plugins-1.PluginTemplateType.Config.html +0 -3
  499. package/docs/interfaces/plugins-1.PluginTemplateType.EventMap.html +0 -10
  500. package/docs/interfaces/plugins-1.PluginTemplateType.Params.html +0 -4
  501. package/docs/interfaces/plugins-1.PluginTemplateType.State.html +0 -8
  502. package/docs/modules/gltf_loader.html +0 -11
  503. package/docs/modules/plugins-1.BackgroundPluginType.html +0 -10
  504. package/docs/modules/plugins-1.BasePlugin.html +0 -7
  505. package/docs/modules/plugins-1.ItemMaskPluginType.html +0 -9
  506. package/docs/modules/plugins-1.OrientationPluginType.html +0 -7
  507. package/docs/modules/plugins-1.PanoAnimePluginType.html +0 -7
  508. package/docs/modules/plugins-1.PluginTemplateType.html +0 -7
  509. package/docs/modules/plugins-1.html +0 -22
  510. package/docs/types/five.LooseWork.html +0 -1
  511. package/docs/types/five.LooseWorkInitial.html +0 -1
  512. package/docs/types/five.LooseWorkModel.html +0 -1
  513. package/docs/types/five.LooseWorkObserver.html +0 -1
  514. package/docs/types/five.LooseWorkPanorama.html +0 -1
  515. package/docs/types/five.LooseWorkVideo.html +0 -1
  516. package/docs/types/five.LooseWorkWithExtrinsics.html +0 -2
  517. package/docs/types/plugins-1.BackgroundPluginType.Mirror.html +0 -1
  518. package/docs/types/plugins-1.BackgroundPluginType.Mode.html +0 -1
  519. package/docs/types/plugins-1.BackgroundPluginType.PluginData.html +0 -1
  520. package/docs/types/plugins-1.BackgroundPluginType.State.html +0 -1
  521. package/docs/types/plugins-1.BasePlugin.EventMap.html +0 -6
  522. package/docs/types/plugins-1.ItemMaskPluginType.PluginData.html +0 -1
  523. package/docs/types/plugins-1.ItemMaskPluginType.ServerData.html +0 -1
  524. package/docs/types/plugins-1.OrientationPluginType.PluginData.html +0 -1
  525. package/docs/types/plugins-1.OrientationPluginType.ServerData.html +0 -1
  526. package/docs/types/plugins-1.PanoAnimePluginType.PluginData.html +0 -1
  527. package/docs/types/plugins-1.PanoAnimePluginType.ServerData.html +0 -1
  528. package/docs/types/plugins-1.PluginTemplateType.PluginData.html +0 -1
  529. package/docs/types/plugins-1.PluginTemplateType.ServerData.html +0 -1
  530. package/docs/variables/five.draco-1.html +0 -1
  531. package/docs/variables/five.ktx2-1.html +0 -1
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 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"><h2>如视 Five SDK</h2></div><h2>Class Hierarchy</h2><ul class="tsd-full-hierarchy"><li><a id="five.BaseEvent" class="tsd-anchor"></a><a href="interfaces/five.BaseEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BaseEvent</a><ul><li><a id="five.IntersectEvent" class="tsd-anchor"></a><a href="interfaces/five.IntersectEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>IntersectEvent</a><ul></ul></li><li><a id="five.ModelEvent" class="tsd-anchor"></a><a href="interfaces/five.ModelEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ModelEvent</a><ul></ul></li><li><a id="five.ModelSceneEvent" class="tsd-anchor"></a><a href="interfaces/five.ModelSceneEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ModelSceneEvent</a><ul></ul></li><li><a id="five.NetworkResourceEvent" class="tsd-anchor"></a><a href="interfaces/five.NetworkResourceEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>NetworkResourceEvent</a><ul></ul></li><li><a id="five.ObjectEvent" class="tsd-anchor"></a><a href="interfaces/five.ObjectEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ObjectEvent</a><ul></ul></li><li><a id="five.PanoTextureEvent" class="tsd-anchor"></a><a href="interfaces/five.PanoTextureEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>PanoTextureEvent</a><ul></ul></li><li><a id="five.RenderEvent" class="tsd-anchor"></a><a href="interfaces/five.RenderEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>RenderEvent</a><ul></ul></li><li><a id="five.StateEvent" class="tsd-anchor"></a><a href="interfaces/five.StateEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>StateEvent</a><ul><li><a id="five.GestureEvent" class="tsd-anchor"></a><a href="interfaces/five.GestureEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>GestureEvent</a><ul></ul></li><li><a id="five.ModeChangeEvent" class="tsd-anchor"></a><a href="interfaces/five.ModeChangeEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ModeChangeEvent</a><ul></ul></li><li><a id="five.PanoEvent" class="tsd-anchor"></a><a href="interfaces/five.PanoEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>PanoEvent</a><ul></ul></li></ul></li><li><a id="five.WorksEvent" class="tsd-anchor"></a><a href="interfaces/five.WorksEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>WorksEvent</a><ul></ul></li><li><a id="five.XRGestureEvent" class="tsd-anchor"></a><a href="interfaces/five.XRGestureEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>XRGestureEvent</a><ul></ul></li><li><a id="five.XRSessionEvent" class="tsd-anchor"></a><a href="interfaces/five.XRSessionEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>XRSessionEvent</a><ul></ul></li><li><a id="five.XRControllerEvent" class="tsd-anchor"></a><a href="interfaces/five.XRControllerEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>XRControllerEvent</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.BoundingVolume" class="tsd-anchor"></a><a href="interfaces/five.BoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BoundingVolume</a><ul><li><a id="five.BoxBoundingVolume" class="tsd-anchor"></a><a href="classes/five.BoxBoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>BoxBoundingVolume</a><ul></ul></li><li><a id="five.RegionBoundingVolume" class="tsd-anchor"></a><a href="classes/five.RegionBoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>RegionBoundingVolume</a><ul></ul></li><li><a id="five.SphereBoundingVolume" class="tsd-anchor"></a><a href="classes/five.SphereBoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>SphereBoundingVolume</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="plugins.BasePlugin.Controller" class="tsd-anchor"></a><a href="classes/plugins-1.BasePlugin.Controller.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Controller</a><ul><li><a id="plugins.ItemMaskController" class="tsd-anchor"></a><a href="classes/plugins-1.ItemMaskController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>ItemMaskController</a><ul></ul></li><li><a id="plugins.OrientationPluginController" class="tsd-anchor"></a><a href="classes/plugins-1.OrientationPluginController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>OrientationPluginController</a><ul></ul></li><li><a id="plugins.BackgroundPluginController" class="tsd-anchor"></a><a href="classes/plugins-1.BackgroundPluginController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>BackgroundPluginController</a><ul></ul></li><li><a id="plugins.TrajectoryController" class="tsd-anchor"></a><a href="classes/plugins-1.TrajectoryController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>TrajectoryController</a><ul></ul></li><li><a id="plugins.PanoAnimeController" class="tsd-anchor"></a><a href="classes/plugins-1.PanoAnimeController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PanoAnimeController</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.IntersectMeshInterface" class="tsd-anchor"></a><a href="interfaces/five.IntersectMeshInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>IntersectMeshInterface</a><ul><li><a id="five.IntersectMesh" class="tsd-anchor"></a><a href="classes/five.IntersectMesh.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>IntersectMesh</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="line.LineSegmentsGeometry" class="tsd-anchor"></a><a href="classes/line.LineSegmentsGeometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>LineSegmentsGeometry</a><ul><li><a id="line.LineGeometry" class="tsd-anchor"></a><a href="classes/line.LineGeometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>LineGeometry</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.NetworkOptions" class="tsd-anchor"></a><a href="interfaces/five.NetworkOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>NetworkOptions</a><ul><li><a id="five.AjaxOptions" class="tsd-anchor"></a><a href="interfaces/five.AjaxOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>AjaxOptions</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.PanoCircleMeshInterface" class="tsd-anchor"></a><a href="interfaces/five.PanoCircleMeshInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>PanoCircleMeshInterface</a><ul><li><a id="five.PanoCircleMesh" class="tsd-anchor"></a><a href="classes/five.PanoCircleMesh.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PanoCircleMesh</a><ul></ul></li><li><a id="five.PanoCircleMeshCustom" class="tsd-anchor"></a><a href="classes/five.PanoCircleMeshCustom.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PanoCircleMeshCustom</a><ul></ul></li><li><a id="five.PanoCircleMeshSolid" class="tsd-anchor"></a><a href="classes/five.PanoCircleMeshSolid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PanoCircleMeshSolid</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.PanoramaLikeControllerCustomInitArgs" class="tsd-anchor"></a><a href="interfaces/five.PanoramaLikeControllerCustomInitArgs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>PanoramaLikeControllerCustomInitArgs</a><ul><li><a id="five.ModelControllerCustomInitArgs" class="tsd-anchor"></a><a href="interfaces/five.ModelControllerCustomInitArgs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ModelControllerCustomInitArgs</a><ul></ul></li><li><a id="five.PanoramaControllerCustomInitArgs" class="tsd-anchor"></a><a href="interfaces/five.PanoramaControllerCustomInitArgs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>PanoramaControllerCustomInitArgs</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.ParameterMaterialValue" class="tsd-anchor"></a><a href="interfaces/five.ParameterMaterialValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ParameterMaterialValue</a><ul><li><a id="five.ParameterValue" class="tsd-anchor"></a><a href="interfaces/five.ParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ParameterValue</a><ul><li><a id="five.ResolvedParameterValue" class="tsd-anchor"></a><a href="interfaces/five.ResolvedParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ResolvedParameterValue</a><ul></ul></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.ParameterTilesetValue" class="tsd-anchor"></a><a href="interfaces/five.ParameterTilesetValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ParameterTilesetValue</a><ul><li><a id="five.ParameterValue" class="tsd-anchor"></a><a href="interfaces/five.ParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ParameterValue</a><ul><li><a id="five.ResolvedParameterValue" class="tsd-anchor"></a><a href="interfaces/five.ResolvedParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ResolvedParameterValue</a><ul></ul></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.PBMMaterial" class="tsd-anchor"></a><a href="classes/five.PBMMaterial.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PBMMaterial</a><ul><li><a id="five.PBMMeshMaterial" class="tsd-anchor"></a><a href="classes/five.PBMMeshMaterial.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PBMMeshMaterial</a><ul></ul></li><li><a id="five.PBMPointCloudMaterial" class="tsd-anchor"></a><a href="classes/five.PBMPointCloudMaterial.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>PBMPointCloudMaterial</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.Pose" class="tsd-anchor"></a><a href="interfaces/five.Pose.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>Pose</a><ul><li><a id="five.State" class="tsd-anchor"></a><a href="interfaces/five.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="plugins.BasePlugin.State" class="tsd-anchor"></a><a href="interfaces/plugins-1.BasePlugin.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul><li><a id="plugins.ItemMaskPluginType.State" class="tsd-anchor"></a><a href="interfaces/plugins-1.ItemMaskPluginType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul></ul></li><li><a id="plugins.OrientationPluginType.State" class="tsd-anchor"></a><a href="interfaces/plugins-1.OrientationPluginType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul></ul></li><li><a id="plugins.PluginTemplateType.State" class="tsd-anchor"></a><a href="interfaces/plugins-1.PluginTemplateType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul></ul></li><li><a id="plugins.PanoAnimePluginType.State" class="tsd-anchor"></a><a href="interfaces/plugins-1.PanoAnimePluginType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.Subscribe" class="tsd-anchor"></a><a href="classes/five.Subscribe.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Subscribe</a><ul><li><a id="five.NetworkSubscribe" class="tsd-anchor"></a><a href="classes/five.NetworkSubscribe.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>NetworkSubscribe</a><ul></ul></li><li><a id="five.Five" class="tsd-anchor"></a><a href="classes/five.Five.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Five</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="line.THREE_LineSegments2" class="tsd-anchor"></a><a href="classes/line.THREE_LineSegments2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>THREE_LineSegments2</a><ul><li><a id="line.THREE_Line2" class="tsd-anchor"></a><a href="classes/line.THREE_Line2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>THREE_Line2</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="gltf-loader.THREEGLTFLoader" class="tsd-anchor"></a><a href="classes/gltf_loader.THREEGLTFLoader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>THREEGLTFLoader</a><ul><li><a id="gltf-loader.GLTFLoader" class="tsd-anchor"></a><a href="classes/gltf_loader.GLTFLoader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>GLTFLoader</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.Tile3DModel" class="tsd-anchor"></a><a href="classes/five.Tile3DModel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Tile3DModel</a><ul><li><a id="five.ViewLayer" class="tsd-anchor"></a><a href="interfaces/five.ViewLayer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ViewLayer</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.WorkCubeImage" class="tsd-anchor"></a><a href="interfaces/five.WorkCubeImage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>WorkCubeImage</a><ul><li><a id="five.WorkImage" class="tsd-anchor"></a><a href="interfaces/five.WorkImage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>WorkImage</a><ul></ul></li><li><a id="five.WorkTile" class="tsd-anchor"></a><a href="interfaces/five.WorkTile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>WorkTile</a><ul></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="five.WorkObserver" class="tsd-anchor"></a><a href="interfaces/five.WorkObserver.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>WorkObserver</a><ul><li><a id="five.WorkResolvedObserver" class="tsd-anchor"></a><a href="classes/five.WorkResolvedObserver.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>WorkResolvedObserver</a><ul></ul></li></ul></li></ul></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" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>如视 Five SDK</h1></div><h2>Hierarchy Summary</h2><ul class="tsd-full-hierarchy"><li data-refl="1189" id="five.BaseEvent"><a href="interfaces/five.BaseEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>BaseEvent</a><ul><li data-refl="1229" id="five.IntersectEvent"><a href="interfaces/five.IntersectEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>IntersectEvent</a></li><li data-refl="1248" id="five.ModelEvent"><a href="interfaces/five.ModelEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ModelEvent</a></li><li data-refl="1257" id="five.ModelSceneEvent"><a href="interfaces/five.ModelSceneEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ModelSceneEvent</a></li><li data-refl="1264" id="five.NetworkResourceEvent"><a href="interfaces/five.NetworkResourceEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>NetworkResourceEvent</a></li><li data-refl="1274" id="five.ObjectEvent"><a href="interfaces/five.ObjectEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ObjectEvent</a></li><li data-refl="1293" id="five.PanoTextureEvent"><a href="interfaces/five.PanoTextureEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PanoTextureEvent</a></li><li data-refl="1303" id="five.RenderEvent"><a href="interfaces/five.RenderEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>RenderEvent</a></li><li data-refl="1310" id="five.StateEvent"><a href="interfaces/five.StateEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>StateEvent</a><ul><li data-refl="1195" id="five.GestureEvent"><a href="interfaces/five.GestureEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>GestureEvent</a></li><li data-refl="1238" id="five.ModeChangeEvent"><a href="interfaces/five.ModeChangeEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ModeChangeEvent</a></li><li data-refl="1281" id="five.PanoEvent"><a href="interfaces/five.PanoEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PanoEvent</a></li></ul></li><li data-refl="1318" id="five.WorksEvent"><a href="interfaces/five.WorksEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WorksEvent</a></li><li data-refl="1328" id="five.XRGestureEvent"><a href="interfaces/five.XRGestureEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>XRGestureEvent</a></li><li data-refl="1345" id="five.XRSessionEvent"><a href="interfaces/five.XRSessionEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>XRSessionEvent</a></li><li data-refl="1353" id="five.XRControllerEvent"><a href="interfaces/five.XRControllerEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>XRControllerEvent</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="986" id="five.BoundingVolume"><a href="interfaces/five.BoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>BoundingVolume</a><ul><li data-refl="1053" id="five.BoxBoundingVolume"><a href="interfaces/five.BoxBoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>BoxBoundingVolume</a></li><li data-refl="1098" id="five.RegionBoundingVolume"><a href="interfaces/five.RegionBoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>RegionBoundingVolume</a></li><li data-refl="1145" id="five.SphereBoundingVolume"><a href="interfaces/five.SphereBoundingVolume.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>SphereBoundingVolume</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="50" id="plugins.BasePlugin.Controller"><a href="classes/plugins.BasePlugin.Controller.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>Controller</a><ul><li data-refl="5474" id="plugins.ItemMaskController"><a href="interfaces/plugins.ItemMaskController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ItemMaskController</a></li><li data-refl="5626" id="plugins.OrientationPluginController"><a href="interfaces/plugins.OrientationPluginController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>OrientationPluginController</a></li><li data-refl="5823" id="plugins.BackgroundPluginController"><a href="interfaces/plugins.BackgroundPluginController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>BackgroundPluginController</a></li><li data-refl="5900" id="plugins.TrajectoryController"><a href="interfaces/plugins.TrajectoryController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>TrajectoryController</a></li><li data-refl="6030" id="plugins.PanoAnimeController"><a href="interfaces/plugins.PanoAnimeController.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PanoAnimeController</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="1551" id="five.ImageOptions"><a href="interfaces/five.ImageOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ImageOptions</a><ul><li data-refl="1562" id="five.TextureOptions"><a href="interfaces/five.TextureOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>TextureOptions</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="1661" id="five.IntersectMeshInterface"><a href="interfaces/five.IntersectMeshInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>IntersectMeshInterface</a><ul><li data-refl="1531" id="five.IntersectMesh"><a href="interfaces/five.IntersectMesh.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>IntersectMesh</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="6279" id="line.LineSegmentsGeometry"><a href="classes/line.LineSegmentsGeometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>LineSegmentsGeometry</a><ul><li data-refl="6225" id="line.LineGeometry"><a href="classes/line.LineGeometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>LineGeometry</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="613" id="five.NetworkOptions"><a href="interfaces/five.NetworkOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>NetworkOptions</a><ul><li data-refl="576" id="five.AjaxOptions"><a href="interfaces/five.AjaxOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>AjaxOptions</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="1630" id="five.PanoCircleMeshInterface"><a href="interfaces/five.PanoCircleMeshInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PanoCircleMeshInterface</a><ul><li data-refl="1389" id="five.PanoCircleMesh"><a href="classes/five.PanoCircleMesh.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>PanoCircleMesh</a></li><li data-refl="1480" id="five.PanoCircleMeshCustom"><a href="classes/five.PanoCircleMeshCustom.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>PanoCircleMeshCustom</a></li><li data-refl="1435" id="five.PanoCircleMeshSolid"><a href="classes/five.PanoCircleMeshSolid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>PanoCircleMeshSolid</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="3124" id="five.PanoramaLikeControllerCustomInitArgs"><a href="interfaces/five.PanoramaLikeControllerCustomInitArgs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PanoramaLikeControllerCustomInitArgs</a><ul><li data-refl="3044" id="five.ModelControllerCustomInitArgs"><a href="interfaces/five.ModelControllerCustomInitArgs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ModelControllerCustomInitArgs</a></li><li data-refl="3061" id="five.PanoramaControllerCustomInitArgs"><a href="interfaces/five.PanoramaControllerCustomInitArgs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PanoramaControllerCustomInitArgs</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="4916" id="five.ParameterMaterialValue"><a href="interfaces/five.ParameterMaterialValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ParameterMaterialValue</a><ul><li data-refl="4807" id="five.ParameterValue"><a href="interfaces/five.ParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ParameterValue</a><ul><li data-refl="4861" id="five.ResolvedParameterValue"><a href="interfaces/five.ResolvedParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ResolvedParameterValue</a></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="4954" id="five.ParameterTilesetValue"><a href="interfaces/five.ParameterTilesetValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ParameterTilesetValue</a><ul><li data-refl="4807"><a href="interfaces/five.ParameterValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ParameterValue</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="3294" id="five.PBMMaterial"><a href="interfaces/five.PBMMaterial.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>PBMMaterial</a><ul><li data-refl="3318" id="five.PBMMeshMaterial"><a href="classes/five.PBMMeshMaterial.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>PBMMeshMaterial</a></li><li data-refl="3440" id="five.PBMPointCloudMaterial"><a href="classes/five.PBMPointCloudMaterial.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>PBMPointCloudMaterial</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="1604" id="five.Pose"><a href="interfaces/five.Pose.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>Pose</a><ul><li data-refl="1611" id="five.State"><a href="interfaces/five.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>State</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="13" id="plugins.BasePlugin.State"><a href="interfaces/plugins.BasePlugin.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>State</a><ul><li data-refl="5450" id="plugins.ItemMaskPluginType.State"><a href="interfaces/plugins.ItemMaskPluginType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>State</a></li><li data-refl="5604" id="plugins.OrientationPluginType.State"><a href="interfaces/plugins.OrientationPluginType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>State</a></li><li data-refl="5879" id="plugins.PluginTemplateType.State"><a href="interfaces/plugins.PluginTemplateType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>State</a></li><li data-refl="6005" id="plugins.PanoAnimePluginType.State"><a href="interfaces/plugins.PanoAnimePluginType.State.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>State</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="633" id="five.Subscribe"><a href="classes/five.Subscribe.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>Subscribe</a><ul><li data-refl="430" id="five.NetworkSubscribe"><a href="classes/five.NetworkSubscribe.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>NetworkSubscribe</a></li><li data-refl="1668" id="five.Five"><a href="classes/five.Five.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>Five</a></li><li data-refl="6695" id="react.FiveInjectionTypes"><a href="interfaces/react.FiveInjectionTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>FiveInjectionTypes</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="6322" id="line.THREE_LineSegments2"><a href="classes/line.THREE_LineSegments2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>THREE_LineSegments2</a><ul><li data-refl="6309" id="line.THREE_Line2"><a href="classes/line.THREE_Line2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>THREE_Line2</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="6171" id="gltf-loader.THREEGLTFLoader"><a href="classes/gltf-loader.THREEGLTFLoader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>THREEGLTFLoader</a><ul><li data-refl="119" id="gltf-loader.GLTFLoader"><a href="classes/gltf-loader.GLTFLoader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>GLTFLoader</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="4123" id="five.Tile3DModel"><a href="classes/five.Tile3DModel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>Tile3DModel</a><ul><li data-refl="4329" id="five.ViewLayer"><a href="interfaces/five.ViewLayer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>ViewLayer</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="5022" id="five.WorkCubeImage"><a href="interfaces/five.WorkCubeImage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WorkCubeImage</a><ul><li data-refl="5030" id="five.WorkImage"><a href="interfaces/five.WorkImage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WorkImage</a></li><li data-refl="5078" id="five.WorkTile"><a href="interfaces/five.WorkTile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WorkTile</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="5061" id="five.WorkObserver"><a href="interfaces/five.WorkObserver.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>WorkObserver</a><ul><li data-refl="5286" id="five.WorkResolvedObserver"><a href="classes/five.WorkResolvedObserver.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WorkResolvedObserver</a></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/index.html CHANGED
@@ -1,10 +1,10 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 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"><h2>如视 Five SDK</h2></div><div class="tsd-panel tsd-typography"><a id="md:fivejs" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Five.js<a href="#md:fivejs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://www.npmjs.com/package/@realsee/five"><img src="https://img.shields.io/npm/v/@realsee/five.svg?style=flat-square&amp;logo=npm&amp;label=npm%20install%20@realsee/five" alt="npm version"></a></p>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>如视 Five SDK</h1></div><div class="tsd-panel tsd-typography"><h1 id="fivejs" class="tsd-anchor-link">Five.js<a href="#fivejs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://www.npmjs.com/package/@realsee/five"><img src="https://img.shields.io/npm/v/@realsee/five.svg?style=flat-square&amp;logo=npm&amp;label=npm%20install%20@realsee/five" alt="npm version"></a></p>
2
2
  <p>贝壳如视三维渲染框架</p>
3
- <a id="md:什么是five" class="tsd-anchor"></a><h2 class="tsd-anchor-link">什么是<strong>Five</strong><a href="#md:什么是five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>是 <a href="https://realsee.com">贝壳如视(realsee.com)</a> 提供的在浏览器中运行的三维空间渲染 Javascript SDK。您可以通过<a href="https://developers.realsee.com">如视开发者中心</a>的数据服务,并结合<strong>Five</strong>,制作丰富多彩的三维空间应用。</p>
3
+ <h2 id="什么是five" class="tsd-anchor-link">什么是<strong>Five</strong><a href="#什么是five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>是 <a href="https://realsee.com">贝壳如视(realsee.com)</a> 提供的在浏览器中运行的三维空间渲染 Javascript SDK。您可以通过<a href="https://developers.realsee.com">如视开发者中心</a>的数据服务,并结合<strong>Five</strong>,制作丰富多彩的三维空间应用。</p>
4
4
  <p>并且<strong>Five</strong>提供了一系列的方法、事件、生命周期函数。您可以方便地基于<strong>Five</strong>进行二次开发,并结合到您自身的项目中,为您的项目添砖加瓦。</p>
5
5
  <p><strong>Five</strong>通过 <a href="https://www.typescriptlang.org/">TypeScript</a> 编写,保证开发的质量以及编程体验,推荐通过 <a href="https://code.visualstudio.com">Visual Studio Code</a>、<a href="https://www.jetbrains.com/webstorm/">WebStorm</a> 等现代源代码编辑器,您将可以体验到友好的代码提示以及自动补全。</p>
6
6
  <p><strong>Five</strong>还提供了完善的 <a href="https://reactjs.org/docs/hooks-intro.html">React Hooks API</a> ,可以方便的通过 <a href="https://reactjs.org">React</a> 开发复杂的响应式数据应用。当然直接使用<strong>Five</strong>开发也是没有问题的。</p>
7
- <a id="md:安装five" class="tsd-anchor"></a><h2 class="tsd-anchor-link">安装<strong>Five</strong><a href="#md:安装five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>提供通过 <a href="https://www.npmjs.com">npm</a> 的方式安装。<strong>Five</strong>基于 <a href="https://threejs.org">Three.js</a>, 所以同时您需要安装相关依赖。</p>
7
+ <h2 id="安装five" class="tsd-anchor-link">安装<strong>Five</strong><a href="#安装five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>提供通过 <a href="https://www.npmjs.com">npm</a> 的方式安装。<strong>Five</strong>基于 <a href="https://threejs.org">Three.js</a>, 所以同时您需要安装相关依赖。</p>
8
8
  <p>目前依赖的<strong>three</strong>版本为 115 ~ 117 的版本</p>
9
9
  <pre><code class="shell"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@realsee/five</span><span class="hl-1"> </span><span class="hl-2">three@0.117.1</span>
10
10
  </code><button type="button">Copy</button></pre>
@@ -17,7 +17,7 @@
17
17
  <pre><code class="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-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><span class="hl-5">// 如果您使用 React Hoos API</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">useFiveState</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five/react&quot;</span><span class="hl-1">;</span><br/>
18
18
  </code><button type="button">Copy</button></pre>
19
19
 
20
- <a id="md:浏览器兼容性" class="tsd-anchor"></a><h2 class="tsd-anchor-link">浏览器兼容性<a href="#md:浏览器兼容性" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><table>
20
+ <h2 id="浏览器兼容性" class="tsd-anchor-link">浏览器兼容性<a href="#浏览器兼容性" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><table>
21
21
  <thead>
22
22
  <tr>
23
23
  <th style="text-align:center">Safari</th>
@@ -39,7 +39,7 @@
39
39
  </tr>
40
40
  </tbody>
41
41
  </table>
42
- <a id="md:快速上手" class="tsd-anchor"></a><h2 class="tsd-anchor-link">快速上手<a href="#md:快速上手" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>提供了快速上手体验的项目生成工具,您可以通过他熟悉<strong>Five</strong>的功能以及尝试基于<strong>Five</strong>开发功能。</p>
42
+ <h2 id="快速上手" class="tsd-anchor-link">快速上手<a href="#快速上手" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>提供了快速上手体验的项目生成工具,您可以通过他熟悉<strong>Five</strong>的功能以及尝试基于<strong>Five</strong>开发功能。</p>
43
43
  <ol>
44
44
  <li>先创建一个文件夹<code>five-quick-start</code>, 作为项目根目录并且使用 <code>npm init</code> 命令初始化一个工程。</li>
45
45
  </ol>
@@ -70,19 +70,19 @@
70
70
  <ol start="4">
71
71
  <li>现在可以打来浏览器 <code>http://0.0.0.0:3000</code> 来看看项目初始化的效果了。您可以修改代码来体验一下如何使用<strong>Five</strong>来二次开发。</li>
72
72
  </ol>
73
- <a id="md:如何使用five" class="tsd-anchor"></a><h2 class="tsd-anchor-link">如何使用<strong>Five</strong><a href="#md:如何使用five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>的简单使用样例:</p>
73
+ <h2 id="如何使用five" class="tsd-anchor-link">如何使用<strong>Five</strong><a href="#如何使用five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>Five</strong>的简单使用样例:</p>
74
74
  <pre><code class="ts"><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-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">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/><br/><span class="hl-5">// 将渲染视图的 canvas 添加到 DOM 中</span><br/><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-0">appendTo</span><span class="hl-1">(</span><span class="hl-4">document</span><span class="hl-1">.</span><span class="hl-0">getElementById</span><span class="hl-1">(</span><span class="hl-2">&#39;app&#39;</span><span class="hl-1">)!);</span><br/><br/><span class="hl-5">// 如果显示区域需要变动,在变动时请调用 refresh 重置显示参数</span><br/><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-0">addEventListener</span><span class="hl-1">(</span><span class="hl-2">&#39;resize&#39;</span><span class="hl-1">, () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-0">refresh</span><span class="hl-1">());</span><br/><br/><span class="hl-5">// 获取三维空间的 Work 数据,加载进来</span><br/><span class="hl-5">// Work 数据可以通过如视开发者中心获取</span><br/><span class="hl-0">fetch</span><span class="hl-1">(</span><span class="hl-2">`./work.json`</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-4">res</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">res</span><span class="hl-1">.</span><span class="hl-0">json</span><span class="hl-1">())</span><br/><span class="hl-1"> .</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-4">work</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1">.</span><span class="hl-0">load</span><span class="hl-1">(</span><span class="hl-4">work</span><span class="hl-1">));</span>
75
75
  </code><button type="button">Copy</button></pre>
76
76
 
77
77
  <p>其他的 Five API 待补充</p>
78
- <a id="md:在react框架中使用five" class="tsd-anchor"></a><h2 class="tsd-anchor-link">在<strong>React</strong>框架中使用<strong>Five</strong><a href="#md:在react框架中使用five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>在<strong>React</strong>框架中使用<strong>Five</strong>的简单使用样例:</p>
78
+ <h2 id="react框架中使用five" class="tsd-anchor-link">在<strong>React</strong>框架中使用<strong>Five</strong><a href="#在react框架中使用five" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>在<strong>React</strong>框架中使用<strong>Five</strong>的简单使用样例:</p>
79
79
  <pre><code class="tsx"><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-6">*</span><span class="hl-1"> </span><span class="hl-3">as</span><span class="hl-1"> </span><span class="hl-4">React</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;react&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-6">*</span><span class="hl-1"> </span><span class="hl-3">as</span><span class="hl-1"> </span><span class="hl-4">ReactDOM</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;react-dom&quot;</span><span class="hl-1">;</span><br/><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">Work</span><span class="hl-1">, </span><span class="hl-4">parseWork</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/><span class="hl-3">import</span><span class="hl-1"> {</span><span class="hl-4">createFiveProvider</span><span class="hl-1">, </span><span class="hl-4">FiveCanvas</span><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@realsee/five/react&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// 创建 Provider, 参数与 new Five 参数类似</span><br/><span class="hl-5">// 构造函数的具体参数见文档</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">FiveProvider</span><span class="hl-1"> = </span><span class="hl-0">createFiveProvider</span><span class="hl-1">();</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-0">App</span><span class="hl-1">: </span><span class="hl-8">React</span><span class="hl-1">.</span><span class="hl-8">FC</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-5">// 声明 State: Work</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> [</span><span class="hl-7">work</span><span class="hl-1">, </span><span class="hl-7">setWork</span><span class="hl-1">] = </span><span class="hl-4">React</span><span class="hl-1">.</span><span class="hl-0">useState</span><span class="hl-1">&lt;</span><span class="hl-8">Work</span><span class="hl-1"> | </span><span class="hl-8">null</span><span class="hl-1">&gt;(</span><span class="hl-6">null</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 声明 State: Size&lt;{width, height}&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> [</span><span class="hl-7">size</span><span class="hl-1">, </span><span class="hl-7">setSize</span><span class="hl-1">] = </span><span class="hl-4">React</span><span class="hl-1">.</span><span class="hl-0">useState</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">width:</span><span class="hl-1"> </span><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-4">innerWidth</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">height:</span><span class="hl-1"> </span><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-4">innerHeight</span><br/><span class="hl-1"> })</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 获取三维空间的 Work 数据,加载进来</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">loadWork</span><span class="hl-1"> = </span><span class="hl-4">React</span><span class="hl-1">.</span><span class="hl-0">useCallback</span><span class="hl-1">((</span><span class="hl-4">url</span><span class="hl-1">: </span><span class="hl-8">string</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-0">fetch</span><span class="hl-1">(</span><span class="hl-4">url</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-4">res</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">res</span><span class="hl-1">.</span><span class="hl-0">json</span><span class="hl-1">())</span><br/><span class="hl-1"> .</span><span class="hl-0">then</span><span class="hl-1">(</span><span class="hl-4">data</span><span class="hl-1"> </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-0">setWork</span><span class="hl-1">(</span><span class="hl-0">parseWork</span><span class="hl-1">(</span><span class="hl-4">data</span><span class="hl-1">)));</span><br/><span class="hl-1"> }, []);</span><br/><br/><span class="hl-1"> </span><span class="hl-4">React</span><span class="hl-1">.</span><span class="hl-0">useEffect</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-0">loadWork</span><span class="hl-1">(</span><span class="hl-2">&quot;./data0.json&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }, []);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">// 如果显示区域需要变动,在变动时请调用 FiveCanvas 的 size</span><br/><span class="hl-1"> </span><span class="hl-4">React</span><span class="hl-1">.</span><span class="hl-0">useEffect</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-6">const</span><span class="hl-1"> </span><span class="hl-0">onResize</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-0">setSize</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">width:</span><span class="hl-1"> </span><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-4">innerWidth</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">height:</span><span class="hl-1"> </span><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-4">innerHeight</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-0">addEventListener</span><span class="hl-1">(</span><span class="hl-2">&quot;resize&quot;</span><span class="hl-1">, </span><span class="hl-4">onResize</span><span class="hl-1">, </span><span class="hl-6">false</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> () </span><span class="hl-6">=&gt;</span><span class="hl-1"> </span><span class="hl-4">window</span><span class="hl-1">.</span><span class="hl-0">removeEventListener</span><span class="hl-1">(</span><span class="hl-2">&quot;resize&quot;</span><span class="hl-1">, </span><span class="hl-4">onResize</span><span class="hl-1">, </span><span class="hl-6">false</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">work</span><span class="hl-1">) {</span><br/><span class="hl-1"> {</span><span class="hl-5">/*</span><br/><span class="hl-5"> 在 FiveProvider 内承载一个 Five 实例,</span><br/><span class="hl-5"> 在他内部的组件可以使用 Five React Hook API 来获取/设置/操作 他</span><br/><span class="hl-5"> 一个页面中也可以有多个 FiveProvider</span><br/><span class="hl-5"> */</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> </span><span class="hl-9">&lt;</span><span class="hl-8">FiveProvider</span><span class="hl-1"> </span><span class="hl-10">initialWork</span><span class="hl-1">=</span><span class="hl-6">{</span><span class="hl-4">work</span><span class="hl-6">}</span><span class="hl-9">&gt;</span><br/><span class="hl-1"> </span><span class="hl-6">{</span><span class="hl-5">/*</span><br/><span class="hl-5"> 将渲染视图的 canvas 添加到 DOM 中</span><br/><span class="hl-5"> FiveCanvas 需要出现在 FiveProvider 内,他将渲染 FiveProvider 的视图</span><br/><span class="hl-5"> 这样的设计可以实现不同的 DOM 层级结构</span><br/><span class="hl-5"> 在 FiveProvider 内的其他组件也可以使用 Five React Hook API 来获取/设置/操作 他外部的 FiveProvider</span><br/><span class="hl-5"> */</span><span class="hl-6">}</span><br/><span class="hl-1"> </span><span class="hl-9">&lt;</span><span class="hl-8">FiveCanvas</span><span class="hl-1"> </span><span class="hl-10">width</span><span class="hl-1">=</span><span class="hl-6">{</span><span class="hl-4">size</span><span class="hl-11">.</span><span class="hl-4">width</span><span class="hl-6">}</span><span class="hl-1"> </span><span class="hl-10">height</span><span class="hl-1">=</span><span class="hl-6">{</span><span class="hl-4">size</span><span class="hl-11">.</span><span class="hl-4">height</span><span class="hl-6">}</span><span class="hl-9">/&gt;</span><br/><span class="hl-1"> </span><span class="hl-9">&lt;/</span><span class="hl-8">FiveProvider</span><span class="hl-9">&gt;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> </span><span class="hl-6">null</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">ReactDOM</span><span class="hl-1">.</span><span class="hl-0">render</span><span class="hl-1">(</span><span class="hl-9">&lt;</span><span class="hl-8">App</span><span class="hl-9">&gt;&lt;/</span><span class="hl-8">App</span><span class="hl-9">&gt;</span><span class="hl-1">, </span><span class="hl-4">document</span><span class="hl-1">.</span><span class="hl-0">getElementById</span><span class="hl-1">(</span><span class="hl-2">&quot;app&quot;</span><span class="hl-1">));</span>
80
80
  </code><button type="button">Copy</button></pre>
81
81
 
82
82
  <p>其他的<strong>Five React Hook API</strong>文档建设中...</p>
83
- <a id="md:five-api文档" class="tsd-anchor"></a><h2 class="tsd-anchor-link"><strong>Five API</strong>文档<a href="#md:five-api文档" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>欢迎查看 <a href="https://unpkg.com/@realsee/five/docs/index.html">Five API 文档</a> 。</p>
83
+ <h2 id="five-api文档" class="tsd-anchor-link"><strong>Five API</strong>文档<a href="#five-api文档" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>欢迎查看 <a href="https://unpkg.com/@realsee/five/docs/index.html">Five API 文档</a> 。</p>
84
84
  <p>该文档由 <a href="https://typedoc.org/">TypeDoc</a> 生成,您可以详细查看 api 使用方式,调用参数,数据结构。</p>
85
- <a id="md:相关名词解释" class="tsd-anchor"></a><h2 class="tsd-anchor-link">相关名词解释<a href="#md:相关名词解释" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:什么是work" class="tsd-anchor"></a><h3 class="tsd-anchor-link">什么是<strong>Work</strong><a href="#md:什么是work" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Work</strong>是<a href="https://developers.realsee.com">如视开发者中心</a> 提供的对于一个三维空间的描述。
85
+ <h2 id="相关名词解释" class="tsd-anchor-link">相关名词解释<a href="#相关名词解释" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="什么是work" class="tsd-anchor-link">什么是<strong>Work</strong><a href="#什么是work" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Work</strong>是<a href="https://developers.realsee.com">如视开发者中心</a> 提供的对于一个三维空间的描述。
86
86
  是通过如视硬件设备(<a href="https://realsee.com/website/product/hardware">如视扫描仪</a> 、<a href="https://realsee.com/website/product/lite">如视<strong>Lite</strong>全景相机</a> 、<a href="https://realsee.com/website/mobile">如视VR App</a> )扫描并处理之后用于三维空间展示的数据。</p>
87
87
  <p><strong>Work</strong>以<code>JSON</code>作为数据格式<strong>Five</strong>框架可以解析<strong>Work</strong>数据并展示。一个<strong>Five</strong>实例每次可以载入并展示一个<strong>Work</strong>。并且也可以在不同的<strong>Work</strong>之间动态切换。</p>
88
88
  <p><strong>Work</strong>的数据样例如下</p>
@@ -130,7 +130,7 @@
130
130
  </ul>
131
131
  </li>
132
132
  </ul>
133
- <a id="md:什么是-five-state" class="tsd-anchor"></a><h3 class="tsd-anchor-link">什么是 Five State<a href="#md:什么是-five-state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>State</strong>是<strong>Five</strong>框架用于描述状态的数据结构。他包含了模态、位于的采集点位、相机的方向、相机可视角度的信息。
133
+ <h3 id="什么是-five-state" class="tsd-anchor-link">什么是 Five State<a href="#什么是-five-state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>State</strong>是<strong>Five</strong>框架用于描述状态的数据结构。他包含了模态、位于的采集点位、相机的方向、相机可视角度的信息。
134
134
  您可以使用<strong>State</strong>来操作<strong>Five</strong>或者获取<strong>Five</strong>当前的状态。</p>
135
135
  <pre><code class="ts"><span class="hl-6">interface</span><span class="hl-1"> </span><span class="hl-8">State</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;mode&quot;</span><span class="hl-1">: </span><span class="hl-8">Five</span><span class="hl-1">.</span><span class="hl-8">Mode</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;panoIndex&quot;</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;longitude&quot;</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;latitude&quot;</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;fov&quot;</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;distanace&quot;</span><span class="hl-1">: </span><span class="hl-8">number</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">&quot;offset&quot;</span><span class="hl-1">: </span><span class="hl-8">THREE</span><span class="hl-1">.</span><span class="hl-8">Vector3</span><span class="hl-1">,</span><br/><span class="hl-1">}</span>
136
136
  </code><button type="button">Copy</button></pre>
@@ -166,17 +166,17 @@ Five 常用有 5 种模态,可以使用 <code>Five.Mode</code> 获得</p>
166
166
  <p><code>offset</code>: 相机看向的目标</p>
167
167
  </li>
168
168
  </ul>
169
- <a id="md:模型坐标的转换说明" class="tsd-anchor"></a><h3 class="tsd-anchor-link">模型坐标的转换说明<a href="#md:模型坐标的转换说明" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
169
+ <h3 id="模型坐标的转换说明" class="tsd-anchor-link">模型坐标的转换说明<a href="#模型坐标的转换说明" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><blockquote>
170
170
  <p>目前涉及到的模型类型 at3d / domez / 3d-tile(b3dm, pnts, glb)</p>
171
171
  </blockquote>
172
- <a id="md:枚举说明" class="tsd-anchor"></a><h4 class="tsd-anchor-link">枚举说明<a href="#md:枚举说明" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
172
+ <h4 id="枚举说明" class="tsd-anchor-link">枚举说明<a href="#枚举说明" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
173
173
  <li><code>world</code>: five.scene 场景下的坐标。属于 view 下的绝对坐标。坐标的上方向是 Y 轴,单位米。</li>
174
174
  <li><code>local</code>: 单个模型的相对坐标。坐标的上方向是 Y 轴,单位米。 单个模型受到 <code>work.transform</code> 的影响会产生一定的位姿变化进行项目拼接(比如沙盘项目)。这种情况下,会与 <code>world</code> 有一定偏转。</li>
175
175
  <li><code>enu</code>: 模型描述坐标(East-North-Up)。坐标的上方向是 Z 轴,单位米。需要在算法模型输入/输出时使用这个坐标系。</li>
176
176
  <li><code>ecef</code>: 模型在地球的坐标系(Earth-centered, Earth-fixed)。坐标的上方向是 Z 轴并且固定是北,单位米。</li>
177
177
  <li><code>lla</code>: 模型在地球的经纬高度 (Latitude-Longitude-Altitude)。 经纬度单位是弧度,高度单位是米。</li>
178
178
  </ul>
179
- <a id="md:数据来源" class="tsd-anchor"></a><h4 class="tsd-anchor-link">数据来源<a href="#md:数据来源" 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>转换:</p>
179
+ <h4 id="数据来源" class="tsd-anchor-link">数据来源<a href="#数据来源" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>转换:</p>
180
180
  <ul>
181
181
  <li><code>local</code> 与 <code>world</code> 的转换依赖 <code>work.transform</code></li>
182
182
  <li><code>local</code> 与 <code>enu</code> 的转换是固定的 yUp 转 zUp</li>
@@ -184,7 +184,7 @@ Five 常用有 5 种模态,可以使用 <code>Five.Mode</code> 获得</p>
184
184
  <li><code>lla</code> 通过 <code>a=6378137.0;invf=298.257223563</code> 的椭球近似计算</li>
185
185
  </ul>
186
186
  <p>椭球近似计算: (<code>enu</code> + <code>lla</code>) 与 <code>ecef</code> 可以相互推导。</p>
187
- <a id="md:转换关系" class="tsd-anchor"></a><h4 class="tsd-anchor-link">转换关系<a href="#md:转换关系" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
187
+ <h4 id="转换关系" class="tsd-anchor-link">转换关系<a href="#转换关系" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
188
188
  <li>在 five 环境下,通过 viewLayer 对象,即 five.models[number].viewLayer[number].scene 转化。提供对应方法。
189
189
  <ul>
190
190
  <li><code>localToWorld(vector: THREE.Vector3): THREE.Vector3</code></li>
@@ -205,6 +205,6 @@ Five 常用有 5 种模态,可以使用 <code>Five.Mode</code> 获得</p>
205
205
  </li>
206
206
  </ul>
207
207
  <p>这些函数均为直接修改传入 <code>vector</code>。 如果要保持原先的数据,请实现 <code>vector.clone()</code>。</p>
208
- <a id="md:位置拾取" class="tsd-anchor"></a><h4 class="tsd-anchor-link">位置拾取<a href="#md:位置拾取" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>通过 <code>intersectRaycaster</code> 方法得到的 <code>Intersection</code> 在 <code>world</code> 坐标系下, 并返回对应的 <code>model</code> 与 <code>viewLayer</code>。</p>
209
- <a id="md:与算法数据对接" class="tsd-anchor"></a><h4 class="tsd-anchor-link">与算法数据对接<a href="#md:与算法数据对接" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>目前约定为,算法的模型输入输出均使用 <code>enu</code> 坐标系。</p>
210
- </div></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><details open class="tsd-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:fivejs"><span>Five.js</span></a><ul><li><a href="#md:什么是five"><span>什么是<wbr/>Five</span></a></li><li><a href="#md:安装five"><span>安装<wbr/>Five</span></a></li><li><a href="#md:浏览器兼容性"><span>浏览器兼容性</span></a></li><li><a href="#md:快速上手"><span>快速上手</span></a></li><li><a href="#md:如何使用five"><span>如何使用<wbr/>Five</span></a></li><li><a href="#md:在react框架中使用five"><span>在<wbr/>React框架中使用<wbr/>Five</span></a></li><li><a href="#md:five-api文档"><span>Five API文档</span></a></li><li><a href="#md:相关名词解释"><span>相关名词解释</span></a></li><li><ul><li><a href="#md:什么是work"><span>什么是<wbr/>Work</span></a></li><li><a href="#md:什么是-five-state"><span>什么是 <wbr/>Five <wbr/>State</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:位置拾取"><span>位置拾取</span></a></li><li><a href="#md:与算法数据对接"><span>与算法数据对接</span></a></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><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>
208
+ <h4 id="位置拾取" class="tsd-anchor-link">位置拾取<a href="#位置拾取" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>通过 <code>intersectRaycaster</code> 方法得到的 <code>Intersection</code> 在 <code>world</code> 坐标系下, 并返回对应的 <code>model</code> 与 <code>viewLayer</code>。</p>
209
+ <h4 id="与算法数据对接" class="tsd-anchor-link">与算法数据对接<a href="#与算法数据对接" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>目前约定为,算法的模型输入输出均使用 <code>enu</code> 坐标系。</p>
210
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#fivejs"><span>Five.js</span></a><ul><li><a href="#什么是five"><span>什么是<wbr/>Five</span></a></li><li><a href="#安装five"><span>安装<wbr/>Five</span></a></li><li><a href="#浏览器兼容性"><span>浏览器兼容性</span></a></li><li><a href="#快速上手"><span>快速上手</span></a></li><li><a href="#如何使用five"><span>如何使用<wbr/>Five</span></a></li><li><a href="#在react框架中使用five"><span>在<wbr/>React框架中使用<wbr/>Five</span></a></li><li><a href="#five-api文档"><span>Five <wbr/>API文档</span></a></li><li><a href="#相关名词解释"><span>相关名词解释</span></a></li><li><ul><li><a href="#什么是work"><span>什么是<wbr/>Work</span></a></li><li><a href="#什么是-five-state"><span>什么是 <wbr/>Five <wbr/>State</span></a></li><li><a href="#模型坐标的转换说明"><span>模型坐标的转换说明</span></a></li><li><ul><li><a href="#枚举说明"><span>枚举说明</span></a></li><li><a href="#数据来源"><span>数据来源</span></a></li><li><a href="#转换关系"><span>转换关系</span></a></li><li><a href="#位置拾取"><span>位置拾取</span></a></li><li><a href="#与算法数据对接"><span>与算法数据对接</span></a></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,9 +1,9 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddableObject | 如视 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.AddableObject.html">AddableObject</a></li></ul><h1>Interface AddableObject</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddableObject</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="five.AddableObject.html#mixer">mixer</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AnimationMixer</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="five.AddableObject.html#needsRender">needsRender</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="five.AddableObject.html#setResolution.setResolution-1">setResolution</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">height</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><a class="tsd-kind-call-signature" href="five.AddableObject.html#setTime.setTime-1">setTime</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</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 class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Object3D</span><ul class="tsd-hierarchy"><li><span class="target">AddableObject</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:3</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="five.AddableObject.html#mixer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mixer?</span></a>
2
- <a href="five.AddableObject.html#needsRender" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render?</span></a>
3
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="five.AddableObject.html#setResolution" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Resolution?</span></a>
4
- <a href="five.AddableObject.html#setTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time?</span></a>
5
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="mixer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>mixer</span><a href="#mixer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mixer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AnimationMixer</span></div><div class="tsd-comment tsd-typography"><p>动画</p>
6
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="needsRender" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>needs<wbr/>Render</span><a href="#needsRender" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">needs<wbr/>Render</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>是否需要渲染一次</p>
7
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:6</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="setResolution" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>set<wbr/>Resolution</span><a href="#setResolution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setResolution.setResolution-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Resolution</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">width</span>, <span class="tsd-kind-parameter">height</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setResolution.setResolution-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>
8
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">width</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</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/types/addableObject.ts:12</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>set<wbr/>Time</span><a href="#setTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setTime.setTime-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Time</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTime.setTime-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>
9
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</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/types/addableObject.ts:15</li></ul></aside></li></ul></section></section></details></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><details open class="tsd-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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#mixer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mixer</span></a><a href="#needsRender" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#setResolution" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Resolution</span></a><a href="#setTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time</span></a></div></details></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>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddableObject | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/five.html">five</a></li><li><a href="" aria-current="page">AddableObject</a></li></ul><h1>Interface AddableObject</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AddableObject</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#mixer">mixer</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AnimationMixer</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#needsrender">needsRender</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#setresolution-1">setResolution</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">height</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/>    <a class="tsd-kind-call-signature" href="#settime-1">setTime</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</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 class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1620"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Object3D</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">AddableObject</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:3</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#mixer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mixer?</span></a>
2
+ <a href="#needsrender" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render?</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#setresolution" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Resolution?</span></a>
4
+ <a href="#settime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time?</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mixer"><code class="tsd-tag">Optional</code><span>mixer</span><a href="#mixer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mixer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AnimationMixer</span></div><div class="tsd-comment tsd-typography"><p>动画</p>
6
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="needsrender"><code class="tsd-tag">Optional</code><span>needs<wbr/>Render</span><a href="#needsrender" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">needsRender</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>是否需要渲染一次</p>
7
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:6</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setresolution"><code class="tsd-tag">Optional</code><span>set<wbr/>Resolution</span><a href="#setresolution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setresolution-1"><span class="tsd-kind-call-signature">setResolution</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">height</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><a href="#setresolution-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>设置当前分辨率</p>
8
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">width</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</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/types/addableObject.ts:12</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settime"><code class="tsd-tag">Optional</code><span>set<wbr/>Time</span><a href="#settime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="settime-1"><span class="tsd-kind-call-signature">setTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</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><a href="#settime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>设置当前时间</p>
9
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</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/types/addableObject.ts:15</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#mixer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mixer</span></a><a href="#needsrender"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#setresolution"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Resolution</span></a><a href="#settime"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>