@realsee/five 6.6.0-alpha.1 → 6.6.0-alpha.3

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 (529) 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 +73 -74
  14. package/docs/classes/five.ModelScene.html +35 -36
  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.ParticleGPU.html +19 -0
  65. package/docs/classes/vfx.SpotLight.html +7 -7
  66. package/docs/documents/coordinate.html +4 -4
  67. package/docs/documents/five.FivePlugin.plugins.html +15 -15
  68. package/docs/documents/five.Pose.coordinate.html +4 -4
  69. package/docs/documents/plugins.html +15 -15
  70. package/docs/documents/react-component.html +32 -0
  71. package/docs/enums/five.VolumePlaneIntersect.html +4 -4
  72. package/docs/enums/plugins.BackgroundPluginType.WarningCodeType.html +2 -0
  73. package/docs/functions/five.coordinatesToVector.html +2 -0
  74. package/docs/functions/five.createDebugBoundingMesh.html +1 -1
  75. package/docs/functions/five.createWorks.html +1 -1
  76. package/docs/functions/five.defaultImageURLTransform.html +2 -2
  77. package/docs/functions/five.getViewportScale.html +1 -1
  78. package/docs/functions/five.headingToLongitude.html +4 -0
  79. package/docs/functions/five.imageSupport.html +1 -1
  80. package/docs/functions/five.isBoundingVolume.html +1 -1
  81. package/docs/functions/five.isPanoId.html +1 -1
  82. package/docs/functions/five.loadAt3d.html +1 -1
  83. package/docs/functions/five.loadB3dm.html +1 -1
  84. package/docs/functions/five.loadDome.html +1 -1
  85. package/docs/functions/five.loadDomez.html +1 -1
  86. package/docs/functions/five.loadFbx.html +1 -1
  87. package/docs/functions/five.loadGltf.html +1 -1
  88. package/docs/functions/five.loadPbm.html +1 -1
  89. package/docs/functions/five.loadPly.html +1 -1
  90. package/docs/functions/five.loadPnts.html +1 -1
  91. package/docs/functions/five.loadX3p.html +1 -1
  92. package/docs/functions/five.longitudeToHeading.html +4 -0
  93. package/docs/functions/five.makeBoundingVolume.html +1 -1
  94. package/docs/functions/five.panoEqual.html +1 -1
  95. package/docs/functions/five.panoParse.html +1 -1
  96. package/docs/functions/five.panoStringify.html +1 -1
  97. package/docs/functions/five.parseWork.html +2 -2
  98. package/docs/functions/five.vectorToCoordinates.html +2 -0
  99. package/docs/functions/five.workToJson.html +1 -1
  100. package/docs/functions/plugins.BackgroundPlugin.html +1 -0
  101. package/docs/functions/plugins.ItemMaskPlugin.html +1 -0
  102. package/docs/functions/plugins.OrientationPlugin.html +1 -0
  103. package/docs/functions/plugins.PanoAnimePlugin.html +1 -0
  104. package/docs/functions/plugins.TrajectoryPlugin.html +1 -0
  105. package/docs/functions/react.createFiveFeature.html +1 -1
  106. package/docs/functions/react.createFiveProvider.html +5 -5
  107. package/docs/functions/react.createStore.html +12 -12
  108. package/docs/functions/react.unsafe__useFiveInstance.html +4 -4
  109. package/docs/functions/react.useFiveAction.html +8 -8
  110. package/docs/functions/react.useFiveCameraDirection.html +3 -3
  111. package/docs/functions/react.useFiveCameraRaycaster.html +3 -3
  112. package/docs/functions/react.useFiveCurrentObserver.html +4 -4
  113. package/docs/functions/react.useFiveCurrentState.html +4 -4
  114. package/docs/functions/react.useFiveEventCallback.html +3 -3
  115. package/docs/functions/react.useFiveFloor.html +4 -4
  116. package/docs/functions/react.useFiveHelper.html +4 -4
  117. package/docs/functions/react.useFiveModelIntersectRaycaster.html +4 -4
  118. package/docs/functions/react.useFiveModelReadyState.html +3 -3
  119. package/docs/functions/react.useFiveProject2d.html +4 -4
  120. package/docs/functions/react.useFiveSceneEffect.html +4 -4
  121. package/docs/functions/react.useFiveState.html +1 -1
  122. package/docs/functions/react.useFiveWork.html +5 -5
  123. package/docs/functions/react.withFive.html +1 -1
  124. package/docs/functions/vue.unsafe__useFiveInject.html +4 -4
  125. package/docs/functions/vue.useFiveAction.html +10 -10
  126. package/docs/functions/vue.useFiveCameraDirection.html +3 -3
  127. package/docs/functions/vue.useFiveCameraRaycaster.html +3 -3
  128. package/docs/functions/vue.useFiveCurrentObserver.html +4 -4
  129. package/docs/functions/vue.useFiveCurrentState.html +4 -4
  130. package/docs/functions/vue.useFiveEventCallback.html +3 -3
  131. package/docs/functions/vue.useFiveFloor.html +4 -4
  132. package/docs/functions/vue.useFiveHelper.html +4 -4
  133. package/docs/functions/vue.useFiveModel.html +2 -2
  134. package/docs/functions/vue.useFiveModelBounding.html +2 -2
  135. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +4 -4
  136. package/docs/functions/vue.useFiveModelReadyState.html +3 -3
  137. package/docs/functions/vue.useFiveProject2d.html +4 -4
  138. package/docs/functions/vue.useFiveScene.html +2 -2
  139. package/docs/functions/vue.useFiveState.html +4 -4
  140. package/docs/functions/vue.useFiveWorks.html +5 -5
  141. package/docs/hierarchy.html +1 -1
  142. package/docs/index.html +17 -17
  143. package/docs/interfaces/five.AddableObject.html +9 -9
  144. package/docs/interfaces/five.AjaxOptions.html +9 -9
  145. package/docs/interfaces/five.AnimationFrame.html +5 -5
  146. package/docs/interfaces/five.AnimationFrameContext.html +3 -3
  147. package/docs/interfaces/five.BaseEvent.html +5 -5
  148. package/docs/interfaces/five.BoundingVolume.html +15 -15
  149. package/docs/interfaces/five.BoxBoundingVolume.html +18 -0
  150. package/docs/interfaces/five.CameraPose.html +6 -6
  151. package/docs/interfaces/five.CullingVolume.html +9 -0
  152. package/docs/interfaces/five.Draco.html +12 -0
  153. package/docs/interfaces/five.EventCallback.html +255 -255
  154. package/docs/interfaces/five.FiveInitArgs.html +85 -85
  155. package/docs/interfaces/five.FiveLoadOptions.html +13 -13
  156. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +17 -17
  157. package/docs/interfaces/five.GestureEvent.html +19 -19
  158. package/docs/interfaces/five.ImageOptions.html +14 -14
  159. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  160. package/docs/interfaces/five.ImageURLOptions.html +15 -15
  161. package/docs/interfaces/five.IntersectEvent.html +8 -8
  162. package/docs/interfaces/five.IntersectMesh.html +2 -0
  163. package/docs/interfaces/five.IntersectMeshInterface.html +3 -3
  164. package/docs/interfaces/five.Intersection.html +6 -5
  165. package/docs/interfaces/five.KTX2.html +9 -0
  166. package/docs/interfaces/five.LoosePanoWork.html +10 -10
  167. package/docs/interfaces/five.LooseWork.html +15 -15
  168. package/docs/interfaces/five.LooseWorkInitial.html +11 -11
  169. package/docs/interfaces/five.LooseWorkModel.html +6 -6
  170. package/docs/interfaces/five.LooseWorkObserver.html +16 -16
  171. package/docs/interfaces/five.LooseWorkPanorama.html +13 -13
  172. package/docs/interfaces/five.LooseWorkVideo.html +4 -4
  173. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +13 -13
  174. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +17 -17
  175. package/docs/interfaces/five.ModeChangeEvent.html +9 -9
  176. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +18 -18
  177. package/docs/interfaces/five.ModelEvent.html +8 -8
  178. package/docs/interfaces/five.ModelLike.html +3 -3
  179. package/docs/interfaces/five.ModelSceneEvent.html +6 -6
  180. package/docs/interfaces/five.MotionKeyframe.html +4 -4
  181. package/docs/interfaces/five.MovePanoOptions.html +24 -24
  182. package/docs/interfaces/five.NetworkAbortError.html +1 -0
  183. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -0
  184. package/docs/interfaces/five.NetworkOptions.html +7 -7
  185. package/docs/interfaces/five.NetworkProxyError.html +1 -0
  186. package/docs/interfaces/five.NetworkResourceEvent.html +9 -9
  187. package/docs/interfaces/five.NetworkResponseError.html +2 -0
  188. package/docs/interfaces/five.NetworkTimeoutError.html +1 -0
  189. package/docs/interfaces/five.ObjectEvent.html +6 -6
  190. package/docs/interfaces/five.PBMClipperParameter.html +3 -3
  191. package/docs/interfaces/five.PBMCustomShaderInitArgs.html +6 -6
  192. package/docs/interfaces/five.PBMCustomShaderSlots.html +3 -3
  193. package/docs/interfaces/five.PBMMaterial.html +1 -0
  194. package/docs/interfaces/five.PBMMeshMaterialParameters.html +28 -28
  195. package/docs/interfaces/five.PBMPanoDepth.html +9 -9
  196. package/docs/interfaces/five.PBMPanoPicture.html +11 -11
  197. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +28 -28
  198. package/docs/interfaces/five.PBMRefinedScreen.html +6 -6
  199. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +9 -9
  200. package/docs/interfaces/five.PanoCircleMeshInterface.html +20 -20
  201. package/docs/interfaces/five.PanoCircleMeshOptions.html +3 -3
  202. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +3 -3
  203. package/docs/interfaces/five.PanoEvent.html +11 -11
  204. package/docs/interfaces/five.PanoTextureEvent.html +9 -9
  205. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +38 -38
  206. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +18 -18
  207. package/docs/interfaces/five.ParameterMaterialValue.html +73 -73
  208. package/docs/interfaces/five.ParameterTilesetValue.html +31 -31
  209. package/docs/interfaces/five.ParameterValue.html +103 -103
  210. package/docs/interfaces/five.Pose.html +13 -13
  211. package/docs/interfaces/five.RegionBoundingVolume.html +21 -0
  212. package/docs/interfaces/five.RenderEvent.html +6 -6
  213. package/docs/interfaces/five.ResolvedParameterValue.html +105 -105
  214. package/docs/interfaces/five.SphereBoundingVolume.html +17 -0
  215. package/docs/interfaces/five.State.html +19 -19
  216. package/docs/interfaces/five.StateEvent.html +7 -7
  217. package/docs/interfaces/five.TextureOptions.html +16 -16
  218. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +12 -12
  219. package/docs/interfaces/five.TileHeader.html +9 -9
  220. package/docs/interfaces/five.TilesetHeader.html +20 -20
  221. package/docs/interfaces/five.TilesetOptions.html +12 -12
  222. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +9 -9
  223. package/docs/interfaces/five.TrajectoryHeader.html +5 -5
  224. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +34 -34
  225. package/docs/interfaces/five.ViewLayer.html +90 -90
  226. package/docs/interfaces/five.Viewport.html +11 -11
  227. package/docs/interfaces/five.WebXRAxesParams.html +4 -4
  228. package/docs/interfaces/five.WebXRControllerParams.html +2 -2
  229. package/docs/interfaces/five.WorkCubeImage.html +8 -8
  230. package/docs/interfaces/five.WorkImage.html +13 -13
  231. package/docs/interfaces/five.WorkInitial.html +17 -17
  232. package/docs/interfaces/five.WorkInitialJson.html +8 -8
  233. package/docs/interfaces/five.WorkJson.html +12 -12
  234. package/docs/interfaces/five.WorkModel.html +12 -12
  235. package/docs/interfaces/five.WorkModelJson.html +5 -5
  236. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  237. package/docs/interfaces/five.WorkModelLayerJson.html +5 -5
  238. package/docs/interfaces/five.WorkObserver.html +34 -34
  239. package/docs/interfaces/five.WorkObserverJson.html +8 -8
  240. package/docs/interfaces/five.WorkPanoramaJson.html +14 -14
  241. package/docs/interfaces/five.WorkPanoramasJson.html +3 -3
  242. package/docs/interfaces/five.WorkTile.html +14 -14
  243. package/docs/interfaces/five.WorkVideo.html +9 -9
  244. package/docs/interfaces/five.WorksEvent.html +9 -9
  245. package/docs/interfaces/five.XRControllerEvent.html +8 -8
  246. package/docs/interfaces/five.XRGestureEvent.html +11 -11
  247. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +34 -34
  248. package/docs/interfaces/five.XRSessionEvent.html +7 -7
  249. package/docs/interfaces/gltf-loader.DDS.html +7 -0
  250. package/docs/interfaces/gltf-loader.GLTF.html +13 -0
  251. package/docs/interfaces/gltf-loader.GLTFReference.html +3 -0
  252. package/docs/interfaces/gltf-loader.THREEGLTF.html +8 -0
  253. package/docs/interfaces/plugins.BackgroundPluginController.html +37 -0
  254. package/docs/interfaces/plugins.BackgroundPluginType.Config.html +1 -0
  255. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +20 -0
  256. package/docs/interfaces/plugins.BackgroundPluginType.Params.html +3 -0
  257. package/docs/interfaces/plugins.BackgroundPluginType.PluginDataItem.html +1 -0
  258. package/docs/interfaces/plugins.BasePlugin.BaseOptions.html +3 -0
  259. package/docs/interfaces/plugins.BasePlugin.Config.html +5 -0
  260. package/docs/interfaces/plugins.BasePlugin.State.html +8 -0
  261. package/docs/interfaces/plugins.BasePlugin.StateChangeParams.html +7 -0
  262. package/docs/interfaces/plugins.ItemMaskController.html +35 -0
  263. package/docs/interfaces/plugins.ItemMaskPluginType.Config.html +2 -0
  264. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +10 -0
  265. package/docs/interfaces/plugins.ItemMaskPluginType.ItemType.html +13 -0
  266. package/docs/interfaces/plugins.ItemMaskPluginType.MaskType.html +4 -0
  267. package/docs/interfaces/plugins.ItemMaskPluginType.Params.html +4 -0
  268. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +14 -0
  269. package/docs/interfaces/plugins.Keyframe.html +3 -0
  270. package/docs/interfaces/plugins.OrientationPluginController.html +46 -0
  271. package/docs/interfaces/plugins.OrientationPluginType.Config.html +4 -0
  272. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +10 -0
  273. package/docs/interfaces/plugins.OrientationPluginType.Params.html +4 -0
  274. package/docs/interfaces/plugins.OrientationPluginType.State.html +10 -0
  275. package/docs/interfaces/plugins.PanoAnimeController.html +32 -0
  276. package/docs/interfaces/plugins.PanoAnimePluginType.Config.html +2 -0
  277. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +11 -0
  278. package/docs/interfaces/plugins.PanoAnimePluginType.Params.html +4 -0
  279. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +8 -0
  280. package/docs/interfaces/plugins.PlayingState.html +3 -0
  281. package/docs/interfaces/plugins.PluginTemplateType.Config.html +3 -0
  282. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +10 -0
  283. package/docs/interfaces/plugins.PluginTemplateType.Params.html +4 -0
  284. package/docs/interfaces/plugins.PluginTemplateType.State.html +8 -0
  285. package/docs/interfaces/plugins.TrajectoryController.html +50 -0
  286. package/docs/interfaces/react.FiveActionReactCallbacks.html +27 -27
  287. package/docs/interfaces/react.FiveCanvasProps.html +5 -5
  288. package/docs/interfaces/react.FiveInjectionTypes.html +153 -146
  289. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +2 -2
  290. package/docs/interfaces/sticker.IntersectionLike.html +7 -7
  291. package/docs/interfaces/vfx.ParticleArgs.html +67 -67
  292. package/docs/interfaces/vfx.ParticleGPUArgs.html +60 -0
  293. package/docs/interfaces/vfx.ParticleGPUTweenKeyframe.html +3 -0
  294. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +3 -3
  295. package/docs/interfaces/vue.FiveActionVueCallbacks.html +30 -30
  296. package/docs/modules/five.html +1 -232
  297. package/docs/modules/gltf-loader.html +1 -0
  298. package/docs/modules/line.html +1 -8
  299. package/docs/modules/plugins.BackgroundPluginType.html +1 -0
  300. package/docs/modules/plugins.BasePlugin.html +1 -0
  301. package/docs/modules/plugins.ItemMaskPluginType.html +1 -0
  302. package/docs/modules/plugins.OrientationPluginType.html +1 -0
  303. package/docs/modules/plugins.PanoAnimePluginType.html +1 -0
  304. package/docs/modules/plugins.PluginTemplateType.html +1 -0
  305. package/docs/modules/plugins.html +1 -0
  306. package/docs/modules/react.html +1 -37
  307. package/docs/modules/sticker.html +1 -3
  308. package/docs/modules/vfx.html +1 -8
  309. package/docs/modules/vue.html +1 -24
  310. package/docs/modules.html +1 -0
  311. package/docs/types/five.AjaxResponseType.html +1 -1
  312. package/docs/types/five.AjaxResponseTypeMapping.html +1 -1
  313. package/docs/types/five.AnimationFrameLoopType.html +1 -1
  314. package/docs/types/five.BoundingVolumeJson.html +1 -1
  315. package/docs/types/five.BoxBoundingVolumeJson.html +2 -1
  316. package/docs/types/five.ControllerCustomInitTypes.html +8 -1
  317. package/docs/types/five.ControllerEventTypes.html +66 -33
  318. package/docs/types/five.CubeFace.html +1 -1
  319. package/docs/types/five.EventTypes.html +26 -26
  320. package/docs/types/five.FivePlugin.html +4 -4
  321. package/docs/types/five.FivePluginInit.html +3 -3
  322. package/docs/types/five.FivePluginInstance.html +3 -3
  323. package/docs/types/five.GestureTypes.html +1 -1
  324. package/docs/types/five.LegacyEventType.html +149 -86
  325. package/docs/types/five.LoadResultType.html +12 -1
  326. package/docs/types/five.Mode.html +9 -9
  327. package/docs/types/five.Models.html +11 -11
  328. package/docs/types/five.MotionCircle.html +2 -2
  329. package/docs/types/five.MotionConfig.html +1 -1
  330. package/docs/types/five.MotionInitalValue.html +1 -1
  331. package/docs/types/five.MotionValue.html +1 -1
  332. package/docs/types/five.MovePanoEffect.html +3 -3
  333. package/docs/types/five.NetWorkMeta.html +8 -1
  334. package/docs/types/five.NetworkError.html +1 -1
  335. package/docs/types/five.NetworkErrorCallback.html +1 -1
  336. package/docs/types/five.NetworkProgressCallback.html +1 -1
  337. package/docs/types/five.NetworkResponse.html +3 -1
  338. package/docs/types/five.NetworkState.html +1 -1
  339. package/docs/types/five.NetworkSuccessCallback.html +1 -1
  340. package/docs/types/five.NetworkType.html +1 -1
  341. package/docs/types/five.PBMAlphaMode.html +1 -1
  342. package/docs/types/five.PBMColorStyle.html +1 -1
  343. package/docs/types/five.PBMFloorStyle.html +1 -1
  344. package/docs/types/five.PBMMeshShaderType.html +1 -1
  345. package/docs/types/five.PBMPointBack.html +1 -1
  346. package/docs/types/five.PBMPointCloudShaderType.html +1 -1
  347. package/docs/types/five.PBMPointShape.html +1 -1
  348. package/docs/types/five.PBMPointSize.html +1 -1
  349. package/docs/types/five.PBMTransition.html +1 -1
  350. package/docs/types/five.Pano.html +3 -1
  351. package/docs/types/five.PanoId.html +1 -1
  352. package/docs/types/five.ParseOptions.html +11 -6
  353. package/docs/types/five.PostProcessingType.html +1 -1
  354. package/docs/types/five.RegionBoundingVolumeJson.html +2 -1
  355. package/docs/types/five.Scissor.html +2 -2
  356. package/docs/types/five.SphereBoundingVolumeJson.html +2 -1
  357. package/docs/types/five.SubscribeEventMap.html +1 -1
  358. package/docs/types/five.Tile3dOptions.html +1 -1
  359. package/docs/types/five.TileCacheOptions.html +3 -1
  360. package/docs/types/five.TileContentData.html +6 -1
  361. package/docs/types/five.TileRequestOrder.html +1 -1
  362. package/docs/types/five.TileRequestSchedulerOptions.html +4 -1
  363. package/docs/types/five.TilesetFrameState.html +22 -1
  364. package/docs/types/five.TrajectoryContentData.html +7 -1
  365. package/docs/types/five.WebXRControllerKey.html +1 -1
  366. package/docs/types/five.WebXRControllerType.html +1 -1
  367. package/docs/types/five.Works.html +1 -1
  368. package/docs/types/line.LineMaterialParameters.html +8 -1
  369. package/docs/types/plugins.BackgroundPluginType.Mirror.html +1 -0
  370. package/docs/types/plugins.BackgroundPluginType.Mode.html +1 -0
  371. package/docs/types/plugins.BackgroundPluginType.PluginData.html +1 -0
  372. package/docs/types/plugins.BackgroundPluginType.State.html +2 -0
  373. package/docs/types/plugins.BasePlugin.EventMap.html +10 -0
  374. package/docs/types/plugins.ItemMaskPluginType.PluginData.html +3 -0
  375. package/docs/types/plugins.ItemMaskPluginType.ServerData.html +3 -0
  376. package/docs/types/plugins.OrientationPluginType.PluginData.html +1 -0
  377. package/docs/types/plugins.OrientationPluginType.ServerData.html +1 -0
  378. package/docs/types/plugins.PanoAnimePluginType.PluginData.html +1 -0
  379. package/docs/types/plugins.PanoAnimePluginType.ServerData.html +1 -0
  380. package/docs/types/plugins.PluginTemplateType.PluginData.html +1 -0
  381. package/docs/types/plugins.PluginTemplateType.ServerData.html +2 -0
  382. package/docs/types/react.FiveInjectionActionFeature.html +1 -1
  383. package/docs/types/react.FiveInjectionDataFeature.html +1 -1
  384. package/docs/types/react.FiveInjectionFeature.html +1 -1
  385. package/docs/types/react.FiveProviderPropTypes.html +11 -1
  386. package/docs/types/react.FiveProviderType.html +1 -1
  387. package/docs/types/react.StoreActionMapHanlder.html +1 -1
  388. package/docs/types/react.StoreActionMapType.html +1 -1
  389. package/docs/types/react.StoreProviderType.html +1 -1
  390. package/docs/types/react.StoreValueMapType.html +1 -1
  391. package/docs/types/vfx.ParticleGPUType.html +1 -0
  392. package/docs/types/vfx.ParticleType.html +1 -1
  393. package/docs/types/vue.FiveModelIntersectRaycaster.html +1 -1
  394. package/docs/types/vue.FiveProviderComponent.html +1 -1
  395. package/docs/types/vue.Project2d.html +1 -1
  396. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  397. package/docs/variables/five.controllersDefaultInitArgs.html +1 -1
  398. package/docs/variables/five.draco.html +1 -0
  399. package/docs/variables/five.ktx2.html +1 -0
  400. package/docs/variables/react.FiveCanvas.html +6 -0
  401. package/docs/variables/react.INJECTION_PROPNAME.html +1 -1
  402. package/docs/variables/react.useFiveScene.html +7 -0
  403. package/docs/variables/vue.FiveCanvas.html +7 -7
  404. package/docs/variables/vue.FiveProvider.html +5 -5
  405. package/five/index.d.ts +44 -13
  406. package/five/index.js +94 -92
  407. package/five/index.mjs +6436 -6366
  408. package/gltf-loader/index.js +5 -5
  409. package/gltf-loader/index.mjs +160 -172
  410. package/line/index.js +4 -4
  411. package/line/index.mjs +15 -15
  412. package/package.json +4 -7
  413. package/plugins/index.js +10 -10
  414. package/plugins/index.mjs +42 -42
  415. package/react/index.d.ts +46 -37
  416. package/react/index.js +3 -3
  417. package/react/index.mjs +8 -8
  418. package/shader-lib/index.js +7 -7
  419. package/shader-lib/index.mjs +14 -14
  420. package/sticker/index.js +3 -3
  421. package/sticker/index.mjs +9 -9
  422. package/umd/five-gltf-loader.js +5 -5
  423. package/umd/five-line.js +4 -4
  424. package/umd/five-plugins.js +10 -10
  425. package/umd/five-react.js +3 -3
  426. package/umd/five-shader-lib.js +8 -8
  427. package/umd/five-sticker.js +3 -3
  428. package/umd/five-vfx.js +126 -19
  429. package/umd/five-vue.js +3 -3
  430. package/umd/five.js +95 -93
  431. package/vfx/index.d.ts +99 -0
  432. package/vfx/index.js +126 -19
  433. package/vfx/index.mjs +335 -129
  434. package/vue/index.js +2 -2
  435. package/vue/index.mjs +2 -2
  436. package/work-downloader/index.js +3 -3
  437. package/work-downloader/index.mjs +91 -84
  438. package/docs/classes/five.BoxBoundingVolume.html +0 -19
  439. package/docs/classes/five.CullingVolume.html +0 -13
  440. package/docs/classes/five.Draco.html +0 -13
  441. package/docs/classes/five.IntersectMesh.html +0 -4
  442. package/docs/classes/five.KTX2.html +0 -10
  443. package/docs/classes/five.NetworkAbortError.html +0 -2
  444. package/docs/classes/five.NetworkFirbiddenError.html +0 -2
  445. package/docs/classes/five.NetworkProxyError.html +0 -2
  446. package/docs/classes/five.NetworkResponseError.html +0 -3
  447. package/docs/classes/five.NetworkTimeoutError.html +0 -2
  448. package/docs/classes/five.PBMMaterial.html +0 -2
  449. package/docs/classes/five.RegionBoundingVolume.html +0 -22
  450. package/docs/classes/five.SphereBoundingVolume.html +0 -18
  451. package/docs/classes/gltf_loader.DDSLoader.html +0 -3
  452. package/docs/classes/gltf_loader.DRACOLoader.html +0 -8
  453. package/docs/classes/gltf_loader.GLTFLoader.html +0 -19
  454. package/docs/classes/gltf_loader.GLTFObject.html +0 -9
  455. package/docs/classes/gltf_loader.GLTFParser.html +0 -6
  456. package/docs/classes/gltf_loader.THREEGLTFLoader.html +0 -8
  457. package/docs/classes/plugins-1.BackgroundPluginController.html +0 -38
  458. package/docs/classes/plugins-1.BasePlugin.Controller.html +0 -39
  459. package/docs/classes/plugins-1.CSS3DRenderer.html +0 -6
  460. package/docs/classes/plugins-1.ItemMaskController.html +0 -36
  461. package/docs/classes/plugins-1.OrbitControls.html +0 -41
  462. package/docs/classes/plugins-1.OrientationPluginController.html +0 -47
  463. package/docs/classes/plugins-1.PanoAnimeController.html +0 -33
  464. package/docs/classes/plugins-1.RoundedBoxGeometry.html +0 -3
  465. package/docs/classes/plugins-1.TrajectoryController.html +0 -51
  466. package/docs/documents/react_component.html +0 -32
  467. package/docs/enums/plugins-1.BackgroundPluginType.WarningCodeType.html +0 -2
  468. package/docs/functions/plugins-1.BackgroundPlugin.html +0 -1
  469. package/docs/functions/plugins-1.ItemMaskPlugin.html +0 -1
  470. package/docs/functions/plugins-1.OrientationPlugin.html +0 -1
  471. package/docs/functions/plugins-1.PanoAnimePlugin.html +0 -1
  472. package/docs/functions/plugins-1.TrajectoryPlugin.html +0 -1
  473. package/docs/functions/react.FiveCanvas.html +0 -6
  474. package/docs/functions/react.useFiveScene.html +0 -7
  475. package/docs/interfaces/gltf_loader.DDS.html +0 -7
  476. package/docs/interfaces/gltf_loader.GLTF.html +0 -13
  477. package/docs/interfaces/gltf_loader.GLTFReference.html +0 -3
  478. package/docs/interfaces/gltf_loader.THREEGLTF.html +0 -8
  479. package/docs/interfaces/plugins-1.BackgroundPluginType.Config.html +0 -1
  480. package/docs/interfaces/plugins-1.BackgroundPluginType.EventMap.html +0 -20
  481. package/docs/interfaces/plugins-1.BackgroundPluginType.Params.html +0 -3
  482. package/docs/interfaces/plugins-1.BackgroundPluginType.PluginDataItem.html +0 -1
  483. package/docs/interfaces/plugins-1.BasePlugin.BaseOptions.html +0 -3
  484. package/docs/interfaces/plugins-1.BasePlugin.Config.html +0 -5
  485. package/docs/interfaces/plugins-1.BasePlugin.State.html +0 -8
  486. package/docs/interfaces/plugins-1.BasePlugin.StateChangeParams.html +0 -7
  487. package/docs/interfaces/plugins-1.ItemMaskPluginType.Config.html +0 -2
  488. package/docs/interfaces/plugins-1.ItemMaskPluginType.EventMap.html +0 -10
  489. package/docs/interfaces/plugins-1.ItemMaskPluginType.ItemType.html +0 -13
  490. package/docs/interfaces/plugins-1.ItemMaskPluginType.MaskType.html +0 -4
  491. package/docs/interfaces/plugins-1.ItemMaskPluginType.Params.html +0 -4
  492. package/docs/interfaces/plugins-1.ItemMaskPluginType.State.html +0 -14
  493. package/docs/interfaces/plugins-1.Keyframe.html +0 -3
  494. package/docs/interfaces/plugins-1.OrientationPluginType.Config.html +0 -4
  495. package/docs/interfaces/plugins-1.OrientationPluginType.EventMap.html +0 -10
  496. package/docs/interfaces/plugins-1.OrientationPluginType.Params.html +0 -4
  497. package/docs/interfaces/plugins-1.OrientationPluginType.State.html +0 -10
  498. package/docs/interfaces/plugins-1.PanoAnimePluginType.Config.html +0 -2
  499. package/docs/interfaces/plugins-1.PanoAnimePluginType.EventMap.html +0 -11
  500. package/docs/interfaces/plugins-1.PanoAnimePluginType.Params.html +0 -4
  501. package/docs/interfaces/plugins-1.PanoAnimePluginType.State.html +0 -8
  502. package/docs/interfaces/plugins-1.PlayingState.html +0 -3
  503. package/docs/interfaces/plugins-1.PluginTemplateType.Config.html +0 -3
  504. package/docs/interfaces/plugins-1.PluginTemplateType.EventMap.html +0 -10
  505. package/docs/interfaces/plugins-1.PluginTemplateType.Params.html +0 -4
  506. package/docs/interfaces/plugins-1.PluginTemplateType.State.html +0 -8
  507. package/docs/modules/gltf_loader.html +0 -11
  508. package/docs/modules/plugins-1.BackgroundPluginType.html +0 -10
  509. package/docs/modules/plugins-1.BasePlugin.html +0 -7
  510. package/docs/modules/plugins-1.ItemMaskPluginType.html +0 -9
  511. package/docs/modules/plugins-1.OrientationPluginType.html +0 -7
  512. package/docs/modules/plugins-1.PanoAnimePluginType.html +0 -7
  513. package/docs/modules/plugins-1.PluginTemplateType.html +0 -7
  514. package/docs/modules/plugins-1.html +0 -22
  515. package/docs/types/plugins-1.BackgroundPluginType.Mirror.html +0 -1
  516. package/docs/types/plugins-1.BackgroundPluginType.Mode.html +0 -1
  517. package/docs/types/plugins-1.BackgroundPluginType.PluginData.html +0 -1
  518. package/docs/types/plugins-1.BackgroundPluginType.State.html +0 -1
  519. package/docs/types/plugins-1.BasePlugin.EventMap.html +0 -6
  520. package/docs/types/plugins-1.ItemMaskPluginType.PluginData.html +0 -1
  521. package/docs/types/plugins-1.ItemMaskPluginType.ServerData.html +0 -1
  522. package/docs/types/plugins-1.OrientationPluginType.PluginData.html +0 -1
  523. package/docs/types/plugins-1.OrientationPluginType.ServerData.html +0 -1
  524. package/docs/types/plugins-1.PanoAnimePluginType.PluginData.html +0 -1
  525. package/docs/types/plugins-1.PanoAnimePluginType.ServerData.html +0 -1
  526. package/docs/types/plugins-1.PluginTemplateType.PluginData.html +0 -1
  527. package/docs/types/plugins-1.PluginTemplateType.ServerData.html +0 -1
  528. package/docs/variables/five.draco-1.html +0 -1
  529. package/docs/variables/five.ktx2-1.html +0 -1
package/docs/classes/vfx.ParticleGPU.html ADDED
@@ -0,0 +1,19 @@
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>ParticleGPU | 如视 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/vfx.html">vfx</a></li><li><a href="" aria-current="page">ParticleGPU</a></li></ul><h1>Class ParticleGPU</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="6511"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Points</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">THREE.ShaderMaterial</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ParticleGPU</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:81</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">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><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
+ <a href="#particledeathage" 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>particle<wbr/>Death<wbr/>Age</span></a>
4
+ <a href="#particlespersecond" 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>particles<wbr/>Per<wbr/>Second</span></a>
5
+ <a href="#paused" 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>paused</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#blending" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>blending</span></a>
7
+ <a href="#texture" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>texture</span></a>
8
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#dispose" 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>dispose</span></a>
9
+ <a href="#pause" 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>pause</span></a>
10
+ <a href="#play" 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>play</span></a>
11
+ <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>
12
+ </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-Constructors"><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>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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="constructorparticlegpu"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ParticleGPU</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/vfx.ParticleGPUArgs.html" class="tsd-signature-type tsd-kind-interface">ParticleGPUArgs</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ParticleGPU</a><a href="#constructorparticlegpu" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/vfx.ParticleGPUArgs.html" class="tsd-signature-type tsd-kind-interface">ParticleGPUArgs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ParticleGPU</a></h4><aside class="tsd-sources"><p>Overrides THREE.Points&lt;THREE.BufferGeometry, THREE.ShaderMaterial&gt;.constructor</p><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:93</li></ul></aside></div></li></ul></section></section></details><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="needsrender"><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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:82</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="particledeathage"><span>particle<wbr/>Death<wbr/>Age</span><a href="#particledeathage" 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">particleDeathAge</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:91</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="particlespersecond"><span>particles<wbr/>Per<wbr/>Second</span><a href="#particlespersecond" 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">particlesPerSecond</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:90</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="paused"><span>paused</span><a href="#paused" 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">paused</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:83</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-Accessors"><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>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="blending"><span>blending</span><a href="#blending" 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><div class="tsd-signature" id="blendingblending"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">blending</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>材质混合方式</p>
13
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Blending</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:265</li></ul></aside></div></li><li><div class="tsd-signature" id="blendingblending-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">blending</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Blending</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Blending</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:268</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="texture"><span>texture</span><a href="#texture" 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><div class="tsd-signature" id="texturetexture"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">texture</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>贴图素材</p>
14
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Texture</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:245</li></ul></aside></div></li><li><div class="tsd-signature" id="texturetexture-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">texture</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Texture</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Texture</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle-gpu/particle.ts:249</li></ul></aside></div></li></ul></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="dispose"><span>dispose</span><a href="#dispose" 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="dispose-1"><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#dispose-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>
15
+ </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/vfx/particle-gpu/particle.ts:308</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pause"><span>pause</span><a href="#pause" 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="pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#pause-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>
16
+ </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/vfx/particle-gpu/particle.ts:273</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="play"><span>play</span><a href="#play" 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="play-1"><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#play-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>
17
+ </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/vfx/particle-gpu/particle.ts:282</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="settime"><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>通过 Five 默认调用的 setTime 方法</p>
18
+ </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><div class="tsd-comment tsd-typography"><p>毫秒</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></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/vfx/particle-gpu/particle.ts:294</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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="#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><a href="#particledeathage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particle<wbr/>Death<wbr/>Age</span></a><a href="#particlespersecond"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particles<wbr/>Per<wbr/>Second</span></a><a href="#paused"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paused</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#blending"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>blending</span></a><a href="#texture"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>texture</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="#dispose"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispose</span></a><a href="#pause"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a><a href="#play"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</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>
package/docs/classes/vfx.SpotLight.html CHANGED
@@ -1,7 +1,7 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpotLight | 如视 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/vfx.html">vfx</a></li><li><a href="vfx.SpotLight.html">SpotLight</a></li></ul><h1>Class SpotLight</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Group</span><ul class="tsd-hierarchy"><li><span class="target">SpotLight</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:5</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">Constructors</h3><div class="tsd-index-list"><a href="vfx.SpotLight.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="vfx.SpotLight.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">Accessors</h3><div class="tsd-index-list"><a href="vfx.SpotLight.html#anglePower" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle<wbr/>Power</span></a>
4
- <a href="vfx.SpotLight.html#attenuation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>attenuation</span></a>
5
- <a href="vfx.SpotLight.html#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>color</span></a>
6
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="vfx.SpotLight.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>
7
- </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-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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="constructor.new_SpotLight" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Spot<wbr/>Light</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">height</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">radiusTop</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">radiusBottom</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vfx.SpotLight.html" class="tsd-signature-type tsd-kind-class">SpotLight</a><a href="#constructor.new_SpotLight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span></li><li><span><span class="tsd-kind-parameter">radiusTop</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.1</span></span></li><li><span><span class="tsd-kind-parameter">radiusBottom</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.2</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="vfx.SpotLight.html" class="tsd-signature-type tsd-kind-class">SpotLight</a></h4><aside class="tsd-sources"><p>Overrides THREE.Group.constructor</p><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:11</li></ul></aside></li></ul></section></section></details><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="needsRender" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:8</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-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="anglePower" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>angle<wbr/>Power</span><a href="#anglePower" 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" id="anglePower.anglePower-1"><span class="tsd-signature-keyword">get</span> anglePower<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:66</li></ul></aside></li><li class="tsd-signature" id="anglePower.anglePower-2"><span class="tsd-signature-keyword">set</span> anglePower<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:62</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="attenuation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>attenuation</span><a href="#attenuation" 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" id="attenuation.attenuation-1"><span class="tsd-signature-keyword">get</span> attenuation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:58</li></ul></aside></li><li class="tsd-signature" id="attenuation.attenuation-2"><span class="tsd-signature-keyword">set</span> attenuation<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:54</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="color" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color</span><a href="#color" 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" id="color.color-1"><span class="tsd-signature-keyword">get</span> color<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Color</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Color</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:74</li></ul></aside></li><li class="tsd-signature" id="color.color-2"><span class="tsd-signature-keyword">set</span> color<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Color</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:70</li></ul></aside></li></ul></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="setTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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-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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:46</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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="#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-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#anglePower" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle<wbr/>Power</span></a><a href="#attenuation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>attenuation</span></a><a href="#color" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>color</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="#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>SpotLight | 如视 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/vfx.html">vfx</a></li><li><a href="" aria-current="page">SpotLight</a></li></ul><h1>Class SpotLight</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="6368"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Group</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">SpotLight</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:5</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">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><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">Accessors</h3><div class="tsd-index-list"><a href="#anglepower" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle<wbr/>Power</span></a>
4
+ <a href="#attenuation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>attenuation</span></a>
5
+ <a href="#color" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>color</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><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>
7
+ </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-Constructors"><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>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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="constructorspotlight"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">SpotLight</span><span class="tsd-signature-symbol">(</span><br/>    <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><br/>    <span class="tsd-kind-parameter">radiusTop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">radiusBottom</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">SpotLight</a><a href="#constructorspotlight" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span></li><li><span><span class="tsd-kind-parameter">radiusTop</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.1</span></span></li><li><span><span class="tsd-kind-parameter">radiusBottom</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.2</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">SpotLight</a></h4><aside class="tsd-sources"><p>Overrides THREE.Group.constructor</p><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:11</li></ul></aside></div></li></ul></section></section></details><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="needsrender"><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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:8</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-Accessors"><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>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="anglepower"><span>angle<wbr/>Power</span><a href="#anglepower" 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><div class="tsd-signature" id="anglepoweranglepower"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">anglePower</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:66</li></ul></aside></div></li><li><div class="tsd-signature" id="anglepoweranglepower-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">anglePower</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:62</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="attenuation"><span>attenuation</span><a href="#attenuation" 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><div class="tsd-signature" id="attenuationattenuation"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">attenuation</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:58</li></ul></aside></div></li><li><div class="tsd-signature" id="attenuationattenuation-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">attenuation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:54</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="color"><span>color</span><a href="#color" 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><div class="tsd-signature" id="colorcolor"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">color</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Color</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Color</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:74</li></ul></aside></div></li><li><div class="tsd-signature" id="colorcolor-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">color</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Color</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Color</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:70</li></ul></aside></div></li></ul></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="settime"><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-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><aside class="tsd-sources"><ul><li>Defined in lib/vfx/spotLight/spotLight.ts:46</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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="#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-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#anglepower"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>angle<wbr/>Power</span></a><a href="#attenuation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>attenuation</span></a><a href="#color"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>color</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="#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>
package/docs/documents/coordinate.html CHANGED
@@ -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>coordinate | 如视 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="coordinate.html">coordinate</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="md:坐标系以及方向角度说明" class="tsd-anchor"></a><h1 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></h1><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><img src="../media/coordinate.jpg" alt="右手坐标系图示"></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>coordinate | 如视 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="" aria-current="page">coordinate</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 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></h1><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><img src="../media/coordinate.jpg" alt="右手坐标系图示"></p>
2
2
  <p>场景使用三位笛卡尔右手坐标系。 <code>XZ</code>平米平行于地面， <code>Y</code>轴垂直于地面。</p>
3
- <a id="md:longitude-水平角度" class="tsd-anchor"></a><h2 class="tsd-anchor-link">longitude 水平角度<a href="#md:longitude-水平角度" 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>longitude 为水平角度，单位是弧度值</p>
3
+ <h2 id="longitude-水平角度" class="tsd-anchor-link">longitude 水平角度<a href="#longitude-水平角度" 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>longitude 为水平角度，单位是弧度值</p>
4
4
  <p>可以认为是相对于 <code>Y</code> 轴为轴旋转的角度，Five中返回的 longitude 必定在 [0, 2PI) 这个区间内，但是方法调用是传入的可以随意。</p>
5
5
  <p>longitude <code>0度</code> 相对于 <code>Y</code> 轴负方向。 绕 <code>Y</code> 轴顺时针方向为 <code>正</code>, 逆时针方向为 <code>负</code></p>
6
- <a id="md:latitude-俯仰角度" class="tsd-anchor"></a><h2 class="tsd-anchor-link">latitude 俯仰角度<a href="#md:latitude-俯仰角度" 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>latitude 为水平角度，单位是弧度值</p>
6
+ <h2 id="latitude-俯仰角度" class="tsd-anchor-link">latitude 俯仰角度<a href="#latitude-俯仰角度" 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>latitude 为水平角度，单位是弧度值</p>
7
7
  <p>可以认为是相对于 <code>ZX</code> 平面的夹角，Five中返回的 latitude 必定在 [-PI, PI]这个区间内，但是方法调用是传入的可以随意。</p>
8
8
  <p>latitude <code>0度</code> 相对于 平行于<code>ZX</code> 平面。 仰视为 <code>正</code>, 俯视为 <code>负</code></p>
9
- </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:坐标系以及方向角度说明"><span>坐标系以及方向角度说明</span></a><ul><li><a href="#md:坐标系说明"><span>坐标系说明</span></a></li><li><a href="#md:longitude-水平角度"><span>longitude 水平角度</span></a></li><li><a href="#md:latitude-俯仰角度"><span>latitude 俯仰角度</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
9
+ </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="#坐标系以及方向角度说明"><span>坐标系以及方向角度说明</span></a><ul><li><a href="#坐标系说明"><span>坐标系说明</span></a></li><li><a href="#longitude-水平角度"><span>longitude 水平角度</span></a></li><li><a href="#latitude-俯仰角度"><span>latitude 俯仰角度</span></a></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>