@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/modules/server.html ADDED
@@ -0,0 +1,18 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>server | 如视 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="server.html">server</a></li></ul><h1>Module server</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventCallback" class="tsd-kind-icon">Event<wbr/>Callback</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWork" class="tsd-kind-icon">Loose<wbr/>Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkInitial" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkModel" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkObserver" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkPanorama" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Panorama</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkVideo" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Mode" class="tsd-kind-icon">Mode</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#ParseWorkOptions" class="tsd-kind-icon">Parse<wbr/>Work<wbr/>Options</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Pose" class="tsd-kind-icon">Pose</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#State" class="tsd-kind-icon">State</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Subscribe" class="tsd-kind-icon">Subscribe</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeEventMap" class="tsd-kind-icon">Subscribe<wbr/>Event<wbr/>Map</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeMixinType" class="tsd-kind-icon">Subscribe<wbr/>Mixin<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Work" class="tsd-kind-icon">Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkCubeImage" class="tsd-kind-icon">Work<wbr/>Cube<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkImage" class="tsd-kind-icon">Work<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkInitial" class="tsd-kind-icon">Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkModel" class="tsd-kind-icon">Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkObserver" class="tsd-kind-icon">Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkTile" class="tsd-kind-icon">Work<wbr/>Tile</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkVideo" class="tsd-kind-icon">Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#parseWork" class="tsd-kind-icon">parse<wbr/>Work</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVH.html" class="tsd-kind-icon">BVH</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHIntersect.html" class="tsd-kind-icon">BVHIntersect</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHNode.html" class="tsd-kind-icon">BVHNode</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHVector3.html" class="tsd-kind-icon">BVHVector3</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.Model.html" class="tsd-kind-icon">Model</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMGroup.html" class="tsd-kind-icon">PBMGroup</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMMesh.html" class="tsd-kind-icon">PBMMesh</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.Intersection.html" class="tsd-kind-icon">Intersection</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.ModelEventCallback.html" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Callback</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="server.html#ModelEventType" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>References</h2><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventCallback" class="tsd-anchor"></a><h3>Event<wbr/>Callback</h3>Renames and re-exports <a href="../interfaces/server.ModelEventCallback.html">ModelEventCallback</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventType" class="tsd-anchor"></a><h3>Event<wbr/>Type</h3>Renames and re-exports <a href="server.html#ModelEventType">ModelEventType</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWork" class="tsd-anchor"></a><h3>Loose<wbr/>Work</h3>Re-exports <a href="five.html#LooseWork">LooseWork</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkInitial" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Initial</h3>Re-exports <a href="five.html#LooseWorkInitial">LooseWorkInitial</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkModel" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Model</h3>Re-exports <a href="five.html#LooseWorkModel">LooseWorkModel</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkObserver" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Observer</h3>Re-exports <a href="five.html#LooseWorkObserver">LooseWorkObserver</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkPanorama" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Panorama</h3>Re-exports <a href="five.html#LooseWorkPanorama">LooseWorkPanorama</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkVideo" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Video</h3>Re-exports <a href="five.html#LooseWorkVideo">LooseWorkVideo</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Mode" class="tsd-anchor"></a><h3>Mode</h3>Re-exports <a href="five.html#Mode">Mode</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="ParseWorkOptions" class="tsd-anchor"></a><h3>Parse<wbr/>Work<wbr/>Options</h3>Re-exports <a href="five.html#ParseWorkOptions">ParseWorkOptions</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Pose" class="tsd-anchor"></a><h3>Pose</h3>Re-exports <a href="../interfaces/five.Pose.html">Pose</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="State" class="tsd-anchor"></a><h3>State</h3>Re-exports <a href="../interfaces/five.State.html">State</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Subscribe" class="tsd-anchor"></a><h3>Subscribe</h3>Re-exports <a href="../classes/five.Subscribe.html">Subscribe</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SubscribeEventMap" class="tsd-anchor"></a><h3>Subscribe<wbr/>Event<wbr/>Map</h3>Re-exports <a href="five.html#SubscribeEventMap">SubscribeEventMap</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SubscribeMixinType" class="tsd-anchor"></a><h3>Subscribe<wbr/>Mixin<wbr/>Type</h3>Re-exports <a href="five.SubscribeMixinType.html">SubscribeMixinType</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Work" class="tsd-anchor"></a><h3>Work</h3>Re-exports <a href="../classes/five.Work.html">Work</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkCubeImage" class="tsd-anchor"></a><h3>Work<wbr/>Cube<wbr/>Image</h3>Re-exports <a href="../interfaces/five.WorkCubeImage.html">WorkCubeImage</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkImage" class="tsd-anchor"></a><h3>Work<wbr/>Image</h3>Re-exports <a href="../interfaces/five.WorkImage.html">WorkImage</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkInitial" class="tsd-anchor"></a><h3>Work<wbr/>Initial</h3>Re-exports <a href="../interfaces/five.WorkInitial.html">WorkInitial</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkModel" class="tsd-anchor"></a><h3>Work<wbr/>Model</h3>Re-exports <a href="../interfaces/five.WorkModel.html">WorkModel</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkObserver" class="tsd-anchor"></a><h3>Work<wbr/>Observer</h3>Re-exports <a href="../interfaces/five.WorkObserver.html">WorkObserver</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkTile" class="tsd-anchor"></a><h3>Work<wbr/>Tile</h3>Re-exports <a href="../interfaces/five.WorkTile.html">WorkTile</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkVideo" class="tsd-anchor"></a><h3>Work<wbr/>Video</h3>Re-exports <a href="../interfaces/five.WorkVideo.html">WorkVideo</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="parseWork" class="tsd-anchor"></a><h3>parse<wbr/>Work</h3>Re-exports <a href="five.html#parseWork">parseWork</a></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ModelEventType" class="tsd-anchor"></a><h3>Model<wbr/>Event<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Model<wbr/>Event<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>bvhLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>geometryLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>loaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>materialLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in lib/five/server/model/index.ts:50</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>模型事件列表</p>
3
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>具体事件列表 请查看 <a href="../interfaces/server.ModelEventCallback.html">ModelEventCallback</a></p>
4
+ </dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>bvh<wbr/>Loaded<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">bvh<wbr/>Loaded<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/model/index.ts:57</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
5
+ <p>模型 bvh树 计算完成</p>
6
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>bvh 树用于高效的碰撞检测，可以在 <code>model.bvh</code> 属性来设置是否开启。默认开启。
7
+ bvh 树计算需要一定事件，可能会暂时影响一些性能。计算完毕后，会对碰撞检测带来质的提升。</p>
8
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>error<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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/model/index.ts:68</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>内部错误</p>
10
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">Error</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>错误对象</p>
12
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>geometry<wbr/>Loaded<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">geometry<wbr/>Loaded<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/model/index.ts:59</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>模型三角面片结构加载完成</p>
14
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>loaded<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">loaded<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/model/index.ts:63</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></li><li class="tsd-parameter"><h5>material<wbr/>Loaded<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">material<wbr/>Loaded<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/model/index.ts:61</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>模型材质结构加载完成</p>
18
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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="five.html">five</a></li><li class=" tsd-kind-module"><a href="gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="line.html">line</a></li><li class=" tsd-kind-module"><a href="react.html">react</a></li><li class="current tsd-kind-module"><a href="server.html">server</a></li><li class=" tsd-kind-module"><a href="sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventCallback" class="tsd-kind-icon">Event<wbr/>Callback</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWork" class="tsd-kind-icon">Loose<wbr/>Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkInitial" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkModel" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkObserver" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkPanorama" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Panorama</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkVideo" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Mode" class="tsd-kind-icon">Mode</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#ParseWorkOptions" class="tsd-kind-icon">Parse<wbr/>Work<wbr/>Options</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Pose" class="tsd-kind-icon">Pose</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#State" class="tsd-kind-icon">State</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Subscribe" class="tsd-kind-icon">Subscribe</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeEventMap" class="tsd-kind-icon">Subscribe<wbr/>Event<wbr/>Map</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeMixinType" class="tsd-kind-icon">Subscribe<wbr/>Mixin<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Work" class="tsd-kind-icon">Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkCubeImage" class="tsd-kind-icon">Work<wbr/>Cube<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkImage" class="tsd-kind-icon">Work<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkInitial" class="tsd-kind-icon">Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkModel" class="tsd-kind-icon">Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkObserver" class="tsd-kind-icon">Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkTile" class="tsd-kind-icon">Work<wbr/>Tile</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkVideo" class="tsd-kind-icon">Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#parseWork" class="tsd-kind-icon">parse<wbr/>Work</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVH.html" class="tsd-kind-icon">BVH</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHIntersect.html" class="tsd-kind-icon">BVHIntersect</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHNode.html" class="tsd-kind-icon">BVHNode</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHVector3.html" class="tsd-kind-icon">BVHVector3</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.Model.html" class="tsd-kind-icon">Model</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMGroup.html" class="tsd-kind-icon">PBMGroup</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMMesh.html" class="tsd-kind-icon">PBMMesh</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.Intersection.html" class="tsd-kind-icon">Intersection</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.ModelEventCallback.html" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="server.html#ModelEventType" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Type</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/modules/sticker.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>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="sticker.html">sticker</a></li></ul><h1>Module sticker</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/sticker.Sticker.html" class="tsd-kind-icon">Sticker</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/sticker.IntersectionLike.html" class="tsd-kind-icon">Intersection<wbr/>Like</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="five.html">five</a></li><li class=" tsd-kind-module"><a href="gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="line.html">line</a></li><li class=" tsd-kind-module"><a href="react.html">react</a></li><li class=" tsd-kind-module"><a href="server.html">server</a></li><li class="current tsd-kind-module"><a href="sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/sticker.Sticker.html" class="tsd-kind-icon">Sticker</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/sticker.IntersectionLike.html" class="tsd-kind-icon">Intersection<wbr/>Like</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/modules.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>如视 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"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/five.html" class="tsd-kind-icon">five</a></li><li class="tsd-kind-module"><a href="modules/gltf_loader.html" class="tsd-kind-icon">gltf-<wbr/>loader</a></li><li class="tsd-kind-module"><a href="modules/line.html" class="tsd-kind-icon">line</a></li><li class="tsd-kind-module"><a href="modules/react.html" class="tsd-kind-icon">react</a></li><li class="tsd-kind-module"><a href="modules/server.html" class="tsd-kind-icon">server</a></li><li class="tsd-kind-module"><a href="modules/sticker.html" class="tsd-kind-icon">sticker</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/five.html">five</a></li><li class=" tsd-kind-module"><a href="modules/gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="modules/line.html">line</a></li><li class=" tsd-kind-module"><a href="modules/react.html">react</a></li><li class=" tsd-kind-module"><a href="modules/server.html">server</a></li><li class=" tsd-kind-module"><a href="modules/sticker.html">sticker</a></li></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/exporters/staticify.js ADDED
@@ -0,0 +1,203 @@
1
+ const fs = require("fs");
2
+ const path = require("path");
3
+ const archiver = require("archiver");
4
+ const { parseWork } = require("@realsee/five/server");
5
+
6
+ function matchJsonpFunctionName(url) {
7
+ const regExps = [
8
+ /\.([0-9a-z]+)\.jsonp([\?\#].*)?$/i,
9
+ /jsonp_([0-9a-z]+)([\?\#].*)?$/i
10
+ ];
11
+ for (const regExp of regExps) {
12
+ const matched = url.match(regExp);
13
+ if (matched) {
14
+ return "jsonp_" + matched[1];
15
+ }
16
+ }
17
+ return null;
18
+ };
19
+
20
+ const CDN_PUBLIC_BASE = "//vrlab-public.ljcdn.com";
21
+ const CDN_IMAGE_BASE = "//vrlab-image4.ljcdn.com";
22
+ const CDN_TEST_PUBLIC_BASE = "//test-vr-public.realsee-cdn.com";
23
+ const CDN_TEST_IMAGE_BASE = "//test-vr-image.realsee-cdn.com";
24
+ function imageURL(url, size) {
25
+ if (url.indexOf(CDN_PUBLIC_BASE) >= 0) {
26
+ if (/\.(jpg|png)$/.test(url)) {
27
+ // 默认使用数据万象
28
+ // https://cloud.tencent.com/document/product/460/36544
29
+ if (size) {
30
+ let suffix = "?imageMogr2";
31
+ if (size) suffix += "/thumbnail/" + size + "x";
32
+ url = url.replace(CDN_PUBLIC_BASE, CDN_IMAGE_BASE) + suffix;
33
+ }
34
+ }
35
+ }
36
+ if (url.indexOf(CDN_TEST_PUBLIC_BASE) >= 0) {
37
+ if (/\.(jpg|png)$/.test(url)) {
38
+ // 默认使用数据万象
39
+ // https://cloud.tencent.com/document/product/460/36544
40
+ if (size) {
41
+ let suffix = "?imageMogr2";
42
+ if (size) suffix += "/thumbnail/" + size + "x";
43
+ url = url.replace(CDN_TEST_PUBLIC_BASE, CDN_TEST_IMAGE_BASE) + suffix;
44
+ }
45
+ }
46
+ }
47
+ return url;
48
+ }
49
+
50
+ async function download(url, jsonpHandleKey) {
51
+ const request = /^https\:/.test(url) ? require("https") : require("http");
52
+ return new Promise((resolve, reject) => {
53
+ const req = request.get(url, res => {
54
+ const mime = res.headers['content-type'];
55
+ const buffers = [];
56
+
57
+ res.on('data', chunk => buffers.push(chunk));
58
+ res.on('end', () => {
59
+ const contents = Buffer.concat(buffers);
60
+ if (jsonpHandleKey) {
61
+ const dataURL = `data:${mime};base64,${contents.toString('base64')}`;
62
+ const jsopContents = `window[${JSON.stringify(jsonpHandleKey)}] && window[${JSON.stringify(jsonpHandleKey)}](${JSON.stringify(dataURL)})`;
63
+ resolve(Buffer.from(jsopContents));
64
+ } else {
65
+ resolve(Buffer.from(contents));
66
+ }
67
+ })
68
+ res.on("error", () => reject(new Error(`fetch ${url} got error`)));
69
+ });
70
+ req.on("error", () => reject(new Error(`fetch ${url} got error`)));
71
+ })
72
+ }
73
+
74
+ function html(workJSONObject, shortPath, jsonp) {
75
+ return `
76
+ <!DOCTYPE html>
77
+ <html lang="en">
78
+ <head>
79
+ <meta charset="UTF-8">
80
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
81
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
82
+ <title>REALSEE PREVIEW</title>
83
+ <style>
84
+ * { margin: 0; padding: 0; }
85
+ html, body { height: 100%; width: 100%; overflow: hidden; }
86
+ #app { position: fixed; top: 0; left: 0; right: 0; bottom: 0; overflow: hidden; }
87
+ .buttons { position: fixed; top: 10px; left: 10px; pointer-events: none; }
88
+ .buttons h3 { margin-top: 10px; text-shadow: 0 0 2px rgba(255, 255, 255, 0.5); }
89
+ .buttons button { pointer-events: auto; display: block; font-size: 14px; color: #FFF; background: #5a6268; padding: 3px 10px; border: 1px solid #333; margin-right: 2px; border-radius: 2px; cursor: pointer; margin-top: 10px; }
90
+ .buttons button:active { background: #333; }
91
+ </style>
92
+ <script src="./three.min.js"></script>
93
+ <script src="./five.js"></script>
94
+ <script>const workJSON = ${JSON.stringify(workJSONObject)}</script>
95
+ </head>
96
+ <body>
97
+ <!-- 试图渲染容器 -->
98
+ <div id="app"></div>
99
+ <script>
100
+ const five = new FiveSDK.Five();
101
+ five.appendTo(document.getElementById("app"));
102
+ const work = FiveSDK.parseWork(workJSON, { baseURL: "./", shortPath: ${JSON.stringify(shortPath)}, jsonp: ${JSON.stringify(jsonp)} });
103
+ five.load(work);
104
+
105
+ const modeButtons = [
106
+ { mode: "Panorama", label: "全景模式" },
107
+ { mode: "Floorplan", label: "模型纵览模式" },
108
+ { mode: "Topview", label: "模型俯视模式" },
109
+ { mode: "Model", label: "模型漫游模式" },
110
+ ];
111
+
112
+ const buttons = document.createElement("div");
113
+ buttons.className = "buttons";
114
+ document.body.appendChild(buttons);
115
+ buttons.appendChild(document.createElement("h3")).innerHTML = "模式控制";
116
+
117
+ // 模态按钮
118
+ for (let i = 0; i < modeButtons.length; i++) {
119
+ const button = document.createElement("button");
120
+ button.innerHTML = modeButtons[i].label;
121
+ button.addEventListener('click', () => {
122
+ // 通过 changeMode 方法可以切换模态
123
+ five.changeMode(FiveSDK.Five.Mode[modeButtons[i].mode]);
124
+ });
125
+ buttons.appendChild(button);
126
+ }
127
+ window.addEventListener("resize", () => five.refresh(), false);
128
+ </script>
129
+ </body>
130
+ </html>
131
+ `
132
+ }
133
+
134
+ function getThreeJsBuffer() {
135
+ let tempPath = path.resolve(__dirname);
136
+ while (!(tempPath === '/' || tempPath === ".")) {
137
+ const threeFilePath = path.join(tempPath, "node_modules/three/build/three.min.js");
138
+ if (fs.existsSync(threeFilePath)) {
139
+ return fs.readFileSync(threeFilePath);
140
+ }
141
+ tempPath = path.dirname(tempPath);
142
+ }
143
+ throw new Error("three.js is not found");
144
+ }
145
+
146
+ function getFiveJsBuffer() {
147
+ return fs.readFileSync(path.join(__dirname, "../umd/five.js"));
148
+ }
149
+
150
+ async function staticify(work, output, shortPath = false, jsonp = false, preview = true) {
151
+ const zipFilename = /\.zip$/.test(output) ? output : output + ".zip";
152
+ const outputStream = fs.createWriteStream(zipFilename);
153
+ const archive = archiver("zip", { zlib: { level: 9 } });
154
+ archive.on("error", (err) => { throw err; });
155
+ outputStream.on("close", function() {
156
+ console.log(`zip ${archive.pointer()} total bytes`);
157
+ console.log(`dist ${zipFilename}`);
158
+ });
159
+ archive.pipe(outputStream);
160
+
161
+ const resources = [];
162
+ const workJSONObject = JSON.parse(fs.readFileSync(work, "utf8"));
163
+ parseWork(workJSONObject, { shortPath, jsonp }, (origin, _, relative, type) => {
164
+ resources.push({ origin, relative, type });
165
+ });
166
+
167
+ const textureCount = resources.filter(({ type }) => type === "texture").length;
168
+ let textureSize;
169
+ if (textureCount > 50) {
170
+ textureSize = 64;
171
+ } else if (textureCount > 40) {
172
+ textureSize = 128;
173
+ } else if (textureCount > 30) {
174
+ textureSize = 256;
175
+ } else if (textureCount > 15) {
176
+ textureSize = 512;
177
+ } else if (textureCount > 10) {
178
+ textureSize = 1024;
179
+ }
180
+ if (textureSize) {
181
+ for (const resource of resources) {
182
+ if (resource.type === "texture") {
183
+ resource.origin = imageURL(resource.origin, textureSize);
184
+ }
185
+ }
186
+ }
187
+ for (const { origin, relative } of resources) {
188
+ const buffer = await download(origin, matchJsonpFunctionName(relative));
189
+ console.log(`${origin} -> ${relative}`);
190
+ archive.append(buffer, { name: relative });
191
+ }
192
+ archive.append(fs.readFileSync(work), { name: "work.json" });
193
+
194
+ if (preview) {
195
+ archive.append(getFiveJsBuffer(), { name: "five.js" });
196
+ archive.append(getThreeJsBuffer(), { name: "three.min.js" });
197
+ archive.append(html(workJSONObject, Boolean(shortPath), Boolean(jsonp)), { name: "index.html" });
198
+ }
199
+
200
+ archive.finalize();
201
+ }
202
+
203
+ module.exports = staticify;