@realsee/five 5.0.0-alpha.162 → 5.0.0-alpha.164

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 (158) 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.Camera.html +1 -1
  8. package/docs/classes/five.Clipper.html +1 -1
  9. package/docs/classes/five.Five.html +1 -1
  10. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  11. package/docs/classes/five.IntersectMesh.html +1 -1
  12. package/docs/classes/five.LegacyPanoCircleMesh.html +3 -3
  13. package/docs/classes/five.Model.html +25 -25
  14. package/docs/classes/five.NetworkSubscribe.html +1 -1
  15. package/docs/classes/five.PBMContainer.html +1 -1
  16. package/docs/classes/five.PBMGroup.html +1 -1
  17. package/docs/classes/five.PBMMaterial.html +1 -1
  18. package/docs/classes/five.PBMMesh.html +1 -1
  19. package/docs/classes/five.PanoCircleMesh.html +4 -4
  20. package/docs/classes/five.PanoCircleMeshDark.html +5 -5
  21. package/docs/classes/five.PanoCircleMeshSolid.html +4 -4
  22. package/docs/classes/five.Scene.html +1 -1
  23. package/docs/classes/five.Subscribe.html +1 -1
  24. package/docs/classes/five.TextureLoader.html +1 -1
  25. package/docs/classes/five.Tile3D.html +2 -2
  26. package/docs/classes/five.Tile3DModel.html +4 -4
  27. package/docs/classes/five.TileBoundingSphere.html +1 -1
  28. package/docs/classes/five.TileCacheNode.html +1 -1
  29. package/docs/classes/five.TileCubeTextureTarget.html +1 -1
  30. package/docs/classes/five.TileCullingVolume.html +1 -1
  31. package/docs/classes/five.TileOrientedBoundingBox.html +1 -1
  32. package/docs/classes/five.TileRequestScheduler.html +1 -1
  33. package/docs/classes/five.Tileset3D.html +4 -4
  34. package/docs/classes/five.Tileset3DTraverser.html +1 -1
  35. package/docs/classes/five.TilesetCache.html +1 -1
  36. package/docs/classes/five.Work.html +1 -1
  37. package/docs/classes/five.XRButton.html +1 -1
  38. package/docs/classes/gltf_loader.DDSLoader.html +1 -1
  39. package/docs/classes/gltf_loader.DRACOLoader.html +1 -1
  40. package/docs/classes/gltf_loader.GLTFLoader.html +1 -1
  41. package/docs/classes/gltf_loader.GLTFObject.html +1 -1
  42. package/docs/classes/gltf_loader.GLTFParser.html +1 -1
  43. package/docs/classes/gltf_loader.THREEGLTFLoader.html +1 -1
  44. package/docs/classes/line.Line.html +1 -1
  45. package/docs/classes/line.LineGeometry.html +1 -1
  46. package/docs/classes/line.LineMaterial.html +1 -1
  47. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  48. package/docs/classes/line.THREE_Line2.html +1 -1
  49. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  50. package/docs/classes/react.Store.html +1 -1
  51. package/docs/classes/server.BVH.html +1 -1
  52. package/docs/classes/server.BVHIntersect.html +1 -1
  53. package/docs/classes/server.BVHNode.html +1 -1
  54. package/docs/classes/server.BVHVector3.html +1 -1
  55. package/docs/classes/server.Model.html +25 -18
  56. package/docs/classes/server.PBMContainer.html +7 -0
  57. package/docs/classes/server.PBMGroup.html +1 -1
  58. package/docs/classes/server.PBMMesh.html +1 -1
  59. package/docs/classes/sticker.Sticker.html +1 -1
  60. package/docs/classes/vfx.Airflow.html +1 -1
  61. package/docs/classes/vfx.Flame.html +1 -1
  62. package/docs/classes/vfx.Particle.html +1 -1
  63. package/docs/classes/vfx.SpotLight.html +1 -1
  64. package/docs/index.html +1 -1
  65. package/docs/interfaces/five.AddableObject.html +1 -1
  66. package/docs/interfaces/five.AnimationFrame.html +1 -1
  67. package/docs/interfaces/five.CameraPose.html +1 -1
  68. package/docs/interfaces/five.ClipperParameter.html +1 -1
  69. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +1 -1
  70. package/docs/interfaces/five.EventCallback.html +1 -1
  71. package/docs/interfaces/five.FiveInitArgs.html +1 -1
  72. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +1 -1
  73. package/docs/interfaces/five.ImageOptions.html +1 -1
  74. package/docs/interfaces/five.ImageURLMappings.html +1 -1
  75. package/docs/interfaces/five.ImageURLOptions.html +1 -1
  76. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  77. package/docs/interfaces/five.Intersection.html +3 -3
  78. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +1 -1
  79. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  80. package/docs/interfaces/five.ModelEventCallback.html +7 -7
  81. package/docs/interfaces/five.MotionKeyframe.html +1 -1
  82. package/docs/interfaces/five.MovePanoOptions.html +1 -1
  83. package/docs/interfaces/five.NetworkOptions.html +1 -1
  84. package/docs/interfaces/five.PBMPanoPicture.html +1 -1
  85. package/docs/interfaces/five.PBMParameters.html +1 -1
  86. package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
  87. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  88. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  89. package/docs/interfaces/five.Pose.html +1 -1
  90. package/docs/interfaces/five.Scissor.html +1 -1
  91. package/docs/interfaces/five.State.html +1 -1
  92. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
  93. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
  94. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
  95. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
  96. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
  97. package/docs/interfaces/five.TextureOptions.html +1 -1
  98. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +2 -2
  99. package/docs/interfaces/five.TileBoundingVolume.html +5 -5
  100. package/docs/interfaces/five.TileContent.html +1 -1
  101. package/docs/interfaces/five.TileCubeNode.html +1 -1
  102. package/docs/interfaces/five.TileCubeTree.html +1 -1
  103. package/docs/interfaces/five.Tileset3dOptions.html +1 -1
  104. package/docs/interfaces/five.TilesetJSON.html +1 -1
  105. package/docs/interfaces/five.TilesetJSONNode.html +1 -1
  106. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  107. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  108. package/docs/interfaces/five.WebXRSelectParams.html +1 -1
  109. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  110. package/docs/interfaces/five.WorkImage.html +1 -1
  111. package/docs/interfaces/five.WorkInitial.html +1 -1
  112. package/docs/interfaces/five.WorkModel.html +1 -1
  113. package/docs/interfaces/five.WorkModelTiles.html +1 -1
  114. package/docs/interfaces/five.WorkObserver.html +1 -1
  115. package/docs/interfaces/five.WorkTile.html +1 -1
  116. package/docs/interfaces/five.WorkVideo.html +1 -1
  117. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  118. package/docs/interfaces/gltf_loader.DDS.html +1 -1
  119. package/docs/interfaces/gltf_loader.GLTF.html +1 -1
  120. package/docs/interfaces/gltf_loader.GLTFReference.html +1 -1
  121. package/docs/interfaces/gltf_loader.THREEGLTF.html +1 -1
  122. package/docs/interfaces/react.FiveActionReactCallbacks.html +1 -1
  123. package/docs/interfaces/react.FiveInjectionTypes.html +1 -1
  124. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
  125. package/docs/interfaces/server.Intersection.html +3 -3
  126. package/docs/interfaces/server.ModelEventCallback.html +6 -6
  127. package/docs/interfaces/sticker.IntersectionLike.html +1 -1
  128. package/docs/interfaces/vfx.ParticleArgs.html +1 -1
  129. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +1 -1
  130. package/docs/interfaces/vue.FiveActionVueCallbacks.html +12 -4
  131. package/docs/modules/five.SubscribeMixinType.html +1 -1
  132. package/docs/modules/five.html +10 -10
  133. package/docs/modules/gltf_loader.html +1 -1
  134. package/docs/modules/line.html +1 -1
  135. package/docs/modules/react.html +1 -1
  136. package/docs/modules/server.html +7 -7
  137. package/docs/modules/sticker.html +1 -1
  138. package/docs/modules/vfx.html +1 -1
  139. package/docs/modules/vue.html +9 -6
  140. package/docs/modules.html +1 -1
  141. package/five/index.d.ts +9 -26
  142. package/five/index.js +12 -12
  143. package/gltf-loader/index.js +3 -3
  144. package/line/index.js +3 -3
  145. package/package.json +2 -5
  146. package/react/index.js +3 -3
  147. package/server/index.d.ts +20 -1
  148. package/server/index.js +11 -11
  149. package/sticker/index.js +3 -3
  150. package/umd/five-gltf-loader.js +1 -1
  151. package/umd/five-line.js +1 -1
  152. package/umd/five-sticker.js +1 -1
  153. package/umd/five-vue.js +1 -1
  154. package/umd/five.js +1 -1
  155. package/vfx/index.js +3 -3
  156. package/vue/index.d.ts +24 -3
  157. package/vue/index.js +3 -3
  158. package/docs/classes/five.TilePlane.html +0 -1
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 - v5.0.0-alpha.162</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.162"/><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 - v5.0.0-alpha.162</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 - v5.0.0-alpha.162</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#useFiveWork" class="tsd-kind-icon">use<wbr/>Five<wbr/>Work</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>initialWork<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-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">&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>onWorkChange<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"> =&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>work<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">&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:22</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 - v5.0.0-alpha.164</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.164"/><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 - v5.0.0-alpha.164</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 - v5.0.0-alpha.164</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#useFiveWork" class="tsd-kind-icon">use<wbr/>Five<wbr/>Work</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>initialWork<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-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">&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>onWorkChange<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"> =&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>work<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">&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:22</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>
@@ -19,7 +19,7 @@
19
19
  </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>不到万不得已，并不推荐直接使用。</p>
20
20
  </dd><dt>deprecated</dt><dd><p>不到万不得已，并不推荐直接使用。</p>
21
21
  </dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../classes/five.Five.html" class="tsd-signature-type" data-tsd-kind="Class">Five</a></h4><div><p>five 实例</p>
22
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">use<wbr/>Five<wbr/>Action<a href="#useFiveAction" 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><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveActionVueCallbacks</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveAction.ts:170</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">use<wbr/>Five<wbr/>Action<a href="#useFiveAction" 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><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveActionVueCallbacks</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveAction.ts:193</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
23
23
  <p>Five Vue Hooks: 使用 Five 的命令</p>
24
24
  </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>updateCamera</p>
25
25
  <pre><code><span class="hl-2">移动相机</span><span class="hl-0">。（</span><span class="hl-2">不触发点位移动</span><span class="hl-0">）</span><br/><span class="hl-2">如果动画中途被打断</span><span class="hl-0">（</span><span class="hl-2">用户触发行为</span><span class="hl-0">，</span><span class="hl-2">或者调用</span><span class="hl-0"> </span><span class="hl-2">setState</span><span class="hl-0">, </span><span class="hl-2">load</span><span class="hl-0">, </span><span class="hl-2">changeMode</span><span class="hl-0">）</span><span class="hl-2">的等</span><br/><span class="hl-2">会</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">.</span><span class="hl-2">reject</span><span class="hl-0">。</span><span class="hl-2">运动完成则</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">.</span><span class="hl-2">resolve</span><br/><br/><span class="hl-4">// params pose - 相机目标位置</span><br/><span class="hl-4">// params duration - 动画触发的时常</span><br/><span class="hl-4">// params Promise - 是否移动成功</span><br/><span class="hl-5">updateCamera</span><span class="hl-0">(</span><span class="hl-2">pose</span><span class="hl-0">: </span><span class="hl-2">Pose</span><span class="hl-0">, </span><span class="hl-2">duration</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">): </span><span class="hl-8">Promise</span><span class="hl-0">&lt;</span><span class="hl-7">void</span><span class="hl-0">&gt;</span>
@@ -39,7 +39,10 @@
39
39
  </dd><dt>function</dt><dd><p>preloadPano</p>
40
40
  <pre><code><span class="hl-2">预加载点位图片资源</span><br/><span class="hl-4">// param panoIndex - 观察点序号</span><br/><span class="hl-4">// param callback - 加载完成回调, 并传递加载用时。</span><br/><span class="hl-4">// returns 加载完成的 Promise 参数同 callback</span><br/><span class="hl-5">preloadPano</span><span class="hl-0">(</span><span class="hl-2">panoIndex</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">callback</span><span class="hl-0">?: (</span><span class="hl-2">costs</span><span class="hl-0">: </span><span class="hl-8">number</span><span class="hl-0">) </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-7">void</span><span class="hl-0">): </span><span class="hl-8">Promise</span><span class="hl-0">&lt;</span><span class="hl-2">number</span><span class="hl-0">&gt;</span>
41
41
  </code></pre>
42
- </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> { </span><span class="hl-6">updateCamera</span><span class="hl-0">, </span><span class="hl-6">initBasisLoader</span><span class="hl-0">, </span><span class="hl-6">getPixels</span><span class="hl-0">, </span><span class="hl-6">render</span><span class="hl-0">, </span><span class="hl-6">needsRender</span><span class="hl-0">, </span><span class="hl-6">preloadPano</span><span class="hl-0"> } = </span><span class="hl-5">useFiveAction</span><span class="hl-0">();</span>
42
+ </dd><dt>function</dt><dd><p>project2d</p>
43
+ <pre><code><span class="hl-2">计算三维空间的点对应到屏幕的二维坐标</span><br/><span class="hl-2">调用</span><span class="hl-0"> </span><span class="hl-3">`project2d()`</span><span class="hl-0"> </span><span class="hl-2">和</span><span class="hl-0"> </span><span class="hl-3">`useFiveProject2d()`</span><span class="hl-0"> </span><span class="hl-2">均可用于计算三维空间的点对应到屏幕的二维坐标</span><br/><span class="hl-2">区别在于</span><span class="hl-0">：</span><br/><span class="hl-0">- </span><span class="hl-3">`project2d()`</span><span class="hl-0"> </span><span class="hl-2">只计算一次</span><span class="hl-0">，</span><span class="hl-2">入参改变或</span><span class="hl-0"> </span><span class="hl-2">cameraUpdate</span><span class="hl-0"> </span><span class="hl-2">时</span><span class="hl-0"> </span><span class="hl-2">不会更新值</span><br/><span class="hl-0">- </span><span class="hl-3">`useFiveProject2d()`</span><span class="hl-0"> </span><span class="hl-2">通过</span><span class="hl-0"> </span><span class="hl-2">watch</span><span class="hl-0"> </span><span class="hl-2">监听入参和</span><span class="hl-0"> </span><span class="hl-2">cameraUpdate</span><span class="hl-0"> </span><span class="hl-2">变化</span><span class="hl-0">，</span><span class="hl-2">自动更新返回值</span><br/><span class="hl-5">project2d</span><span class="hl-0">(</span><span class="hl-2">vector3</span><span class="hl-0">: </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector3</span><span class="hl-0">, </span><span class="hl-2">testModel</span><span class="hl-0">?: </span><span class="hl-2">boolean</span><span class="hl-0"> ): </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector2</span>
44
+ </code></pre>
45
+ </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> { </span><span class="hl-6">updateCamera</span><span class="hl-0">, </span><span class="hl-6">initBasisLoader</span><span class="hl-0">, </span><span class="hl-6">getPixels</span><span class="hl-0">, </span><span class="hl-6">render</span><span class="hl-0">, </span><span class="hl-6">needsRender</span><span class="hl-0">, </span><span class="hl-6">preloadPano</span><span class="hl-0">, </span><span class="hl-6">project2d</span><span class="hl-0"> } = </span><span class="hl-5">useFiveAction</span><span class="hl-0">();</span>
43
46
  </code></pre>
44
47
  </dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveActionVueCallbacks</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveCameraDirection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">use<wbr/>Five<wbr/>Camera<wbr/>Direction<a href="#useFiveCameraDirection" 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><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction<span class="tsd-signature-symbol">(</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.Vector3</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveCameraDirection.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
45
48
  <p>Five Vue Hooks: 得到当前相机的方向（单位向量）</p>
@@ -87,10 +90,10 @@
87
90
  <p>Five Vue Hooks: 获取当前模型加载状态</p>
88
91
  </div></div><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">&quot;Loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Empty&quot;</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>&quot;Loaded&quot;: 加载完成
89
92
  &quot;Empty&quot; 加载未完成</p>
90
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveProject2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link">use<wbr/>Five<wbr/>Project2d<a href="#useFiveProject2d" 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><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Project2d<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vue.html#Project2d" class="tsd-signature-type" data-tsd-kind="Type alias">Project2d</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveProject2d.ts:45</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
91
- <p>Five Vue Hooks: 将三维的坐标对应到二维屏幕</p>
93
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveProject2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link">use<wbr/>Five<wbr/>Project2d<a href="#useFiveProject2d" 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><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Project2d<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vue.html#Project2d" class="tsd-signature-type" data-tsd-kind="Type alias">Project2d</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveProject2d.ts:47</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
94
+ <p>Five Vue Hooks: 计算三维坐标对应到屏幕二维坐标</p>
92
95
  </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>project2d</p>
93
- <pre><code><span class="hl-2">计算模型射线碰撞检测</span><br/><span class="hl-4">// param vector 三维的坐标</span><br/><span class="hl-4">// param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null</span><br/><span class="hl-4">// returns 三维的坐标 或者 null</span><br/><span class="hl-5">project2d</span><span class="hl-0">(</span><span class="hl-2">vector</span><span class="hl-0">: </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector3</span><span class="hl-0"> | </span><span class="hl-2">Ref</span><span class="hl-0">&lt;</span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector3</span><span class="hl-0">&gt;, </span><span class="hl-2">testModel</span><span class="hl-0">: </span><span class="hl-2">boolean</span><span class="hl-0">)</span><br/><span class="hl-15">v2</span><span class="hl-0">: </span><span class="hl-2">Ref</span><span class="hl-0">&lt;</span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector2</span><span class="hl-0"> | </span><span class="hl-7">null</span><span class="hl-0">&gt;</span>
96
+ <pre><code><span class="hl-2">计算三维坐标对应到屏幕二维坐标</span><br/><span class="hl-3">`useFiveProject2d()`</span><span class="hl-0"> </span><span class="hl-2">通过</span><span class="hl-0"> </span><span class="hl-2">watch</span><span class="hl-0"> </span><span class="hl-2">监听入参和</span><span class="hl-0"> </span><span class="hl-2">cameraUpdate</span><span class="hl-0"> </span><span class="hl-2">变化</span><span class="hl-0">，</span><span class="hl-2">自动更新返回值</span><br/><span class="hl-2">多次调用时会创建多个</span><span class="hl-0"> </span><span class="hl-2">watch</span><span class="hl-0"> </span><span class="hl-2">监听</span><span class="hl-0">，</span><span class="hl-2">推荐</span><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> { </span><span class="hl-6">project2d</span><span class="hl-0"> } = </span><span class="hl-5">useFiveAction</span><span class="hl-0">();</span><br/><span class="hl-4">// param vector 三维的坐标</span><br/><span class="hl-4">// param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null</span><br/><span class="hl-4">// returns 三维的坐标 或者 null</span><br/><span class="hl-5">project2d</span><span class="hl-0">(</span><span class="hl-2">vector</span><span class="hl-0">: </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector3</span><span class="hl-0"> | </span><span class="hl-2">Ref</span><span class="hl-0">&lt;</span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector3</span><span class="hl-0">&gt;, </span><span class="hl-2">testModel</span><span class="hl-0">: </span><span class="hl-2">boolean</span><span class="hl-0">)</span><br/><span class="hl-15">v2</span><span class="hl-0">: </span><span class="hl-2">Ref</span><span class="hl-0">&lt;</span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector2</span><span class="hl-0"> | </span><span class="hl-7">null</span><span class="hl-0">&gt;</span>
94
97
  </code></pre>
95
98
  </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">project2d</span><span class="hl-0"> = </span><span class="hl-5">useFiveProject2d</span><span class="hl-0">();</span><br/><span class="hl-5">project2d</span><span class="hl-0">(</span><span class="hl-7">new</span><span class="hl-0"> </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-5">Vector3</span><span class="hl-0">(</span><span class="hl-13">0</span><span class="hl-0">, </span><span class="hl-13">0</span><span class="hl-0">, </span><span class="hl-13">0</span><span class="hl-0">));</span>
96
99
  </code></pre>
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 - v5.0.0-alpha.162</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.162"/><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 - v5.0.0-alpha.162</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 - v5.0.0-alpha.162 </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/server.html" class="tsd-kind-icon">server</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/server.html">server</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></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 - v5.0.0-alpha.164</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.164"/><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 - v5.0.0-alpha.164</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 - v5.0.0-alpha.164 </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/server.html" class="tsd-kind-icon">server</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/server.html">server</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></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
@@ -1,8 +1,8 @@
1
- import { Matrix3 } from '@math.gl/core';
2
- import { Matrix4 } from '@math.gl/core';
3
- import { Quaternion } from '@math.gl/core';
1
+ import { Matrix3 } from 'three';
2
+ import { Matrix4 } from 'three';
3
+ import { Plane } from 'three';
4
4
  import * as THREE_2 from 'three';
5
- import { Vector3 } from '@math.gl/core';
5
+ import { Vector3 } from 'three';
6
6
 
7
7
  export declare interface AddableObject extends THREE_2.Object3D {
8
8
  needsRender?: boolean;
@@ -2461,7 +2461,7 @@ export declare class TileBoundingSphere {
2461
2461
  transform(transform: Matrix4): this;
2462
2462
  distanceSquaredTo(point: number[]): number;
2463
2463
  distanceTo(point: number[]): number;
2464
- intersectPlane(plane: TilePlane): 0 | 1 | -1;
2464
+ intersectPlane(plane: Plane): 0 | 1 | -1;
2465
2465
  }
2466
2466
 
2467
2467
  export declare interface TileBoundingVolume {
@@ -2485,7 +2485,7 @@ export declare interface TileBoundingVolume {
2485
2485
  * - `INTERSECTION.OUTSIDE` if the entire box is on the opposite side.
2486
2486
  * - `INTERSECTION.INTERSECTING` if the box intersects the plane.
2487
2487
  */
2488
- intersectPlane(plane: TilePlane): number;
2488
+ intersectPlane(plane: Plane): number;
2489
2489
  }
2490
2490
 
2491
2491
  export declare class TileCacheNode<T> {
@@ -2571,8 +2571,8 @@ export declare class TileCullingVolume {
2571
2571
  static get MASK_OUTSIDE(): number;
2572
2572
  static get MASK_INSIDE(): number;
2573
2573
  static get MASK_INDETERMINATE(): number;
2574
- planes: TilePlane[];
2575
- constructor(planes?: TilePlane[]);
2574
+ planes: Plane[];
2575
+ constructor(planes?: Plane[]);
2576
2576
  fromBoundingSphere(boundingSphere: {
2577
2577
  center: Vector3;
2578
2578
  radius: number;
@@ -2596,33 +2596,16 @@ export declare class TileOrientedBoundingBox {
2596
2596
  center: Vector3;
2597
2597
  halfAxes: Matrix3;
2598
2598
  constructor(center?: number[], halfAxes?: number[]);
2599
- get halfSize(): number[];
2600
- get quaternion(): Quaternion;
2601
- fromCenterHalfSizeQuaternion(center: number[], halfSize: number[], quaternion: number[]): this;
2602
2599
  clone(): TileOrientedBoundingBox;
2603
2600
  equals(right: TileOrientedBoundingBox): boolean;
2604
2601
  getBoundingSphere(result?: TileBoundingSphere): TileBoundingSphere;
2605
- intersectPlane(plane: TilePlane): 0 | 1 | -1;
2602
+ intersectPlane(plane: Plane): 0 | 1 | -1;
2606
2603
  distanceTo(point: number[]): number;
2607
2604
  distanceSquaredTo(point: number[]): number;
2608
2605
  computePlaneDistances(position: Vector3, direction: Vector3, result?: number[]): number[];
2609
2606
  transform(transformation: number[]): this;
2610
2607
  }
2611
2608
 
2612
- export declare class TilePlane {
2613
- normal: Vector3;
2614
- distance: number;
2615
- constructor(normal?: number[], distance?: number);
2616
- fromNormalDistance(normal: number[], distance: number): this;
2617
- fromPointNormal(point: number[], normal: number[]): this;
2618
- fromCoefficients(a: number, b: number, c: number, d: number): this;
2619
- clone(): TilePlane;
2620
- equals(right: TilePlane): boolean;
2621
- getPointDistance(point: number[]): number;
2622
- transform(matrix4: Matrix4): this;
2623
- projectPointOntoPlane(point: number[], result?: number[]): Vector3;
2624
- }
2625
-
2626
2609
  /** Tracks one request */
2627
2610
  export declare type TileRequest<Identiy> = {
2628
2611
  identiy: Identiy;