@realsee/five 5.0.0-alpha.71 → 5.0.0-alpha.72

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 (108) hide show
  1. package/docs/.nojekyll +1 -0
  2. package/docs/assets/highlight.css +134 -0
  3. package/docs/assets/icons.css +1043 -0
  4. package/docs/assets/{images/icons.png → icons.png} +0 -0
  5. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  6. package/docs/assets/main.js +52 -0
  7. package/docs/assets/search.js +1 -0
  8. package/docs/assets/style.css +1388 -0
  9. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  10. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  11. package/docs/classes/five.AnimationFrameLoop.html +22 -522
  12. package/docs/classes/five.BVH.html +10 -488
  13. package/docs/classes/five.BVHNode.html +8 -468
  14. package/docs/classes/five.BVHVector3.html +1 -525
  15. package/docs/classes/five.Camera.html +11 -323
  16. package/docs/classes/five.Five.html +269 -2938
  17. package/docs/classes/five.InternalWebGLRenderer.html +1 -212
  18. package/docs/classes/five.Model.html +76 -1011
  19. package/docs/classes/five.NetworkSubscribe.html +50 -564
  20. package/docs/classes/five.PBMContainer.html +17 -428
  21. package/docs/classes/five.PBMGroup.html +19 -430
  22. package/docs/classes/five.PBMMaterial.html +15 -367
  23. package/docs/classes/five.PBMMesh.html +7 -254
  24. package/docs/classes/five.Scene.html +3 -263
  25. package/docs/classes/five.Subscribe.html +55 -599
  26. package/docs/classes/five.Work.html +1 -348
  27. package/docs/classes/gltf_loader.GLTFLoader.html +16 -411
  28. package/docs/classes/gltf_loader.GLTFObject.html +7 -287
  29. package/docs/classes/line.Line.html +1 -384
  30. package/docs/classes/line.LineGeometry.html +1 -530
  31. package/docs/classes/line.LineMaterial.html +1 -306
  32. package/docs/classes/line.LineSegmentsGeometry.html +1 -477
  33. package/docs/classes/line.THREE_Line2.html +1 -280
  34. package/docs/classes/line.THREE_LineSegments2.html +1 -282
  35. package/docs/classes/react.Store.html +28 -621
  36. package/docs/classes/server.BVH.html +10 -587
  37. package/docs/classes/server.BVHNode.html +8 -567
  38. package/docs/classes/server.BVHVector3.html +1 -624
  39. package/docs/classes/server.Model.html +62 -840
  40. package/docs/classes/server.PBMGroup.html +9 -384
  41. package/docs/classes/server.PBMMesh.html +7 -353
  42. package/docs/classes/sticker.Sticker.html +31 -470
  43. package/docs/index.html +166 -458
  44. package/docs/interfaces/five.AddableObject.html +1 -234
  45. package/docs/interfaces/five.AnimationFrame.html +1 -243
  46. package/docs/interfaces/five.BVHIntersect.html +1 -204
  47. package/docs/interfaces/five.CameraPose.html +1 -232
  48. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +28 -438
  49. package/docs/interfaces/five.EventCallback.html +370 -2644
  50. package/docs/interfaces/five.FiveInitArgs.html +93 -723
  51. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +15 -295
  52. package/docs/interfaces/five.ImageOptions.html +16 -277
  53. package/docs/interfaces/five.ImageURLOptions.html +1 -260
  54. package/docs/interfaces/five.IntersectMeshInterface.html +1 -188
  55. package/docs/interfaces/five.Intersection.html +7 -227
  56. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +20 -366
  57. package/docs/interfaces/five.ModelEventCallback.html +22 -367
  58. package/docs/interfaces/five.MovePanoOptions.html +39 -456
  59. package/docs/interfaces/five.PBMPanoPicture.html +7 -219
  60. package/docs/interfaces/five.PBMParameters.html +15 -303
  61. package/docs/interfaces/five.PanoCircleMeshInterface.html +5 -426
  62. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +28 -452
  63. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +20 -365
  64. package/docs/interfaces/five.Pose.html +35 -270
  65. package/docs/interfaces/five.Scissor.html +14 -252
  66. package/docs/interfaces/five.State.html +16 -297
  67. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -180
  68. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -171
  69. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -198
  70. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -213
  71. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -210
  72. package/docs/interfaces/five.TextureOptions.html +18 -296
  73. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -226
  74. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +27 -439
  75. package/docs/interfaces/five.WorkCubeImage.html +1 -251
  76. package/docs/interfaces/five.WorkImage.html +3 -306
  77. package/docs/interfaces/five.WorkInitial.html +13 -273
  78. package/docs/interfaces/five.WorkModel.html +3 -239
  79. package/docs/interfaces/five.WorkObserver.html +3 -323
  80. package/docs/interfaces/five.WorkTile.html +1 -274
  81. package/docs/interfaces/five.WorkVideo.html +3 -211
  82. package/docs/interfaces/gltf_loader.GLTF.html +7 -304
  83. package/docs/interfaces/react.FiveActionReactCallbacks.html +61 -585
  84. package/docs/interfaces/react.FiveInjectionTypes.html +154 -1645
  85. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -286
  86. package/docs/interfaces/server.BVHIntersect.html +1 -303
  87. package/docs/interfaces/server.Intersection.html +7 -326
  88. package/docs/interfaces/server.ModelEventCallback.html +18 -427
  89. package/docs/interfaces/sticker.IntersectionLike.html +8 -223
  90. package/docs/modules/five.SubscribeMixinType.html +1 -143
  91. package/docs/modules/five.html +442 -3044
  92. package/docs/modules/gltf_loader.html +1 -155
  93. package/docs/modules/line.html +1 -210
  94. package/docs/modules/react.html +130 -1607
  95. package/docs/modules/server.html +18 -560
  96. package/docs/modules/sticker.html +1 -151
  97. package/docs/modules.html +1 -136
  98. package/five/index.js +5 -5
  99. package/gltf-loader/index.js +2 -2
  100. package/line/index.js +2 -2
  101. package/package.json +1 -1
  102. package/react/index.js +2 -2
  103. package/server/index.js +3 -3
  104. package/sticker/index.js +2 -2
  105. package/umd/five.js +1 -1
  106. package/docs/assets/css/main.css +0 -2660
  107. package/docs/assets/js/main.js +0 -248
  108. package/docs/assets/js/search.js +0 -1
package/docs/interfaces/react.FiveActionReactCallbacks.html CHANGED
@@ -1,586 +1,62 @@
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.71</title>
7
- <meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.71">
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.71</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.71</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>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FiveActionReactCallbacks | 如视 Five SDK - v5.0.0-alpha.71</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.71"/><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.71</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.71</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.FiveActionReactCallbacks.html">FiveActionReactCallbacks</a></li></ul><h1>Interface FiveActionReactCallbacks</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Five 命令集合</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">FiveActionReactCallbacks</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#getPixels" class="tsd-kind-icon">get<wbr/>Pixels</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#initBasisLoader" class="tsd-kind-icon">init<wbr/>Basis<wbr/>Loader</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#preloadPano" class="tsd-kind-icon">preload<wbr/>Pano</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#render" class="tsd-kind-icon">render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#updateCamera" class="tsd-kind-icon">update<wbr/>Camera</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getPixels" class="tsd-anchor"></a><h3>get<wbr/>Pixels</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pixels<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pixelRatio<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:50</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>获取画面中的像素颜色</p>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>x: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>获取像素区域的起始坐标 x</p>
7
+ </div></div></li><li><h5>y: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>获取像素区域的起始坐标 y</p>
9
+ </div></div></li><li><h5>width: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>获取像素区域的宽度</p>
11
+ </div></div></li><li><h5>height: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>获取像素区域的高度</p>
13
+ </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> pixelRatio: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>获取区域的像素比</p>
15
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><div><p>rgba颜色平铺的 Uint8Array</p>
16
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="initBasisLoader" class="tsd-anchor"></a><h3>init<wbr/>Basis<wbr/>Loader</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><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></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:39</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>初始化 initBasisLoader</p>
18
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>同初始化的 initBasisLoader 参数。用于初始化 basisLoader。
19
+ basisLoader 只会初始化一次，一旦初始化则不会再修改。</p>
20
+ </dd><dt>example</dt><dd><pre><code><span class="hl-4">// 使用默认解析器</span><br/><span class="hl-5">initialBasisLoader</span><span class="hl-0">();</span><br/><br/><span class="hl-4">// 使用指定解析器</span><br/><span class="hl-4">// 会调用这个目录下的 basis_transcoder.js basis_transcoder.wasm 文件作为解析器</span><br/><span class="hl-5">initialBasisLoader</span><span class="hl-0">(</span><span class="hl-3">&quot;https://vrlab-public.ljcdn.com/release/static/image/release/five/basis/&quot;</span><span class="hl-0">);</span>
189
21
  </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="five.Pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a>, duration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
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="five.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/five.html">five</a>
405
- </li>
406
- <li class=" tsd-kind-module">
407
- <a href="../modules/gltf_loader.html">gltf-<wbr>loader</a>
408
- </li>
409
- <li class=" tsd-kind-module">
410
- <a href="../modules/line.html">line</a>
411
- </li>
412
- <li class="current tsd-kind-module">
413
- <a href="../modules/react.html">react</a>
414
- </li>
415
- <li class=" tsd-kind-module">
416
- <a href="../modules/server.html">server</a>
417
- </li>
418
- <li class=" tsd-kind-module">
419
- <a href="../modules/sticker.html">sticker</a>
420
- </li>
421
- </ul>
422
- </nav>
423
- <nav class="tsd-navigation secondary menu-sticky">
424
- <ul class="before-current">
425
- <li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
426
- <a href="../classes/react.Store.html" class="tsd-kind-icon">Store</a>
427
- </li>
428
- </ul>
429
- <ul class="current">
430
- <li class="current tsd-kind-interface tsd-parent-kind-module">
431
- <a href="react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr>Action<wbr>React<wbr>Callbacks</a>
432
- <ul>
433
- <li class=" tsd-kind-method tsd-parent-kind-interface">
434
- <a href="react.FiveActionReactCallbacks.html#getPixels" class="tsd-kind-icon">get<wbr>Pixels</a>
435
- </li>
436
- <li class=" tsd-kind-method tsd-parent-kind-interface">
437
- <a href="react.FiveActionReactCallbacks.html#initBasisLoader" class="tsd-kind-icon">init<wbr>Basis<wbr>Loader</a>
438
- </li>
439
- <li class=" tsd-kind-method tsd-parent-kind-interface">
440
- <a href="react.FiveActionReactCallbacks.html#needsRender" class="tsd-kind-icon">needs<wbr>Render</a>
441
- </li>
442
- <li class=" tsd-kind-method tsd-parent-kind-interface">
443
- <a href="react.FiveActionReactCallbacks.html#preloadPano" class="tsd-kind-icon">preload<wbr>Pano</a>
444
- </li>
445
- <li class=" tsd-kind-method tsd-parent-kind-interface">
446
- <a href="react.FiveActionReactCallbacks.html#render" class="tsd-kind-icon">render</a>
447
- </li>
448
- <li class=" tsd-kind-method tsd-parent-kind-interface">
449
- <a href="react.FiveActionReactCallbacks.html#updateCamera" class="tsd-kind-icon">update<wbr>Camera</a>
450
- </li>
451
- </ul>
452
- </li>
453
- </ul>
454
- <ul class="after-current">
455
- <li class=" tsd-kind-interface tsd-parent-kind-module">
456
- <a href="react.FiveInjectionTypes.html" class="tsd-kind-icon">Five<wbr>Injection<wbr>Types</a>
457
- </li>
458
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
459
- <a href="react.PropTypeOfFiveFeatures.html" class="tsd-kind-icon">Prop<wbr>Type<wbr>OfFive<wbr>Features</a>
460
- </li>
461
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
462
- <a href="../modules/react.html#FiveInjectionActionFeature" class="tsd-kind-icon">Five<wbr>Injection<wbr>Action<wbr>Feature</a>
463
- </li>
464
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
465
- <a href="../modules/react.html#FiveInjectionDataFeature" class="tsd-kind-icon">Five<wbr>Injection<wbr>Data<wbr>Feature</a>
466
- </li>
467
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
468
- <a href="../modules/react.html#FiveInjectionFeature" class="tsd-kind-icon">Five<wbr>Injection<wbr>Feature</a>
469
- </li>
470
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
471
- <a href="../modules/react.html#FiveProviderPropTypes" class="tsd-kind-icon">Five<wbr>Provider<wbr>Prop<wbr>Types</a>
472
- </li>
473
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
474
- <a href="../modules/react.html#FiveProviderType" class="tsd-kind-icon">Five<wbr>Provider<wbr>Type</a>
475
- </li>
476
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
477
- <a href="../modules/react.html#StoreActionMapHanlder" class="tsd-kind-icon">Store<wbr>Action<wbr>Map<wbr>Hanlder</a>
478
- </li>
479
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
480
- <a href="../modules/react.html#StoreActionMapType" class="tsd-kind-icon">Store<wbr>Action<wbr>Map<wbr>Type</a>
481
- </li>
482
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
483
- <a href="../modules/react.html#StoreProviderType" class="tsd-kind-icon">Store<wbr>Provider<wbr>Type</a>
484
- </li>
485
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
486
- <a href="../modules/react.html#StoreValueMapType" class="tsd-kind-icon">Store<wbr>Value<wbr>Map<wbr>Type</a>
487
- </li>
488
- <li class=" tsd-kind-variable tsd-parent-kind-module">
489
- <a href="../modules/react.html#FiveCanvas" class="tsd-kind-icon">Five<wbr>Canvas</a>
490
- </li>
491
- <li class=" tsd-kind-variable tsd-parent-kind-module">
492
- <a href="../modules/react.html#INJECTION_PROPNAME" class="tsd-kind-icon">INJECTION_<wbr>PROPNAME</a>
493
- </li>
494
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
495
- <a href="../modules/react.html#createFiveFeature" class="tsd-kind-icon">create<wbr>Five<wbr>Feature</a>
496
- </li>
497
- <li class=" tsd-kind-function tsd-parent-kind-module">
498
- <a href="../modules/react.html#createFiveProvider" class="tsd-kind-icon">create<wbr>Five<wbr>Provider</a>
499
- </li>
500
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
501
- <a href="../modules/react.html#createStore" class="tsd-kind-icon">create<wbr>Store</a>
502
- </li>
503
- <li class=" tsd-kind-function tsd-parent-kind-module">
504
- <a href="../modules/react.html#unsafe__useFiveInstance" class="tsd-kind-icon">unsafe__use<wbr>Five<wbr>Instance</a>
505
- </li>
506
- <li class=" tsd-kind-function tsd-parent-kind-module">
507
- <a href="../modules/react.html#useFiveAction" class="tsd-kind-icon">use<wbr>Five<wbr>Action</a>
508
- </li>
509
- <li class=" tsd-kind-function tsd-parent-kind-module">
510
- <a href="../modules/react.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr>Five<wbr>Camera<wbr>Direction</a>
511
- </li>
512
- <li class=" tsd-kind-function tsd-parent-kind-module">
513
- <a href="../modules/react.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr>Five<wbr>Camera<wbr>Raycaster</a>
514
- </li>
515
- <li class=" tsd-kind-function tsd-parent-kind-module">
516
- <a href="../modules/react.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr>Five<wbr>Current<wbr>Observer</a>
517
- </li>
518
- <li class=" tsd-kind-function tsd-parent-kind-module">
519
- <a href="../modules/react.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr>Five<wbr>Current<wbr>State</a>
520
- </li>
521
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
522
- <a href="../modules/react.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr>Five<wbr>Event<wbr>Callback</a>
523
- </li>
524
- <li class=" tsd-kind-function tsd-parent-kind-module">
525
- <a href="../modules/react.html#useFiveFloor" class="tsd-kind-icon">use<wbr>Five<wbr>Floor</a>
526
- </li>
527
- <li class=" tsd-kind-function tsd-parent-kind-module">
528
- <a href="../modules/react.html#useFiveHelper" class="tsd-kind-icon">use<wbr>Five<wbr>Helper</a>
529
- </li>
530
- <li class=" tsd-kind-function tsd-parent-kind-module">
531
- <a href="../modules/react.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr>Five<wbr>Model<wbr>Intersect<wbr>Raycaster</a>
532
- </li>
533
- <li class=" tsd-kind-function tsd-parent-kind-module">
534
- <a href="../modules/react.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr>Five<wbr>Model<wbr>Ready<wbr>State</a>
535
- </li>
536
- <li class=" tsd-kind-function tsd-parent-kind-module">
537
- <a href="../modules/react.html#useFiveProject2d" class="tsd-kind-icon">use<wbr>Five<wbr>Project2d</a>
538
- </li>
539
- <li class=" tsd-kind-function tsd-parent-kind-module">
540
- <a href="../modules/react.html#useFiveScene" class="tsd-kind-icon">use<wbr>Five<wbr>Scene</a>
541
- </li>
542
- <li class=" tsd-kind-function tsd-parent-kind-module">
543
- <a href="../modules/react.html#useFiveSceneEffect" class="tsd-kind-icon">use<wbr>Five<wbr>Scene<wbr>Effect</a>
544
- </li>
545
- <li class=" tsd-kind-function tsd-parent-kind-module">
546
- <a href="../modules/react.html#useFiveState" class="tsd-kind-icon">use<wbr>Five<wbr>State</a>
547
- </li>
548
- <li class=" tsd-kind-function tsd-parent-kind-module">
549
- <a href="../modules/react.html#useFiveWork" class="tsd-kind-icon">use<wbr>Five<wbr>Work</a>
550
- </li>
551
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
552
- <a href="../modules/react.html#withFive" class="tsd-kind-icon">with<wbr>Five</a>
553
- </li>
554
- </ul>
555
- </nav>
556
- </div>
557
- </div>
558
- </div>
559
- <footer>
560
- <div class="container">
561
- <h2>Legend</h2>
562
- <div class="tsd-legend-group">
563
- <ul class="tsd-legend">
564
- <li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
565
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
566
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
567
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
568
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
569
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
570
- </ul>
571
- <ul class="tsd-legend">
572
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
573
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
574
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
575
- </ul>
576
- <ul class="tsd-legend">
577
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
578
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
579
- </ul>
580
- </div>
581
- </div>
582
- </footer>
583
- <div class="overlay"></div>
584
- <script src="../assets/js/main.js"></script>
585
- </body>
586
- </html>
22
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> transcoderResourcePath: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>basis 解析器路径
24
+ 如果不设置，使用默认解析器 basis 解析器。
25
+ 可以传入解析器的 <code>resourcePath</code>, 则使用指定的解析器</p>
26
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="needsRender" class="tsd-anchor"></a><h3>needs<wbr/>Render</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">needs<wbr/>Render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:74</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>下一帧渲染</p>
28
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>调用 <code>render()</code> 和 <code>needsRender()</code> 均可在按需渲染时，使得画面渲染一次
29
+ 区别在于：</p>
30
+ <ul>
31
+ <li><code>needsRender()</code> 为在下帧渲染画面</li>
32
+ <li><code>render()</code> 在当前帧渲染画面
33
+ 推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作，可以使用 <code>render()</code></li>
34
+ </ul>
35
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="preloadPano" class="tsd-anchor"></a><h3>preload<wbr/>Pano</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">preload<wbr/>Pano<span class="tsd-signature-symbol">(</span>panoIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>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></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:82</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
36
+ <p>预加载点位图片资源</p>
37
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>panoIndex: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
38
+ <p>观察点序号</p>
39
+ </div></div></li><li><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><div class="tsd-comment tsd-typography"><div class="lead">
40
+ <p>加载完成回调, 并传递加载用时。</p>
41
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>costs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>costs: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>加载完成的 Promise 参数同 callback</p>
42
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="render" class="tsd-anchor"></a><h3>render</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&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></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:63</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
43
+ <p>强制渲染</p>
44
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>调用 <code>render()</code> 和 <code>needsRender()</code> 均可在按需渲染时，使得画面渲染一次
45
+ 区别在于：</p>
46
+ <ul>
47
+ <li><code>needsRender()</code> 为在下帧渲染画面</li>
48
+ <li><code>render()</code> 在当前帧渲染画面
49
+ 推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作，可以使用 <code>render()</code></li>
50
+ </ul>
51
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
52
+ <p>渲染完成回调</p>
53
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="updateCamera" class="tsd-anchor"></a><h3>update<wbr/>Camera</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Camera<span class="tsd-signature-symbol">(</span>pose<span class="tsd-signature-symbol">: </span><a href="five.Pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a>, duration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
54
+ <p>移动相机。（不触发点位移动）</p>
55
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>如果动画中途被打断（用户触发行为，或者调用 setState, load, changeMode）的等
56
+ 会 Promise.reject。运动完成则 Promise.resolve</p>
57
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pose: <a href="five.Pose.html" class="tsd-signature-type" data-tsd-kind="Interface">Pose</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
58
+ <p>相机目标位置</p>
59
+ </div></div></li><li><h5>duration: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
60
+ <p>动画触发的时常</p>
61
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>Promise 是否移动成功</p>
62
+ </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/five.html">five</a></li><li class=" tsd-kind-module"><a href="../modules/gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="../modules/line.html">line</a></li><li class="current tsd-kind-module"><a href="../modules/react.html">react</a></li><li class=" tsd-kind-module"><a href="../modules/server.html">server</a></li><li class=" tsd-kind-module"><a href="../modules/sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>React<wbr/>Callbacks</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#getPixels" class="tsd-kind-icon">get<wbr/>Pixels</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#initBasisLoader" class="tsd-kind-icon">init<wbr/>Basis<wbr/>Loader</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#needsRender" class="tsd-kind-icon">needs<wbr/>Render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#preloadPano" class="tsd-kind-icon">preload<wbr/>Pano</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#render" class="tsd-kind-icon">render</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="react.FiveActionReactCallbacks.html#updateCamera" class="tsd-kind-icon">update<wbr/>Camera</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>