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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. package/docs/assets/icons.js +17 -14
  2. package/docs/assets/icons.svg +1 -1
  3. package/docs/assets/main.js +5 -4
  4. package/docs/assets/navigation.js +1 -1
  5. package/docs/assets/search.js +1 -1
  6. package/docs/assets/style.css +67 -31
  7. package/docs/classes/five.AnimationFrameLoop.html +5 -5
  8. package/docs/classes/five.BoxBoundingVolume.html +2 -2
  9. package/docs/classes/five.Camera.html +6 -6
  10. package/docs/classes/five.CullingVolume.html +2 -2
  11. package/docs/classes/five.Fetcher.html +2 -2
  12. package/docs/classes/five.Five.html +107 -96
  13. package/docs/classes/five.InternalWebGLRenderer.html +2 -2
  14. package/docs/classes/five.IntersectMesh.html +3 -3
  15. package/docs/classes/five.Model.html +25 -22
  16. package/docs/classes/five.ModelViewLayer.html +6 -6
  17. package/docs/classes/five.NetworkAbortError.html +2 -2
  18. package/docs/classes/five.NetworkFirbiddenError.html +2 -2
  19. package/docs/classes/five.NetworkResponseError.html +2 -2
  20. package/docs/classes/five.NetworkSubscribe.html +16 -15
  21. package/docs/classes/five.NetworkTimeoutError.html +2 -2
  22. package/docs/classes/five.PBMContainer.html +5 -5
  23. package/docs/classes/five.PBMGroup.html +3 -3
  24. package/docs/classes/five.PBMMesh.html +3 -3
  25. package/docs/classes/five.PBMMeshMaterial.html +31 -27
  26. package/docs/classes/five.PanoCircleMesh.html +5 -5
  27. package/docs/classes/five.PanoCircleMeshCustom.html +5 -5
  28. package/docs/classes/five.PanoCircleMeshSolid.html +5 -5
  29. package/docs/classes/five.RegionBoundingVolume.html +2 -2
  30. package/docs/classes/five.Scene.html +5 -3
  31. package/docs/classes/five.SphereBoundingVolume.html +2 -2
  32. package/docs/classes/five.Subscribe.html +14 -13
  33. package/docs/classes/five.TextureLoader.html +2 -2
  34. package/docs/classes/five.Tile.html +3 -2
  35. package/docs/classes/five.Tile3DModel.html +5 -2
  36. package/docs/classes/five.TileCache.html +2 -2
  37. package/docs/classes/five.TileCubeTextureTarget.html +5 -3
  38. package/docs/classes/five.TileNode.html +2 -2
  39. package/docs/classes/five.TileRequestScheduler.html +6 -9
  40. package/docs/classes/five.Tileset.html +5 -4
  41. package/docs/classes/five.Work.html +17 -11
  42. package/docs/classes/five.XRButton.html +2 -2
  43. package/docs/classes/gltf_loader.DDSLoader.html +2 -2
  44. package/docs/classes/gltf_loader.DRACOLoader.html +2 -2
  45. package/docs/classes/gltf_loader.GLTFLoader.html +10 -9
  46. package/docs/classes/gltf_loader.GLTFObject.html +5 -5
  47. package/docs/classes/gltf_loader.GLTFParser.html +2 -2
  48. package/docs/classes/gltf_loader.THREEGLTFLoader.html +2 -2
  49. package/docs/classes/line.Line.html +2 -2
  50. package/docs/classes/line.LineGeometry.html +7 -2
  51. package/docs/classes/line.LineMaterial.html +2 -2
  52. package/docs/classes/line.LineSegmentsGeometry.html +7 -2
  53. package/docs/classes/line.THREE_Line2.html +2 -2
  54. package/docs/classes/line.THREE_LineSegments2.html +2 -2
  55. package/docs/classes/plugins-1.BackgroundPluginController.html +38 -0
  56. package/docs/classes/plugins-1.BasePlugin.Controller.html +39 -0
  57. package/docs/classes/plugins-1.ItemMaskController.html +36 -0
  58. package/docs/classes/plugins-1.OrientationPluginController.html +47 -0
  59. package/docs/classes/plugins-1.RoundedBoxGeometry.html +3 -0
  60. package/docs/classes/react.Store.html +9 -8
  61. package/docs/classes/sticker.Sticker.html +9 -8
  62. package/docs/classes/vfx.Airflow.html +2 -2
  63. package/docs/classes/vfx.Flame.html +2 -2
  64. package/docs/classes/vfx.Particle.html +10 -10
  65. package/docs/classes/vfx.SpotLight.html +2 -2
  66. package/docs/documents/coordinate.html +9 -0
  67. package/docs/documents/five.FivePlugin.plugins.html +77 -0
  68. package/docs/documents/five.Pose.coordinate.html +9 -0
  69. package/docs/documents/plugins.html +77 -0
  70. package/docs/documents/react_component.html +32 -0
  71. package/docs/enums/five.VolumePlaneIntersect.html +2 -2
  72. package/docs/enums/plugins-1.BackgroundPluginType.WarningCodeType.html +2 -0
  73. package/docs/functions/five.defaultImageURLTransform.html +2 -2
  74. package/docs/functions/five.getViewportScale.html +1 -1
  75. package/docs/functions/five.imageSupport.html +1 -1
  76. package/docs/functions/five.isPanoId.html +1 -1
  77. package/docs/functions/five.loadAt3d.html +1 -1
  78. package/docs/functions/five.loadB3dm.html +1 -1
  79. package/docs/functions/five.loadDome.html +1 -1
  80. package/docs/functions/five.loadDomez.html +1 -1
  81. package/docs/functions/five.loadGlb.html +1 -1
  82. package/docs/functions/five.loadPbm.html +1 -1
  83. package/docs/functions/five.loadPnts.html +1 -1
  84. package/docs/functions/five.panoEqual.html +1 -1
  85. package/docs/functions/five.panoParse.html +1 -1
  86. package/docs/functions/five.panoStringify.html +1 -1
  87. package/docs/functions/five.parseWork.html +3 -3
  88. package/docs/functions/plugins-1.BackgroundPlugin.html +1 -0
  89. package/docs/functions/plugins-1.ItemMaskPlugin.html +1 -0
  90. package/docs/functions/plugins-1.OrientationPlugin.html +1 -0
  91. package/docs/functions/react.FiveCanvas.html +6 -6
  92. package/docs/functions/react.createFiveFeature.html +1 -1
  93. package/docs/functions/react.createFiveProvider.html +4 -3
  94. package/docs/functions/react.createStore.html +8 -8
  95. package/docs/functions/react.unsafe__useFiveInstance.html +4 -4
  96. package/docs/functions/react.useFiveAction.html +14 -8
  97. package/docs/functions/react.useFiveCameraDirection.html +2 -2
  98. package/docs/functions/react.useFiveCameraRaycaster.html +2 -2
  99. package/docs/functions/react.useFiveCurrentObserver.html +4 -3
  100. package/docs/functions/react.useFiveCurrentState.html +5 -4
  101. package/docs/functions/react.useFiveEventCallback.html +4 -3
  102. package/docs/functions/react.useFiveFloor.html +5 -4
  103. package/docs/functions/react.useFiveHelper.html +5 -4
  104. package/docs/functions/react.useFiveModelIntersectRaycaster.html +6 -4
  105. package/docs/functions/react.useFiveModelReadyState.html +2 -2
  106. package/docs/functions/react.useFiveProject2d.html +6 -4
  107. package/docs/functions/react.useFiveScene.html +7 -2
  108. package/docs/functions/react.useFiveSceneEffect.html +5 -4
  109. package/docs/functions/react.useFiveState.html +1 -1
  110. package/docs/functions/react.useFiveWork.html +7 -5
  111. package/docs/functions/react.withFive.html +1 -1
  112. package/docs/functions/vue.unsafe__useFiveInject.html +4 -4
  113. package/docs/functions/vue.useFiveAction.html +18 -10
  114. package/docs/functions/vue.useFiveCameraDirection.html +2 -2
  115. package/docs/functions/vue.useFiveCameraRaycaster.html +2 -2
  116. package/docs/functions/vue.useFiveCurrentObserver.html +4 -3
  117. package/docs/functions/vue.useFiveCurrentState.html +5 -4
  118. package/docs/functions/vue.useFiveEventCallback.html +4 -3
  119. package/docs/functions/vue.useFiveFloor.html +5 -4
  120. package/docs/functions/vue.useFiveHelper.html +5 -4
  121. package/docs/functions/vue.useFiveModel.html +2 -2
  122. package/docs/functions/vue.useFiveModelBounding.html +2 -2
  123. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +6 -4
  124. package/docs/functions/vue.useFiveModelReadyState.html +2 -2
  125. package/docs/functions/vue.useFiveProject2d.html +6 -4
  126. package/docs/functions/vue.useFiveScene.html +2 -2
  127. package/docs/functions/vue.useFiveState.html +5 -4
  128. package/docs/functions/vue.useFiveWorks.html +7 -5
  129. package/docs/hierarchy.html +1 -1
  130. package/docs/index.html +91 -65
  131. package/docs/interfaces/five.AddableObject.html +6 -6
  132. package/docs/interfaces/five.AjaxOptions.html +7 -7
  133. package/docs/interfaces/five.AnimationFrame.html +2 -2
  134. package/docs/interfaces/five.BaseEvent.html +2 -2
  135. package/docs/interfaces/five.BoundingVolume.html +2 -2
  136. package/docs/interfaces/five.CameraPose.html +2 -2
  137. package/docs/interfaces/five.ClipperParameter.html +2 -2
  138. package/docs/interfaces/five.EventCallback.html +70 -63
  139. package/docs/interfaces/five.FiveInitArgs.html +58 -52
  140. package/docs/interfaces/five.FiveLoadOptions.html +25 -25
  141. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +14 -10
  142. package/docs/interfaces/five.GestureEvent.html +2 -2
  143. package/docs/interfaces/five.ImageOptions.html +9 -9
  144. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  145. package/docs/interfaces/five.ImageURLOptions.html +8 -8
  146. package/docs/interfaces/five.IntersectEvent.html +2 -2
  147. package/docs/interfaces/five.IntersectMeshInterface.html +3 -3
  148. package/docs/interfaces/five.Intersection.html +3 -3
  149. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +16 -9
  150. package/docs/interfaces/five.ModeChangeEvent.html +2 -2
  151. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +11 -11
  152. package/docs/interfaces/five.ModelEvent.html +2 -2
  153. package/docs/interfaces/five.ModelsEvent.html +2 -2
  154. package/docs/interfaces/five.MotionKeyframe.html +2 -2
  155. package/docs/interfaces/five.MovePanoOptions.html +15 -15
  156. package/docs/interfaces/five.NetworkOptions.html +6 -6
  157. package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
  158. package/docs/interfaces/five.ObjectEvent.html +2 -2
  159. package/docs/interfaces/five.PBMPanoPicture.html +3 -3
  160. package/docs/interfaces/five.PBMParameters.html +4 -4
  161. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +2 -2
  162. package/docs/interfaces/five.PanoCircleMeshInterface.html +6 -6
  163. package/docs/interfaces/five.PanoCircleMeshOptions.html +2 -2
  164. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +2 -2
  165. package/docs/interfaces/five.PanoEvent.html +2 -2
  166. package/docs/interfaces/five.PanoTextureEvent.html +2 -2
  167. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +22 -20
  168. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +11 -11
  169. package/docs/interfaces/five.Pose.html +5 -12
  170. package/docs/interfaces/five.RenderEvent.html +2 -2
  171. package/docs/interfaces/five.Scissor.html +5 -5
  172. package/docs/interfaces/five.State.html +7 -6
  173. package/docs/interfaces/five.StateEvent.html +2 -2
  174. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
  175. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
  176. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
  177. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
  178. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
  179. package/docs/interfaces/five.SubscribeMixinType.waitUnitl.html +1 -1
  180. package/docs/interfaces/five.TextureOptions.html +10 -10
  181. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +4 -4
  182. package/docs/interfaces/five.TileCubeNode.html +2 -2
  183. package/docs/interfaces/five.TileCubeTree.html +2 -2
  184. package/docs/interfaces/five.TileHeader.html +2 -2
  185. package/docs/interfaces/five.TilesetHeader.html +2 -2
  186. package/docs/interfaces/five.TilesetOptions.html +3 -2
  187. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +10 -6
  188. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +20 -18
  189. package/docs/interfaces/five.WebXRAxesParams.html +2 -2
  190. package/docs/interfaces/five.WebXRControllerParams.html +2 -2
  191. package/docs/interfaces/five.WorkCubeImage.html +4 -4
  192. package/docs/interfaces/five.WorkImage.html +8 -8
  193. package/docs/interfaces/five.WorkInitial.html +10 -10
  194. package/docs/interfaces/five.WorkModel.html +6 -6
  195. package/docs/interfaces/five.WorkObserver.html +7 -7
  196. package/docs/interfaces/five.WorkResolvedObserver.html +7 -7
  197. package/docs/interfaces/five.WorkTile.html +2 -2
  198. package/docs/interfaces/five.WorkVideo.html +4 -4
  199. package/docs/interfaces/five.WorksEvent.html +2 -2
  200. package/docs/interfaces/five.XRControllerEvent.html +2 -2
  201. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  202. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +20 -18
  203. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  204. package/docs/interfaces/gltf_loader.DDS.html +2 -2
  205. package/docs/interfaces/gltf_loader.GLTF.html +4 -4
  206. package/docs/interfaces/gltf_loader.GLTFReference.html +2 -2
  207. package/docs/interfaces/gltf_loader.THREEGLTF.html +2 -2
  208. package/docs/interfaces/plugins-1.BackgroundPluginType.Config.html +1 -0
  209. package/docs/interfaces/plugins-1.BackgroundPluginType.EventMap.html +20 -0
  210. package/docs/interfaces/plugins-1.BackgroundPluginType.Params.html +3 -0
  211. package/docs/interfaces/plugins-1.BackgroundPluginType.PluginDataItem.html +1 -0
  212. package/docs/interfaces/plugins-1.BasePlugin.BaseOptions.html +3 -0
  213. package/docs/interfaces/plugins-1.BasePlugin.Config.html +5 -0
  214. package/docs/interfaces/plugins-1.BasePlugin.State.html +8 -0
  215. package/docs/interfaces/plugins-1.BasePlugin.StateChangeParams.html +7 -0
  216. package/docs/interfaces/plugins-1.ItemMaskPluginType.Config.html +2 -0
  217. package/docs/interfaces/plugins-1.ItemMaskPluginType.EventMap.html +10 -0
  218. package/docs/interfaces/plugins-1.ItemMaskPluginType.ItemType.html +13 -0
  219. package/docs/interfaces/plugins-1.ItemMaskPluginType.MaskType.html +4 -0
  220. package/docs/interfaces/plugins-1.ItemMaskPluginType.Params.html +4 -0
  221. package/docs/interfaces/plugins-1.ItemMaskPluginType.State.html +14 -0
  222. package/docs/interfaces/plugins-1.OrientationPluginType.Config.html +4 -0
  223. package/docs/interfaces/plugins-1.OrientationPluginType.EventMap.html +10 -0
  224. package/docs/interfaces/plugins-1.OrientationPluginType.Params.html +4 -0
  225. package/docs/interfaces/plugins-1.OrientationPluginType.State.html +10 -0
  226. package/docs/interfaces/react.FiveActionReactCallbacks.html +11 -10
  227. package/docs/interfaces/react.FiveCanvasProps.html +5 -0
  228. package/docs/interfaces/react.FiveInjectionTypes.html +148 -57
  229. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +2 -2
  230. package/docs/interfaces/sticker.IntersectionLike.html +6 -6
  231. package/docs/interfaces/vfx.ParticleArgs.html +9 -9
  232. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +2 -2
  233. package/docs/interfaces/vue.FiveActionVueCallbacks.html +11 -11
  234. package/docs/modules/five.SubscribeMixinType.html +2 -2
  235. package/docs/modules/five.html +2 -2
  236. package/docs/modules/gltf_loader.html +2 -2
  237. package/docs/modules/line.html +2 -2
  238. package/docs/modules/plugins-1.BackgroundPluginType.html +10 -0
  239. package/docs/modules/plugins-1.BasePlugin.html +7 -0
  240. package/docs/modules/plugins-1.ItemMaskPluginType.html +9 -0
  241. package/docs/modules/plugins-1.OrientationPluginType.html +7 -0
  242. package/docs/modules/plugins-1.html +12 -0
  243. package/docs/modules/react.html +3 -2
  244. package/docs/modules/sticker.html +2 -2
  245. package/docs/modules/vfx.html +2 -2
  246. package/docs/modules/vue.html +2 -2
  247. package/docs/types/five.AjaxResponseType.html +1 -1
  248. package/docs/types/five.AjaxResponseTypeMapping.html +1 -1
  249. package/docs/types/five.BoundingVolumeJson.html +1 -1
  250. package/docs/types/five.BoxBoundingVolumeJson.html +1 -1
  251. package/docs/types/five.ControllerCustomInitTypes.html +1 -1
  252. package/docs/types/five.ControllerEventTypes.html +2 -2
  253. package/docs/types/five.EventTypes.html +3 -3
  254. package/docs/types/five.FivePlugin.html +2 -69
  255. package/docs/types/five.FivePluginInit.html +2 -2
  256. package/docs/types/five.FivePluginInstance.html +2 -2
  257. package/docs/types/five.GestureTypes.html +1 -1
  258. package/docs/types/five.LegacyEventType.html +66 -59
  259. package/docs/types/five.LooseWork.html +1 -1
  260. package/docs/types/five.LooseWorkInitial.html +1 -1
  261. package/docs/types/five.LooseWorkModel.html +1 -1
  262. package/docs/types/five.LooseWorkObserver.html +1 -1
  263. package/docs/types/five.LooseWorkPanorama.html +1 -1
  264. package/docs/types/five.LooseWorkVideo.html +1 -1
  265. package/docs/types/five.LooseWorkWithExtrinsics.html +2 -2
  266. package/docs/types/five.Mirror.html +1 -1
  267. package/docs/types/five.Mode.html +9 -2
  268. package/docs/types/five.ModelMaterialValues.html +1 -1
  269. package/docs/types/five.Models.html +6 -6
  270. package/docs/types/five.MotionValue.html +1 -1
  271. package/docs/types/five.MovePanoEffect.html +3 -3
  272. package/docs/types/five.NetWorkMeta.html +1 -1
  273. package/docs/types/five.NetworkError.html +1 -1
  274. package/docs/types/five.NetworkErrorCallback.html +1 -1
  275. package/docs/types/five.NetworkProgressCallback.html +1 -1
  276. package/docs/types/five.NetworkResponse.html +1 -1
  277. package/docs/types/five.NetworkState.html +1 -1
  278. package/docs/types/five.NetworkSuccessCallback.html +1 -1
  279. package/docs/types/five.NetworkType.html +1 -1
  280. package/docs/types/five.Pano.html +1 -1
  281. package/docs/types/five.PanoId.html +1 -1
  282. package/docs/types/five.ParseWorkOptions.html +6 -6
  283. package/docs/types/five.ParsedResultType.html +1 -1
  284. package/docs/types/five.PostProcessingType.html +1 -1
  285. package/docs/types/five.RegionBoundingVolumeJson.html +1 -1
  286. package/docs/types/five.SphereBoundingVolumeJson.html +1 -1
  287. package/docs/types/five.SubscribeEventMap.html +1 -1
  288. package/docs/types/five.TileContentData.html +1 -1
  289. package/docs/types/five.TileRequest.html +2 -2
  290. package/docs/types/five.TileRequestResult.html +1 -1
  291. package/docs/types/five.TilesetFrameState.html +1 -1
  292. package/docs/types/five.WebXRControllerKey.html +1 -1
  293. package/docs/types/five.WebXRControllerType.html +1 -1
  294. package/docs/types/five.Works.html +1 -1
  295. package/docs/types/line.LineMaterialParameters.html +1 -1
  296. package/docs/types/plugins-1.BackgroundPluginType.Mirror.html +1 -0
  297. package/docs/types/plugins-1.BackgroundPluginType.Mode.html +1 -0
  298. package/docs/types/plugins-1.BackgroundPluginType.PluginData.html +1 -0
  299. package/docs/types/plugins-1.BackgroundPluginType.State.html +1 -0
  300. package/docs/types/plugins-1.BasePlugin.EventMap.html +6 -0
  301. package/docs/types/plugins-1.ItemMaskPluginType.PluginData.html +1 -0
  302. package/docs/types/plugins-1.ItemMaskPluginType.ServerData.html +1 -0
  303. package/docs/types/{plugins.OrientationPluginType.PluginData.html → plugins-1.OrientationPluginType.PluginData.html} +1 -1
  304. package/docs/types/{plugins.OrientationPluginType.ServerData.html → plugins-1.OrientationPluginType.ServerData.html} +1 -1
  305. package/docs/types/react.FiveInjectionActionFeature.html +1 -1
  306. package/docs/types/react.FiveInjectionDataFeature.html +1 -1
  307. package/docs/types/react.FiveInjectionFeature.html +1 -1
  308. package/docs/types/react.FiveProviderPropTypes.html +1 -1
  309. package/docs/types/react.FiveProviderType.html +1 -1
  310. package/docs/types/react.StoreActionMapHanlder.html +1 -1
  311. package/docs/types/react.StoreActionMapType.html +1 -1
  312. package/docs/types/react.StoreProviderType.html +1 -1
  313. package/docs/types/react.StoreValueMapType.html +1 -1
  314. package/docs/types/vfx.ParticleType.html +1 -1
  315. package/docs/types/vue.FiveModelIntersectRaycaster.html +1 -1
  316. package/docs/types/vue.FiveProviderComponent.html +1 -1
  317. package/docs/types/vue.Project2d.html +1 -1
  318. package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
  319. package/docs/variables/five.defaultPbmParameters.html +1 -1
  320. package/docs/variables/react.INJECTION_PROPNAME.html +1 -1
  321. package/docs/variables/vue.FiveCanvas.html +9 -8
  322. package/docs/variables/vue.FiveProvider.html +7 -6
  323. package/five/index.d.ts +73 -28
  324. package/five/index.js +91 -91
  325. package/five/index.mjs +6177 -5970
  326. package/gltf-loader/index.js +3 -3
  327. package/gltf-loader/index.mjs +3 -3
  328. package/line/index.js +3 -3
  329. package/line/index.mjs +3 -3
  330. package/package.json +2 -2
  331. package/plugins/index.d.ts +14 -17
  332. package/plugins/index.js +3 -3
  333. package/plugins/index.mjs +4 -4
  334. package/react/index.d.ts +9 -8
  335. package/react/index.js +3 -3
  336. package/react/index.mjs +3 -3
  337. package/sticker/index.js +3 -3
  338. package/sticker/index.mjs +3 -3
  339. package/umd/five-gltf-loader.js +3 -3
  340. package/umd/five-line.js +3 -3
  341. package/umd/five-plugins.js +3 -3
  342. package/umd/five-react.js +3 -3
  343. package/umd/five-sticker.js +3 -3
  344. package/umd/five-vfx.js +2 -2
  345. package/umd/five-vue.js +2 -2
  346. package/umd/five.js +49 -49
  347. package/vfx/index.js +2 -2
  348. package/vfx/index.mjs +2 -2
  349. package/vue/index.js +2 -2
  350. package/vue/index.mjs +2 -2
  351. package/docs/classes/plugins.BackgroundPluginController.html +0 -37
  352. package/docs/classes/plugins.BasePlugin.Controller.html +0 -38
  353. package/docs/classes/plugins.ItemMaskController.html +0 -37
  354. package/docs/classes/plugins.OrientationPluginController.html +0 -49
  355. package/docs/classes/plugins.RoundedBoxGeometry.html +0 -3
  356. package/docs/enums/plugins.BackgroundPluginType.WarningCodeType.html +0 -2
  357. package/docs/functions/plugins.BackgroundPlugin.html +0 -1
  358. package/docs/functions/plugins.ItemMaskPlugin.html +0 -1
  359. package/docs/functions/plugins.OrientationPlugin.html +0 -1
  360. package/docs/interfaces/plugins.BackgroundPluginType.Config.html +0 -1
  361. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +0 -20
  362. package/docs/interfaces/plugins.BackgroundPluginType.Params.html +0 -3
  363. package/docs/interfaces/plugins.BackgroundPluginType.PluginDataItem.html +0 -1
  364. package/docs/interfaces/plugins.BasePlugin.BaseOptions.html +0 -3
  365. package/docs/interfaces/plugins.BasePlugin.Config.html +0 -5
  366. package/docs/interfaces/plugins.BasePlugin.State.html +0 -8
  367. package/docs/interfaces/plugins.ItemMaskPluginType.Config.html +0 -2
  368. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +0 -10
  369. package/docs/interfaces/plugins.ItemMaskPluginType.ItemType.html +0 -13
  370. package/docs/interfaces/plugins.ItemMaskPluginType.MaskType.html +0 -4
  371. package/docs/interfaces/plugins.ItemMaskPluginType.Params.html +0 -4
  372. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +0 -14
  373. package/docs/interfaces/plugins.OrientationPluginType.Config.html +0 -4
  374. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +0 -10
  375. package/docs/interfaces/plugins.OrientationPluginType.Params.html +0 -4
  376. package/docs/interfaces/plugins.OrientationPluginType.State.html +0 -10
  377. package/docs/media/topview.jpg +0 -0
  378. package/docs/media/typescript.jpg +0 -0
  379. package/docs/modules/plugins.BackgroundPluginType.html +0 -10
  380. package/docs/modules/plugins.BasePlugin.html +0 -6
  381. package/docs/modules/plugins.ItemMaskPluginType.html +0 -9
  382. package/docs/modules/plugins.OrientationPluginType.html +0 -7
  383. package/docs/modules/plugins.html +0 -12
  384. package/docs/types/plugins.BackgroundPluginType.Mirror.html +0 -1
  385. package/docs/types/plugins.BackgroundPluginType.Mode.html +0 -1
  386. package/docs/types/plugins.BackgroundPluginType.PluginData.html +0 -1
  387. package/docs/types/plugins.BackgroundPluginType.State.html +0 -1
  388. package/docs/types/plugins.BasePlugin.EventMap.html +0 -6
  389. package/docs/types/plugins.ItemMaskPluginType.PluginData.html +0 -1
  390. package/docs/types/plugins.ItemMaskPluginType.ServerData.html +0 -1
package/docs/classes/vfx.Particle.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Particle | 如视 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.Particle.html">Particle</a></li></ul><h1>Class Particle</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><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><span class="target">Particle</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:112</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-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.Particle.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>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Particle | 如视 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.Particle.html">Particle</a></li></ul><h1>Class Particle</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><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><span class="target">Particle</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:112</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.Particle.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
2
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="vfx.Particle.html#accelerationBase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Base</span></a>
3
3
  <a href="vfx.Particle.html#accelerationSpread" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Spread</span></a>
4
4
  <a href="vfx.Particle.html#angleAccelerationBase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Acceleration<wbr/>Base</span></a>
@@ -35,7 +35,7 @@
35
35
  <a href="vfx.Particle.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a>
36
36
  <a href="vfx.Particle.html#play" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a>
37
37
  <a href="vfx.Particle.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>
38
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><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_Particle" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Particle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vfx.Particle.html" class="tsd-signature-type tsd-kind-class">Particle</a><a href="#constructor.new_Particle" 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">args</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/vfx.ParticleArgs.html" class="tsd-signature-type tsd-kind-interface">ParticleArgs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="vfx.Particle.html" class="tsd-signature-type tsd-kind-class">Particle</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/particle.ts:214</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="accelerationBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>acceleration<wbr/>Base</span><a href="#accelerationBase" 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">acceleration<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>粒子加速度</p>
38
+ </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_Particle" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Particle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vfx.Particle.html" class="tsd-signature-type tsd-kind-class">Particle</a><a href="#constructor.new_Particle" 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">args</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/vfx.ParticleArgs.html" class="tsd-signature-type tsd-kind-interface">ParticleArgs</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="vfx.Particle.html" class="tsd-signature-type tsd-kind-class">Particle</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/particle.ts:214</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="accelerationBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>acceleration<wbr/>Base</span><a href="#accelerationBase" 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">acceleration<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>粒子加速度</p>
39
39
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:157</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="accelerationSpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>acceleration<wbr/>Spread</span><a href="#accelerationSpread" 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">acceleration<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>粒子加速度扩散值</p>
40
40
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:159</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="angleAccelerationBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>angle<wbr/>Acceleration<wbr/>Base</span><a href="#angleAccelerationBase" 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">angle<wbr/>Acceleration<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>旋转角度加速度值</p>
41
41
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:170</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="angleAccelerationSpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>angle<wbr/>Acceleration<wbr/>Spread</span><a href="#angleAccelerationSpread" 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">angle<wbr/>Acceleration<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>旋转角度加速度值扩散值</p>
@@ -44,13 +44,13 @@
44
44
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:164</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="angleVelocityBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>angle<wbr/>Velocity<wbr/>Base</span><a href="#angleVelocityBase" 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">angle<wbr/>Velocity<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>旋转角度速度值</p>
45
45
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:166</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="angleVelocitySpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>angle<wbr/>Velocity<wbr/>Spread</span><a href="#angleVelocitySpread" 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">angle<wbr/>Velocity<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>旋转角度速度值的扩散值</p>
46
46
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:168</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="colorBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color<wbr/>Base</span><a href="#colorBase" 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">color<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>颜色（hsl）</p>
47
- </div><div class="tsd-comment tsd-typography"><h4>Description</h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
47
+ </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description" class="tsd-anchor"></a>Description<a href="#Description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
48
48
  <code>{ x: h, y: s, z: l }</code></p>
49
49
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:187</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="colorSpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color<wbr/>Spread</span><a href="#colorSpread" 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">color<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>颜色（hsl）的扩散值</p>
50
- </div><div class="tsd-comment tsd-typography"><h4>Description</h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
50
+ </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-1" class="tsd-anchor"></a>Description<a href="#Description-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
51
51
  <code>{ x: h, y: s, z: l }</code></p>
52
52
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:193</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="colorTween" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>color<wbr/>Tween</span><a href="#colorTween" 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">color<wbr/>Tween</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/vfx.ParticleTweenKeyframe.html" class="tsd-signature-type tsd-kind-interface">ParticleTweenKeyframe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Vector3</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>颜色（hsl）随时间分布的增益</p>
53
- </div><div class="tsd-comment tsd-typography"><h4>Description</h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
53
+ </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-2" class="tsd-anchor"></a>Description<a href="#Description-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="http://en.wikipedia.org/wiki/HSL_and_HSV">http://en.wikipedia.org/wiki/HSL_and_HSV</a>
54
54
  <code>{ x: h, y: s, z: l }</code></p>
55
55
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:200</li></ul></aside></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/particle/particle.ts:114</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="opacityBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>opacity<wbr/>Base</span><a href="#opacityBase" 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">opacity<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>透明度</p>
56
56
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:203</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="opacitySpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>opacity<wbr/>Spread</span><a href="#opacitySpread" 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">opacity<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>透明度的扩散值</p>
@@ -62,7 +62,7 @@
62
62
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:124</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="positionCubeSpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>position<wbr/>Cube<wbr/>Spread</span><a href="#positionCubeSpread" 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">position<wbr/>Cube<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector3</span></div><div class="tsd-comment tsd-typography"><p>粒子坐标的抖动<code>CUBE</code>计算形式下的扩散值</p>
63
63
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:135</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="positionSphereSpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>position<wbr/>Sphere<wbr/>Spread</span><a href="#positionSphereSpread" 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">position<wbr/>Sphere<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子坐标的抖动<code>SPHERE</code>计算形式下的扩散值</p>
64
64
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:137</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="positionStyle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>position<wbr/>Style</span><a href="#positionStyle" 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">position<wbr/>Style</span><span class="tsd-signature-symbol">:</span> <a href="../types/vfx.ParticleType.html" class="tsd-signature-type tsd-kind-type-alias">ParticleType</a></div><div class="tsd-comment tsd-typography"><p>粒子坐标的抖动计算形式</p>
65
- </div><div class="tsd-comment tsd-typography"><h4>Description</h4><p>粒子坐标的抖动计算形式，分 <code>CUBE</code> 和 <code>SPHERE</code> 形式。
65
+ </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-3" class="tsd-anchor"></a>Description<a href="#Description-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>粒子坐标的抖动计算形式，分 <code>CUBE</code> 和 <code>SPHERE</code> 形式。
66
66
  <code>CUBE</code> 形式通过一个 三维向量 的扩散值 positionCubeSpread，乘上一个 [0, 1] 的随机三维向量 计算。
67
67
  <code>SPHERE</code> 形式通过一个 数字 的扩散值 positionSphereSpread，乘上一个随机单位向量 计算。</p>
68
68
  </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:133</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sizeBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>size<wbr/>Base</span><a href="#sizeBase" 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">size<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子大小</p>
@@ -73,14 +73,14 @@
73
73
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:150</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="velocitySphereBase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>velocity<wbr/>Sphere<wbr/>Base</span><a href="#velocitySphereBase" 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">velocity<wbr/>Sphere<wbr/>Base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子速度的<code>SPHERE</code>计算形式下的速度值</p>
74
74
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:152</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="velocitySphereSpread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>velocity<wbr/>Sphere<wbr/>Spread</span><a href="#velocitySphereSpread" 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">velocity<wbr/>Sphere<wbr/>Spread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>粒子速度的<code>SPHERE</code>计算形式下的扩散值</p>
75
75
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:154</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="velocityStyle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>velocity<wbr/>Style</span><a href="#velocityStyle" 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">velocity<wbr/>Style</span><span class="tsd-signature-symbol">:</span> <a href="../types/vfx.ParticleType.html" class="tsd-signature-type tsd-kind-type-alias">ParticleType</a></div><div class="tsd-comment tsd-typography"><p>粒子速度的抖动计算形式</p>
76
- </div><div class="tsd-comment tsd-typography"><h4>Description</h4><p>粒子速度的抖动计算形式，分 <code>CUBE</code> 和 <code>SPHERE</code> 形式。
76
+ </div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-4" class="tsd-anchor"></a>Description<a href="#Description-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>粒子速度的抖动计算形式，分 <code>CUBE</code> 和 <code>SPHERE</code> 形式。
77
77
  <code>CUBE</code> 形式通过一个 三维向量 的速度值 velocityCubeBase 加上 三维向量 的扩散值 velocityCubeSpread 乘上一个 [0, 1] 的随机三维向量 计算。
78
78
  <code>SPHERE</code> 形式通过一个 数字 的速度值 velocitySphereBase 加上 数字 的扩散值 velocitySphereSpread 乘上 粒子坐标与粒子的初始位置坐标方向的单位向量 计算。</p>
79
- </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:146</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="blending" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>blending</span><a href="#blending" 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="blending.blending-1"><span class="tsd-signature-keyword">get</span> blending<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blending</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>材质混合方式</p>
79
+ </div><aside class="tsd-sources"><ul><li>Defined in lib/vfx/particle/particle.ts:146</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="blending" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>blending</span><a href="#blending" 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="blending.blending-1"><span class="tsd-signature-keyword">get</span> blending<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Blending</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>材质混合方式</p>
80
80
  </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/particle.ts:293</li></ul></aside></li><li class="tsd-signature" id="blending.blending-2"><span class="tsd-signature-keyword">set</span> blending<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">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/particle.ts:296</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="texture" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>texture</span><a href="#texture" 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="texture.texture-1"><span class="tsd-signature-keyword">get</span> texture<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Texture</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>贴图素材</p>
81
- </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/particle.ts:273</li></ul></aside></li><li class="tsd-signature" id="texture.texture-2"><span class="tsd-signature-keyword">set</span> texture<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">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/particle.ts:277</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="dispose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dispose</span><a href="#dispose" 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="dispose.dispose-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#dispose.dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>析构</p>
81
+ </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/particle.ts:273</li></ul></aside></li><li class="tsd-signature" id="texture.texture-2"><span class="tsd-signature-keyword">set</span> texture<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">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/particle.ts:277</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="dispose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dispose</span><a href="#dispose" 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="dispose.dispose-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dispose</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#dispose.dispose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>析构</p>
82
82
  </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/particle.ts:475</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" 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="pause.pause-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#pause.pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>暂停</p>
83
83
  </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/particle.ts:354</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="play" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play</span><a href="#play" 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="play.play-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#play.play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>开始</p>
84
84
  </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/particle.ts:363</li></ul></aside></li></ul></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-comment tsd-typography"><p>通过 Five 默认调用的 setTime 方法</p>
85
85
  </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>
86
- </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/particle.ts:375</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#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><a href="#accelerationBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Base</span></a><a href="#accelerationSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Spread</span></a><a href="#angleAccelerationBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Acceleration<wbr/>Base</span></a><a href="#angleAccelerationSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Acceleration<wbr/>Spread</span></a><a href="#angleBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Base</span></a><a href="#angleSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Spread</span></a><a href="#angleVelocityBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Velocity<wbr/>Base</span></a><a href="#angleVelocitySpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Velocity<wbr/>Spread</span></a><a href="#colorBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color<wbr/>Base</span></a><a href="#colorSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color<wbr/>Spread</span></a><a href="#colorTween" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color<wbr/>Tween</span></a><a href="#needsRender" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render</span></a><a href="#opacityBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity<wbr/>Base</span></a><a href="#opacitySpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity<wbr/>Spread</span></a><a href="#opacityTween" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity<wbr/>Tween</span></a><a href="#particleDeathAge" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particle<wbr/>Death<wbr/>Age</span></a><a href="#particlesPerSecond" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particles<wbr/>Per<wbr/>Second</span></a><a href="#paused" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paused</span></a><a href="#positionBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Base</span></a><a href="#positionCubeSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Cube<wbr/>Spread</span></a><a href="#positionSphereSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Sphere<wbr/>Spread</span></a><a href="#positionStyle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Style</span></a><a href="#sizeBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Base</span></a><a href="#sizeSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Spread</span></a><a href="#sizeTween" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Tween</span></a><a href="#velocityCubeBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Cube<wbr/>Base</span></a><a href="#velocityCubeSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Cube<wbr/>Spread</span></a><a href="#velocitySphereBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Sphere<wbr/>Base</span></a><a href="#velocitySphereSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Sphere<wbr/>Spread</span></a><a href="#velocityStyle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Style</span></a><a href="#blending" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>blending</span></a><a href="#texture" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>texture</span></a><a href="#dispose" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispose</span></a><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a><a href="#play" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a><a href="#setTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time</span></a></div></details></div><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>
86
+ </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/particle.ts:375</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="#accelerationBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Base</span></a><a href="#accelerationSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>acceleration<wbr/>Spread</span></a><a href="#angleAccelerationBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Acceleration<wbr/>Base</span></a><a href="#angleAccelerationSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Acceleration<wbr/>Spread</span></a><a href="#angleBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Base</span></a><a href="#angleSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Spread</span></a><a href="#angleVelocityBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Velocity<wbr/>Base</span></a><a href="#angleVelocitySpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle<wbr/>Velocity<wbr/>Spread</span></a><a href="#colorBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color<wbr/>Base</span></a><a href="#colorSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color<wbr/>Spread</span></a><a href="#colorTween" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>color<wbr/>Tween</span></a><a href="#needsRender" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>needs<wbr/>Render</span></a><a href="#opacityBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity<wbr/>Base</span></a><a href="#opacitySpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity<wbr/>Spread</span></a><a href="#opacityTween" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity<wbr/>Tween</span></a><a href="#particleDeathAge" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particle<wbr/>Death<wbr/>Age</span></a><a href="#particlesPerSecond" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>particles<wbr/>Per<wbr/>Second</span></a><a href="#paused" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paused</span></a><a href="#positionBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Base</span></a><a href="#positionCubeSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Cube<wbr/>Spread</span></a><a href="#positionSphereSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Sphere<wbr/>Spread</span></a><a href="#positionStyle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position<wbr/>Style</span></a><a href="#sizeBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Base</span></a><a href="#sizeSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Spread</span></a><a href="#sizeTween" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size<wbr/>Tween</span></a><a href="#velocityCubeBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Cube<wbr/>Base</span></a><a href="#velocityCubeSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Cube<wbr/>Spread</span></a><a href="#velocitySphereBase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Sphere<wbr/>Base</span></a><a href="#velocitySphereSpread" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Sphere<wbr/>Spread</span></a><a href="#velocityStyle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>velocity<wbr/>Style</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="#blending" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>blending</span></a><a href="#texture" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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="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="#dispose" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dispose</span></a><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a><a href="#play" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a><a href="#setTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Time</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Five SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
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-index-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>
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
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
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
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
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
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><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><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><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><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><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><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><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><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></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#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><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><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><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><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>
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>
package/docs/documents/coordinate.html ADDED
@@ -0,0 +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>
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>
4
+ <p>可以认为是相对于 <code>Y</code> 轴为轴旋转的角度，Five中返回的 longitude 必定在 [0, 2PI) 这个区间内，但是方法调用是传入的可以随意。</p>
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>
7
+ <p>可以认为是相对于 <code>ZX</code> 平面的夹角，Five中返回的 latitude 必定在 [-PI, PI]这个区间内，但是方法调用是传入的可以随意。</p>
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>