@realsee/five 5.0.0-alpha.20 → 5.0.0-alpha.201

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 (252) hide show
  1. package/README.md +18 -8
  2. package/docs/.nojekyll +1 -0
  3. package/docs/assets/highlight.css +134 -0
  4. package/docs/assets/icons.css +1043 -0
  5. package/docs/assets/main.js +52 -0
  6. package/docs/assets/search.js +1 -0
  7. package/docs/assets/style.css +1414 -0
  8. package/docs/classes/five.AnimationFrameLoop.html +15 -0
  9. package/docs/classes/five.BVH.html +10 -0
  10. package/docs/classes/five.BVHIntersect.html +1 -0
  11. package/docs/classes/five.BVHNode.html +7 -0
  12. package/docs/classes/five.BVHVector3.html +1 -0
  13. package/docs/classes/five.Camera.html +11 -0
  14. package/docs/classes/five.Clipper.html +1 -0
  15. package/docs/classes/five.Five.html +333 -0
  16. package/docs/classes/five.InternalWebGLRenderer.html +1 -0
  17. package/docs/classes/five.IntersectMesh.html +1 -0
  18. package/docs/classes/five.Model.html +91 -0
  19. package/docs/classes/five.NetworkSubscribe.html +50 -0
  20. package/docs/classes/five.PBMContainer.html +17 -0
  21. package/docs/classes/five.PBMGroup.html +19 -0
  22. package/docs/classes/five.PBMMaterial.html +29 -0
  23. package/docs/classes/five.PBMMesh.html +7 -0
  24. package/docs/classes/five.PanoCircleMesh.html +7 -0
  25. package/docs/classes/five.PanoCircleMeshCustom.html +7 -0
  26. package/docs/classes/five.PanoCircleMeshSolid.html +7 -0
  27. package/docs/classes/five.Scene.html +3 -0
  28. package/docs/classes/five.Subscribe.html +56 -0
  29. package/docs/classes/five.TextureLoader.html +1 -0
  30. package/docs/classes/five.Tile3D.html +34 -0
  31. package/docs/classes/five.Tile3DModel.html +15 -0
  32. package/docs/classes/five.TileBoundingSphere.html +1 -0
  33. package/docs/classes/five.TileCacheNode.html +1 -0
  34. package/docs/classes/five.TileCubeTextureTarget.html +1 -0
  35. package/docs/classes/five.TileCullingVolume.html +1 -0
  36. package/docs/classes/five.TileOrientedBoundingBox.html +1 -0
  37. package/docs/classes/five.TileRequestScheduler.html +16 -0
  38. package/docs/classes/five.Tileset3D.html +11 -0
  39. package/docs/classes/five.Tileset3DTraverser.html +1 -0
  40. package/docs/classes/five.TilesetCache.html +1 -0
  41. package/docs/classes/five.Work.html +32 -0
  42. package/docs/classes/five.XRButton.html +1 -0
  43. package/docs/classes/gltf_loader.DDSLoader.html +1 -0
  44. package/docs/classes/gltf_loader.DRACOLoader.html +1 -0
  45. package/docs/classes/gltf_loader.GLTFLoader.html +17 -0
  46. package/docs/classes/gltf_loader.GLTFObject.html +7 -0
  47. package/docs/classes/gltf_loader.GLTFParser.html +1 -0
  48. package/docs/classes/gltf_loader.THREEGLTFLoader.html +1 -0
  49. package/docs/classes/line.Line.html +1 -0
  50. package/docs/classes/line.LineGeometry.html +1 -0
  51. package/docs/classes/line.LineMaterial.html +1 -0
  52. package/docs/classes/line.LineSegmentsGeometry.html +1 -0
  53. package/docs/classes/line.THREE_Line2.html +1 -0
  54. package/docs/classes/line.THREE_LineSegments2.html +1 -0
  55. package/docs/classes/react.Store.html +29 -0
  56. package/docs/classes/server.BVH.html +10 -0
  57. package/docs/classes/server.BVHIntersect.html +1 -0
  58. package/docs/classes/server.BVHNode.html +7 -0
  59. package/docs/classes/server.BVHVector3.html +1 -0
  60. package/docs/classes/server.Model.html +70 -0
  61. package/docs/classes/server.PBMContainer.html +7 -0
  62. package/docs/classes/server.PBMGroup.html +9 -0
  63. package/docs/classes/server.PBMMesh.html +7 -0
  64. package/docs/classes/sticker.Sticker.html +32 -0
  65. package/docs/classes/vfx.Airflow.html +1 -0
  66. package/docs/classes/vfx.Flame.html +1 -0
  67. package/docs/classes/vfx.Particle.html +89 -0
  68. package/docs/classes/vfx.SpotLight.html +1 -0
  69. package/docs/index.html +166 -434
  70. package/docs/interfaces/five.AddableObject.html +9 -0
  71. package/docs/interfaces/five.AnimationFrame.html +1 -0
  72. package/docs/interfaces/five.CameraPose.html +1 -0
  73. package/docs/interfaces/five.ClipperParameter.html +1 -0
  74. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +28 -0
  75. package/docs/interfaces/five.EventCallback.html +400 -0
  76. package/docs/interfaces/five.FiveInitArgs.html +111 -0
  77. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +17 -0
  78. package/docs/interfaces/five.ImageOptions.html +18 -0
  79. package/docs/interfaces/five.ImageURLMappings.html +1 -0
  80. package/docs/interfaces/five.ImageURLOptions.html +15 -0
  81. package/docs/interfaces/five.IntersectMeshInterface.html +3 -0
  82. package/docs/interfaces/five.Intersection.html +7 -0
  83. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +15 -0
  84. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +20 -0
  85. package/docs/interfaces/five.ModelEventCallback.html +26 -0
  86. package/docs/interfaces/five.ModelLodOptions.html +1 -0
  87. package/docs/interfaces/five.MotionKeyframe.html +1 -0
  88. package/docs/interfaces/five.MovePanoOptions.html +42 -0
  89. package/docs/interfaces/five.NetworkOptions.html +9 -0
  90. package/docs/interfaces/five.PBMPanoPicture.html +7 -0
  91. package/docs/interfaces/five.PBMParameters.html +29 -0
  92. package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +1 -0
  93. package/docs/interfaces/five.PanoCircleMeshInterface.html +19 -0
  94. package/docs/interfaces/five.PanoCircleMeshOptions.html +1 -0
  95. package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +1 -0
  96. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +35 -0
  97. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +20 -0
  98. package/docs/interfaces/five.Pose.html +37 -0
  99. package/docs/interfaces/five.Scissor.html +14 -0
  100. package/docs/interfaces/five.State.html +21 -0
  101. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -0
  102. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -0
  103. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -0
  104. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -0
  105. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -0
  106. package/docs/interfaces/five.TextureOptions.html +20 -0
  107. package/docs/interfaces/five.Tile3DModelLoaderOptions.html +3 -0
  108. package/docs/interfaces/five.TileBoundingVolume.html +19 -0
  109. package/docs/interfaces/five.TileContent.html +1 -0
  110. package/docs/interfaces/five.TileCubeNode.html +1 -0
  111. package/docs/interfaces/five.TileCubeTree.html +1 -0
  112. package/docs/interfaces/five.Tileset3dOptions.html +1 -0
  113. package/docs/interfaces/five.TilesetJSON.html +1 -0
  114. package/docs/interfaces/five.TilesetJSONNode.html +1 -0
  115. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +9 -0
  116. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +31 -0
  117. package/docs/interfaces/five.WebXRSelectParams.html +1 -0
  118. package/docs/interfaces/five.WorkCubeImage.html +13 -0
  119. package/docs/interfaces/five.WorkImage.html +21 -0
  120. package/docs/interfaces/five.WorkInitial.html +13 -0
  121. package/docs/interfaces/five.WorkModel.html +11 -0
  122. package/docs/interfaces/five.WorkModelTiles.html +3 -0
  123. package/docs/interfaces/five.WorkObserver.html +27 -0
  124. package/docs/interfaces/five.WorkTile.html +1 -0
  125. package/docs/interfaces/five.WorkVideo.html +9 -0
  126. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +31 -0
  127. package/docs/interfaces/gltf_loader.DDS.html +1 -0
  128. package/docs/interfaces/gltf_loader.GLTF.html +7 -0
  129. package/docs/interfaces/gltf_loader.GLTFReference.html +1 -0
  130. package/docs/interfaces/gltf_loader.THREEGLTF.html +1 -0
  131. package/docs/interfaces/react.FiveActionReactCallbacks.html +52 -0
  132. package/docs/interfaces/react.FiveInjectionTypes.html +181 -0
  133. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -0
  134. package/docs/interfaces/server.Intersection.html +7 -0
  135. package/docs/interfaces/server.ModelEventCallback.html +18 -0
  136. package/docs/interfaces/sticker.IntersectionLike.html +8 -0
  137. package/docs/interfaces/vfx.ParticleArgs.html +75 -0
  138. package/docs/interfaces/vfx.ParticleTweenKeyframe.html +1 -0
  139. package/docs/interfaces/vue.FiveActionVueCallbacks.html +60 -0
  140. package/docs/modules/five.SubscribeMixinType.html +1 -0
  141. package/docs/modules/five.html +465 -3002
  142. package/docs/modules/gltf_loader.html +1 -155
  143. package/docs/modules/line.html +1 -202
  144. package/docs/modules/react.html +130 -1507
  145. package/docs/modules/server.html +18 -526
  146. package/docs/modules/sticker.html +1 -151
  147. package/docs/modules/vfx.html +1 -0
  148. package/docs/modules/vue.html +115 -0
  149. package/docs/modules.html +1 -136
  150. package/exporters/staticify.js +210 -0
  151. package/five/index.d.ts +1465 -286
  152. package/five/index.js +362 -1
  153. package/gltf-loader/index.d.ts +90 -5
  154. package/gltf-loader/index.js +260 -1
  155. package/line/index.d.ts +15 -2
  156. package/line/index.js +260 -1
  157. package/package.json +12 -11
  158. package/react/index.d.ts +73 -72
  159. package/react/index.js +260 -1
  160. package/scripts/five-staticify.js +26 -0
  161. package/server/index.d.ts +222 -27
  162. package/server/index.js +357 -1
  163. package/sticker/index.d.ts +2 -1
  164. package/sticker/index.js +260 -1
  165. package/templates/quick-start/package.json +1 -1
  166. package/umd/five-gltf-loader.js +1 -2
  167. package/umd/five-line.js +1 -2
  168. package/umd/five-react.js +1 -2
  169. package/umd/five-sticker.js +1 -2
  170. package/umd/five-vfx.js +1 -0
  171. package/umd/five-vue.js +1 -0
  172. package/umd/five.js +1 -1
  173. package/umd/five.js.LICENSE.txt +58 -118
  174. package/vfx/index.d.ts +264 -0
  175. package/vfx/index.js +260 -0
  176. package/vue/index.d.ts +441 -0
  177. package/vue/index.js +260 -0
  178. package/docs/assets/css/main.css +0 -2660
  179. package/docs/assets/js/main.js +0 -248
  180. package/docs/assets/js/search.js +0 -1
  181. package/docs/classes/five.camera.html +0 -323
  182. package/docs/classes/five.five-1.html +0 -2670
  183. package/docs/classes/five.hashcubetexture.html +0 -252
  184. package/docs/classes/five.internalwebglrenderer.html +0 -212
  185. package/docs/classes/five.model.html +0 -982
  186. package/docs/classes/five.pbmgroup.html +0 -427
  187. package/docs/classes/five.pbmmaterial.html +0 -533
  188. package/docs/classes/five.pbmmesh.html +0 -254
  189. package/docs/classes/five.scene.html +0 -263
  190. package/docs/classes/five.subscribe.html +0 -569
  191. package/docs/classes/gltf_loader.gltfloader.html +0 -412
  192. package/docs/classes/gltf_loader.gltfobject.html +0 -287
  193. package/docs/classes/line.line-1.html +0 -381
  194. package/docs/classes/line.linegeometry.html +0 -524
  195. package/docs/classes/line.linematerial.html +0 -300
  196. package/docs/classes/line.linesegmentsgeometry.html +0 -471
  197. package/docs/classes/react.store.html +0 -605
  198. package/docs/classes/server.model.html +0 -823
  199. package/docs/classes/server.pbmgroup.html +0 -366
  200. package/docs/classes/server.pbmmesh.html +0 -335
  201. package/docs/classes/sticker.sticker-1.html +0 -465
  202. package/docs/interfaces/five.addableobject.html +0 -234
  203. package/docs/interfaces/five.depthpanoramacontrollercustominitargs.html +0 -420
  204. package/docs/interfaces/five.eventcallback.html +0 -2548
  205. package/docs/interfaces/five.fiveinitargs.html +0 -707
  206. package/docs/interfaces/five.floorplancontrollercustominitargs.html +0 -295
  207. package/docs/interfaces/five.imageoptions.html +0 -332
  208. package/docs/interfaces/five.intersection.html +0 -227
  209. package/docs/interfaces/five.intersectmeshinterface.html +0 -188
  210. package/docs/interfaces/five.modelcontrollercustominitargs.html +0 -366
  211. package/docs/interfaces/five.modeleventcallback.html +0 -367
  212. package/docs/interfaces/five.movepanooptions.html +0 -469
  213. package/docs/interfaces/five.panocirclemeshinterface.html +0 -361
  214. package/docs/interfaces/five.panoramacontrollercustominitargs.html +0 -464
  215. package/docs/interfaces/five.panoramalikecontrollercustominitargs.html +0 -364
  216. package/docs/interfaces/five.pbmparameters.html +0 -474
  217. package/docs/interfaces/five.pose.html +0 -270
  218. package/docs/interfaces/five.scissor.html +0 -252
  219. package/docs/interfaces/five.state.html +0 -300
  220. package/docs/interfaces/five.subscribemixintype.emit.html +0 -180
  221. package/docs/interfaces/five.subscribemixintype.haslistener.html +0 -171
  222. package/docs/interfaces/five.subscribemixintype.off.html +0 -198
  223. package/docs/interfaces/five.subscribemixintype.on.html +0 -213
  224. package/docs/interfaces/five.subscribemixintype.once.html +0 -210
  225. package/docs/interfaces/five.topviewcontrollercustominitargs.html +0 -226
  226. package/docs/interfaces/five.vrpanoramacontrollercustominitargs.html +0 -452
  227. package/docs/interfaces/gltf_loader.gltf.html +0 -304
  228. package/docs/interfaces/react.fiveactionreactcallbacks.html +0 -580
  229. package/docs/interfaces/react.fiveinjectiontypes.html +0 -1625
  230. package/docs/interfaces/react.injectfivetoprops.html +0 -280
  231. package/docs/interfaces/server.intersection.html +0 -308
  232. package/docs/interfaces/server.modeleventcallback.html +0 -409
  233. package/docs/interfaces/sticker.intersectionlike.html +0 -223
  234. package/docs/modules/five.subscribemixintype.html +0 -143
  235. package/scripts/export-five-resource/chfs.exe +0 -0
  236. package/scripts/export-five-resource/fileify.js +0 -192
  237. package/scripts/export-five-resource/format-work.js +0 -71
  238. package/scripts/export-five-resource/staticify.js +0 -327
  239. package/scripts/transcode-model/BufferGeometryUtils.js +0 -832
  240. package/scripts/transcode-model/LoaderSupport.js +0 -1545
  241. package/scripts/transcode-model/MTLLoader.js +0 -602
  242. package/scripts/transcode-model/OBJLoader2.js +0 -1470
  243. package/scripts/transcode-model/obj2pbm.js +0 -65
  244. /package/docs/assets/{images/icons.png → icons.png} +0 -0
  245. /package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  246. /package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  247. /package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  248. /package/resource/{basis_transcoder.js → basis/basis_transcoder.js} +0 -0
  249. /package/resource/{basis_transcoder.wasm → basis/basis_transcoder.wasm} +0 -0
  250. /package/resource/{draco_decoder.js → gltf/draco_decoder.js} +0 -0
  251. /package/resource/{draco_decoder.wasm → gltf/draco_decoder.wasm} +0 -0
  252. /package/resource/{draco_wasm_wrapper.js → gltf/draco_wasm_wrapper.js} +0 -0
package/docs/interfaces/react.FiveActionReactCallbacks.html ADDED
@@ -0,0 +1,52 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FiveActionReactCallbacks | 如视 Five SDK - v5.0.0-alpha.201</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.201"/><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.201</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.201</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.FiveActionReactCallbacks.html">FiveActionReactCallbacks</a></li></ul><h1>Interface FiveActionReactCallbacks </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Five 命令集合</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">FiveActionReactCallbacks</span></li></ul></section><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>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#getPixels" class="tsd-kind-icon">get<wbr/>Pixels</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#preloadPano" class="tsd-kind-icon">preload<wbr/>Pano</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#render" class="tsd-kind-icon">render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#updateCamera" class="tsd-kind-icon">update<wbr/>Camera</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getPixels" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pixels<a href="#getPixels" 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-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pixels<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pixelRatio<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:29</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>获取画面中的像素颜色</p>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>获取像素区域的起始坐标 x</p>
7
+ </div></div></li><li><h5>y: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>获取像素区域的起始坐标 y</p>
9
+ </div></div></li><li><h5>width: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>获取像素区域的宽度</p>
11
+ </div></div></li><li><h5>height: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>获取像素区域的高度</p>
13
+ </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> pixelRatio: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>获取区域的像素比</p>
15
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><div><p>rgba颜色平铺的 Uint8Array</p>
16
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="needsRender" class="tsd-anchor"></a><h3 class="tsd-anchor-link">needs<wbr/>Render<a href="#needsRender" 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-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">needs<wbr/>Render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:53</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>下一帧渲染</p>
18
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>调用 <code>render()</code> 和 <code>needsRender()</code> 均可在按需渲染时，使得画面渲染一次
19
+ 区别在于：</p>
20
+ <ul>
21
+ <li><code>needsRender()</code> 为在下帧渲染画面</li>
22
+ <li><code>render()</code> 在当前帧渲染画面
23
+ 推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作，可以使用 <code>render()</code></li>
24
+ </ul>
25
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="preloadPano" class="tsd-anchor"></a><h3 class="tsd-anchor-link">preload<wbr/>Pano<a href="#preloadPano" 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-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">preload<wbr/>Pano<span class="tsd-signature-symbol">(</span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</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/react/hooks/useFiveAction.ts:61</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
26
+ <p>预加载点位图片资源</p>
27
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>panoIndex: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
28
+ <p>观察点序号</p>
29
+ </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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></h5><div class="tsd-comment tsd-typography"><div class="lead">
30
+ <p>加载完成回调, 并传递加载用时。</p>
31
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>costs: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>加载完成的 Promise 参数同 callback</p>
32
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link">render<a href="#render" 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-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>callback<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:42</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>强制渲染</p>
34
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>调用 <code>render()</code> 和 <code>needsRender()</code> 均可在按需渲染时，使得画面渲染一次
35
+ 区别在于：</p>
36
+ <ul>
37
+ <li><code>needsRender()</code> 为在下帧渲染画面</li>
38
+ <li><code>render()</code> 在当前帧渲染画面
39
+ 推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作，可以使用 <code>render()</code></li>
40
+ </ul>
41
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <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">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
42
+ <p>渲染完成回调</p>
43
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="updateCamera" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>Camera<a href="#updateCamera" 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-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Camera<span class="tsd-signature-symbol">(</span>pose<span class="tsd-signature-symbol">: </span><a href="five.Pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a>, duration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</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/react/hooks/useFiveAction.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
44
+ <p>移动相机。（不触发点位移动）</p>
45
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
46
+ 会 Promise.reject。运动完成则 Promise.resolve</p>
47
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pose: <a href="five.Pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
48
+ <p>相机目标位置</p>
49
+ </div></div></li><li><h5>duration: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
50
+ <p>动画触发的时常</p>
51
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise 是否移动成功</p>
52
+ </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><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="current 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><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>React<wbr/>Callbacks</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#getPixels" class="tsd-kind-icon">get<wbr/>Pixels</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#preloadPano" class="tsd-kind-icon">preload<wbr/>Pano</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#render" class="tsd-kind-icon">render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#updateCamera" class="tsd-kind-icon">update<wbr/>Camera</a></li></ul></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><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>