@realsee/five 5.0.0-alpha.100

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 (173) hide show
  1. package/README.md +362 -0
  2. package/TERMS.txt +56 -0
  3. package/docs/.nojekyll +1 -0
  4. package/docs/assets/highlight.css +134 -0
  5. package/docs/assets/icons.css +1043 -0
  6. package/docs/assets/icons.png +0 -0
  7. package/docs/assets/icons@2x.png +0 -0
  8. package/docs/assets/main.js +52 -0
  9. package/docs/assets/search.js +1 -0
  10. package/docs/assets/style.css +1388 -0
  11. package/docs/assets/widgets.png +0 -0
  12. package/docs/assets/widgets@2x.png +0 -0
  13. package/docs/classes/five.AnimationFrameLoop.html +15 -0
  14. package/docs/classes/five.BVH.html +10 -0
  15. package/docs/classes/five.BVHIntersect.html +1 -0
  16. package/docs/classes/five.BVHNode.html +7 -0
  17. package/docs/classes/five.BVHVector3.html +1 -0
  18. package/docs/classes/five.Camera.html +11 -0
  19. package/docs/classes/five.Five.html +303 -0
  20. package/docs/classes/five.InternalWebGLRenderer.html +1 -0
  21. package/docs/classes/five.IntersectMesh.html +1 -0
  22. package/docs/classes/five.LegacyPanoCircleMesh.html +5 -0
  23. package/docs/classes/five.Model.html +77 -0
  24. package/docs/classes/five.NetworkSubscribe.html +50 -0
  25. package/docs/classes/five.PBMContainer.html +17 -0
  26. package/docs/classes/five.PBMGroup.html +19 -0
  27. package/docs/classes/five.PBMMaterial.html +15 -0
  28. package/docs/classes/five.PBMMesh.html +7 -0
  29. package/docs/classes/five.PanoCircleMesh.html +7 -0
  30. package/docs/classes/five.Scene.html +3 -0
  31. package/docs/classes/five.Subscribe.html +56 -0
  32. package/docs/classes/five.Work.html +30 -0
  33. package/docs/classes/gltf_loader.GLTFLoader.html +17 -0
  34. package/docs/classes/gltf_loader.GLTFObject.html +7 -0
  35. package/docs/classes/line.Line.html +1 -0
  36. package/docs/classes/line.LineGeometry.html +1 -0
  37. package/docs/classes/line.LineMaterial.html +1 -0
  38. package/docs/classes/line.LineSegmentsGeometry.html +1 -0
  39. package/docs/classes/line.THREE_Line2.html +1 -0
  40. package/docs/classes/line.THREE_LineSegments2.html +1 -0
  41. package/docs/classes/react.Store.html +29 -0
  42. package/docs/classes/server.BVH.html +10 -0
  43. package/docs/classes/server.BVHIntersect.html +1 -0
  44. package/docs/classes/server.BVHNode.html +7 -0
  45. package/docs/classes/server.BVHVector3.html +1 -0
  46. package/docs/classes/server.Model.html +63 -0
  47. package/docs/classes/server.PBMGroup.html +9 -0
  48. package/docs/classes/server.PBMMesh.html +7 -0
  49. package/docs/classes/sticker.Sticker.html +32 -0
  50. package/docs/index.html +182 -0
  51. package/docs/interfaces/five.AddableObject.html +1 -0
  52. package/docs/interfaces/five.AnimationFrame.html +1 -0
  53. package/docs/interfaces/five.CameraPose.html +1 -0
  54. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +28 -0
  55. package/docs/interfaces/five.EventCallback.html +391 -0
  56. package/docs/interfaces/five.FiveInitArgs.html +96 -0
  57. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +15 -0
  58. package/docs/interfaces/five.ImageOptions.html +16 -0
  59. package/docs/interfaces/five.ImageURLOptions.html +1 -0
  60. package/docs/interfaces/five.IntersectMeshInterface.html +3 -0
  61. package/docs/interfaces/five.Intersection.html +7 -0
  62. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +20 -0
  63. package/docs/interfaces/five.ModelEventCallback.html +22 -0
  64. package/docs/interfaces/five.MovePanoOptions.html +39 -0
  65. package/docs/interfaces/five.PBMPanoPicture.html +7 -0
  66. package/docs/interfaces/five.PBMParameters.html +15 -0
  67. package/docs/interfaces/five.PanoCircleMeshInterface.html +19 -0
  68. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +28 -0
  69. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +20 -0
  70. package/docs/interfaces/five.Pose.html +35 -0
  71. package/docs/interfaces/five.Scissor.html +14 -0
  72. package/docs/interfaces/five.State.html +19 -0
  73. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -0
  74. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -0
  75. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -0
  76. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -0
  77. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -0
  78. package/docs/interfaces/five.TextureOptions.html +18 -0
  79. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -0
  80. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +24 -0
  81. package/docs/interfaces/five.WorkCubeImage.html +13 -0
  82. package/docs/interfaces/five.WorkImage.html +21 -0
  83. package/docs/interfaces/five.WorkInitial.html +13 -0
  84. package/docs/interfaces/five.WorkModel.html +11 -0
  85. package/docs/interfaces/five.WorkObserver.html +25 -0
  86. package/docs/interfaces/five.WorkTile.html +1 -0
  87. package/docs/interfaces/five.WorkVideo.html +9 -0
  88. package/docs/interfaces/gltf_loader.GLTF.html +7 -0
  89. package/docs/interfaces/react.FiveActionReactCallbacks.html +62 -0
  90. package/docs/interfaces/react.FiveInjectionTypes.html +191 -0
  91. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -0
  92. package/docs/interfaces/server.Intersection.html +7 -0
  93. package/docs/interfaces/server.ModelEventCallback.html +18 -0
  94. package/docs/interfaces/sticker.IntersectionLike.html +8 -0
  95. package/docs/media/coordinate.jpg +0 -0
  96. package/docs/media/topview.jpg +0 -0
  97. package/docs/media/typescript.jpg +0 -0
  98. package/docs/modules/five.SubscribeMixinType.html +1 -0
  99. package/docs/modules/five.html +481 -0
  100. package/docs/modules/gltf_loader.html +1 -0
  101. package/docs/modules/line.html +1 -0
  102. package/docs/modules/react.html +130 -0
  103. package/docs/modules/server.html +18 -0
  104. package/docs/modules/sticker.html +1 -0
  105. package/docs/modules.html +1 -0
  106. package/exporters/staticify.js +203 -0
  107. package/five/index.d.ts +2061 -0
  108. package/five/index.js +372 -0
  109. package/gltf-loader/index.d.ts +75 -0
  110. package/gltf-loader/index.js +260 -0
  111. package/line/index.d.ts +68 -0
  112. package/line/index.js +260 -0
  113. package/package.json +36 -0
  114. package/react/index.d.ts +812 -0
  115. package/react/index.js +260 -0
  116. package/resource/basis/basis_transcoder.js +22 -0
  117. package/resource/basis/basis_transcoder.wasm +0 -0
  118. package/resource/gltf/draco_decoder.js +31 -0
  119. package/resource/gltf/draco_decoder.wasm +0 -0
  120. package/resource/gltf/draco_wasm_wrapper.js +119 -0
  121. package/scripts/five-plugin-init.js +83 -0
  122. package/scripts/five-quick-start-init.js +80 -0
  123. package/scripts/five-react-component-init.js +83 -0
  124. package/scripts/five-staticify.js +21 -0
  125. package/server/index.d.ts +568 -0
  126. package/server/index.js +367 -0
  127. package/sticker/index.d.ts +70 -0
  128. package/sticker/index.js +260 -0
  129. package/templates/plugin/README.md +38 -0
  130. package/templates/plugin/devtools/external-five.js +5 -0
  131. package/templates/plugin/devtools/external-three.js +5 -0
  132. package/templates/plugin/devtools/tsconfig.build.json +18 -0
  133. package/templates/plugin/devtools/webpack.bundle.js +44 -0
  134. package/templates/plugin/devtools/webpack.example.js +39 -0
  135. package/templates/plugin/docs/.gitkeep +0 -0
  136. package/templates/plugin/examples/data.json +507 -0
  137. package/templates/plugin/examples/index.html +28 -0
  138. package/templates/plugin/examples/index.ts +12 -0
  139. package/templates/plugin/lib/index.ts +30 -0
  140. package/templates/plugin/package.json +32 -0
  141. package/templates/plugin/tsconfig.json +26 -0
  142. package/templates/quick-start/README.md +47 -0
  143. package/templates/quick-start/assets/work.json +507 -0
  144. package/templates/quick-start/index.html +54 -0
  145. package/templates/quick-start/index.tsx +123 -0
  146. package/templates/quick-start/package.json +25 -0
  147. package/templates/quick-start/tsconfig.json +27 -0
  148. package/templates/quick-start/webpack.config.js +45 -0
  149. package/templates/quick-start/webpack.production.js +42 -0
  150. package/templates/react-component/README.md +32 -0
  151. package/templates/react-component/devtools/external-five.js +5 -0
  152. package/templates/react-component/devtools/external-react.js +5 -0
  153. package/templates/react-component/devtools/external-three.js +5 -0
  154. package/templates/react-component/devtools/tsconfig.build.json +19 -0
  155. package/templates/react-component/devtools/webpack.bundle.js +44 -0
  156. package/templates/react-component/devtools/webpack.example.js +39 -0
  157. package/templates/react-component/docs/.gitkeep +0 -0
  158. package/templates/react-component/examples/data.json +507 -0
  159. package/templates/react-component/examples/index.html +17 -0
  160. package/templates/react-component/examples/index.tsx +62 -0
  161. package/templates/react-component/lib/index.tsx +157 -0
  162. package/templates/react-component/package.json +38 -0
  163. package/templates/react-component/tsconfig.json +27 -0
  164. package/umd/five-gltf-loader.js +2 -0
  165. package/umd/five-gltf-loader.js.LICENSE.txt +14 -0
  166. package/umd/five-line.js +2 -0
  167. package/umd/five-line.js.LICENSE.txt +14 -0
  168. package/umd/five-react.js +2 -0
  169. package/umd/five-react.js.LICENSE.txt +14 -0
  170. package/umd/five-sticker.js +2 -0
  171. package/umd/five-sticker.js.LICENSE.txt +14 -0
  172. package/umd/five.js +2 -0
  173. package/umd/five.js.LICENSE.txt +116 -0
package/docs/classes/server.PBMGroup.html ADDED
@@ -0,0 +1,9 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PBMGroup | 如视 Five SDK - v5.0.0-alpha.100</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.100"/><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.100</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.100</a></li><li><a href="../modules/server.html">server</a></li><li><a href="server.PBMGroup.html">PBMGroup</a></li></ul><h1>Class PBMGroup</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>PBM 模型组</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Group</span><ul class="tsd-hierarchy"><li><span class="target">PBMGroup</span><ul class="tsd-hierarchy"><li><a href="server.Model.html" class="tsd-signature-type" data-tsd-kind="Class">Model</a></li></ul></li></ul></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 tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="server.PBMGroup.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMGroup.html#floorIndex" class="tsd-kind-icon">floor<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMGroup.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="server.PBMGroup.html#disposeGeometry" class="tsd-kind-icon">dispose<wbr/>Geometry</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new PBMGroup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="server.PBMGroup.html" class="tsd-signature-type" data-tsd-kind="Class">PBMGroup</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from THREE.Group.constructor</p><ul><li>Defined in node_modules/three/src/objects/Group.d.ts:5</li></ul></aside><h4 class="tsd-returns-title">Returns <a href="server.PBMGroup.html" class="tsd-signature-type" data-tsd-kind="Class">PBMGroup</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="floorIndex" class="tsd-anchor"></a><h3>floor<wbr/>Index</h3><div class="tsd-signature tsd-kind-icon">floor<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/server/core/pbmGroup.ts:8</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>楼层序号</p>
5
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="needsRender" class="tsd-anchor"></a><h3>needs<wbr/>Render</h3><div class="tsd-signature tsd-kind-icon">needs<wbr/>Render<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/server/core/pbmGroup.ts:11</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>是否需要更新按需渲染</p>
7
+ </div></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-class"><a id="disposeGeometry" class="tsd-anchor"></a><h3>dispose<wbr/>Geometry</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">dispose<wbr/>Geometry<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/five/server/core/pbmGroup.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>析构模型网格</p>
9
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></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=" tsd-kind-module"><a href="../modules/react.html">react</a></li><li class="current tsd-kind-module"><a href="../modules/server.html">server</a></li><li class=" tsd-kind-module"><a href="../modules/sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="server.PBMGroup.html" class="tsd-kind-icon">PBMGroup</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="server.PBMGroup.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMGroup.html#floorIndex" class="tsd-kind-icon">floor<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMGroup.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="server.PBMGroup.html#disposeGeometry" class="tsd-kind-icon">dispose<wbr/>Geometry</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-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><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</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/docs/classes/server.PBMMesh.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PBMMesh | 如视 Five SDK - v5.0.0-alpha.100</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.100"/><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.100</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.100</a></li><li><a href="../modules/server.html">server</a></li><li><a href="server.PBMMesh.html">PBMMesh</a></li></ul><h1>Class PBMMesh</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>PBM 对象</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Mesh</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">PBMMesh</span></li></ul></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 tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="server.PBMMesh.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMMesh.html#floorIndex" class="tsd-kind-icon">floor<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMMesh.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new PBMMesh<span class="tsd-signature-symbol">(</span>geometry<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BufferGeometry</span>, material<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Material</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Material</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="server.PBMMesh.html" class="tsd-signature-type" data-tsd-kind="Class">PBMMesh</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from THREE.Mesh&lt;THREE.BufferGeometry&gt;.constructor</p><ul><li>Defined in node_modules/three/src/objects/Mesh.d.ts:13</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> geometry: <span class="tsd-signature-type">BufferGeometry</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> material: <span class="tsd-signature-type">Material</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Material</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="server.PBMMesh.html" class="tsd-signature-type" data-tsd-kind="Class">PBMMesh</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="floorIndex" class="tsd-anchor"></a><h3>floor<wbr/>Index</h3><div class="tsd-signature tsd-kind-icon">floor<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/server/core/pbmMesh.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>楼层序号</p>
5
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="needsRender" class="tsd-anchor"></a><h3>needs<wbr/>Render</h3><div class="tsd-signature tsd-kind-icon">needs<wbr/>Render<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/server/core/pbmMesh.ts:8</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>是否需要更新按需渲染</p>
7
+ </div></div></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=" tsd-kind-module"><a href="../modules/react.html">react</a></li><li class="current tsd-kind-module"><a href="../modules/server.html">server</a></li><li class=" tsd-kind-module"><a href="../modules/sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="server.PBMMesh.html" class="tsd-kind-icon">PBMMesh</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="server.PBMMesh.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMMesh.html#floorIndex" class="tsd-kind-icon">floor<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="server.PBMMesh.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</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-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><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</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/docs/classes/sticker.Sticker.html ADDED
@@ -0,0 +1,32 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Sticker | 如视 Five SDK - v5.0.0-alpha.100</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.100"/><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.100</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.100</a></li><li><a href="../modules/sticker.html">sticker</a></li><li><a href="sticker.Sticker.html">Sticker</a></li></ul><h1>Class Sticker</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>贴纸</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Mesh</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.BufferGeometry</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">THREE.MeshBasicMaterial</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">Sticker</span></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="sticker.Sticker.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="sticker.Sticker.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#dispose" class="tsd-kind-icon">dispose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#locationWithIntersection" class="tsd-kind-icon">location<wbr/>With<wbr/>Intersection</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#setSize" class="tsd-kind-icon">set<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#setTransparent" class="tsd-kind-icon">set<wbr/>Transparent</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Sticker<span class="tsd-signature-symbol">(</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>, resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sticker.Sticker.html" class="tsd-signature-type" data-tsd-kind="Class">Sticker</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides THREE.Mesh&lt;THREE.BufferGeometry, THREE.MeshBasicMaterial&gt;.constructor</p><ul><li>Defined in lib/sticker/index.ts:101</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>贴纸</p>
5
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>默认加载时, 透明图根据图片类型，如果是 png 默认透明，其他为不透明，且不支持 gif 动画。</p>
6
+ </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">resource</span><span class="hl-0"> = </span><span class="hl-3">&quot;http://vrlab-public.ljcdn.com/release/static/image/release/five/demo/sticker/kagami.jpg&quot;</span><span class="hl-0">;</span><br/><span class="hl-2">five</span><span class="hl-0">.</span><span class="hl-5">on</span><span class="hl-0">(</span><span class="hl-3">&quot;wantsTapGesture&quot;</span><span class="hl-0">, </span><span class="hl-2">raycaster</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> [</span><span class="hl-6">intersection</span><span class="hl-0">] = </span><span class="hl-2">five</span><span class="hl-0">.</span><span class="hl-2">model</span><span class="hl-0">.</span><span class="hl-5">intersectRaycaster</span><span class="hl-0">(</span><span class="hl-2">raycaster</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">if</span><span class="hl-0"> (</span><span class="hl-2">intersection</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">sticker</span><span class="hl-0"> = </span><span class="hl-7">new</span><span class="hl-0"> </span><span class="hl-5">Sticker</span><span class="hl-0">(</span><span class="hl-13">1</span><span class="hl-0">, </span><span class="hl-13">1</span><span class="hl-0">, </span><span class="hl-2">resource</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">five</span><span class="hl-0">.</span><span class="hl-2">scene</span><span class="hl-0">.</span><span class="hl-5">add</span><span class="hl-0">(</span><span class="hl-2">sticker</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">sticker</span><span class="hl-0">.</span><span class="hl-5">locationWithIntersection</span><span class="hl-0">(</span><span class="hl-2">intersection</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> </span><span class="hl-7">false</span><span class="hl-0">;</span><br/><span class="hl-0">});</span>
7
+ </code></pre>
8
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>width: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>贴纸长</p>
10
+ </div></div></li><li><h5>height: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>贴纸宽</p>
12
+ </div></div></li><li><h5>resource: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLVideoElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>贴纸图片地址 或者 image / canvas / video 标签</p>
14
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="sticker.Sticker.html" class="tsd-signature-type" data-tsd-kind="Class">Sticker</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="needsRender" class="tsd-anchor"></a><h3>needs<wbr/>Render</h3><ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> needsRender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> needsRender<span class="tsd-signature-symbol">(</span>value<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/sticker/index.ts:146</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/sticker/index.ts:150</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></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-class"><a id="dispose" class="tsd-anchor"></a><h3>dispose</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">dispose<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/sticker/index.ts:196</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
15
+ <p>资源回收</p>
16
+ </div></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-class"><a id="locationWithIntersection" class="tsd-anchor"></a><h3>location<wbr/>With<wbr/>Intersection</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">location<wbr/>With<wbr/>Intersection<span class="tsd-signature-symbol">(</span>intersection<span class="tsd-signature-symbol">: </span><a href="../interfaces/sticker.IntersectionLike.html" class="tsd-signature-type" data-tsd-kind="Interface">IntersectionLike</a>, offset<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"><aside class="tsd-sources"><ul><li>Defined in lib/sticker/index.ts:183</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>通过焦点快捷设置贴纸位置</p>
18
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>intersection: <a href="../interfaces/sticker.IntersectionLike.html" class="tsd-signature-type" data-tsd-kind="Interface">IntersectionLike</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>焦点</p>
20
+ </div></div></li><li><h5>offset: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.005</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
21
+ <p>位置值（已通过焦点面的法线位移一定值，防止重叠）</p>
22
+ </div></div></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-class"><a id="setSize" class="tsd-anchor"></a><h3>set<wbr/>Size</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Size<span class="tsd-signature-symbol">(</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><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/sticker/index.ts:164</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>设置贴纸大小</p>
24
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>width: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>贴纸长</p>
26
+ </div></div></li><li><h5>height: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>贴纸宽</p>
28
+ </div></div></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-class"><a id="setTransparent" class="tsd-anchor"></a><h3>set<wbr/>Transparent</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Transparent<span class="tsd-signature-symbol">(</span>transparent<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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/sticker/index.ts:173</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
29
+ <p>设置贴纸背景是否透明</p>
30
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>transparent: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
31
+ <p>是否透明</p>
32
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></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=" 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="current tsd-kind-module"><a href="../modules/sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="sticker.Sticker.html" class="tsd-kind-icon">Sticker</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="sticker.Sticker.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="sticker.Sticker.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#dispose" class="tsd-kind-icon">dispose</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#locationWithIntersection" class="tsd-kind-icon">location<wbr/>With<wbr/>Intersection</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#setSize" class="tsd-kind-icon">set<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="sticker.Sticker.html#setTransparent" class="tsd-kind-icon">set<wbr/>Transparent</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-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><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</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></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/docs/index.html ADDED
@@ -0,0 +1,182 @@
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.100</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.100"/><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.100</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.100</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
2
+ <a href="#fivejs" id="fivejs" style="color: inherit; text-decoration: none;">
3
+ <h1>Five.js</h1>
4
+ </a>
5
+ <p><a href="https://www.npmjs.com/package/@realsee/five"><img src="https://img.shields.io/npm/v/@realsee/five.svg?style=flat-square&logo=npm&label=npm%20install%20@realsee/five" alt="npm version"></a></p>
6
+ <p>贝壳如视三维渲染框架</p>
7
+
8
+ <a href="#什么是five" id="什么是five" style="color: inherit; text-decoration: none;">
9
+ <h2>什么是<strong>Five</strong></h2>
10
+ </a>
11
+ <p><strong>Five</strong>是 <a href="https://realsee.com">贝壳如视(realsee.com)</a> 提供的在浏览器中运行的三维空间渲染 Javascript SDK。您可以通过<a href="https://developers.realsee.com">如视开发者中心</a>的数据服务，并结合<strong>Five</strong>，制作丰富多彩的三维空间应用。</p>
12
+ <p>并且<strong>Five</strong>提供了一系列的方法、事件、生命周期函数。您可以方便地基于<strong>Five</strong>进行二次开发，并结合到您自身的项目中，为您的项目添砖加瓦。</p>
13
+ <p><strong>Five</strong>通过 <a href="https://www.typescriptlang.org/">TypeScript</a> 编写，保证开发的质量以及编程体验，推荐通过 <a href="https://code.visualstudio.com">Visual Studio Code</a>、<a href="https://www.jetbrains.com/webstorm/">WebStorm</a> 等现代源代码编辑器，您将可以体验到友好的代码提示以及自动补全。</p>
14
+ <p><strong>Five</strong>还提供了完善的 <a href="https://reactjs.org/docs/hooks-intro.html">React Hooks API</a> ，可以方便的通过 <a href="https://reactjs.org">React</a> 开发复杂的响应式数据应用。当然直接使用<strong>Five</strong>开发也是没有问题的。</p>
15
+
16
+ <a href="#安装five" id="安装five" style="color: inherit; text-decoration: none;">
17
+ <h2>安装<strong>Five</strong></h2>
18
+ </a>
19
+ <p><strong>Five</strong>提供通过 <a href="https://www.npmjs.com">npm</a> 的方式安装。<strong>Five</strong>基于 <a href="https://threejs.org">Three.js</a>, 所以同时您需要安装相关依赖。</p>
20
+ <p>目前依赖的<strong>three</strong>版本为 115 ~ 117 的版本</p>
21
+ <pre><code class="language-shell"><span class="hl-0">npm install @realsee/five three@0.117.1</span>
22
+ </code></pre>
23
+ <p>如果您使用<strong>React Hooks API</strong>，那么也请同时安装<strong>React</strong>的相关依赖。</p>
24
+ <pre><code class="language-shell"><span class="hl-0">npm install @realsee/five three@0.117.1 react react-dom @types/react @types/react-dom</span>
25
+ </code></pre>
26
+ <p>接下来便可以在您的项目使用<strong>Five</strong>了。</p>
27
+ <pre><code class="language-typescript"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">Five</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@realsee/five&quot;</span><span class="hl-0">;</span><br/><span class="hl-4">// 如果您使用 React Hoos API</span><br/><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">useFiveState</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@realsee/five/react&quot;</span><span class="hl-0">;</span><br/>
28
+ </code></pre>
29
+
30
+ <a href="#浏览器兼容性" id="浏览器兼容性" style="color: inherit; text-decoration: none;">
31
+ <h2>浏览器兼容性</h2>
32
+ </a>
33
+ <table>
34
+ <thead>
35
+ <tr>
36
+ <th align="center">Safari</th>
37
+ <th align="center">Safari on iOS</th>
38
+ <th align="right">Chrome</th>
39
+ <th align="center">Chrome for Android</th>
40
+ <th align="center">Edge</th>
41
+ <th align="center">Firefox</th>
42
+ </tr>
43
+ </thead>
44
+ <tbody><tr>
45
+ <td align="center">&gt;= 9</td>
46
+ <td align="center">&gt;= 9</td>
47
+ <td align="right">&gt;= 49</td>
48
+ <td align="center">&gt;= 93</td>
49
+ <td align="center">&gt;= 13</td>
50
+ <td align="center">&gt;= 45</td>
51
+ </tr>
52
+ </tbody></table>
53
+
54
+ <a href="#快速上手" id="快速上手" style="color: inherit; text-decoration: none;">
55
+ <h2>快速上手</h2>
56
+ </a>
57
+ <p><strong>Five</strong>提供了快速上手体验的项目生成工具，您可以通过他熟悉<strong>Five</strong>的功能以及尝试基于<strong>Five</strong>开发功能。</p>
58
+ <ol>
59
+ <li>先创建一个文件夹<code>five-quick-start</code>, 作为项目根目录并且使用 <code>npm init</code> 命令初始化一个工程。</li>
60
+ </ol>
61
+ <pre><code class="language-shell"><span class="hl-0">mkdir five-quick-start &amp;&amp; </span><span class="hl-5">cd</span><span class="hl-0"> five-quick-start &amp;&amp; npm init -y</span>
62
+ </code></pre>
63
+ <ol start="2">
64
+ <li>安装<strong>Five</strong></li>
65
+ </ol>
66
+ <pre><code class="language-shell"><span class="hl-0">npm install @realsee/five</span>
67
+ </code></pre>
68
+ <ol start="3">
69
+ <li>通过<strong>Five</strong>的内置的<code>five-quick-start-init</code>脚本来快速补完当前项目</li>
70
+ </ol>
71
+ <pre><code class="language-shell"><span class="hl-0">npx five-quick-start-init</span>
72
+ </code></pre>
73
+ <p>项目的文件结构如下</p>
74
+ <pre><code><span class="hl-0">.</span><br/><span class="hl-0">├── </span><span class="hl-6">README</span><span class="hl-0">.</span><span class="hl-2">md</span><br/><span class="hl-0">├── </span><span class="hl-2">assets</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><br/><span class="hl-0">│ ├── </span><span class="hl-2">data0</span><span class="hl-0">.</span><span class="hl-2">json</span><br/><span class="hl-0">│ └── </span><span class="hl-2">data1</span><span class="hl-0">.</span><span class="hl-2">json</span><br/><span class="hl-0">├── </span><span class="hl-2">index</span><span class="hl-0">.</span><span class="hl-2">html</span><span class="hl-0"> </span><span class="hl-2">页面模版</span><br/><span class="hl-0">├── </span><span class="hl-2">index</span><span class="hl-0">.</span><span class="hl-2">tsx</span><span class="hl-0"> </span><span class="hl-2">逻辑代码</span><br/><span class="hl-0">├── </span><span class="hl-2">package</span><span class="hl-0">.</span><span class="hl-2">json</span><span class="hl-0"> </span><span class="hl-2">npm</span><span class="hl-0"> </span><span class="hl-2">包管理描述</span><br/><span class="hl-0">├── </span><span class="hl-2">tsconfig</span><span class="hl-0">.</span><span class="hl-2">json</span><span class="hl-0"> </span><span class="hl-2">typescript</span><span class="hl-0"> </span><span class="hl-2">配置</span><br/><span class="hl-0">├── </span><span class="hl-2">webpack</span><span class="hl-0">.</span><span class="hl-2">config</span><span class="hl-0">.</span><span class="hl-2">js</span><span class="hl-0"> </span><span class="hl-2">webpack</span><span class="hl-0"> </span><span class="hl-2">开发环境配置</span><br/><span class="hl-0">└── </span><span class="hl-2">webpack</span><span class="hl-0">.</span><span class="hl-2">production</span><span class="hl-0">.</span><span class="hl-2">js</span><span class="hl-0"> </span><span class="hl-2">webpack</span><span class="hl-0"> </span><span class="hl-2">生产配置</span>
75
+ </code></pre>
76
+ <p>通<strong>npm script</strong>运行测试环境</p>
77
+ <pre><code class="language-shell"><span class="hl-0">npm run dev</span>
78
+ </code></pre>
79
+ <p>默认将会在 <code>port: 3000</code> 开启 <code>webpack dev server</code>。您也可以在 <code>webpack.config.js</code> 中修改配置。</p>
80
+ <ol start="4">
81
+ <li>现在可以打来浏览器 <code>http://0.0.0.0:3000</code> 来看看项目初始化的效果了。您可以修改代码来体验一下如何使用<strong>Five</strong>来二次开发。</li>
82
+ </ol>
83
+
84
+ <a href="#如何使用five" id="如何使用five" style="color: inherit; text-decoration: none;">
85
+ <h2>如何使用<strong>Five</strong></h2>
86
+ </a>
87
+ <p><strong>Five</strong>的简单使用样例:</p>
88
+ <pre><code class="language-ts"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">Five</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@realsee/five&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">// 构造函数的具体参数见文档</span><br/><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">five</span><span class="hl-0"> = </span><span class="hl-7">new</span><span class="hl-0"> </span><span class="hl-5">Five</span><span class="hl-0">();</span><br/><br/><span class="hl-4">// 将渲染视图的 canvas 添加到 DOM 中</span><br/><span class="hl-2">five</span><span class="hl-0">.</span><span class="hl-5">appendTo</span><span class="hl-0">(</span><span class="hl-2">document</span><span class="hl-0">.</span><span class="hl-5">getElementById</span><span class="hl-0">(</span><span class="hl-3">&#39;app&#39;</span><span class="hl-0">)!);</span><br/><br/><span class="hl-4">// 如果显示区域需要变动，在变动时请调用 refresh 重置显示参数</span><br/><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-5">addEventListener</span><span class="hl-0">(</span><span class="hl-3">&#39;resize&#39;</span><span class="hl-0">, () </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-2">five</span><span class="hl-0">.</span><span class="hl-5">refresh</span><span class="hl-0">());</span><br/><br/><span class="hl-4">// 获取三维空间的 Work 数据，加载进来</span><br/><span class="hl-4">// Work 数据可以通过如视开发者中心获取</span><br/><span class="hl-5">fetch</span><span class="hl-0">(</span><span class="hl-3">`./work.json`</span><span class="hl-0">)</span><br/><span class="hl-0"> .</span><span class="hl-5">then</span><span class="hl-0">(</span><span class="hl-2">res</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-2">res</span><span class="hl-0">.</span><span class="hl-5">json</span><span class="hl-0">())</span><br/><span class="hl-0"> .</span><span class="hl-5">then</span><span class="hl-0">(</span><span class="hl-2">work</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-2">five</span><span class="hl-0">.</span><span class="hl-5">load</span><span class="hl-0">(</span><span class="hl-2">work</span><span class="hl-0">));</span>
89
+ </code></pre>
90
+ <p>其他的 Five API 待补充</p>
91
+
92
+ <a href="#在react框架中使用five" id="在react框架中使用five" style="color: inherit; text-decoration: none;">
93
+ <h2>在<strong>React</strong>框架中使用<strong>Five</strong></h2>
94
+ </a>
95
+ <p>在<strong>React</strong>框架中使用<strong>Five</strong>的简单使用样例:</p>
96
+ <pre><code class="language-tsx"><span class="hl-1">import</span><span class="hl-0"> </span><span class="hl-7">*</span><span class="hl-0"> </span><span class="hl-1">as</span><span class="hl-0"> </span><span class="hl-2">React</span><span class="hl-0"> </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;react&quot;</span><span class="hl-0">;</span><br/><span class="hl-1">import</span><span class="hl-0"> </span><span class="hl-7">*</span><span class="hl-0"> </span><span class="hl-1">as</span><span class="hl-0"> </span><span class="hl-2">ReactDOM</span><span class="hl-0"> </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;react-dom&quot;</span><span class="hl-0">;</span><br/><span class="hl-1">import</span><span class="hl-0"> {</span><span class="hl-2">Five</span><span class="hl-0">, </span><span class="hl-2">Work</span><span class="hl-0">, </span><span class="hl-2">parseWork</span><span class="hl-0">} </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@realsee/five&quot;</span><span class="hl-0">;</span><br/><span class="hl-1">import</span><span class="hl-0"> {</span><span class="hl-2">createFiveProvider</span><span class="hl-0">, </span><span class="hl-2">FiveCanvas</span><span class="hl-0">} </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;@realsee/five/react&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">// 创建 Provider, 参数与 new Five 参数类似</span><br/><span class="hl-4">// 构造函数的具体参数见文档</span><br/><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">FiveProvider</span><span class="hl-0"> = </span><span class="hl-5">createFiveProvider</span><span class="hl-0">();</span><br/><br/><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-5">App</span><span class="hl-0">: </span><span class="hl-8">React</span><span class="hl-0">.</span><span class="hl-8">FC</span><span class="hl-0"> = () </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><br/><span class="hl-0"> </span><span class="hl-4">// 声明 State: Work</span><br/><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> [</span><span class="hl-6">work</span><span class="hl-0">, </span><span class="hl-6">setWork</span><span class="hl-0">] = </span><span class="hl-2">React</span><span class="hl-0">.</span><span class="hl-5">useState</span><span class="hl-0">&lt;</span><span class="hl-8">Work</span><span class="hl-0"> | </span><span class="hl-8">null</span><span class="hl-0">&gt;(</span><span class="hl-7">null</span><span class="hl-0">);</span><br/><br/><span class="hl-0"> </span><span class="hl-4">// 声明 State: Size&lt;{width, height}&gt;</span><br/><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> [</span><span class="hl-6">size</span><span class="hl-0">, </span><span class="hl-6">setSize</span><span class="hl-0">] = </span><span class="hl-2">React</span><span class="hl-0">.</span><span class="hl-5">useState</span><span class="hl-0">({</span><br/><span class="hl-0"> </span><span class="hl-2">width:</span><span class="hl-0"> </span><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-2">innerWidth</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-2">height:</span><span class="hl-0"> </span><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-2">innerHeight</span><br/><span class="hl-0"> })</span><br/><br/><span class="hl-0"> </span><span class="hl-4">// 获取三维空间的 Work 数据，加载进来</span><br/><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">loadWork</span><span class="hl-0"> = </span><span class="hl-2">React</span><span class="hl-0">.</span><span class="hl-5">useCallback</span><span class="hl-0">((</span><span class="hl-2">url</span><span class="hl-0">: </span><span class="hl-8">string</span><span class="hl-0">) </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">fetch</span><span class="hl-0">(</span><span class="hl-2">url</span><span class="hl-0">)</span><br/><span class="hl-0"> .</span><span class="hl-5">then</span><span class="hl-0">(</span><span class="hl-2">res</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-2">res</span><span class="hl-0">.</span><span class="hl-5">json</span><span class="hl-0">())</span><br/><span class="hl-0"> .</span><span class="hl-5">then</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-5">setWork</span><span class="hl-0">(</span><span class="hl-5">parseWork</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0">)));</span><br/><span class="hl-0"> }, []);</span><br/><br/><span class="hl-0"> </span><span class="hl-2">React</span><span class="hl-0">.</span><span class="hl-5">useEffect</span><span class="hl-0">(() </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">loadWork</span><span class="hl-0">(</span><span class="hl-3">&quot;./data0.json&quot;</span><span class="hl-0">);</span><br/><span class="hl-0"> }, []);</span><br/><br/><span class="hl-0"> </span><span class="hl-4">// 如果显示区域需要变动，在变动时请调用 FiveCanvas 的 size</span><br/><span class="hl-0"> </span><span class="hl-2">React</span><span class="hl-0">.</span><span class="hl-5">useEffect</span><span class="hl-0">(() </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-5">onResize</span><span class="hl-0"> = () </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">setSize</span><span class="hl-0">({</span><br/><span class="hl-0"> </span><span class="hl-2">width:</span><span class="hl-0"> </span><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-2">innerWidth</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-2">height:</span><span class="hl-0"> </span><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-2">innerHeight</span><br/><span class="hl-0"> });</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-5">addEventListener</span><span class="hl-0">(</span><span class="hl-3">&quot;resize&quot;</span><span class="hl-0">, </span><span class="hl-2">onResize</span><span class="hl-0">, </span><span class="hl-7">false</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> () </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-2">window</span><span class="hl-0">.</span><span class="hl-5">removeEventListener</span><span class="hl-0">(</span><span class="hl-3">&quot;resize&quot;</span><span class="hl-0">, </span><span class="hl-2">onResize</span><span class="hl-0">, </span><span class="hl-7">false</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-1">if</span><span class="hl-0"> (</span><span class="hl-2">work</span><span class="hl-0">) {</span><br/><span class="hl-0"> {</span><span class="hl-4">/*</span><br/><span class="hl-4"> 在 FiveProvider 内承载一个 Five 实例，</span><br/><span class="hl-4"> 在他内部的组件可以使用 Five React Hook API 来获取/设置/操作 他</span><br/><span class="hl-4"> 一个页面中也可以有多个 FiveProvider</span><br/><span class="hl-4"> */</span><span class="hl-0">}</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> </span><span class="hl-9">&lt;</span><span class="hl-8">FiveProvider</span><span class="hl-0"> </span><span class="hl-10">initialWork</span><span class="hl-0">=</span><span class="hl-7">{</span><span class="hl-2">work</span><span class="hl-7">}</span><span class="hl-9">&gt;</span><br/><span class="hl-0"> </span><span class="hl-7">{</span><span class="hl-4">/*</span><br/><span class="hl-4"> 将渲染视图的 canvas 添加到 DOM 中</span><br/><span class="hl-4"> FiveCanvas 需要出现在 FiveProvider 内，他将渲染 FiveProvider 的视图</span><br/><span class="hl-4"> 这样的设计可以实现不同的 DOM 层级结构</span><br/><span class="hl-4"> 在 FiveProvider 内的其他组件也可以使用 Five React Hook API 来获取/设置/操作 他外部的 FiveProvider</span><br/><span class="hl-4"> */</span><span class="hl-7">}</span><br/><span class="hl-0"> </span><span class="hl-9">&lt;</span><span class="hl-8">FiveCanvas</span><span class="hl-0"> </span><span class="hl-10">width</span><span class="hl-0">=</span><span class="hl-7">{</span><span class="hl-2">size</span><span class="hl-11">.</span><span class="hl-2">width</span><span class="hl-7">}</span><span class="hl-0"> </span><span class="hl-10">height</span><span class="hl-0">=</span><span class="hl-7">{</span><span class="hl-2">size</span><span class="hl-11">.</span><span class="hl-2">height</span><span class="hl-7">}</span><span class="hl-9">/&gt;</span><br/><span class="hl-0"> </span><span class="hl-9">&lt;/</span><span class="hl-8">FiveProvider</span><span class="hl-9">&gt;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> </span><span class="hl-7">null</span><span class="hl-0">;</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-2">ReactDOM</span><span class="hl-0">.</span><span class="hl-5">render</span><span class="hl-0">(</span><span class="hl-9">&lt;</span><span class="hl-8">App</span><span class="hl-9">&gt;&lt;/</span><span class="hl-8">App</span><span class="hl-9">&gt;</span><span class="hl-0">, </span><span class="hl-2">document</span><span class="hl-0">.</span><span class="hl-5">getElementById</span><span class="hl-0">(</span><span class="hl-3">&quot;app&quot;</span><span class="hl-0">));</span>
97
+ </code></pre>
98
+ <p>其他的<strong>Five React Hook API</strong>文档建设中...</p>
99
+
100
+ <a href="#five-api文档" id="five-api文档" style="color: inherit; text-decoration: none;">
101
+ <h2><strong>Five API</strong>文档</h2>
102
+ </a>
103
+ <p>欢迎查看 <a href="https://unpkg.com/@realsee/five/docs/index.html">Five API 文档</a> 。</p>
104
+ <p>该文档由 <a href="https://typedoc.org/">TypeDoc</a> 生成，您可以详细查看 api 使用方式，调用参数，数据结构。</p>
105
+
106
+ <a href="#相关名词解释" id="相关名词解释" style="color: inherit; text-decoration: none;">
107
+ <h2>相关名词解释</h2>
108
+ </a>
109
+
110
+ <a href="#什么是work" id="什么是work" style="color: inherit; text-decoration: none;">
111
+ <h3>什么是<strong>Work</strong></h3>
112
+ </a>
113
+ <p><strong>Work</strong>是<a href="https://developers.realsee.com">如视开发者中心</a> 提供的对于一个三维空间的描述。
114
+ 是通过如视硬件设备（<a href="https://realsee.com/website/product/hardware">如视扫描仪</a> 、<a href="https://realsee.com/website/product/lite">如视<strong>Lite</strong>全景相机</a> 、<a href="https://realsee.com/website/mobile">如视VR App</a> ）扫描并处理之后用于三维空间展示的数据。</p>
115
+ <p><strong>Work</strong>以<code>JSON</code>作为数据格式<strong>Five</strong>框架可以解析<strong>Work</strong>数据并展示。一个<strong>Five</strong>实例每次可以载入并展示一个<strong>Work</strong>。并且也可以在不同的<strong>Work</strong>之间动态切换。</p>
116
+ <p><strong>Work</strong>的数据样例如下</p>
117
+ <pre><code class="language-json"><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;initial&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;mode&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;Panorama&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;pano_index&quot;</span><span class="hl-0">: </span><span class="hl-13">6</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;longitude&quot;</span><span class="hl-0">: </span><span class="hl-13">2.6869287662553916</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;latitude&quot;</span><span class="hl-0">: </span><span class="hl-13">0</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;fov&quot;</span><span class="hl-0">: </span><span class="hl-13">95</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;model&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;file_url&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">model</span><span class="hl-14">\/</span><span class="hl-3">auto3d-DJaa08PIzN4JYluXQ1j2VS.at3d&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;material_textures&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_0.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_1.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_2.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_3.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_4.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_5.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_6.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_7.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_8.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">materials</span><span class="hl-14">\/</span><span class="hl-3">texture_9.jpg&quot;</span><br/><span class="hl-0"> ]</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;panorama&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;list&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;up&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">0</span><span class="hl-14">\/</span><span class="hl-3">2257f0f0b29d5b00ff01934ce51aaa35</span><span class="hl-14">\/</span><span class="hl-3">0_u.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;down&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">0</span><span class="hl-14">\/</span><span class="hl-3">2257f0f0b29d5b00ff01934ce51aaa35</span><span class="hl-14">\/</span><span class="hl-3">0_d.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;left&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">0</span><span class="hl-14">\/</span><span class="hl-3">2257f0f0b29d5b00ff01934ce51aaa35</span><span class="hl-14">\/</span><span class="hl-3">0_l.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;right&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">0</span><span class="hl-14">\/</span><span class="hl-3">2257f0f0b29d5b00ff01934ce51aaa35</span><span class="hl-14">\/</span><span class="hl-3">0_r.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;front&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">0</span><span class="hl-14">\/</span><span class="hl-3">2257f0f0b29d5b00ff01934ce51aaa35</span><span class="hl-14">\/</span><span class="hl-3">0_f.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;back&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">0</span><span class="hl-14">\/</span><span class="hl-3">2257f0f0b29d5b00ff01934ce51aaa35</span><span class="hl-14">\/</span><span class="hl-3">0_b.jpg&quot;</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;up&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">1</span><span class="hl-14">\/</span><span class="hl-3">ecb554bb1c122fa90186d176ccfecde4</span><span class="hl-14">\/</span><span class="hl-3">1_u.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;down&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">1</span><span class="hl-14">\/</span><span class="hl-3">ecb554bb1c122fa90186d176ccfecde4</span><span class="hl-14">\/</span><span class="hl-3">1_d.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;left&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">1</span><span class="hl-14">\/</span><span class="hl-3">ecb554bb1c122fa90186d176ccfecde4</span><span class="hl-14">\/</span><span class="hl-3">1_l.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;right&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">1</span><span class="hl-14">\/</span><span class="hl-3">ecb554bb1c122fa90186d176ccfecde4</span><span class="hl-14">\/</span><span class="hl-3">1_r.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;front&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">1</span><span class="hl-14">\/</span><span class="hl-3">ecb554bb1c122fa90186d176ccfecde4</span><span class="hl-14">\/</span><span class="hl-3">1_f.jpg&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;back&quot;</span><span class="hl-0">: </span><span class="hl-3">&quot;https:</span><span class="hl-14">\/\/</span><span class="hl-3">vrlab-public.ljcdn.com</span><span class="hl-14">\/</span><span class="hl-3">release</span><span class="hl-14">\/</span><span class="hl-3">auto3dhd</span><span class="hl-14">\/</span><span class="hl-3">a62e1ebf7d013f7df117551a14af79fc</span><span class="hl-14">\/</span><span class="hl-3">images</span><span class="hl-14">\/</span><span class="hl-3">cube_2048</span><span class="hl-14">\/</span><span class="hl-3">1</span><span class="hl-14">\/</span><span class="hl-3">ecb554bb1c122fa90186d176ccfecde4</span><span class="hl-14">\/</span><span class="hl-3">1_b.jpg&quot;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;observers&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;visible_nodes&quot;</span><span class="hl-0">: [ </span><span class="hl-13">1</span><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;accessible_nodes&quot;</span><span class="hl-0">: [ </span><span class="hl-13">1</span><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;quaternion&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;w&quot;</span><span class="hl-0">: </span><span class="hl-13">0.45076583925142194</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;x&quot;</span><span class="hl-0">: </span><span class="hl-13">0.010070951976936936</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;y&quot;</span><span class="hl-0">: </span><span class="hl-13">-0.8925839597148215</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;z&quot;</span><span class="hl-0">: </span><span class="hl-13">-0.0016154299986102319</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;standing_position&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> </span><span class="hl-13">-6.956049919128418</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">-1.3924440682333898</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">1.6591600179672241</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;position&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> </span><span class="hl-13">-6.956049919128418</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">-0.10312400013208389</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">1.6591600179672241</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;floor_index&quot;</span><span class="hl-0">: </span><span class="hl-13">0</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;visible_nodes&quot;</span><span class="hl-0">: [ </span><span class="hl-13">0</span><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;accessible_nodes&quot;</span><span class="hl-0">: [ </span><span class="hl-13">0</span><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;index&quot;</span><span class="hl-0">: </span><span class="hl-13">1</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;quaternion&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;w&quot;</span><span class="hl-0">: </span><span class="hl-13">-0.9884643083591809</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;x&quot;</span><span class="hl-0">: </span><span class="hl-13">-0.0038900979633806664</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;y&quot;</span><span class="hl-0">: </span><span class="hl-13">0.1512670435365699</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;z&quot;</span><span class="hl-0">: </span><span class="hl-13">-0.006439990839033269</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;standing_position&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> </span><span class="hl-13">-6.176340103149414</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">-1.380554749576384</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">2.179759979248047</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;position&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0"> </span><span class="hl-13">-6.176340103149414</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">-0.10025200247764587</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-13">2.179759979248047</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-12">&quot;floor_index&quot;</span><span class="hl-0">: </span><span class="hl-13">0</span><span class="hl-0">,</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> ]</span><br/><span class="hl-0">}</span>
118
+ </code></pre>
119
+ <p>Work 的数据说明</p>
120
+ <ul>
121
+ <li><p><code>initial</code>: 初始化数据，是一个 <code>State</code> 数据。描述<strong>Work</strong>被加载初始状态的位姿，也叫做VR的初始视角</p>
122
+ <ul>
123
+ <li>mode: 模态</li>
124
+ <li>pano_index: 初始化点位</li>
125
+ <li>longitude: 相机的水平角</li>
126
+ <li>latitude: 相机的偏航角</li>
127
+ <li>fov: 相机垂直方向的可视角度</li>
128
+ </ul>
129
+ </li>
130
+ <li><p><code>model</code>: 三维模型</p>
131
+ <ul>
132
+ <li>file_url: 三维模型的资源地址，文件为 <code>.at3d</code> 为如视定制的模型格式</li>
133
+ <li>material_textures: 三维模型的贴图资源地址</li>
134
+ </ul>
135
+ </li>
136
+ <li><p><code>panorama</code>: 全景彩色信息</p>
137
+ <ul>
138
+ <li>list:<ul>
139
+ <li>up / down / left / right / front / back: 全景彩色信息以 <a href="https://en.wikipedia.org/wiki/Cube_mapping">cubemap</a> 方式存储和使用。</li>
140
+ </ul>
141
+ </li>
142
+ </ul>
143
+ </li>
144
+ <li><p><code>observers</code>: 采集点信息</p>
145
+ <ul>
146
+ <li>visible_nodes: 采集点之间的可见性列表</li>
147
+ <li>accessible_nodes: 采集点之间的连通性列表</li>
148
+ <li>quaternion: 采集点与模型坐标的旋转偏移量</li>
149
+ <li>standing_position: 采集点地面坐标</li>
150
+ <li>position: 采集点坐标</li>
151
+ <li>floor_index: 采集点楼层</li>
152
+ </ul>
153
+ </li>
154
+ </ul>
155
+
156
+ <a href="#什么是-five-state" id="什么是-five-state" style="color: inherit; text-decoration: none;">
157
+ <h3>什么是 Five State</h3>
158
+ </a>
159
+ <p><strong>State</strong>是<strong>Five</strong>框架用于描述状态的数据结构。他包含了模态、位于的采集点位、相机的方向、相机可视角度的信息。
160
+ 您可以使用<strong>State</strong>来操作<strong>Five</strong>或者获取<strong>Five</strong>当前的状态。</p>
161
+ <pre><code class="language-ts"><span class="hl-7">interface</span><span class="hl-0"> </span><span class="hl-8">State</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;mode&quot;</span><span class="hl-0">: </span><span class="hl-8">Five</span><span class="hl-0">.</span><span class="hl-8">Mode</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;panoIndex&quot;</span><span class="hl-0">: </span><span class="hl-8">number</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;longitude&quot;</span><span class="hl-0">: </span><span class="hl-8">number</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;latitude&quot;</span><span class="hl-0">: </span><span class="hl-8">number</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">&quot;fov&quot;</span><span class="hl-0">: </span><span class="hl-8">number</span><span class="hl-0">,</span><br/><span class="hl-0">}</span>
162
+ </code></pre>
163
+ <p><strong>State</strong>的数据描述</p>
164
+ <ul>
165
+ <li><p><code>mode</code>: 当前的模态
166
+ Five 常用有 5 种模态，可以使用 <code>Five.Mode</code> 获得</p>
167
+ <ul>
168
+ <li>Panorama: 全景游走模态，该模态下视图将在采集点间游走，手势操作可以旋转/放大视角/切换采集点，适合查看采集的全景信息。</li>
169
+ <li>Floorplan: 空间总览模态, 该模态下视图以模型为中心，手势操作可以旋转/放大模型/切换楼层，适合查看模型的整体效果。</li>
170
+ <li>Topview: 户型图模态，该模态下视图以模型为中心，垂直俯视模型，手势操作可以平移/放大模型/切换楼层，适合查看模型平面结构。</li>
171
+ <li>Model: 模型游走模态，该模态下视图将在模型中自由游走，手势操作可以旋转/放大视角/位移，适合查看模型的细节，做一些定位操作。</li>
172
+ <li>VRPanorama: VR 眼镜模态，该模态下可以使用 <a href="https://arvr.google.com/cardboard/">Cardboard 眼镜</a> 或者他的第三方衍生产品，实现 VR 虚拟显示效果。</li>
173
+ </ul>
174
+ </li>
175
+ <li><p><code>panoIndex</code>: 采集点位</p>
176
+ </li>
177
+ <li><p><code>longitude</code> / <code>latitude</code>: 相机的水平角 / 相机的偏航角（弧度），我们使用类似经纬度的方式描述相机位置。</p>
178
+ </li>
179
+ <li><p><code>fov</code>: 相机垂直方向的可视角度 (角度)</p>
180
+ </li>
181
+ </ul>
182
+ </div></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></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/docs/interfaces/five.AddableObject.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AddableObject | 如视 Five SDK - v5.0.0-alpha.100</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.100"/><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.100</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.100</a></li><li><a href="../modules/five.html">five</a></li><li><a href="five.AddableObject.html">AddableObject</a></li></ul><h1>Interface AddableObject</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Object3D</span><ul class="tsd-hierarchy"><li><span class="target">AddableObject</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="five.AddableObject.html#mixer" class="tsd-kind-icon">mixer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="five.AddableObject.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="five.AddableObject.html#setResolution" class="tsd-kind-icon">set<wbr/>Resolution</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="mixer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> mixer</h3><div class="tsd-signature tsd-kind-icon">mixer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AnimationMixer</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:7</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="needsRender" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> needs<wbr/>Render</h3><div class="tsd-signature tsd-kind-icon">needs<wbr/>Render<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/types/addableObject.ts:5</li></ul></aside></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="setResolution" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> set<wbr/>Resolution</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Resolution<span class="tsd-signature-symbol">(</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><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/five/types/addableObject.ts:9</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>width: <span class="tsd-signature-type">number</span></h5></li><li><h5>height: <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></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="current tsd-kind-module"><a href="../modules/five.html">five</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-module"><a href="../modules/five.SubscribeMixinType.html">Subscribe<wbr/>Mixin<wbr/>Type</a></li></ul></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="five.AddableObject.html" class="tsd-kind-icon">Addable<wbr/>Object</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="five.AddableObject.html#mixer" class="tsd-kind-icon">mixer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="five.AddableObject.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="five.AddableObject.html#setResolution" class="tsd-kind-icon">set<wbr/>Resolution</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>