@realsee/five 6.7.0-alpha.2 → 6.7.0-alpha.20

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 (195) hide show
  1. package/docs/assets/hierarchy.js +1 -1
  2. package/docs/assets/navigation.js +1 -1
  3. package/docs/assets/search.js +1 -1
  4. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  5. package/docs/classes/five.BoundingMesh.html +4 -0
  6. package/docs/classes/five.Camera.html +5 -5
  7. package/docs/classes/five.Five.html +55 -42
  8. package/docs/classes/five.FivePass.html +20 -0
  9. package/docs/classes/five.FullScreenQuad.html +7 -0
  10. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  11. package/docs/classes/five.Model.html +32 -31
  12. package/docs/classes/five.ModelScene.html +22 -20
  13. package/docs/classes/five.NetworkSubscribe.html +1 -1
  14. package/docs/classes/five.PBMContainer.html +1 -1
  15. package/docs/classes/five.PBMGroup.html +1 -1
  16. package/docs/classes/five.PBMMesh.html +1 -1
  17. package/docs/classes/five.PBMMeshMaterial.html +1 -1
  18. package/docs/classes/five.PBMPointCloud.html +1 -1
  19. package/docs/classes/five.PBMPointCloudMaterial.html +1 -1
  20. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  21. package/docs/classes/five.PanoCircleMesh.html +1 -1
  22. package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
  23. package/docs/classes/five.PanoCircleMeshSolid.html +5 -5
  24. package/docs/classes/five.Parameter.html +1 -1
  25. package/docs/classes/five.Pass.html +11 -0
  26. package/docs/classes/five.Scene.html +1 -1
  27. package/docs/classes/five.Subscribe.html +1 -1
  28. package/docs/classes/five.Tile3D.html +21 -21
  29. package/docs/classes/five.TileNode.html +2 -2
  30. package/docs/classes/five.TrajectoryNode.html +1 -1
  31. package/docs/classes/five.Work.html +16 -16
  32. package/docs/classes/five.WorkResolvedObserver.html +20 -21
  33. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  34. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  35. package/docs/classes/gltf-loader.GLTFLoader.html +1 -1
  36. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  37. package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
  38. package/docs/classes/line.Line.html +1 -1
  39. package/docs/classes/line.LineGeometry.html +1 -1
  40. package/docs/classes/line.LineMaterial.html +1 -1
  41. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  42. package/docs/classes/line.THREE_Line2.html +1 -1
  43. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  44. package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
  45. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  46. package/docs/classes/sticker.Sticker.html +1 -1
  47. package/docs/classes/vfx.Airflow.html +1 -1
  48. package/docs/classes/vfx.Flame.html +1 -1
  49. package/docs/classes/vfx.Particle.html +1 -1
  50. package/docs/classes/vfx.ParticleGPU.html +1 -1
  51. package/docs/classes/vfx.SpotLight.html +1 -1
  52. package/docs/functions/five.parseWork.html +1 -1
  53. package/docs/functions/five.workToJson.html +1 -1
  54. package/docs/functions/plugins.DynamicPathLinePlugin.html +1 -0
  55. package/docs/functions/vue.useFiveWorks.html +2 -2
  56. package/docs/hierarchy.html +1 -1
  57. package/docs/interfaces/five.AddableObject.html +1 -1
  58. package/docs/interfaces/five.AjaxOptions.html +1 -1
  59. package/docs/interfaces/five.BaseEvent.html +1 -1
  60. package/docs/interfaces/five.EventCallback.html +1 -1
  61. package/docs/interfaces/five.FiveLoadOptions.html +8 -10
  62. package/docs/interfaces/five.GestureEvent.html +1 -1
  63. package/docs/interfaces/five.ImageOptions.html +1 -1
  64. package/docs/interfaces/five.IntersectEvent.html +1 -1
  65. package/docs/interfaces/five.IntersectMesh.html +1 -1
  66. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  67. package/docs/interfaces/five.Intersection.html +1 -1
  68. package/docs/interfaces/five.LoosePanoWork.html +2 -2
  69. package/docs/interfaces/five.LooseWork.html +2 -2
  70. package/docs/interfaces/five.LooseWorkInitial.html +2 -2
  71. package/docs/interfaces/five.LooseWorkModel.html +4 -2
  72. package/docs/interfaces/five.LooseWorkObserver.html +3 -2
  73. package/docs/interfaces/five.LooseWorkPanorama.html +8 -8
  74. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +7 -7
  75. package/docs/interfaces/five.ModeChangeEvent.html +1 -1
  76. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +5 -3
  77. package/docs/interfaces/five.ModelEvent.html +1 -1
  78. package/docs/interfaces/five.ModelOptions.html +11 -0
  79. package/docs/interfaces/five.ModelSceneEvent.html +1 -1
  80. package/docs/interfaces/five.MovePanoOptions.html +9 -7
  81. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  82. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  83. package/docs/interfaces/five.NetworkOptions.html +1 -1
  84. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  85. package/docs/interfaces/five.NetworkResourceEvent.html +1 -1
  86. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  87. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  88. package/docs/interfaces/five.ObjectEvent.html +1 -1
  89. package/docs/interfaces/five.PBMMaterial.html +1 -1
  90. package/docs/interfaces/five.PBMMeshMaterialParameters.html +1 -1
  91. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +1 -1
  92. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  93. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +2 -2
  94. package/docs/interfaces/five.PanoEvent.html +1 -1
  95. package/docs/interfaces/five.PanoTextureEvent.html +1 -1
  96. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +12 -10
  97. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +5 -3
  98. package/docs/interfaces/five.ParameterMaterialValue.html +1 -1
  99. package/docs/interfaces/five.ParameterTilesetValue.html +1 -1
  100. package/docs/interfaces/five.ParameterValue.html +1 -1
  101. package/docs/interfaces/five.Pose.html +1 -1
  102. package/docs/interfaces/five.RenderEvent.html +1 -1
  103. package/docs/interfaces/five.ResolvedParameterValue.html +1 -1
  104. package/docs/interfaces/five.State.html +1 -1
  105. package/docs/interfaces/five.StateEvent.html +1 -1
  106. package/docs/interfaces/five.TextureOptions.html +1 -1
  107. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  108. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +12 -10
  109. package/docs/interfaces/five.ViewLayer.html +21 -21
  110. package/docs/interfaces/five.WorkCubeImage.html +2 -2
  111. package/docs/interfaces/five.WorkImage.html +5 -3
  112. package/docs/interfaces/five.WorkInitial.html +8 -8
  113. package/docs/interfaces/five.WorkModel.html +11 -7
  114. package/docs/interfaces/five.WorkModelJson.html +3 -2
  115. package/docs/interfaces/five.WorkModelLayer.html +7 -2
  116. package/docs/interfaces/five.WorkModelLayerJson.html +2 -2
  117. package/docs/interfaces/five.WorkObserver.html +21 -22
  118. package/docs/interfaces/five.WorkObserverJson.html +4 -2
  119. package/docs/interfaces/five.WorkPanoramaJson.html +2 -2
  120. package/docs/interfaces/five.WorkPanoramasJson.html +2 -2
  121. package/docs/interfaces/five.WorkTile.html +4 -4
  122. package/docs/interfaces/five.WorkVideo.html +4 -4
  123. package/docs/interfaces/five.WorksEvent.html +1 -1
  124. package/docs/interfaces/five.XRControllerEvent.html +1 -1
  125. package/docs/interfaces/five.XRGestureEvent.html +1 -1
  126. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +12 -10
  127. package/docs/interfaces/five.XRSessionEvent.html +1 -1
  128. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  129. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  130. package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
  131. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +82 -0
  132. package/docs/interfaces/plugins.DynamicPathLinePluginType.Config.html +36 -0
  133. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +26 -0
  134. package/docs/interfaces/plugins.DynamicPathLinePluginType.Params.html +6 -0
  135. package/docs/interfaces/plugins.DynamicPathLinePluginType.PathConfig.html +26 -0
  136. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +10 -0
  137. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  138. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  139. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
  140. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  141. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  142. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  143. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  144. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  145. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  146. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  147. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  148. package/docs/interfaces/plugins.TrajectoryController.html +1 -1
  149. package/docs/interfaces/react.FiveInjectionTypes.html +1 -1
  150. package/docs/modules/five.html +1 -1
  151. package/docs/modules/plugins.DynamicPathLinePluginType.html +1 -0
  152. package/docs/modules/plugins.html +1 -1
  153. package/docs/types/five.Models.html +4 -4
  154. package/docs/types/five.MovePanoEffect.html +3 -2
  155. package/docs/types/five.ParseOptions.html +6 -6
  156. package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
  157. package/docs/types/plugins.DynamicPathLinePluginType.PluginData.html +3 -0
  158. package/docs/types/plugins.DynamicPathLinePluginType.ServerData.html +3 -0
  159. package/docs/types/vue.FiveProviderComponent.html +1 -1
  160. package/five/index.d.ts +201 -45
  161. package/five/index.js +108 -76
  162. package/five/index.mjs +3962 -3482
  163. package/gltf-loader/index.js +3 -3
  164. package/gltf-loader/index.mjs +3 -3
  165. package/line/index.js +3 -3
  166. package/line/index.mjs +3 -3
  167. package/package.json +1 -1
  168. package/plugins/index.d.ts +307 -0
  169. package/plugins/index.js +294 -15
  170. package/plugins/index.mjs +2457 -1385
  171. package/react/index.js +2 -2
  172. package/react/index.mjs +2 -2
  173. package/shader-lib/index.d.ts +24 -1
  174. package/shader-lib/index.js +14 -13
  175. package/shader-lib/index.mjs +433 -205
  176. package/sticker/index.js +3 -3
  177. package/sticker/index.mjs +3 -3
  178. package/umd/five-gltf-loader.js +3 -3
  179. package/umd/five-line.js +3 -3
  180. package/umd/five-plugins.js +294 -15
  181. package/umd/five-react.js +2 -2
  182. package/umd/five-shader-lib.js +14 -13
  183. package/umd/five-sticker.js +3 -3
  184. package/umd/five-vfx.js +2 -2
  185. package/umd/five-vue.js +2 -2
  186. package/umd/five.js +108 -76
  187. package/vfx/index.js +2 -2
  188. package/vfx/index.mjs +2 -2
  189. package/vue/index.d.ts +1 -1
  190. package/vue/index.js +2 -2
  191. package/vue/index.mjs +2 -2
  192. package/work-downloader/index.js +3 -3
  193. package/work-downloader/index.mjs +309 -257
  194. package/docs/interfaces/five.ModelLike.html +0 -3
  195. package/docs/types/five.Tile3dOptions.html +0 -1
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServerData | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/plugins.html">plugins</a></li><li><a href="../modules/plugins.DynamicPathLinePluginType.html">DynamicPathLinePluginType</a></li><li><a href="" aria-current="page">ServerData</a></li></ul><h1>Type Alias ServerData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>服务端数据</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ServerData</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#paths">paths</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">enableSubMesh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">lineWidth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">points</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">z</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">range</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">speed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">subMeshColor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">subMeshOpacity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">subMeshWidth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">visible</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/plugins/DynamicPathLinePlugin/typing.ts:38</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#paths" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a>
3
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="paths"><span>paths</span><a href="#paths" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">paths</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">color</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">enableSubMesh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">lineWidth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">points</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">z</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">range</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">speed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">subMeshColor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">subMeshOpacity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">subMeshWidth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">visible</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in lib/plugins/DynamicPathLinePlugin/typing.ts:39</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#paths"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>paths</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FiveProviderComponent | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/vue.html">vue</a></li><li><a href="" aria-current="page">FiveProviderComponent</a></li></ul><h1>Type Alias FiveProviderComponent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">FiveProviderComponent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">fiveInitArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.FiveInitArgs.html" class="tsd-signature-type tsd-kind-interface">FiveInitArgs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;renderer&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;scissor&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">initialState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><br/>            <span class="tsd-signature-type">&quot;inherit&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;initial&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">initialUserAction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BooleanConstructor</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">initialWorks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onCurrentStateChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><br/>            <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onStateChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onWorksChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">work</span><span class="tsd-signature-symbol">:</span> <a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">style</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ObjectConstructor</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">works</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">five</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveProvider.ts:37</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FiveProviderComponent | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/vue.html">vue</a></li><li><a href="" aria-current="page">FiveProviderComponent</a></li></ul><h1>Type Alias FiveProviderComponent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">FiveProviderComponent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">fiveInitArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">default</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.FiveInitArgs.html" class="tsd-signature-type tsd-kind-interface">FiveInitArgs</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;renderer&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;scissor&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">initialState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><br/>            <span class="tsd-signature-type">&quot;inherit&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;initial&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">initialUserAction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BooleanConstructor</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">initialWorks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onCurrentStateChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><br/>            <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onError</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onStateChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">onWorksChange</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">work</span><span class="tsd-signature-symbol">:</span> <a href="five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">style</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ObjectConstructor</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">works</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">five</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveProvider.ts:37</li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/five/index.d.ts CHANGED
@@ -75,6 +75,14 @@ export declare interface BaseEvent {
75
75
  defaultPrevented: boolean;
76
76
  }
77
77
 
78
+ export declare class BoundingMesh extends PBMMesh {
79
+ constructor(options?: {
80
+ name?: string;
81
+ });
82
+ update(renderer: THREE_2.WebGLRenderer, camera: Camera, modelScene: ModelScene): boolean;
83
+ dispose(): void;
84
+ }
85
+
78
86
  export declare interface BoundingVolume {
79
87
  type: 'box' | 'sphere' | 'regin';
80
88
  applyMatrix4(matrix: THREE_2.Matrix4): this;
@@ -540,9 +548,7 @@ export declare class Five extends Subscribe<EventTypes> {
540
548
  plugins: {
541
549
  [key: string]: FivePluginInstance<any>;
542
550
  };
543
- ident: string;
544
- /** 包围盒子 */
545
- private boundingMesh;
551
+ readonly fiveId: string;
546
552
  private stopAnimationLoop?;
547
553
  private fps;
548
554
  private helperGroup;
@@ -566,6 +572,7 @@ export declare class Five extends Subscribe<EventTypes> {
566
572
  private _builtinRenderer;
567
573
  private _buildInRendererType;
568
574
  constructor(initArgs?: FiveInitArgs);
575
+ get ident(): string;
569
576
  get panoIndex(): number;
570
577
  /**
571
578
  * 析构 five 对象。
@@ -586,6 +593,10 @@ export declare class Five extends Subscribe<EventTypes> {
586
593
  * ```
587
594
  */
588
595
  setViewport(viewport: Viewport): void;
596
+ /**
597
+ * 获取 boundingMesh
598
+ */
599
+ get boundingMesh(): BoundingMesh;
589
600
  /**
590
601
  * 帮助元素显示/隐藏
591
602
  */
@@ -807,7 +818,8 @@ export declare class Five extends Subscribe<EventTypes> {
807
818
  */
808
819
  exitFullscreen(): void;
809
820
  private throwError;
810
- private loadModels;
821
+ private bindModel;
822
+ private bindWorkFetcher;
811
823
  private commonParams;
812
824
  private applyController;
813
825
  /** 移除事件绑定 */
@@ -848,6 +860,22 @@ export declare class Five extends Subscribe<EventTypes> {
848
860
  phi: number;
849
861
  lookAtVector: THREE_2.Vector3;
850
862
  };
863
+ /**
864
+ * 增加后处理PASS
865
+ * @param pass - 要添加的Pass实例
866
+ */
867
+ addPass(pass: Pass): void;
868
+ /**
869
+ * 移除后处理Pass
870
+ * @param pass - 要移除的Pass实例
871
+ */
872
+ removePass(pass: Pass): void;
873
+ /**
874
+ * 在指定位置插入后处理Pass
875
+ * @param pass - 要插入的Pass实例
876
+ * @param index - 插入位置的索引
877
+ */
878
+ insertPass(pass: Pass, index: number): void;
851
879
  /**
852
880
  * @deprecated
853
881
  * use five.effect instead
@@ -1045,32 +1073,45 @@ export declare interface FiveInitArgs {
1045
1073
  }
1046
1074
 
1047
1075
  export declare interface FiveLoadOptions {
1076
+ /** 替换 / 追加 */
1077
+ mode?: 'replace' | "add";
1048
1078
  /** 切换运动时间 */
1049
1079
  duration?: number;
1050
1080
  /** 切换运动全景图效果 */
1051
1081
  effect?: MovePanoEffect;
1052
- model?: {
1053
- light?: boolean;
1054
- /**
1055
- * 模型贴图的配置参数
1056
- * @description
1057
- * 可以动态对配置在 `work` 数据中的模型贴图在 runtime 做 url 调整。
1058
- * 平衡加载时间和图片质量
1059
- */
1060
- textureOptions?: TextureOptions;
1061
- /** 模型 3d-tile 参数 */
1062
- "3d-tiles"?: Tile3dOptions;
1063
- };
1082
+ model?: ModelOptions;
1064
1083
  /**
1065
1084
  * @deprecated
1066
1085
  * 请通过 model.textureOptions 设置
1067
1086
  */
1068
- textureOptions?: TextureOptions;
1087
+ textureOptions?: ModelOptions['textureOptions'];
1069
1088
  /**
1070
1089
  * @deprecated
1071
1090
  * 请通过 model.textureOptions 设置
1072
1091
  */
1073
- "3d-tiles"?: Tile3dOptions;
1092
+ "3d-tiles"?: ModelOptions['3d-tiles'];
1093
+ }
1094
+
1095
+ /**
1096
+ * FivePass
1097
+ *
1098
+ * Five引擎优化的Pass基类
1099
+ * 支持G-Buffer注入,避免重复渲染场景
1100
+ */
1101
+ export declare class FivePass extends Pass {
1102
+ dependencies: ('depth' | 'normal' | 'color')[];
1103
+ constructor(dependencies?: ['depth' | 'normal' | 'color']);
1104
+ /**
1105
+ * G-Buffer纹理集合
1106
+ * 包含depth、normal、color等纹理
1107
+ * 由EffectComposer在render时注入
1108
+ */
1109
+ gbuffer?: Map<'depth' | 'normal' | 'color', THREE_2.Texture>;
1110
+ /**
1111
+ * 设置G-Buffer
1112
+ * @param gbuffer - G-Buffer纹理集合
1113
+ */
1114
+ setGBuffer(gbuffer: Map<'depth' | 'normal' | 'color', THREE_2.Texture>): void;
1074
1115
  }
1075
1116
 
1076
1117
  /**
@@ -1119,6 +1160,23 @@ export declare interface FloorplanControllerCustomInitArgs {
1119
1160
  intersectMeshCreator?: () => IntersectMeshInterface;
1120
1161
  }
1121
1162
 
1163
+ /**
1164
+ * FullScreenQuad
1165
+ *
1166
+ * 用于全屏渲染的辅助类
1167
+ */
1168
+ export declare class FullScreenQuad {
1169
+ private _mesh;
1170
+ private static camera;
1171
+ private static geometry;
1172
+ private _scene;
1173
+ constructor(material?: THREE_2.Material);
1174
+ get material(): THREE_2.Material | THREE_2.Material[];
1175
+ set material(value: THREE_2.Material | THREE_2.Material[]);
1176
+ dispose(): void;
1177
+ render(renderer: THREE_2.WebGLRenderer): void;
1178
+ }
1179
+
1122
1180
  export declare interface GestureEvent extends StateEvent {
1123
1181
  target: EventTarget | null;
1124
1182
  pointerType: 'touch' | 'pen' | 'mouse' | 'kinect';
@@ -1838,6 +1896,7 @@ export declare interface LooseWork {
1838
1896
  base_url?: string;
1839
1897
  pano_high_cube_base_url?: string;
1840
1898
  pano_cube_base_url?: string;
1899
+ pattern?: LooseWorkPanorama;
1841
1900
  info?: LooseWorkPanorama[];
1842
1901
  list?: LooseWorkPanorama[];
1843
1902
  };
@@ -1865,6 +1924,8 @@ export declare interface LooseWorkModel {
1865
1924
  file_url?: string;
1866
1925
  material_textures?: string[];
1867
1926
  material_base_url?: string;
1927
+ up_axis?: string;
1928
+ coordinate?: NonNullable<TilesetHeader['rootMeta']>['coordinate'];
1868
1929
  tiles?: {
1869
1930
  type?: 'point_cloud' | 'mesh' | string;
1870
1931
  name?: string;
@@ -1883,6 +1944,7 @@ export declare interface LooseWorkModel {
1883
1944
 
1884
1945
  export declare interface LooseWorkObserver {
1885
1946
  active?: boolean;
1947
+ loadable?: boolean;
1886
1948
  index?: number;
1887
1949
  visible_nodes?: number[];
1888
1950
  visibleNodes?: number[];
@@ -1904,10 +1966,16 @@ export declare interface LooseWorkObserver {
1904
1966
  derived_id_str?: string;
1905
1967
  }
1906
1968
 
1907
- export declare interface LooseWorkPanorama extends Record<CubeFace, string> {
1969
+ export declare interface LooseWorkPanorama {
1908
1970
  active?: boolean;
1909
1971
  loadable?: boolean;
1910
1972
  index?: number;
1973
+ right?: string;
1974
+ left?: string;
1975
+ up?: string;
1976
+ down?: string;
1977
+ front?: string;
1978
+ back?: string;
1911
1979
  video?: LooseWorkVideo;
1912
1980
  tiles?: number[];
1913
1981
  size_list?: number[];
@@ -2044,6 +2112,7 @@ export declare interface Model {
2044
2112
  * 通过 json_xxxxxx(<dataURL>) 方式返回。
2045
2113
  */
2046
2114
  export declare class Model extends THREE_2.Object3D {
2115
+ fiveId: string;
2047
2116
  parent: ModelScene | null;
2048
2117
  needsRender: boolean;
2049
2118
  children: ViewLayer[];
@@ -2065,14 +2134,14 @@ export declare class Model extends THREE_2.Object3D {
2065
2134
  /** 模型细化进度 */
2066
2135
  refineProgress: [number, number];
2067
2136
  /** 初始化完成 */
2068
- initReady: Promise<void>;
2137
+ initReady: Promise<Model>;
2069
2138
  /** 初次加载完成 */
2070
- loadedReady: Promise<void>;
2139
+ loadedReady: Promise<Model>;
2071
2140
  /** 外接盒子的大小 */
2072
2141
  boundingBox: THREE_2.Box3;
2073
2142
  /** 所有楼层 */
2074
2143
  floorLength: number;
2075
- constructor(work: Work, options?: {
2144
+ constructor(fiveId: string, work: Work, options?: {
2076
2145
  light?: boolean;
2077
2146
  textureOptions?: TextureOptions;
2078
2147
  });
@@ -2170,9 +2239,26 @@ export declare interface ModelEvent extends BaseEvent {
2170
2239
  error: Error | null;
2171
2240
  }
2172
2241
 
2173
- export declare interface ModelLike extends THREE_2.Object3D {
2174
- update?(renderer: THREE_2.WebGLRenderer, camera: Camera, modelScene: ModelScene): boolean;
2175
- dispose?: () => void;
2242
+ export declare interface ModelOptions {
2243
+ /** 模型是否感光 */
2244
+ light?: boolean;
2245
+ /** 模型 3d-tile 参数 */
2246
+ "3d-tiles"?: (Partial<ParameterTilesetValue> & {
2247
+ viewerRequestVolume?: BoundingVolume | BoundingVolumeJson;
2248
+ showLayers?: boolean | string[];
2249
+ }) | ((viewLayer: ViewLayer, model: Model) => void | (Partial<ParameterTilesetValue> & {
2250
+ viewerRequestVolume?: BoundingVolume | BoundingVolumeJson;
2251
+ showLayers?: boolean | string[];
2252
+ }));
2253
+ /**
2254
+ * 模型贴图的配置参数
2255
+ * @description
2256
+ * 可以动态对配置在 `work` 数据中的模型贴图在 runtime 做 url 调整。
2257
+ * 平衡加载时间和图片质量
2258
+ */
2259
+ textureOptions?: TextureOptions;
2260
+ /** 强制显示模型,不等待加载完 */
2261
+ forceReplaceImmediately?: boolean;
2176
2262
  }
2177
2263
 
2178
2264
  export declare type Models = Model[] & {
@@ -2228,13 +2314,48 @@ export declare type Models = Model[] & {
2228
2314
  resetBrightness(): void;
2229
2315
  };
2230
2316
 
2317
+ export declare interface ModelScene {
2318
+ dispatchEvent(event: {
2319
+ type: 'model.create';
2320
+ model: Model;
2321
+ }): void;
2322
+ dispatchEvent(event: {
2323
+ type: 'model.dispose';
2324
+ model: Model;
2325
+ }): void;
2326
+ dispatchEvent(event: {
2327
+ type: string;
2328
+ [attachment: string]: any;
2329
+ }): void;
2330
+ addEventListener(type: 'model.create', listener: (event: THREE_2.Event & {
2331
+ type: 'model.create';
2332
+ model: Model;
2333
+ }) => void): void;
2334
+ addEventListener(type: 'model.dispose', listener: (event: THREE_2.Event & {
2335
+ type: 'model.dispose';
2336
+ model: Model;
2337
+ }) => void): void;
2338
+ addEventListener(type: string, listener: (event: THREE_2.Event) => void): void;
2339
+ removeEventListener(type: 'model.create', listener: (event: THREE_2.Event & {
2340
+ type: 'model.create';
2341
+ model: Model;
2342
+ }) => void): void;
2343
+ removeEventListener(type: 'model.dispose', listener: (event: THREE_2.Event & {
2344
+ type: 'model.dispose';
2345
+ model: Model;
2346
+ }) => void): void;
2347
+ removeEventListener(type: string, listener: (event: THREE_2.Event) => void): void;
2348
+ }
2349
+
2231
2350
  export declare class ModelScene extends THREE_2.Scene {
2351
+ fiveId: string;
2232
2352
  needsRender: boolean;
2233
- children: ModelLike[];
2234
2353
  /** 自动细化 */
2235
2354
  autoRefine: boolean;
2236
2355
  /** 包围盒 */
2237
2356
  boundingBox: THREE_2.Box3;
2357
+ /** 包围盒 Mesh */
2358
+ boundingMesh: BoundingMesh;
2238
2359
  /** 加载完成 */
2239
2360
  loaded: boolean;
2240
2361
  /** 细化完成 */
@@ -2245,9 +2366,12 @@ export declare class ModelScene extends THREE_2.Scene {
2245
2366
  parameter: Parameter;
2246
2367
  /** 模型列表 */
2247
2368
  readonly models: Models;
2248
- constructor();
2249
- add(...objects: ModelLike[]): this;
2250
- remove(...objects: ModelLike[]): this;
2369
+ private readonly shownModels;
2370
+ private updateModelMap;
2371
+ constructor(options: {
2372
+ fiveId: string;
2373
+ });
2374
+ setModels(works: Works, options: ModelOptions): Model[];
2251
2375
  /**
2252
2376
  * 计算模型射线碰撞检测
2253
2377
  * @param raycaster - THREE 射线对象
@@ -2276,6 +2400,7 @@ export declare class ModelScene extends THREE_2.Scene {
2276
2400
  * Use `.parameter.reset('brightness')` instead
2277
2401
  */
2278
2402
  resetBrightness(): void;
2403
+ dispose(): void;
2279
2404
  }
2280
2405
 
2281
2406
  export declare interface ModelSceneEvent extends BaseEvent {
@@ -2333,8 +2458,9 @@ export declare type MotionValue<K extends string> = Record<K, number>;
2333
2458
  * - `spread` 通过扩散方式变化
2334
2459
  * - `zoomin` 通过放大变化
2335
2460
  * - `zoomout` 通过缩小变化
2461
+ * - `model` 通过过度到模型
2336
2462
  */
2337
- export declare type MovePanoEffect = "fly" | "instant" | "fade" | "montage" | "spread" | "zoomin" | "zoomout";
2463
+ export declare type MovePanoEffect = "fly" | "instant" | "fade" | "montage" | "spread" | "zoomin" | "zoomout" | "model";
2338
2464
 
2339
2465
  /**
2340
2466
  * 点位移动参数
@@ -2344,6 +2470,8 @@ export declare interface MovePanoOptions extends Partial<Omit<State, "offset" |
2344
2470
  * 动画模式
2345
2471
  */
2346
2472
  effect?: MovePanoEffect;
2473
+ /** 走点图片过度策略 */
2474
+ effectEasing?: (progress: number) => number;
2347
2475
  /**
2348
2476
  * 运动耗时
2349
2477
  * @description
@@ -2607,7 +2735,9 @@ export declare interface PanoramaControllerCustomInitArgs extends PanoramaLikeCo
2607
2735
  */
2608
2736
  panoTapTriggerRadius?: number;
2609
2737
  /** 地面观察点标识自定义创建器 */
2610
- panoCircleMeshCreator?: (pano: Pano) => PanoCircleMeshInterface;
2738
+ panoCircleMeshCreator?: (observer: WorkObserver, options: {
2739
+ aerialObserverMinHeight: number;
2740
+ }) => PanoCircleMeshInterface;
2611
2741
  /** 基于模型调整 地面观察点 的位置 */
2612
2742
  adjustPanoCircleMeshPositionBasedOnModel?: boolean;
2613
2743
  /**
@@ -2646,6 +2776,8 @@ export declare interface PanoramaLikeControllerCustomInitArgs {
2646
2776
  moveSpeed?: number;
2647
2777
  /** 鼠标焦点环自定义创建器 */
2648
2778
  intersectMeshCreator?: () => IntersectMeshInterface;
2779
+ /** 航拍点最小高度 */
2780
+ aerialObserverMinHeight?: number;
2649
2781
  }
2650
2782
 
2651
2783
  export declare function panoStringify(pano: Pano): PanoId;
@@ -2812,6 +2944,22 @@ export declare type ParseOptions = {
2812
2944
  */
2813
2945
  export declare function parseWork(obj: Work | LoosePanoWork | LooseWork | string | any, options?: ParseOptions): Work;
2814
2946
 
2947
+ /**
2948
+ * Pass基类
2949
+ *
2950
+ * three.js的Pass接口,用于EffectComposer
2951
+ */
2952
+ export declare class Pass {
2953
+ enabled: boolean;
2954
+ needsSwap: boolean;
2955
+ clear: boolean;
2956
+ renderToScreen: boolean;
2957
+ constructor();
2958
+ setSize(width: number, height: number): void;
2959
+ render(renderer: THREE_2.WebGLRenderer, writeBuffer: THREE_2.WebGLRenderTarget, readBuffer: THREE_2.WebGLRenderTarget, deltaTime?: number, maskActive?: boolean): void;
2960
+ static FullScreenQuad: typeof FullScreenQuad;
2961
+ }
2962
+
2815
2963
  export declare type PBMAlphaMode = 'OPAQUE' | 'MASK' | 'BLEND';
2816
2964
 
2817
2965
  export declare interface PBMClipperParameter {
@@ -3654,14 +3802,6 @@ declare interface Tile3DOptions {
3654
3802
  export { Tile3DOptions as Tile3DModelLoaderOptions }
3655
3803
  export { Tile3DOptions }
3656
3804
 
3657
- export declare type Tile3dOptions = (Partial<ParameterTilesetValue> & {
3658
- viewerRequestVolume?: BoundingVolume | BoundingVolumeJson;
3659
- showLayers?: boolean | string[];
3660
- }) | ((viewLayer: ViewLayer, model: Model, modelIndex: number) => void | (Partial<ParameterTilesetValue> & {
3661
- viewerRequestVolume?: BoundingVolume | BoundingVolumeJson;
3662
- showLayers?: boolean | string[];
3663
- }));
3664
-
3665
3805
  export declare class TileCache {
3666
3806
  private options;
3667
3807
  private cacheNodeMap;
@@ -4079,6 +4219,8 @@ export declare interface WorkImage extends WorkCubeImage {
4079
4219
  sizeList: readonly number[];
4080
4220
  /** 瓦片信息 */
4081
4221
  tiles: readonly WorkTile[];
4222
+ /** 点位视频 */
4223
+ video?: WorkVideo;
4082
4224
  }
4083
4225
 
4084
4226
  /** 初始化位姿参数 */
@@ -4133,6 +4275,10 @@ export declare interface WorkModel {
4133
4275
  textures?: readonly string[];
4134
4276
  /** 模型贴图文件地址的父目录 */
4135
4277
  textureBase?: string;
4278
+ /** 指定上方向,对于 obj, ply 等定义不明确的需要指定上方向 */
4279
+ upAxis?: string;
4280
+ /** 模型的地理坐标数据 */
4281
+ coordinate?: NonNullable<TilesetHeader['rootMeta']>['coordinate'];
4136
4282
  /** 3d tile */
4137
4283
  layers: readonly WorkModelLayer[];
4138
4284
  }
@@ -4141,14 +4287,20 @@ export declare interface WorkModelJson {
4141
4287
  file_url?: string;
4142
4288
  material_textures?: string[];
4143
4289
  material_base_url?: string;
4290
+ up_axis?: string;
4144
4291
  layers?: WorkModelLayerJson[];
4145
4292
  }
4146
4293
 
4147
4294
  export declare interface WorkModelLayer {
4295
+ /** work */
4148
4296
  work: Work;
4297
+ /** 模型类型 point_cloud mesh */
4149
4298
  type: 'point_cloud' | 'mesh';
4299
+ /** 模型名称 */
4150
4300
  name: string;
4301
+ /** 指定上方向 */
4151
4302
  upAxis: string;
4303
+ /** 如果 tileset.json 地址 */
4152
4304
  tileset: string;
4153
4305
  }
4154
4306
 
@@ -4172,22 +4324,24 @@ export declare interface WorkObserver {
4172
4324
  * @example
4173
4325
  * `${workCode}[${panoIndex}]`
4174
4326
  */
4175
- panoId: string;
4327
+ panoId: PanoId;
4176
4328
  /** 点位所在楼层 */
4177
4329
  floorIndex: number;
4178
4330
  /** 点位 derived_id */
4179
- derivedId?: number;
4331
+ derivedId: number;
4180
4332
  /** 点位 derived_id_str */
4181
- derivedIdStr?: string;
4333
+ derivedIdStr: string;
4182
4334
  /** 点位是否激活可用 */
4183
4335
  active: boolean;
4184
4336
  /** 点位是否可加载 */
4185
4337
  loadable: boolean;
4186
4338
  /** 点位全景图 */
4187
4339
  images: WorkImage;
4188
- /** 点位视频 */
4189
- video?: WorkVideo;
4190
- /** 可以看到的相关点位序号 */
4340
+ /**
4341
+ * @deprecated
4342
+ * 可以看到的相关点位序号
4343
+ * 数据和 accessibleNodes 一致,使用 accessibleNodes
4344
+ */
4191
4345
  visibleNodes: readonly number[];
4192
4346
  /** 可以连通的相关点位序号 */
4193
4347
  accessibleNodes: readonly number[];
@@ -4204,6 +4358,8 @@ export declare interface WorkObserver {
4204
4358
  export declare interface WorkObserverJson {
4205
4359
  index: number;
4206
4360
  floor_index: number;
4361
+ derived_id: number;
4362
+ derived_id_str: string;
4207
4363
  position: number[];
4208
4364
  standing_position: number[];
4209
4365
  quaternion: {