@realsee/five 6.0.0-alpha.37 → 6.0.0-alpha.39

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 (165) hide show
  1. package/docs/assets/search.js +1 -1
  2. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  3. package/docs/classes/five.BVH.html +1 -1
  4. package/docs/classes/five.BVHIntersect.html +1 -1
  5. package/docs/classes/five.BVHNode.html +1 -1
  6. package/docs/classes/five.BVHVector3.html +1 -1
  7. package/docs/classes/five.BoxBoundingVolume.html +1 -1
  8. package/docs/classes/five.Camera.html +6 -6
  9. package/docs/classes/five.Clipper.html +1 -1
  10. package/docs/classes/five.CullingVolume.html +1 -1
  11. package/docs/classes/five.Five.html +33 -33
  12. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  13. package/docs/classes/five.IntersectMesh.html +1 -1
  14. package/docs/classes/five.Model.html +23 -21
  15. package/docs/classes/five.NetworkSubscribe.html +1 -1
  16. package/docs/classes/five.PBMContainer.html +1 -1
  17. package/docs/classes/five.PBMGroup.html +1 -1
  18. package/docs/classes/five.PBMMaterialReferenceCache.html +1 -1
  19. package/docs/classes/five.PBMMesh.html +1 -1
  20. package/docs/classes/five.PBMMeshMaterial.html +8 -6
  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 +1 -1
  24. package/docs/classes/five.RegionBoundingVolume.html +1 -1
  25. package/docs/classes/five.RequestScheduler.html +1 -1
  26. package/docs/classes/five.Scene.html +1 -1
  27. package/docs/classes/five.SphereBoundingVolume.html +1 -1
  28. package/docs/classes/five.Subscribe.html +1 -1
  29. package/docs/classes/five.TextureLoader.html +1 -1
  30. package/docs/classes/five.Tile.html +1 -1
  31. package/docs/classes/five.Tile3DModel.html +1 -1
  32. package/docs/classes/five.TileCubeTextureTarget.html +1 -1
  33. package/docs/classes/five.TileNode.html +1 -1
  34. package/docs/classes/five.Tileset.html +3 -3
  35. package/docs/classes/five.TilesetCache.html +1 -1
  36. package/docs/classes/five.TilesetTraverser.html +1 -1
  37. package/docs/classes/five.Work.html +14 -12
  38. package/docs/classes/five.XRButton.html +1 -1
  39. package/docs/classes/gltf_loader.DDSLoader.html +1 -1
  40. package/docs/classes/gltf_loader.DRACOLoader.html +1 -1
  41. package/docs/classes/gltf_loader.GLTFLoader.html +1 -1
  42. package/docs/classes/gltf_loader.GLTFObject.html +1 -1
  43. package/docs/classes/gltf_loader.GLTFParser.html +1 -1
  44. package/docs/classes/gltf_loader.THREEGLTFLoader.html +1 -1
  45. package/docs/classes/line.Line.html +1 -1
  46. package/docs/classes/line.LineGeometry.html +1 -1
  47. package/docs/classes/line.LineMaterial.html +1 -1
  48. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  49. package/docs/classes/line.THREE_Line2.html +1 -1
  50. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  51. package/docs/classes/react.Store.html +1 -1
  52. package/docs/classes/sticker.Sticker.html +1 -1
  53. package/docs/classes/vfx.Airflow.html +1 -1
  54. package/docs/classes/vfx.Flame.html +1 -1
  55. package/docs/classes/vfx.Particle.html +1 -1
  56. package/docs/classes/vfx.SpotLight.html +1 -1
  57. package/docs/enums/five.VolumePlaneIntersect.html +1 -1
  58. package/docs/index.html +1 -1
  59. package/docs/interfaces/five.AddableObject.html +1 -1
  60. package/docs/interfaces/five.AnimationFrame.html +1 -1
  61. package/docs/interfaces/five.BaseEvent.html +1 -1
  62. package/docs/interfaces/five.BoundingVolume.html +1 -1
  63. package/docs/interfaces/five.CameraPose.html +1 -1
  64. package/docs/interfaces/five.ClipperParameter.html +1 -1
  65. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +1 -1
  66. package/docs/interfaces/five.EventCallback.html +1 -1
  67. package/docs/interfaces/five.FiveInitArgs.html +1 -1
  68. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +1 -1
  69. package/docs/interfaces/five.GestureEvent.html +1 -1
  70. package/docs/interfaces/five.ImageOptions.html +1 -1
  71. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  72. package/docs/interfaces/five.ImageURLOptions.html +1 -1
  73. package/docs/interfaces/five.IntersectEvent.html +1 -1
  74. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  75. package/docs/interfaces/five.Intersection.html +1 -1
  76. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +1 -1
  77. package/docs/interfaces/five.ModeChangeEvent.html +1 -1
  78. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  79. package/docs/interfaces/five.ModelEvent.html +1 -1
  80. package/docs/interfaces/five.ModelLodOptions.html +1 -1
  81. package/docs/interfaces/five.ModelsEvent.html +1 -1
  82. package/docs/interfaces/five.MotionKeyframe.html +1 -1
  83. package/docs/interfaces/five.MovePanoOptions.html +1 -1
  84. package/docs/interfaces/five.NetworkOptions.html +1 -1
  85. package/docs/interfaces/five.NetworkResourceEvent.html +1 -1
  86. package/docs/interfaces/five.ObjectEvent.html +1 -1
  87. package/docs/interfaces/five.PBMPanoPicture.html +1 -1
  88. package/docs/interfaces/five.PBMParameters.html +9 -7
  89. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +1 -1
  90. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  91. package/docs/interfaces/five.PanoCircleMeshOptions.html +1 -1
  92. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +1 -1
  93. package/docs/interfaces/five.PanoEvent.html +1 -1
  94. package/docs/interfaces/five.PanoTextureEvent.html +1 -1
  95. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  96. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  97. package/docs/interfaces/five.Pose.html +1 -1
  98. package/docs/interfaces/five.RenderEvent.html +1 -1
  99. package/docs/interfaces/five.Scissor.html +1 -1
  100. package/docs/interfaces/five.State.html +1 -1
  101. package/docs/interfaces/five.StateEvent.html +1 -1
  102. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
  103. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
  104. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
  105. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
  106. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
  107. package/docs/interfaces/five.SubscribeMixinType.waitUnitl.html +1 -1
  108. package/docs/interfaces/five.TextureOptions.html +1 -1
  109. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +2 -2
  110. package/docs/interfaces/five.TileCubeNode.html +1 -1
  111. package/docs/interfaces/five.TileCubeTree.html +1 -1
  112. package/docs/interfaces/five.TileHeader.html +1 -1
  113. package/docs/interfaces/five.TilesetHeader.html +1 -1
  114. package/docs/interfaces/five.TilesetOptions.html +1 -1
  115. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  116. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  117. package/docs/interfaces/five.WebXRAxesParams.html +1 -1
  118. package/docs/interfaces/five.WebXRControllerParams.html +1 -1
  119. package/docs/interfaces/five.WorkCubeImage.html +6 -6
  120. package/docs/interfaces/five.WorkImage.html +10 -10
  121. package/docs/interfaces/five.WorkInitial.html +9 -9
  122. package/docs/interfaces/five.WorkModel.html +6 -6
  123. package/docs/interfaces/five.WorkObserver.html +22 -20
  124. package/docs/interfaces/five.WorkOptions.html +10 -8
  125. package/docs/interfaces/five.WorkResolvedObserver.html +21 -19
  126. package/docs/interfaces/five.WorkTile.html +1 -1
  127. package/docs/interfaces/five.WorkVideo.html +4 -4
  128. package/docs/interfaces/five.WorksEvent.html +1 -1
  129. package/docs/interfaces/five.XRControllerEvent.html +1 -1
  130. package/docs/interfaces/five.XRGestureEvent.html +1 -1
  131. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  132. package/docs/interfaces/five.XRSessionEvent.html +1 -1
  133. package/docs/interfaces/gltf_loader.DDS.html +1 -1
  134. package/docs/interfaces/gltf_loader.GLTF.html +1 -1
  135. package/docs/interfaces/gltf_loader.GLTFReference.html +1 -1
  136. package/docs/interfaces/gltf_loader.THREEGLTF.html +1 -1
  137. package/docs/interfaces/react.FiveActionReactCallbacks.html +1 -1
  138. package/docs/interfaces/react.FiveInjectionTypes.html +4 -4
  139. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
  140. package/docs/interfaces/sticker.IntersectionLike.html +1 -1
  141. package/docs/interfaces/vfx.ParticleArgs.html +1 -1
  142. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +1 -1
  143. package/docs/interfaces/vue.FiveActionVueCallbacks.html +1 -1
  144. package/docs/modules/five.SubscribeMixinType.html +1 -1
  145. package/docs/modules/five.html +7 -5
  146. package/docs/modules/gltf_loader.html +1 -1
  147. package/docs/modules/line.html +1 -1
  148. package/docs/modules/react.html +1 -1
  149. package/docs/modules/sticker.html +1 -1
  150. package/docs/modules/vfx.html +1 -1
  151. package/docs/modules/vue.html +1 -1
  152. package/docs/modules.html +1 -1
  153. package/five/index.d.ts +92 -39
  154. package/five/index.js +5 -5
  155. package/gltf-loader/index.js +3 -3
  156. package/line/index.js +3 -3
  157. package/package.json +1 -1
  158. package/react/index.js +2 -2
  159. package/sticker/index.js +3 -3
  160. package/umd/five-gltf-loader.js +1 -1
  161. package/umd/five-line.js +1 -1
  162. package/umd/five-sticker.js +1 -1
  163. package/umd/five.js +1 -1
  164. package/vfx/index.js +2 -2
  165. package/vue/index.js +2 -2
package/docs/modules/vue.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>vue | 如视 Five SDK - v6.0.0-alpha.37</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.37"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v6.0.0-alpha.37</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Five SDK - v6.0.0-alpha.37</a></li><li><a href="vue.html">vue</a></li></ul><h1>Module vue </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>Vue<wbr/>Callbacks</a></li></ul></section><section class="tsd-index-section "><h3>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#FiveModelIntersectRaycaster" class="tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#FiveProviderComponent" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Component</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#Project2d" class="tsd-kind-icon">Project2d</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="vue.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="vue.html#FiveProvider" class="tsd-kind-icon">Five<wbr/>Provider</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#unsafe__useFiveInject" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Inject</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="vue.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModel" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelBounding" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Bounding</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveWorks" class="tsd-kind-icon">use<wbr/>Five<wbr/>Works</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type Aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveModelIntersectRaycaster" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<a href="#FiveModelIntersectRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveModelIntersectRaycaster.ts:7</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>raycaster: <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderComponent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Provider<wbr/>Component<a href="#FiveProviderComponent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>fiveInitArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<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" data-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>default<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>initialState<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">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><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" data-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">&gt;</span><span class="tsd-signature-symbol">; </span>initialUserAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BooleanConstructor</span><span class="tsd-signature-symbol">; </span>initialWorks<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" data-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" data-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>onCurrentStateChange<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-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<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><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onError<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-signature-symbol">(</span>error<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">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onStateChange<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-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<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><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onWorksChange<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-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-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">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ObjectConstructor</span><span class="tsd-signature-symbol">; </span>works<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" data-tsd-kind="Class">Work</a><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><span class="tsd-signature-symbol">{ </span>five<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" data-tsd-kind="Class">Five</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><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></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Project2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Project2d<a href="#Project2d" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Project2d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<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">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveProject2d.ts:5</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vector3: <span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>testModel: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Five<wbr/>Canvas<a href="#FiveCanvas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RendererNode</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">RendererElement</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><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PublicProps</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ExtractPropTypes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</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">&gt;</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></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveCanvas.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>vue | 如视 Five SDK - v6.0.0-alpha.39</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.39"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v6.0.0-alpha.39</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Five SDK - v6.0.0-alpha.39</a></li><li><a href="vue.html">vue</a></li></ul><h1>Module vue </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>Vue<wbr/>Callbacks</a></li></ul></section><section class="tsd-index-section "><h3>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#FiveModelIntersectRaycaster" class="tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#FiveProviderComponent" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Component</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#Project2d" class="tsd-kind-icon">Project2d</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="vue.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="vue.html#FiveProvider" class="tsd-kind-icon">Five<wbr/>Provider</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#unsafe__useFiveInject" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Inject</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="vue.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModel" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelBounding" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Bounding</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveWorks" class="tsd-kind-icon">use<wbr/>Five<wbr/>Works</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type Aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveModelIntersectRaycaster" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<a href="#FiveModelIntersectRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveModelIntersectRaycaster.ts:7</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>raycaster: <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderComponent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Provider<wbr/>Component<a href="#FiveProviderComponent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>fiveInitArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<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" data-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>default<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>initialState<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">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><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" data-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">&gt;</span><span class="tsd-signature-symbol">; </span>initialUserAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BooleanConstructor</span><span class="tsd-signature-symbol">; </span>initialWorks<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" data-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" data-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>onCurrentStateChange<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-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<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><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onError<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-signature-symbol">(</span>error<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">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onStateChange<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-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<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><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onWorksChange<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-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-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">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ObjectConstructor</span><span class="tsd-signature-symbol">; </span>works<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" data-tsd-kind="Class">Work</a><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><span class="tsd-signature-symbol">{ </span>five<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" data-tsd-kind="Class">Five</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><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></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Project2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Project2d<a href="#Project2d" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Project2d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<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">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveProject2d.ts:5</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vector3: <span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>testModel: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Five<wbr/>Canvas<a href="#FiveCanvas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RendererNode</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">RendererElement</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><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PublicProps</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ExtractPropTypes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<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">number</span><span class="tsd-signature-symbol">&gt;</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">&gt;</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></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveCanvas.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Five 渲染区域组件</p>
3
3
  </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Five 渲染区域组件，请在 FiveProvider 内使用</p>
4
4
  </dd><dt>param width</dt><dd><p>渲染区域的宽度</p>
package/docs/modules.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK - v6.0.0-alpha.37</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.37"/><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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v6.0.0-alpha.37</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> 如视 Five SDK - v6.0.0-alpha.37 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/five.html" class="tsd-kind-icon">five</a></li><li class="tsd-kind-module"><a href="modules/gltf_loader.html" class="tsd-kind-icon">gltf-<wbr/>loader</a></li><li class="tsd-kind-module"><a href="modules/line.html" class="tsd-kind-icon">line</a></li><li class="tsd-kind-module"><a href="modules/react.html" class="tsd-kind-icon">react</a></li><li class="tsd-kind-module"><a href="modules/sticker.html" class="tsd-kind-icon">sticker</a></li><li class="tsd-kind-module"><a href="modules/vfx.html" class="tsd-kind-icon">vfx</a></li><li class="tsd-kind-module"><a href="modules/vue.html" class="tsd-kind-icon">vue</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/five.html">five</a></li><li class=" tsd-kind-module"><a href="modules/gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="modules/line.html">line</a></li><li class=" tsd-kind-module"><a href="modules/react.html">react</a></li><li class=" tsd-kind-module"><a href="modules/sticker.html">sticker</a></li><li class=" tsd-kind-module"><a href="modules/vfx.html">vfx</a></li><li class=" tsd-kind-module"><a href="modules/vue.html">vue</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK - v6.0.0-alpha.39</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.39"/><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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v6.0.0-alpha.39</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> 如视 Five SDK - v6.0.0-alpha.39 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/five.html" class="tsd-kind-icon">five</a></li><li class="tsd-kind-module"><a href="modules/gltf_loader.html" class="tsd-kind-icon">gltf-<wbr/>loader</a></li><li class="tsd-kind-module"><a href="modules/line.html" class="tsd-kind-icon">line</a></li><li class="tsd-kind-module"><a href="modules/react.html" class="tsd-kind-icon">react</a></li><li class="tsd-kind-module"><a href="modules/sticker.html" class="tsd-kind-icon">sticker</a></li><li class="tsd-kind-module"><a href="modules/vfx.html" class="tsd-kind-icon">vfx</a></li><li class="tsd-kind-module"><a href="modules/vue.html" class="tsd-kind-icon">vue</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/five.html">five</a></li><li class=" tsd-kind-module"><a href="modules/gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="modules/line.html">line</a></li><li class=" tsd-kind-module"><a href="modules/react.html">react</a></li><li class=" tsd-kind-module"><a href="modules/sticker.html">sticker</a></li><li class=" tsd-kind-module"><a href="modules/vfx.html">vfx</a></li><li class=" tsd-kind-module"><a href="modules/vue.html">vue</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>
package/five/index.d.ts CHANGED
@@ -13,6 +13,15 @@ export declare interface AddableObject extends THREE_2.Object3D {
13
13
  setTime?(time: number): void;
14
14
  }
15
15
 
16
+ declare interface AjaxOptions<T extends AjaxResponseType = AjaxResponseType> extends NetworkOptions {
17
+ /** 数据返回类型 */
18
+ responseType?: T;
19
+ }
20
+
21
+ declare type AjaxResponseType = "arraybuffer" | "blob" | "text";
22
+
23
+ declare type AjaxResponseTypeMapping<K extends AjaxResponseType> = K extends "arraybuffer" ? ArrayBuffer : K extends "blob" ? Blob : K extends "text" ? string : never;
24
+
16
25
  export declare interface AnimationFrame {
17
26
  callback: (time: number, deltaTime: number, ...args: any[]) => void;
18
27
  once: boolean;
@@ -163,13 +172,15 @@ export declare class Camera extends THREE_2.Camera {
163
172
  far: number;
164
173
  perspToOrtho: THREE_2.Vector2;
165
174
  orthoDistance: number;
175
+ screenHeight: number;
176
+ pixelRatio: number;
166
177
  /** 相机姿态 */
167
178
  pose: CameraPose;
168
179
  private perspectiveCamera;
169
180
  private orthographicCamera;
170
181
  needsRender: boolean;
171
182
  private lastValues;
172
- constructor(fov: number, aspect?: number, near?: number, far?: number, perspToOrtho?: THREE_2.Vector2, orthoDistance?: number);
183
+ constructor(fov: number, aspect?: number, near?: number, far?: number, perspToOrtho?: THREE_2.Vector2, orthoDistance?: number, screenHeight?: number, pixelRatio?: number);
173
184
  get zoom(): number;
174
185
  get top(): number;
175
186
  get bottom(): number;
@@ -392,6 +403,14 @@ export declare type EventTypes = Pick<ControllerEventTypes, typeof PROXY_CONTROL
392
403
  "dispose"(): void;
393
404
  };
394
405
 
406
+ declare class Fetcher {
407
+ private options;
408
+ constructor(options?: NetworkOptions);
409
+ ajax<T extends AjaxResponseType = "text">(source: string, options?: AjaxOptions<T>, onLoad?: NetworkSuccessCallback<AjaxResponseTypeMapping<T>>, onError?: NetworkErrorCallback, onProgress?: NetworkProgressCallback): Promise<NetworkResponse<AjaxResponseTypeMapping<T>>>;
410
+ loadImage<T extends HTMLImageElement = HTMLImageElement>(source: string, options?: NetworkOptions, onLoad?: NetworkSuccessCallback, onError?: NetworkErrorCallback, onProgress?: NetworkProgressCallback, target?: T): Promise<NetworkResponse<T>>;
411
+ preload(source: string, options?: NetworkOptions): Promise<void>;
412
+ }
413
+
395
414
  /**
396
415
  * 如视 VR Web展示器
397
416
  *
@@ -1602,47 +1621,35 @@ export declare function loadAt3d(url: string, options: {
1602
1621
  textureOptions?: TextureOptions;
1603
1622
  textureBaseUri?: string;
1604
1623
  textureArray?: string[];
1605
- allowHosts?: string[];
1606
- requestProxy?: (url: string) => string | Promise<string>;
1607
- networkSubscribe?: NetworkSubscribe;
1624
+ fetcher: Fetcher;
1608
1625
  }): Promise<ParsedResultType>;
1609
1626
 
1610
1627
  export declare function loadB3dm(url: string, options: {
1611
1628
  upAxis: 'X' | 'Y' | 'Z';
1612
- allowHosts?: string[];
1613
- requestProxy?: (url: string) => string | Promise<string>;
1614
- networkSubscribe?: NetworkSubscribe;
1629
+ fetcher: Fetcher;
1615
1630
  }): Promise<ParsedResultType>;
1616
1631
 
1617
1632
  export declare function loadDome(url: string, options: {
1618
1633
  textureOptions: TextureOptions;
1619
1634
  textureBaseUri?: string;
1620
- allowHosts?: string[];
1621
- requestProxy?: (url: string) => string | Promise<string>;
1622
- networkSubscribe?: NetworkSubscribe;
1635
+ fetcher: Fetcher;
1623
1636
  }): Promise<ParsedResultType>;
1624
1637
 
1625
1638
  export declare function loadDomez(url: string, options: {
1626
1639
  textureOptions: TextureOptions;
1627
1640
  textureBaseUri?: string;
1628
- allowHosts?: string[];
1629
- requestProxy?: (url: string) => string | Promise<string>;
1630
- networkSubscribe?: NetworkSubscribe;
1641
+ fetcher: Fetcher;
1631
1642
  }): Promise<ParsedResultType>;
1632
1643
 
1633
1644
  export declare function loadPbm(url: string, options: {
1634
1645
  textureOptions?: TextureOptions;
1635
1646
  textureBaseUri?: string;
1636
1647
  textureArray?: string[];
1637
- allowHosts?: string[];
1638
- requestProxy?: (url: string) => string | Promise<string>;
1639
- networkSubscribe?: NetworkSubscribe;
1648
+ fetcher: Fetcher;
1640
1649
  }): Promise<ParsedResultType>;
1641
1650
 
1642
1651
  export declare function loadPnts(url: string, options: {
1643
- allowHosts?: string[];
1644
- requestProxy?: (url: string) => string | Promise<string>;
1645
- networkSubscribe?: NetworkSubscribe;
1652
+ fetcher: Fetcher;
1646
1653
  }): Promise<ParsedResultType>;
1647
1654
 
1648
1655
  export declare type LooseWork = {
@@ -1742,6 +1749,8 @@ export declare type LooseWorkWithExtrinsics = {
1742
1749
  transform?: number[];
1743
1750
  /** 可视区域 */
1744
1751
  viewerRequestVolume?: BoundingVolumeJson;
1752
+ /** 模型显示最小细化层级 */
1753
+ modelMinLevelOfDetail?: number;
1745
1754
  /** 模型显示最大细化层级 */
1746
1755
  modelMaxLevelOfDetail?: number;
1747
1756
  /** 模型最大内存缓存 */
@@ -1832,6 +1841,8 @@ export declare class Model extends THREE_2.Object3D {
1832
1841
  textureOptions: TextureOptions;
1833
1842
  /** 模型是否已经细化 */
1834
1843
  refined: boolean;
1844
+ /** 模型细化进度 */
1845
+ refineProgress: [number, number];
1835
1846
  /** 模型已经加载 */
1836
1847
  loaded: boolean;
1837
1848
  /** 当前样式参数 */
@@ -1895,8 +1906,6 @@ export declare class Model extends THREE_2.Object3D {
1895
1906
  * @param imageOptions - 图片参数
1896
1907
  */
1897
1908
  load(work: Work, options?: {
1898
- networkSubscribe?: NetworkSubscribe;
1899
- requestProxy?: (url: string) => string | Promise<string>;
1900
1909
  textureOptions?: TextureOptions;
1901
1910
  }): Promise<void>;
1902
1911
  update(renderer: THREE_2.WebGLRenderer, camera: Camera, mode: Mode): void;
@@ -1921,13 +1930,14 @@ export declare interface ModelLodOptions {
1921
1930
  maxDepth?: number;
1922
1931
  }
1923
1932
 
1924
- export declare type ModelMaterialValues = Pick<PBMParameters, 'pano0' | 'pano1' | 'modelAlpha' | 'progress' | 'useBlackTransition' | 'opacity' | 'constantColor' | 'useEDL' | 'useHQWeight' | 'useHQDepth' | 'pointShape' | 'pointColor' | 'pointSize' | 'pointScale' | 'pointMinPixel' | 'pointMaxPixel' | 'gradientTexture'>;
1933
+ export declare type ModelMaterialValues = Pick<PBMParameters, 'pano0' | 'pano1' | 'modelAlpha' | 'progress' | 'useBlackTransition' | 'opacity' | 'constantColor' | 'useEDL' | 'useHQWeight' | 'useHQDepth' | 'pointShape' | 'pointColor' | 'pointSize' | 'pointBack' | 'pointScale' | 'pointMinPixel' | 'pointMaxPixel' | 'gradientTexture'>;
1925
1934
 
1926
1935
  export declare type Models = Model[] & {
1927
1936
  needsRender: boolean;
1928
1937
  bounding: THREE_2.Box3;
1929
1938
  loaded: boolean;
1930
1939
  refined: boolean;
1940
+ refineProgress: [number, number];
1931
1941
  materialVersion: string;
1932
1942
  intersectRaycaster(raycaster: THREE_2.Raycaster): Intersection[];
1933
1943
  setMaterial(values: Partial<ModelMaterialValues>): void;
@@ -1987,6 +1997,18 @@ export declare interface MovePanoOptions extends Partial<Omit<State, "offset" |
1987
1997
  moveCancelCallback?: () => void;
1988
1998
  }
1989
1999
 
2000
+ declare class NetworkAbortError extends Error {
2001
+ constructor(source: string, type: NetworkType);
2002
+ }
2003
+
2004
+ declare type NetworkError = NetworkResponseError | NetworkAbortError | NetworkTimeoutError | NetworkFirbiddenError;
2005
+
2006
+ declare type NetworkErrorCallback = (error: NetworkError) => void;
2007
+
2008
+ declare class NetworkFirbiddenError extends Error {
2009
+ constructor(source: string, type: NetworkType, reason: string);
2010
+ }
2011
+
1990
2012
  export declare type NetWorkMeta = {
1991
2013
  origin: string;
1992
2014
  source: string;
@@ -2010,6 +2032,8 @@ export declare interface NetworkOptions {
2010
2032
  allowHosts?: string[];
2011
2033
  }
2012
2034
 
2035
+ declare type NetworkProgressCallback = (percent: number) => void;
2036
+
2013
2037
  export declare interface NetworkResourceEvent extends BaseEvent {
2014
2038
  source: string;
2015
2039
  requestType: NetworkType;
@@ -2022,6 +2046,11 @@ export declare type NetworkResponse<T = any, E extends NetWorkMeta | NetWorkMeta
2022
2046
  meta: E;
2023
2047
  };
2024
2048
 
2049
+ declare class NetworkResponseError extends Error {
2050
+ httpStatus: number;
2051
+ constructor(source: string, type: NetworkType, status: number);
2052
+ }
2053
+
2025
2054
  export declare type NetworkState = "ok" | "preload" | "error" | "proxy-error" | "timeout" | "forbidden";
2026
2055
 
2027
2056
  export declare class NetworkSubscribe extends Subscribe<{
@@ -2029,6 +2058,12 @@ export declare class NetworkSubscribe extends Subscribe<{
2029
2058
  }> {
2030
2059
  }
2031
2060
 
2061
+ declare type NetworkSuccessCallback<T = any> = (response: NetworkResponse<T>) => void;
2062
+
2063
+ declare class NetworkTimeoutError extends Error {
2064
+ constructor(source: string, type: NetworkType, timeout: number);
2065
+ }
2066
+
2032
2067
  export declare type NetworkType = "XMLHttpRequest" | "Script" | "Image" | "Link";
2033
2068
 
2034
2069
  export declare interface ObjectEvent extends BaseEvent {
@@ -2249,6 +2284,7 @@ export declare type ParsedResultType = {
2249
2284
  byteLength: number;
2250
2285
  uri: string;
2251
2286
  object: THREE_2.Object3D;
2287
+ dispose: () => void;
2252
2288
  };
2253
2289
 
2254
2290
  /**
@@ -2362,6 +2398,8 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
2362
2398
  pointShape: PBMParameters['pointShape'];
2363
2399
  /** 点云基础大小*/
2364
2400
  pointScale: PBMParameters['pointScale'];
2401
+ /** 点云背面绘制方式*/
2402
+ pointBack: PBMParameters['pointBack'];
2365
2403
  /** 点云像素最小值*/
2366
2404
  pointMinPixel: PBMParameters['pointMinPixel'];
2367
2405
  /** 点云像素最大值*/
@@ -2413,6 +2451,8 @@ export declare interface PBMParameters {
2413
2451
  pointColor: 'RGB' | 'ALTITUDE';
2414
2452
  /** 点云大小绘制方式*/
2415
2453
  pointSize: 'FIXED' | 'ATTENUATION' | 'GEOMETRIC';
2454
+ /** 点云背面绘制方式*/
2455
+ pointBack: 'VISIBLE' | 'HIDDEN' | 'DARK';
2416
2456
  /** 点云基础大小*/
2417
2457
  pointScale: number;
2418
2458
  /** 点云最大尺寸*/
@@ -2688,7 +2728,7 @@ export declare namespace SubscribeMixinType {
2688
2728
  }
2689
2729
 
2690
2730
  export declare class TextureLoader {
2691
- loadTexture(source: string, options?: {
2731
+ loadTexture(source: string, options: {
2692
2732
  imageURL?: {
2693
2733
  transform?: (source: string, options: ImageURLOptions) => string;
2694
2734
  options?: ImageURLOptions;
@@ -2701,7 +2741,9 @@ export declare class TextureLoader {
2701
2741
  wrapT?: THREE_2.Wrapping;
2702
2742
  maxSize?: THREE_2.Vector2;
2703
2743
  viaAjax?: boolean;
2704
- } & NetworkOptions, onLoad?: (response: NetworkResponse<THREE_2.Texture>) => void, onError?: (error: Error) => void, onProgress?: (percent: number) => void, renderer?: THREE_2.WebGLRenderer): Promise<NetworkResponse<THREE_2.Texture>>;
2744
+ timeout?: number;
2745
+ fetcher: Fetcher;
2746
+ }, onLoad?: (response: NetworkResponse<THREE_2.Texture>) => void, onError?: (error: Error) => void, onProgress?: (percent: number) => void, renderer?: THREE_2.WebGLRenderer): Promise<NetworkResponse<THREE_2.Texture>>;
2705
2747
  loadCubeTexture(sources: WorkCubeImage, options: {
2706
2748
  imageURL?: {
2707
2749
  transform?: (source: string, options: ImageURLOptions) => string;
@@ -2713,7 +2755,9 @@ export declare class TextureLoader {
2713
2755
  wrapS?: THREE_2.Wrapping;
2714
2756
  wrapT?: THREE_2.Wrapping;
2715
2757
  viaAjax?: boolean;
2716
- } & NetworkOptions, onLoad: (response: NetworkResponse<THREE_2.CubeTexture, NetWorkMeta[]>) => void, onError: (error: Error) => void, onProgress: (percent: number) => void, renderer: THREE_2.WebGLRenderer): Promise<NetworkResponse<THREE_2.CubeTexture, NetWorkMeta[]>>;
2758
+ timeout?: number;
2759
+ fetcher: Fetcher;
2760
+ }, onLoad: (response: NetworkResponse<THREE_2.CubeTexture, NetWorkMeta[]>) => void, onError: (error: Error) => void, onProgress: (percent: number) => void, renderer: THREE_2.WebGLRenderer): Promise<NetworkResponse<THREE_2.CubeTexture, NetWorkMeta[]>>;
2717
2761
  loadTiledCubeTexture(sources: WorkCubeImage, tileSources: WorkTile[], options: {
2718
2762
  tileImageSize?: number;
2719
2763
  tileMaxLevel?: number;
@@ -2727,7 +2771,9 @@ export declare class TextureLoader {
2727
2771
  wrapS?: THREE_2.Wrapping;
2728
2772
  wrapT?: THREE_2.Wrapping;
2729
2773
  viaAjax?: boolean;
2730
- } & NetworkOptions, onLoad: (response: NetworkResponse<TileCubeTextureTarget, NetWorkMeta[]>) => void, onError: (error: Error) => void, onProgress: (percent: number) => void, renderer: THREE_2.WebGLRenderer): Promise<NetworkResponse<TileCubeTextureTarget, NetWorkMeta[]>>;
2774
+ timeout?: number;
2775
+ fetcher: Fetcher;
2776
+ }, onLoad: (response: NetworkResponse<TileCubeTextureTarget, NetWorkMeta[]>) => void, onError: (error: Error) => void, onProgress: (percent: number) => void, renderer: THREE_2.WebGLRenderer): Promise<NetworkResponse<TileCubeTextureTarget, NetWorkMeta[]>>;
2731
2777
  }
2732
2778
 
2733
2779
  /**
@@ -2807,6 +2853,7 @@ export declare class Tile {
2807
2853
  }
2808
2854
 
2809
2855
  export declare class Tile3DModel extends THREE_2.Object3D {
2856
+ static DEFAULT_MIN_LEVEL_OF_DETAIL: number;
2810
2857
  static DEFAULT_MAX_LEVEL_OF_DETAIL: number;
2811
2858
  static DEFAULT_MAX_MEMORY_USAGE: number;
2812
2859
  static DEFAULT_MAX_SCREEN_SPACE_ERROR: number;
@@ -2815,10 +2862,12 @@ export declare class Tile3DModel extends THREE_2.Object3D {
2815
2862
  workCode: string;
2816
2863
  search: string;
2817
2864
  tileset: Tileset;
2865
+ minLevelOfDetail: number;
2818
2866
  maxLevelOfDetail: number;
2819
2867
  boundingBox: THREE_2.Box3;
2820
2868
  needsRefined: boolean;
2821
2869
  refined: boolean;
2870
+ refineProgress: [number, number];
2822
2871
  loaded: boolean;
2823
2872
  disposed: boolean;
2824
2873
  needsRender: boolean;
@@ -2829,7 +2878,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
2829
2878
  private nodes;
2830
2879
  private debugBoundings;
2831
2880
  private unloadTileQueue;
2832
- constructor(workCode: string, objType: 'mesh' | 'point_cloud', tilesetHeader: TilesetHeader, options: Partial<Tile3DModelLoaderOptions>);
2881
+ constructor(workCode: string, objType: 'mesh' | 'point_cloud', tilesetHeader: TilesetHeader, options: Tile3DModelLoaderOptions);
2833
2882
  get debug(): boolean;
2834
2883
  set debug(value: boolean);
2835
2884
  get maxMemoryUsage(): number;
@@ -2839,9 +2888,7 @@ export declare class Tile3DModel extends THREE_2.Object3D {
2839
2888
  get maxScreenSpaceError(): number;
2840
2889
  set maxScreenSpaceError(value: number);
2841
2890
  loadContent(tile: Tile, options: {
2842
- allowHosts?: string[];
2843
- requestProxy?: (url: string) => string | Promise<string>;
2844
- networkSubscribe?: NetworkSubscribe;
2891
+ fetcher: Fetcher;
2845
2892
  }): Promise<boolean>;
2846
2893
  intersectRaycaster(raycaster: THREE_2.Raycaster, distanceOrder: boolean): Intersection[];
2847
2894
  update(renderer: THREE_2.WebGLRenderer, camera: Camera): void;
@@ -2850,10 +2897,8 @@ export declare class Tile3DModel extends THREE_2.Object3D {
2850
2897
 
2851
2898
  /** Advanced loader options */
2852
2899
  export declare interface Tile3DModelLoaderOptions {
2900
+ fetcher: Fetcher;
2853
2901
  resourcePath: string;
2854
- allowHosts?: string[];
2855
- requestProxy?: (url: string) => string | Promise<string>;
2856
- networkSubscribe?: NetworkSubscribe;
2857
2902
  search?: string;
2858
2903
  onError?: (error: Error) => void;
2859
2904
  }
@@ -2900,7 +2945,9 @@ export declare class TileCubeTextureTarget {
2900
2945
  magFilter?: THREE_2.TextureFilter;
2901
2946
  wrapS?: THREE_2.Wrapping;
2902
2947
  wrapT?: THREE_2.Wrapping;
2903
- } & NetworkOptions, renderer: THREE_2.WebGLRenderer);
2948
+ timeout?: number;
2949
+ fetcher: Fetcher;
2950
+ }, renderer: THREE_2.WebGLRenderer);
2904
2951
  get cubeRenderTarget(): THREE_2.WebGLCubeRenderTarget | null;
2905
2952
  set cubeRenderTarget(cubeRenderTarget: THREE_2.WebGLCubeRenderTarget | null);
2906
2953
  private requestTile;
@@ -2932,8 +2979,9 @@ export declare interface TileHeader {
2932
2979
  export declare class TileNode extends THREE_2.Group {
2933
2980
  objType: 'mesh' | 'point_cloud';
2934
2981
  bvhTree: BVH | undefined;
2982
+ private objDisposer;
2935
2983
  private floorsArray;
2936
- constructor(obj: THREE_2.Object3D, objType: 'mesh' | 'point_cloud');
2984
+ constructor(obj: THREE_2.Object3D, objType: 'mesh' | 'point_cloud', objDisposer: () => void);
2937
2985
  buildBvhTree(): void;
2938
2986
  intersectRaycaster(raycaster: THREE_2.Raycaster): Intersection[];
2939
2987
  dispose(): void;
@@ -3003,9 +3051,11 @@ export declare type TilesetFrameState = {
3003
3051
  up: THREE.Vector3;
3004
3052
  };
3005
3053
  height: number;
3054
+ pixelRatio: number;
3006
3055
  cullingVolume: CullingVolume;
3007
3056
  frameNumber: number;
3008
3057
  sseDenominator: number;
3058
+ minLevelOfDetail: number;
3009
3059
  maxLevelOfDetail: number;
3010
3060
  };
3011
3061
 
@@ -3021,13 +3071,10 @@ export declare interface TilesetHeader {
3021
3071
  }
3022
3072
 
3023
3073
  export declare interface TilesetOptions {
3074
+ contentLoader: (tile: Tile) => Promise<boolean>;
3024
3075
  onTileLoad: (tile: Tile) => any;
3025
3076
  onTileUnload: (tile: Tile) => any;
3026
3077
  onTileError: (tile: Tile, error: Error) => any;
3027
- contentLoader: (tile: Tile) => Promise<boolean>;
3028
- allowHosts?: string[];
3029
- requestProxy?: (url: string) => string | Promise<string>;
3030
- networkSubscribe?: NetworkSubscribe;
3031
3078
  }
3032
3079
 
3033
3080
  export declare class TilesetTraverser {
@@ -3103,6 +3150,8 @@ export declare interface WebXRControllerParams {
3103
3150
  export declare type WebXRControllerType = 'tap' | 'press' | 'axes' | 'buttonUp' | 'buttonDown';
3104
3151
 
3105
3152
  export declare class Work {
3153
+ /** five load 会对其赋值 */
3154
+ fetcher: Fetcher;
3106
3155
  /** 名称 */
3107
3156
  name: string;
3108
3157
  /** 编号 */
@@ -3216,6 +3265,8 @@ export declare interface WorkObserver {
3216
3265
  floorIndex: number;
3217
3266
  /** 点位 derived_id */
3218
3267
  derivedId?: number;
3268
+ /** 点位 derived_str */
3269
+ derivedStr?: string;
3219
3270
  /** 点位是否激活可用 */
3220
3271
  active: boolean;
3221
3272
  /** 点位是否可加载 */
@@ -3247,6 +3298,8 @@ export declare interface WorkOptions {
3247
3298
  transform: THREE_2.Matrix4;
3248
3299
  /** 可观测区域 */
3249
3300
  viewerRequestVolume?: BoundingVolume;
3301
+ /** 模型显示最小细化层级 */
3302
+ modelMinLevelOfDetail?: number;
3250
3303
  /** 模型显示最大细化层级 */
3251
3304
  modelMaxLevelOfDetail?: number;
3252
3305
  /** 模型最大内存缓存 */