@realsee/five 5.0.0-alpha.13 → 5.0.0-alpha.130

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 (203) hide show
  1. package/README.md +21 -11
  2. package/docs/.nojekyll +1 -0
  3. package/docs/assets/highlight.css +134 -0
  4. package/docs/assets/icons.css +1043 -0
  5. package/docs/assets/{images/icons.png → icons.png} +0 -0
  6. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  7. package/docs/assets/main.js +52 -0
  8. package/docs/assets/search.js +1 -0
  9. package/docs/assets/style.css +1413 -0
  10. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  11. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  12. package/docs/classes/five.AnimationFrameLoop.html +15 -0
  13. package/docs/classes/five.BVH.html +10 -0
  14. package/docs/classes/five.BVHIntersect.html +1 -0
  15. package/docs/classes/five.BVHNode.html +7 -0
  16. package/docs/classes/five.BVHVector3.html +1 -0
  17. package/docs/classes/five.Camera.html +11 -0
  18. package/docs/classes/five.Five.html +303 -0
  19. package/docs/classes/five.InternalWebGLRenderer.html +1 -0
  20. package/docs/classes/five.IntersectMesh.html +1 -0
  21. package/docs/classes/five.LegacyPanoCircleMesh.html +5 -0
  22. package/docs/classes/five.Model.html +87 -0
  23. package/docs/classes/five.NetworkSubscribe.html +50 -0
  24. package/docs/classes/five.PBMContainer.html +17 -0
  25. package/docs/classes/five.PBMGroup.html +19 -0
  26. package/docs/classes/five.PBMMaterial.html +17 -0
  27. package/docs/classes/five.PBMMesh.html +7 -0
  28. package/docs/classes/five.PanoCircleMesh.html +7 -0
  29. package/docs/classes/five.Scene.html +3 -0
  30. package/docs/classes/five.Subscribe.html +56 -0
  31. package/docs/classes/five.Tile3DModel.html +15 -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 +166 -422
  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 +100 -0
  57. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +15 -0
  58. package/docs/interfaces/five.ImageOptions.html +18 -0
  59. package/docs/interfaces/five.ImageURLMappings.html +1 -0
  60. package/docs/interfaces/five.ImageURLOptions.html +17 -0
  61. package/docs/interfaces/five.IntersectMeshInterface.html +3 -0
  62. package/docs/interfaces/five.Intersection.html +7 -0
  63. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +15 -0
  64. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +20 -0
  65. package/docs/interfaces/five.ModelEventCallback.html +22 -0
  66. package/docs/interfaces/five.MovePanoOptions.html +42 -0
  67. package/docs/interfaces/five.PBMPanoPicture.html +7 -0
  68. package/docs/interfaces/five.PBMParameters.html +17 -0
  69. package/docs/interfaces/five.PanoCircleMeshInterface.html +19 -0
  70. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +28 -0
  71. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +20 -0
  72. package/docs/interfaces/five.Pose.html +37 -0
  73. package/docs/interfaces/five.Scissor.html +14 -0
  74. package/docs/interfaces/five.State.html +21 -0
  75. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -0
  76. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -0
  77. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -0
  78. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -0
  79. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -0
  80. package/docs/interfaces/five.TextureOptions.html +20 -0
  81. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -0
  82. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +24 -0
  83. package/docs/interfaces/five.WorkCubeImage.html +13 -0
  84. package/docs/interfaces/five.WorkImage.html +21 -0
  85. package/docs/interfaces/five.WorkInitial.html +13 -0
  86. package/docs/interfaces/five.WorkModel.html +11 -0
  87. package/docs/interfaces/five.WorkModelTiles.html +3 -0
  88. package/docs/interfaces/five.WorkObserver.html +25 -0
  89. package/docs/interfaces/five.WorkTile.html +1 -0
  90. package/docs/interfaces/five.WorkVideo.html +9 -0
  91. package/docs/interfaces/gltf_loader.GLTF.html +7 -0
  92. package/docs/interfaces/react.FiveActionReactCallbacks.html +62 -0
  93. package/docs/interfaces/react.FiveInjectionTypes.html +191 -0
  94. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -0
  95. package/docs/interfaces/server.Intersection.html +7 -0
  96. package/docs/interfaces/server.ModelEventCallback.html +18 -0
  97. package/docs/interfaces/sticker.IntersectionLike.html +8 -0
  98. package/docs/interfaces/vue.FiveActionVueCallbacks.html +62 -0
  99. package/docs/modules/five.SubscribeMixinType.html +1 -0
  100. package/docs/modules/five.html +482 -0
  101. package/docs/modules/gltf_loader.html +1 -0
  102. package/docs/modules/line.html +1 -0
  103. package/docs/modules/react.html +130 -1178
  104. package/docs/modules/server.html +18 -0
  105. package/docs/modules/sticker.html +1 -0
  106. package/docs/modules/vue.html +112 -0
  107. package/docs/modules.html +1 -120
  108. package/exporters/staticify.js +210 -0
  109. package/{index.d.ts → five/index.d.ts} +1178 -322
  110. package/five/index.js +372 -0
  111. package/gltf-loader/index.d.ts +75 -0
  112. package/gltf-loader/index.js +260 -0
  113. package/line/index.d.ts +68 -0
  114. package/line/index.js +260 -0
  115. package/package.json +25 -17
  116. package/react/index.d.ts +160 -92
  117. package/react/index.js +260 -1
  118. package/resource/{basis_transcoder.js → basis/basis_transcoder.js} +0 -0
  119. package/resource/{basis_transcoder.wasm → basis/basis_transcoder.wasm} +0 -0
  120. package/resource/gltf/draco_decoder.js +31 -0
  121. package/resource/gltf/draco_decoder.wasm +0 -0
  122. package/resource/gltf/draco_wasm_wrapper.js +119 -0
  123. package/scripts/five-staticify.js +26 -0
  124. package/server/index.d.ts +194 -25
  125. package/server/index.js +367 -1
  126. package/sticker/index.d.ts +70 -0
  127. package/sticker/index.js +260 -0
  128. package/templates/quick-start/README.md +1 -1
  129. package/templates/quick-start/package.json +1 -1
  130. package/templates/react-component/lib/index.tsx +3 -3
  131. package/umd/five-gltf-loader.js +2 -0
  132. package/umd/five-gltf-loader.js.LICENSE.txt +14 -0
  133. package/umd/five-line.js +2 -0
  134. package/umd/five-line.js.LICENSE.txt +14 -0
  135. package/umd/five-react.js +2 -0
  136. package/umd/five-react.js.LICENSE.txt +14 -0
  137. package/umd/five-sticker.js +2 -0
  138. package/umd/five-sticker.js.LICENSE.txt +14 -0
  139. package/umd/five-vue.js +1 -0
  140. package/umd/five.js +2 -0
  141. package/umd/five.js.LICENSE.txt +116 -0
  142. package/vue/index.d.ts +433 -0
  143. package/vue/index.js +260 -0
  144. package/bundles/five.js +0 -2
  145. package/bundles/five.js.LICENSE.txt +0 -160
  146. package/docs/assets/css/main.css +0 -2660
  147. package/docs/assets/js/main.js +0 -248
  148. package/docs/assets/js/search.js +0 -1
  149. package/docs/classes/index.five.html +0 -2498
  150. package/docs/classes/index.fivecamera.html +0 -311
  151. package/docs/classes/index.fivehashcubetexture.html +0 -240
  152. package/docs/classes/index.fiveline.html +0 -342
  153. package/docs/classes/index.fivelinegeometry.html +0 -500
  154. package/docs/classes/index.fivelinematerial.html +0 -276
  155. package/docs/classes/index.fivelinesegmentsgeometry.html +0 -447
  156. package/docs/classes/index.fivescene.html +0 -186
  157. package/docs/classes/index.internalwebglrenderer.html +0 -200
  158. package/docs/classes/index.model.html +0 -883
  159. package/docs/classes/index.pbmgroup.html +0 -415
  160. package/docs/classes/index.pbmmaterial.html +0 -521
  161. package/docs/classes/index.pbmmesh.html +0 -242
  162. package/docs/classes/index.subscribe.html +0 -556
  163. package/docs/classes/react.store.html +0 -584
  164. package/docs/interfaces/index.depthpanoramacontrollercustominitargs.html +0 -408
  165. package/docs/interfaces/index.eventcallback.html +0 -2452
  166. package/docs/interfaces/index.fiveinitargs.html +0 -695
  167. package/docs/interfaces/index.floorplancontrollercustominitargs.html +0 -283
  168. package/docs/interfaces/index.imageoptions.html +0 -320
  169. package/docs/interfaces/index.intersection.html +0 -215
  170. package/docs/interfaces/index.intersectmeshinterface.html +0 -176
  171. package/docs/interfaces/index.modelcontrollercustominitargs.html +0 -354
  172. package/docs/interfaces/index.modeleventcallback.html +0 -316
  173. package/docs/interfaces/index.movepanooptions.html +0 -457
  174. package/docs/interfaces/index.panocirclemeshinterface.html +0 -349
  175. package/docs/interfaces/index.panoramacontrollercustominitargs.html +0 -433
  176. package/docs/interfaces/index.panoramalikecontrollercustominitargs.html +0 -352
  177. package/docs/interfaces/index.pbmparameters.html +0 -462
  178. package/docs/interfaces/index.pose.html +0 -258
  179. package/docs/interfaces/index.scissor.html +0 -240
  180. package/docs/interfaces/index.state.html +0 -288
  181. package/docs/interfaces/index.subscribemixintype.emit.html +0 -180
  182. package/docs/interfaces/index.subscribemixintype.haslistener.html +0 -171
  183. package/docs/interfaces/index.subscribemixintype.off.html +0 -198
  184. package/docs/interfaces/index.subscribemixintype.on.html +0 -213
  185. package/docs/interfaces/index.subscribemixintype.once.html +0 -210
  186. package/docs/interfaces/index.topviewcontrollercustominitargs.html +0 -214
  187. package/docs/interfaces/index.vrpanoramacontrollercustominitargs.html +0 -420
  188. package/docs/interfaces/react.fiveactionreactcallbacks.html +0 -559
  189. package/docs/interfaces/react.fiveinjectiontypes.html +0 -1473
  190. package/docs/interfaces/react.injectfivetoprops.html +0 -259
  191. package/docs/modules/index.html +0 -3027
  192. package/docs/modules/index.subscribemixintype.html +0 -143
  193. package/five.js.LICENSE.txt +0 -160
  194. package/index.js +0 -1
  195. package/scripts/export-five-resource/chfs.exe +0 -0
  196. package/scripts/export-five-resource/fileify.js +0 -192
  197. package/scripts/export-five-resource/format-work.js +0 -71
  198. package/scripts/export-five-resource/staticify.js +0 -327
  199. package/scripts/transcode-model/BufferGeometryUtils.js +0 -832
  200. package/scripts/transcode-model/LoaderSupport.js +0 -1545
  201. package/scripts/transcode-model/MTLLoader.js +0 -602
  202. package/scripts/transcode-model/OBJLoader2.js +0 -1470
  203. package/scripts/transcode-model/obj2pbm.js +0 -65
package/docs/interfaces/react.fiveactionreactcallbacks.html DELETED
@@ -1,559 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>FiveActionReactCallbacks | 如视 Five SDK - v5.0.0-alpha.13</title>
7
- <meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.13">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">如视 Five SDK - v5.0.0-alpha.13</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- </div>
43
- </div>
44
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45
- </div>
46
- </div>
47
- </div>
48
- </div>
49
- <div class="tsd-page-title">
50
- <div class="container">
51
- <ul class="tsd-breadcrumb">
52
- <li>
53
- <a href="../modules.html">如视 Five SDK - v5.0.0-alpha.13</a>
54
- </li>
55
- <li>
56
- <a href="../modules/react.html">react</a>
57
- </li>
58
- <li>
59
- <a href="react.fiveactionreactcallbacks.html">FiveActionReactCallbacks</a>
60
- </li>
61
- </ul>
62
- <h1>Interface FiveActionReactCallbacks</h1>
63
- </div>
64
- </div>
65
- </header>
66
- <div class="container container-main">
67
- <div class="row">
68
- <div class="col-8 col-content">
69
- <section class="tsd-panel tsd-comment">
70
- <div class="tsd-comment tsd-typography">
71
- <div class="lead">
72
- <p>Five 命令集合</p>
73
- </div>
74
- </div>
75
- </section>
76
- <section class="tsd-panel tsd-hierarchy">
77
- <h3>Hierarchy</h3>
78
- <ul class="tsd-hierarchy">
79
- <li>
80
- <span class="target">FiveActionReactCallbacks</span>
81
- </li>
82
- </ul>
83
- </section>
84
- <section class="tsd-panel-group tsd-index-group">
85
- <h2>Index</h2>
86
- <section class="tsd-panel tsd-index-panel">
87
- <div class="tsd-index-content">
88
- <section class="tsd-index-section ">
89
- <h3>Methods</h3>
90
- <ul class="tsd-index-list">
91
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.fiveactionreactcallbacks.html#getpixels" class="tsd-kind-icon">get<wbr>Pixels</a></li>
92
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.fiveactionreactcallbacks.html#initbasisloader" class="tsd-kind-icon">init<wbr>Basis<wbr>Loader</a></li>
93
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.fiveactionreactcallbacks.html#needsrender" class="tsd-kind-icon">needs<wbr>Render</a></li>
94
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.fiveactionreactcallbacks.html#preloadpano" class="tsd-kind-icon">preload<wbr>Pano</a></li>
95
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.fiveactionreactcallbacks.html#render" class="tsd-kind-icon">render</a></li>
96
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.fiveactionreactcallbacks.html#updatecamera" class="tsd-kind-icon">update<wbr>Camera</a></li>
97
- </ul>
98
- </section>
99
- </div>
100
- </section>
101
- </section>
102
- <section class="tsd-panel-group tsd-member-group ">
103
- <h2>Methods</h2>
104
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
105
- <a name="getpixels" class="tsd-anchor"></a>
106
- <h3>get<wbr>Pixels</h3>
107
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
108
- <li class="tsd-signature tsd-kind-icon">get<wbr>Pixels<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pixelRatio<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
109
- </ul>
110
- <ul class="tsd-descriptions">
111
- <li class="tsd-description">
112
- <aside class="tsd-sources">
113
- <ul>
114
- <li>Defined in lib/react/hooks/useFiveAction.ts:50</li>
115
- </ul>
116
- </aside>
117
- <div class="tsd-comment tsd-typography">
118
- <div class="lead">
119
- <p>获取画面中的像素颜色</p>
120
- </div>
121
- </div>
122
- <h4 class="tsd-parameters-title">Parameters</h4>
123
- <ul class="tsd-parameters">
124
- <li>
125
- <h5>x: <span class="tsd-signature-type">number</span></h5>
126
- <div class="tsd-comment tsd-typography">
127
- <p>获取像素区域的起始坐标 x</p>
128
- </div>
129
- </li>
130
- <li>
131
- <h5>y: <span class="tsd-signature-type">number</span></h5>
132
- <div class="tsd-comment tsd-typography">
133
- <p>获取像素区域的起始坐标 y</p>
134
- </div>
135
- </li>
136
- <li>
137
- <h5>width: <span class="tsd-signature-type">number</span></h5>
138
- <div class="tsd-comment tsd-typography">
139
- <p>获取像素区域的宽度</p>
140
- </div>
141
- </li>
142
- <li>
143
- <h5>height: <span class="tsd-signature-type">number</span></h5>
144
- <div class="tsd-comment tsd-typography">
145
- <p>获取像素区域的高度</p>
146
- </div>
147
- </li>
148
- <li>
149
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> pixelRatio: <span class="tsd-signature-type">number</span></h5>
150
- <div class="tsd-comment tsd-typography">
151
- <p>获取区域的像素比</p>
152
- </div>
153
- </li>
154
- </ul>
155
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
156
- <p>rgba颜色平铺的 Uint8Array</p>
157
- </li>
158
- </ul>
159
- </section>
160
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
161
- <a name="initbasisloader" class="tsd-anchor"></a>
162
- <h3>init<wbr>Basis<wbr>Loader</h3>
163
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
164
- <li class="tsd-signature tsd-kind-icon">init<wbr>Basis<wbr>Loader<span class="tsd-signature-symbol">(</span>transcoderResourcePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
165
- </ul>
166
- <ul class="tsd-descriptions">
167
- <li class="tsd-description">
168
- <aside class="tsd-sources">
169
- <ul>
170
- <li>Defined in lib/react/hooks/useFiveAction.ts:39</li>
171
- </ul>
172
- </aside>
173
- <div class="tsd-comment tsd-typography">
174
- <div class="lead">
175
- <p>初始化 initBasisLoader</p>
176
- </div>
177
- <dl class="tsd-comment-tags">
178
- <dt>description</dt>
179
- <dd><p>同初始化的 initBasisLoader 参数。用于初始化 basisLoader。
180
- basisLoader 只会初始化一次，一旦初始化则不会再修改。</p>
181
- </dd>
182
- <dt>example</dt>
183
- <dd><pre><code><span style="color: #008000">// 使用默认解析器</span>
184
- <span style="color: #795E26">initialBasisLoader</span><span style="color: #000000">();</span>
185
-
186
- <span style="color: #008000">// 使用指定解析器</span>
187
- <span style="color: #008000">// 会调用这个目录下的 basis_transcoder.js basis_transcoder.wasm 文件作为解析器</span>
188
- <span style="color: #795E26">initialBasisLoader</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;https://vrlab-public.ljcdn.com/release/static/image/release/five/basis/&quot;</span><span style="color: #000000">);</span>
189
- </code></pre>
190
- </dd>
191
- </dl>
192
- </div>
193
- <h4 class="tsd-parameters-title">Parameters</h4>
194
- <ul class="tsd-parameters">
195
- <li>
196
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> transcoderResourcePath: <span class="tsd-signature-type">string</span></h5>
197
- <div class="tsd-comment tsd-typography">
198
- <p>basis 解析器路径
199
- 如果不设置，使用默认解析器 basis 解析器。
200
- 可以传入解析器的 <code>resourcePath</code>, 则使用指定的解析器</p>
201
- </div>
202
- </li>
203
- </ul>
204
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
205
- </li>
206
- </ul>
207
- </section>
208
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
209
- <a name="needsrender" class="tsd-anchor"></a>
210
- <h3>needs<wbr>Render</h3>
211
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
212
- <li class="tsd-signature tsd-kind-icon">needs<wbr>Render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
213
- </ul>
214
- <ul class="tsd-descriptions">
215
- <li class="tsd-description">
216
- <aside class="tsd-sources">
217
- <ul>
218
- <li>Defined in lib/react/hooks/useFiveAction.ts:74</li>
219
- </ul>
220
- </aside>
221
- <div class="tsd-comment tsd-typography">
222
- <div class="lead">
223
- <p>下一帧渲染</p>
224
- </div>
225
- <dl class="tsd-comment-tags">
226
- <dt>description</dt>
227
- <dd><p>调用 <code>render()</code> 和 <code>needsRender()</code> 均可在按需渲染时，使得画面渲染一次
228
- 区别在于：</p>
229
- <ul>
230
- <li><code>needsRender()</code> 为在下帧渲染画面</li>
231
- <li><code>render()</code> 在当前帧渲染画面
232
- 推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作，可以使用 <code>render()</code></li>
233
- </ul>
234
- </dd>
235
- </dl>
236
- </div>
237
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
238
- </li>
239
- </ul>
240
- </section>
241
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
242
- <a name="preloadpano" class="tsd-anchor"></a>
243
- <h3>preload<wbr>Pano</h3>
244
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
245
- <li class="tsd-signature tsd-kind-icon">preload<wbr>Pano<span class="tsd-signature-symbol">(</span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li>
246
- </ul>
247
- <ul class="tsd-descriptions">
248
- <li class="tsd-description">
249
- <aside class="tsd-sources">
250
- <ul>
251
- <li>Defined in lib/react/hooks/useFiveAction.ts:82</li>
252
- </ul>
253
- </aside>
254
- <div class="tsd-comment tsd-typography">
255
- <div class="lead">
256
- <p>预加载点位图片资源</p>
257
- </div>
258
- </div>
259
- <h4 class="tsd-parameters-title">Parameters</h4>
260
- <ul class="tsd-parameters">
261
- <li>
262
- <h5>panoIndex: <span class="tsd-signature-type">number</span></h5>
263
- <div class="tsd-comment tsd-typography">
264
- <p>观察点序号</p>
265
- </div>
266
- </li>
267
- <li>
268
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
269
- <div class="tsd-comment tsd-typography">
270
- <p>加载完成回调, 并传递加载用时。</p>
271
- </div>
272
- <ul class="tsd-parameters">
273
- <li class="tsd-parameter-signature">
274
- <ul class="tsd-signatures tsd-kind-type-literal">
275
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
276
- </ul>
277
- <ul class="tsd-descriptions">
278
- <li class="tsd-description">
279
- <h4 class="tsd-parameters-title">Parameters</h4>
280
- <ul class="tsd-parameters">
281
- <li>
282
- <h5>costs: <span class="tsd-signature-type">number</span></h5>
283
- </li>
284
- </ul>
285
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
286
- </li>
287
- </ul>
288
- </li>
289
- </ul>
290
- </li>
291
- </ul>
292
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
293
- <p>加载完成的 Promise 参数同 callback</p>
294
- </li>
295
- </ul>
296
- </section>
297
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
298
- <a name="render" class="tsd-anchor"></a>
299
- <h3>render</h3>
300
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
301
- <li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
302
- </ul>
303
- <ul class="tsd-descriptions">
304
- <li class="tsd-description">
305
- <aside class="tsd-sources">
306
- <ul>
307
- <li>Defined in lib/react/hooks/useFiveAction.ts:63</li>
308
- </ul>
309
- </aside>
310
- <div class="tsd-comment tsd-typography">
311
- <div class="lead">
312
- <p>强制渲染</p>
313
- </div>
314
- <dl class="tsd-comment-tags">
315
- <dt>description</dt>
316
- <dd><p>调用 <code>render()</code> 和 <code>needsRender()</code> 均可在按需渲染时，使得画面渲染一次
317
- 区别在于：</p>
318
- <ul>
319
- <li><code>needsRender()</code> 为在下帧渲染画面</li>
320
- <li><code>render()</code> 在当前帧渲染画面
321
- 推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作，可以使用 <code>render()</code></li>
322
- </ul>
323
- </dd>
324
- </dl>
325
- </div>
326
- <h4 class="tsd-parameters-title">Parameters</h4>
327
- <ul class="tsd-parameters">
328
- <li>
329
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
330
- <div class="tsd-comment tsd-typography">
331
- <p>渲染完成回调</p>
332
- </div>
333
- <ul class="tsd-parameters">
334
- <li class="tsd-parameter-signature">
335
- <ul class="tsd-signatures tsd-kind-type-literal">
336
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
337
- </ul>
338
- <ul class="tsd-descriptions">
339
- <li class="tsd-description">
340
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
341
- </li>
342
- </ul>
343
- </li>
344
- </ul>
345
- </li>
346
- </ul>
347
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
348
- </li>
349
- </ul>
350
- </section>
351
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
352
- <a name="updatecamera" class="tsd-anchor"></a>
353
- <h3>update<wbr>Camera</h3>
354
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
355
- <li class="tsd-signature tsd-kind-icon">update<wbr>Camera<span class="tsd-signature-symbol">(</span>pose<span class="tsd-signature-symbol">: </span><a href="index.pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a>, duration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
356
- </ul>
357
- <ul class="tsd-descriptions">
358
- <li class="tsd-description">
359
- <aside class="tsd-sources">
360
- <ul>
361
- <li>Defined in lib/react/hooks/useFiveAction.ts:18</li>
362
- </ul>
363
- </aside>
364
- <div class="tsd-comment tsd-typography">
365
- <div class="lead">
366
- <p>移动相机。（不触发点位移动）</p>
367
- </div>
368
- <dl class="tsd-comment-tags">
369
- <dt>description</dt>
370
- <dd><p>如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
371
- 会 Promise.reject。运动完成则 Promise.resolve</p>
372
- </dd>
373
- </dl>
374
- </div>
375
- <h4 class="tsd-parameters-title">Parameters</h4>
376
- <ul class="tsd-parameters">
377
- <li>
378
- <h5>pose: <a href="index.pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a></h5>
379
- <div class="tsd-comment tsd-typography">
380
- <p>相机目标位置</p>
381
- </div>
382
- </li>
383
- <li>
384
- <h5>duration: <span class="tsd-signature-type">number</span></h5>
385
- <div class="tsd-comment tsd-typography">
386
- <p>动画触发的时常</p>
387
- </div>
388
- </li>
389
- </ul>
390
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
391
- <p>Promise 是否移动成功</p>
392
- </li>
393
- </ul>
394
- </section>
395
- </section>
396
- </div>
397
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
398
- <nav class="tsd-navigation primary">
399
- <ul>
400
- <li class=" ">
401
- <a href="../modules.html">Modules</a>
402
- </li>
403
- <li class=" tsd-kind-module">
404
- <a href="../modules/index.html">index</a>
405
- </li>
406
- <li class="current tsd-kind-module">
407
- <a href="../modules/react.html">react</a>
408
- </li>
409
- </ul>
410
- </nav>
411
- <nav class="tsd-navigation secondary menu-sticky">
412
- <ul class="before-current">
413
- <li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
414
- <a href="../classes/react.store.html" class="tsd-kind-icon">Store</a>
415
- </li>
416
- </ul>
417
- <ul class="current">
418
- <li class="current tsd-kind-interface tsd-parent-kind-module">
419
- <a href="react.fiveactionreactcallbacks.html" class="tsd-kind-icon">Five<wbr>Action<wbr>React<wbr>Callbacks</a>
420
- <ul>
421
- <li class=" tsd-kind-method tsd-parent-kind-interface">
422
- <a href="react.fiveactionreactcallbacks.html#getpixels" class="tsd-kind-icon">get<wbr>Pixels</a>
423
- </li>
424
- <li class=" tsd-kind-method tsd-parent-kind-interface">
425
- <a href="react.fiveactionreactcallbacks.html#initbasisloader" class="tsd-kind-icon">init<wbr>Basis<wbr>Loader</a>
426
- </li>
427
- <li class=" tsd-kind-method tsd-parent-kind-interface">
428
- <a href="react.fiveactionreactcallbacks.html#needsrender" class="tsd-kind-icon">needs<wbr>Render</a>
429
- </li>
430
- <li class=" tsd-kind-method tsd-parent-kind-interface">
431
- <a href="react.fiveactionreactcallbacks.html#preloadpano" class="tsd-kind-icon">preload<wbr>Pano</a>
432
- </li>
433
- <li class=" tsd-kind-method tsd-parent-kind-interface">
434
- <a href="react.fiveactionreactcallbacks.html#render" class="tsd-kind-icon">render</a>
435
- </li>
436
- <li class=" tsd-kind-method tsd-parent-kind-interface">
437
- <a href="react.fiveactionreactcallbacks.html#updatecamera" class="tsd-kind-icon">update<wbr>Camera</a>
438
- </li>
439
- </ul>
440
- </li>
441
- </ul>
442
- <ul class="after-current">
443
- <li class=" tsd-kind-interface tsd-parent-kind-module">
444
- <a href="react.fiveinjectiontypes.html" class="tsd-kind-icon">Five<wbr>Injection<wbr>Types</a>
445
- </li>
446
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
447
- <a href="react.injectfivetoprops.html" class="tsd-kind-icon">Inject<wbr>Five<wbr>ToProps</a>
448
- </li>
449
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
450
- <a href="../modules/react.html#fiveinjectionactionfeature" class="tsd-kind-icon">Five<wbr>Injection<wbr>Action<wbr>Feature</a>
451
- </li>
452
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
453
- <a href="../modules/react.html#fiveinjectiondatafeature" class="tsd-kind-icon">Five<wbr>Injection<wbr>Data<wbr>Feature</a>
454
- </li>
455
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
456
- <a href="../modules/react.html#fiveinjectionfeature" class="tsd-kind-icon">Five<wbr>Injection<wbr>Feature</a>
457
- </li>
458
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
459
- <a href="../modules/react.html#fiveproviderproptypes" class="tsd-kind-icon">Five<wbr>Provider<wbr>Prop<wbr>Types</a>
460
- </li>
461
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
462
- <a href="../modules/react.html#fiveprovidertype" class="tsd-kind-icon">Five<wbr>Provider<wbr>Type</a>
463
- </li>
464
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
465
- <a href="../modules/react.html#storeactionmaphanlder" class="tsd-kind-icon">Store<wbr>Action<wbr>Map<wbr>Hanlder</a>
466
- </li>
467
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
468
- <a href="../modules/react.html#storeactionmaptype" class="tsd-kind-icon">Store<wbr>Action<wbr>Map<wbr>Type</a>
469
- </li>
470
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
471
- <a href="../modules/react.html#storeprovidertype" class="tsd-kind-icon">Store<wbr>Provider<wbr>Type</a>
472
- </li>
473
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
474
- <a href="../modules/react.html#storevaluemaptype" class="tsd-kind-icon">Store<wbr>Value<wbr>Map<wbr>Type</a>
475
- </li>
476
- <li class=" tsd-kind-variable tsd-parent-kind-module">
477
- <a href="../modules/react.html#fivecanvas" class="tsd-kind-icon">Five<wbr>Canvas</a>
478
- </li>
479
- <li class=" tsd-kind-variable tsd-parent-kind-module">
480
- <a href="../modules/react.html#injection_propname" class="tsd-kind-icon">INJECTION_<wbr>PROPNAME</a>
481
- </li>
482
- <li class=" tsd-kind-function tsd-parent-kind-module">
483
- <a href="../modules/react.html#createfiveprovider" class="tsd-kind-icon">create<wbr>Five<wbr>Provider</a>
484
- </li>
485
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
486
- <a href="../modules/react.html#createstore" class="tsd-kind-icon">create<wbr>Store</a>
487
- </li>
488
- <li class=" tsd-kind-function tsd-parent-kind-module">
489
- <a href="../modules/react.html#unsafe__usefiveinstance" class="tsd-kind-icon">unsafe__use<wbr>Five<wbr>Instance</a>
490
- </li>
491
- <li class=" tsd-kind-function tsd-parent-kind-module">
492
- <a href="../modules/react.html#usefiveaction" class="tsd-kind-icon">use<wbr>Five<wbr>Action</a>
493
- </li>
494
- <li class=" tsd-kind-function tsd-parent-kind-module">
495
- <a href="../modules/react.html#usefivecameradirection" class="tsd-kind-icon">use<wbr>Five<wbr>Camera<wbr>Direction</a>
496
- </li>
497
- <li class=" tsd-kind-function tsd-parent-kind-module">
498
- <a href="../modules/react.html#usefivecameraraycaster" class="tsd-kind-icon">use<wbr>Five<wbr>Camera<wbr>Raycaster</a>
499
- </li>
500
- <li class=" tsd-kind-function tsd-parent-kind-module">
501
- <a href="../modules/react.html#usefivecurrentstate" class="tsd-kind-icon">use<wbr>Five<wbr>Current<wbr>State</a>
502
- </li>
503
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
504
- <a href="../modules/react.html#usefiveevent" class="tsd-kind-icon">use<wbr>Five<wbr>Event</a>
505
- </li>
506
- <li class=" tsd-kind-function tsd-parent-kind-module">
507
- <a href="../modules/react.html#usefivemodelintersectraycaster" class="tsd-kind-icon">use<wbr>Five<wbr>Model<wbr>Intersect<wbr>Raycaster</a>
508
- </li>
509
- <li class=" tsd-kind-function tsd-parent-kind-module">
510
- <a href="../modules/react.html#usefivemodelreadystate" class="tsd-kind-icon">use<wbr>Five<wbr>Model<wbr>Ready<wbr>State</a>
511
- </li>
512
- <li class=" tsd-kind-function tsd-parent-kind-module">
513
- <a href="../modules/react.html#usefiveproject2d" class="tsd-kind-icon">use<wbr>Five<wbr>Project2d</a>
514
- </li>
515
- <li class=" tsd-kind-function tsd-parent-kind-module">
516
- <a href="../modules/react.html#usefivescene" class="tsd-kind-icon">use<wbr>Five<wbr>Scene</a>
517
- </li>
518
- <li class=" tsd-kind-function tsd-parent-kind-module">
519
- <a href="../modules/react.html#usefivestate" class="tsd-kind-icon">use<wbr>Five<wbr>State</a>
520
- </li>
521
- <li class=" tsd-kind-function tsd-parent-kind-module">
522
- <a href="../modules/react.html#usefivework" class="tsd-kind-icon">use<wbr>Five<wbr>Work</a>
523
- </li>
524
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
525
- <a href="../modules/react.html#withfive" class="tsd-kind-icon">with<wbr>Five</a>
526
- </li>
527
- </ul>
528
- </nav>
529
- </div>
530
- </div>
531
- </div>
532
- <footer>
533
- <div class="container">
534
- <h2>Legend</h2>
535
- <div class="tsd-legend-group">
536
- <ul class="tsd-legend">
537
- <li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
538
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
539
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
540
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
541
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
542
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
543
- </ul>
544
- <ul class="tsd-legend">
545
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
546
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
547
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
548
- </ul>
549
- <ul class="tsd-legend">
550
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
551
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
552
- </ul>
553
- </div>
554
- </div>
555
- </footer>
556
- <div class="overlay"></div>
557
- <script src="../assets/js/main.js"></script>
558
- </body>
559
- </html>