Página inicial Explorar Ajuda
Registrar Entrar
samien
/
three.js
mirror de https://github.com/mrdoob/three.js.git
1
0
Fork 0
Arquivos Issues 0 Wiki
Tree: b5e596d160
Branches Tags
three.js
/
docs
/
pages
/
GLTFLoader.html

GLTFLoader.html 14 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>GLTFLoader - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 		<p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
    13. 

  13. 	<h1 translate="no">GLTFLoader</h1>
    14. 

  14. 		<section>
    15. 

  15. 			<header>
    16. 

  16. 				<div class="class-description"><p>A loader for the glTF 2.0 format.</p>
    17. 

  17. <p>[glTF](https://www.khronos.org/gltf/} (GL Transmission Format) is an <a href="https://github.com/KhronosGroup/glTF/tree/main/specification/2.0)">open format specification</a> whenever possible. Be advised that image bitmaps are not
    18. 

  18. automatically GC-collected when they are no longer referenced, and they require special handling during
    19. 

  19. the disposal process.</p>
    20. 

  20. <p><code>GLTFLoader</code> supports the following glTF 2.0 extensions:</p>
    21. 

  21. <ul>
    22. 

  22. <li>KHR_draco_mesh_compression</li>
    23. 

  23. <li>KHR_materials_clearcoat</li>
    24. 

  24. <li>KHR_materials_dispersion</li>
    25. 

  25. <li>KHR_materials_ior</li>
    26. 

  26. <li>KHR_materials_specular</li>
    27. 

  27. <li>KHR_materials_transmission</li>
    28. 

  28. <li>KHR_materials_iridescence</li>
    29. 

  29. <li>KHR_materials_unlit</li>
    30. 

  30. <li>KHR_materials_volume</li>
    31. 

  31. <li>KHR_mesh_quantization</li>
    32. 

  32. <li>KHR_lights_punctual</li>
    33. 

  33. <li>KHR_texture_basisu</li>
    34. 

  34. <li>KHR_texture_transform</li>
    35. 

  35. <li>EXT_texture_webp</li>
    36. 

  36. <li>EXT_meshopt_compression</li>
    37. 

  37. <li>EXT_mesh_gpu_instancing</li>
    38. 

  38. </ul>
    39. 

  39. <p>The following glTF 2.0 extension is supported by an external user plugin:</p>
    40. 

  40. <ul>
    41. 

  41. <li><a href="https://github.com/takahirox/three-gltf-extensions">KHR_materials_variants</a></li>
    42. 

  42. <li><a href="https://github.com/takahirox/three-gltf-extensions">MSFT_texture_dds</a></li>
    43. 

  43. <li><a href="https://github.com/needle-tools/three-animation-pointer">KHR_animation_pointer</a></li>
    44. 

  44. <li><a href="https://github.com/needle-tools/gltf-progressive">NEEDLE_progressive</a></li>
    45. 

  45. </ul></div>
    46. 

  46. 				<h2>Code Example</h2>
    47. 

  47. 				<div translate="no"><pre><code class="language-js">const loader = new GLTFLoader();
    48. 

  48. // Optional: Provide a DRACOLoader instance to decode compressed mesh data
    49. 

  49. const dracoLoader = new DRACOLoader();
    50. 

  50. dracoLoader.setDecoderPath( '/examples/jsm/libs/draco/' );
    51. 

  51. loader.setDRACOLoader( dracoLoader );
    52. 

  52. const gltf = await loader.loadAsync( 'models/gltf/duck/duck.gltf' );
    53. 

  53. scene.add( gltf.scene );
    54. 

  54. </code></pre></div>
    55. 

  55. 			</header>
    56. 

  56. 			<article>
    57. 

  57. 				<h2 class="subsection-title">Import</h2>
    58. 

  58. 				<p><span translate="no">GLTFLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
    59. 

  59. 				<pre><code class="language-js">import { GLTFLoader } from 'three/addons/loaders/GLTFLoader.js';</code></pre>
    60. 

  60. 				<div class="container-overview">
    61. 

  61. 					<h2>Constructor</h2>
    62. 

  62. 					<h3 class="name name-method" id="GLTFLoader" translate="no">new <a href="#GLTFLoader">GLTFLoader</a><span class="signature">( manager : <span class="param-type">LoadingManager</span> )</span> </h3>
    63. 

  63. 					<div class="method">
    64. 

  64. 						<div class="description">
    65. 

  65. 							<p>Constructs a new glTF loader.</p>
    66. 

  66. 						</div>
    67. 

  67. 						<table class="params">
    68. 

  68. 							<tbody>
    69. 

  69. 								<tr>
    70. 

  70. 									<td class="name"><code>manager</code></td>
    71. 

  71. 									<td class="description last"><p>The loading manager.</p></td>
    72. 

  72. 								</tr>
    73. 

  73. 							</tbody>
    74. 

  74. 						</table>
    75. 

  75. 					</div>
    76. 

  76. 				</div>
    77. 

  77. 				<h2 class="subsection-title">Methods</h2>
    78. 

  78. 					<h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type">onProgressCallback</span>, onError : <span class="param-type">onErrorCallback</span> )</span> </h3>
    79. 

  79. 					<div class="method">
    80. 

  80. 						<div class="description">
    81. 

  81. 							<p>Starts loading from the given URL and passes the loaded glTF asset
    82. 

  82. to the <code>onLoad()</code> callback.</p>
    83. 

  83. 						</div>
    84. 

  84. 						<table class="params">
    85. 

  85. 							<tbody>
    86. 

  86. 								<tr>
    87. 

  87. 									<td class="name"><code>url</code></td>
    88. 

  88. 									<td class="description last"><p>The path/URL of the file to be loaded. This can also be a data URI.</p></td>
    89. 

  89. 								</tr>
    90. 

  90. 								<tr>
    91. 

  91. 									<td class="name"><code>onLoad</code></td>
    92. 

  92. 									<td class="description last"><p>Executed when the loading process has been finished.</p></td>
    93. 

  93. 								</tr>
    94. 

  94. 								<tr>
    95. 

  95. 									<td class="name"><code>onProgress</code></td>
    96. 

  96. 									<td class="description last"><p>Executed while the loading is in progress.</p></td>
    97. 

  97. 								</tr>
    98. 

  98. 								<tr>
    99. 

  99. 									<td class="name"><code>onError</code></td>
    100. 

  100. 									<td class="description last"><p>Executed when errors occur.</p></td>
    101. 

  101. 								</tr>
    102. 

  102. 							</tbody>
    103. 

  103. 						</table>
    104. 

  104. 						<dl class="details">
    105. 

  105. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
    106. 

  106. 						</dl>
    107. 

  107. 					</div>
    108. 

  108. 					<h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( data : <span class="param-type">string | ArrayBuffer</span>, path : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onError : <span class="param-type">onErrorCallback</span> )</span> </h3>
    109. 

  109. 					<div class="method">
    110. 

  110. 						<div class="description">
    111. 

  111. 							<p>Parses the given FBX data and returns the resulting group.</p>
    112. 

  112. 						</div>
    113. 

  113. 						<table class="params">
    114. 

  114. 							<tbody>
    115. 

  115. 								<tr>
    116. 

  116. 									<td class="name"><code>data</code></td>
    117. 

  117. 									<td class="description last"><p>The raw glTF data.</p></td>
    118. 

  118. 								</tr>
    119. 

  119. 								<tr>
    120. 

  120. 									<td class="name"><code>path</code></td>
    121. 

  121. 									<td class="description last"><p>The URL base path.</p></td>
    122. 

  122. 								</tr>
    123. 

  123. 								<tr>
    124. 

  124. 									<td class="name"><code>onLoad</code></td>
    125. 

  125. 									<td class="description last"><p>Executed when the loading process has been finished.</p></td>
    126. 

  126. 								</tr>
    127. 

  127. 								<tr>
    128. 

  128. 									<td class="name"><code>onError</code></td>
    129. 

  129. 									<td class="description last"><p>Executed when errors occur.</p></td>
    130. 

  130. 								</tr>
    131. 

  131. 							</tbody>
    132. 

  132. 						</table>
    133. 

  133. 						<dl class="details">
    134. 

  134. 							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
    135. 

  135. 						</dl>
    136. 

  136. 					</div>
    137. 

  137. 					<h3 class="name name-method" id="parseAsync" translate="no">.<a href="#parseAsync">parseAsync</a><span class="signature">( data : <span class="param-type">string | ArrayBuffer</span>, path : <span class="param-type">string</span> )</span><span class="type-signature"> : Promise.&lt;<a href="GLTFLoader.html#~LoadObject">GLTFLoader~LoadObject</a>></span> <span class="type-signature">(async) </span></h3>
    138. 

  138. 					<div class="method">
    139. 

  139. 						<div class="description">
    140. 

  140. 							<p>Async version of <a href="GLTFLoader.html#parse">GLTFLoader#parse</a>.</p>
    141. 

  141. 						</div>
    142. 

  142. 						<table class="params">
    143. 

  143. 							<tbody>
    144. 

  144. 								<tr>
    145. 

  145. 									<td class="name"><code>data</code></td>
    146. 

  146. 									<td class="description last"><p>The raw glTF data.</p></td>
    147. 

  147. 								</tr>
    148. 

  148. 								<tr>
    149. 

  149. 									<td class="name"><code>path</code></td>
    150. 

  150. 									<td class="description last"><p>The URL base path.</p></td>
    151. 

  151. 								</tr>
    152. 

  152. 							</tbody>
    153. 

  153. 						</table>
    154. 

  154. 						<dl class="details">
    155. 

  155. 							<dt class="tag-returns"><strong>Returns:</strong> A Promise that resolves with the loaded glTF when the parsing has been finished.</dt>
    156. 

  156. 						</dl>
    157. 

  157. 					</div>
    158. 

  158. 					<h3 class="name name-method" id="register" translate="no">.<a href="#register">register</a><span class="signature">( callback : <span class="param-type">function</span> )</span><span class="type-signature"> : <a href="GLTFLoader.html">GLTFLoader</a></span> </h3>
    159. 

  159. 					<div class="method">
    160. 

  160. 						<div class="description">
    161. 

  161. 							<p>Registers a plugin callback. This API is internally used to implement the various
    162. 

  162. glTF extensions but can also used by third-party code to add additional logic
    163. 

  163. to the loader.</p>
    164. 

  164. 						</div>
    165. 

  165. 						<table class="params">
    166. 

  166. 							<tbody>
    167. 

  167. 								<tr>
    168. 

  168. 									<td class="name"><code>callback</code></td>
    169. 

  169. 									<td class="description last"><p>The callback function to register.</p></td>
    170. 

  170. 								</tr>
    171. 

  171. 							</tbody>
    172. 

  172. 						</table>
    173. 

  173. 						<dl class="details">
    174. 

  174. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
    175. 

  175. 						</dl>
    176. 

  176. 					</div>
    177. 

  177. 					<h3 class="name name-method" id="setDRACOLoader" translate="no">.<a href="#setDRACOLoader">setDRACOLoader</a><span class="signature">( dracoLoader : <span class="param-type">DRACOLoader</span> )</span><span class="type-signature"> : <a href="GLTFLoader.html">GLTFLoader</a></span> </h3>
    178. 

  178. 					<div class="method">
    179. 

  179. 						<div class="description">
    180. 

  180. 							<p>Sets the given Draco loader to this loader. Required for decoding assets
    181. 

  181. compressed with the <code>KHR_draco_mesh_compression</code> extension.</p>
    182. 

  182. 						</div>
    183. 

  183. 						<table class="params">
    184. 

  184. 							<tbody>
    185. 

  185. 								<tr>
    186. 

  186. 									<td class="name"><code>dracoLoader</code></td>
    187. 

  187. 									<td class="description last"><p>The Draco loader to set.</p></td>
    188. 

  188. 								</tr>
    189. 

  189. 							</tbody>
    190. 

  190. 						</table>
    191. 

  191. 						<dl class="details">
    192. 

  192. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
    193. 

  193. 						</dl>
    194. 

  194. 					</div>
    195. 

  195. 					<h3 class="name name-method" id="setKTX2Loader" translate="no">.<a href="#setKTX2Loader">setKTX2Loader</a><span class="signature">( ktx2Loader : <span class="param-type">KTX2Loader</span> )</span><span class="type-signature"> : <a href="GLTFLoader.html">GLTFLoader</a></span> </h3>
    196. 

  196. 					<div class="method">
    197. 

  197. 						<div class="description">
    198. 

  198. 							<p>Sets the given KTX2 loader to this loader. Required for loading KTX2
    199. 

  199. compressed textures.</p>
    200. 

  200. 						</div>
    201. 

  201. 						<table class="params">
    202. 

  202. 							<tbody>
    203. 

  203. 								<tr>
    204. 

  204. 									<td class="name"><code>ktx2Loader</code></td>
    205. 

  205. 									<td class="description last"><p>The KTX2 loader to set.</p></td>
    206. 

  206. 								</tr>
    207. 

  207. 							</tbody>
    208. 

  208. 						</table>
    209. 

  209. 						<dl class="details">
    210. 

  210. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
    211. 

  211. 						</dl>
    212. 

  212. 					</div>
    213. 

  213. 					<h3 class="name name-method" id="setMeshoptDecoder" translate="no">.<a href="#setMeshoptDecoder">setMeshoptDecoder</a><span class="signature">( meshoptDecoder : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="GLTFLoader.html">GLTFLoader</a></span> </h3>
    214. 

  214. 					<div class="method">
    215. 

  215. 						<div class="description">
    216. 

  216. 							<p>Sets the given meshopt decoder. Required for decoding assets
    217. 

  217. compressed with the <code>EXT_meshopt_compression</code> extension.</p>
    218. 

  218. 						</div>
    219. 

  219. 						<table class="params">
    220. 

  220. 							<tbody>
    221. 

  221. 								<tr>
    222. 

  222. 									<td class="name"><code>meshoptDecoder</code></td>
    223. 

  223. 									<td class="description last"><p>The meshopt decoder to set.</p></td>
    224. 

  224. 								</tr>
    225. 

  225. 							</tbody>
    226. 

  226. 						</table>
    227. 

  227. 						<dl class="details">
    228. 

  228. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
    229. 

  229. 						</dl>
    230. 

  230. 					</div>
    231. 

  231. 					<h3 class="name name-method" id="unregister" translate="no">.<a href="#unregister">unregister</a><span class="signature">( callback : <span class="param-type">function</span> )</span><span class="type-signature"> : <a href="GLTFLoader.html">GLTFLoader</a></span> </h3>
    232. 

  232. 					<div class="method">
    233. 

  233. 						<div class="description">
    234. 

  234. 							<p>Unregisters a plugin callback.</p>
    235. 

  235. 						</div>
    236. 

  236. 						<table class="params">
    237. 

  237. 							<tbody>
    238. 

  238. 								<tr>
    239. 

  239. 									<td class="name"><code>callback</code></td>
    240. 

  240. 									<td class="description last"><p>The callback function to unregister.</p></td>
    241. 

  241. 								</tr>
    242. 

  242. 							</tbody>
    243. 

  243. 						</table>
    244. 

  244. 						<dl class="details">
    245. 

  245. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
    246. 

  246. 						</dl>
    247. 

  247. 					</div>
    248. 

  248. 				<h2 class="subsection-title">Type Definitions</h2>
    249. 

  249. 				<div class="member">
    250. 

  250. 					<h3 class="name" id="~LoadObject" translate="no">.<a href="#~LoadObject">LoadObject</a> </h3>
    251. 

  251. 					<div class="description">
    252. 

  252. 						<p>Loader result of <code>GLTFLoader</code>.</p>
    253. 

  253. 					</div>
    254. 

  254. 						<h5 class="subsection-title">Properties:</h5>
    255. 

  255. <table class="props">
    256. 

  256. 	<thead>
    257. 

  257. 	<tr>
    258. 

  258. 		<th>Name</th>
    259. 

  259. 		<th>Type</th>
    260. 

  260. 		<th class="last">Description</th>
    261. 

  261. 	</tr>
    262. 

  262. 	</thead>
    263. 

  263. 	<tbody>
    264. 

  264. 		<tr>
    265. 

  265. 				<td class="name"><code>animations</code></td>
    266. 

  266. 			<td class="type">
    267. 

  267. <span class="param-type">Array.&lt;<a href="AnimationClip.html">AnimationClip</a>></span>
    268. 

  268. 			</td>
    269. 

  269. 			<td class="description last"><p>An array of animation clips.</p></td>
    270. 

  270. 		</tr>
    271. 

  271. 		<tr>
    272. 

  272. 				<td class="name"><code>asset</code></td>
    273. 

  273. 			<td class="type">
    274. 

  274. <span class="param-type">Object</span>
    275. 

  275. 			</td>
    276. 

  276. 			<td class="description last"><p>Meta data about the loaded asset.</p></td>
    277. 

  277. 		</tr>
    278. 

  278. 		<tr>
    279. 

  279. 				<td class="name"><code>cameras</code></td>
    280. 

  280. 			<td class="type">
    281. 

  281. <span class="param-type">Array.&lt;<a href="Camera.html">Camera</a>></span>
    282. 

  282. 			</td>
    283. 

  283. 			<td class="description last"><p>An array of cameras.</p></td>
    284. 

  284. 		</tr>
    285. 

  285. 		<tr>
    286. 

  286. 				<td class="name"><code>parser</code></td>
    287. 

  287. 			<td class="type">
    288. 

  288. <span class="param-type">GLTFParser</span>
    289. 

  289. 			</td>
    290. 

  290. 			<td class="description last"><p>A reference to the internal parser.</p></td>
    291. 

  291. 		</tr>
    292. 

  292. 		<tr>
    293. 

  293. 				<td class="name"><code>scene</code></td>
    294. 

  294. 			<td class="type">
    295. 

  295. <span class="param-type"><a href="Group.html">Group</a></span>
    296. 

  296. 			</td>
    297. 

  297. 			<td class="description last"><p>The default scene.</p></td>
    298. 

  298. 		</tr>
    299. 

  299. 		<tr>
    300. 

  300. 				<td class="name"><code>scenes</code></td>
    301. 

  301. 			<td class="type">
    302. 

  302. <span class="param-type">Array.&lt;<a href="Group.html">Group</a>></span>
    303. 

  303. 			</td>
    304. 

  304. 			<td class="description last"><p>glTF assets might define multiple scenes.</p></td>
    305. 

  305. 		</tr>
    306. 

  306. 		<tr>
    307. 

  307. 				<td class="name"><code>userData</code></td>
    308. 

  308. 			<td class="type">
    309. 

  309. <span class="param-type">Object</span>
    310. 

  310. 			</td>
    311. 

  311. 			<td class="description last"><p>Additional data.</p></td>
    312. 

  312. 		</tr>
    313. 

  313. 	</tbody>
    314. 

  314. </table>
    315. 

  315. 				</div>
    316. 

  316. 				<h2 class="subsection-title">Source</h2>
    317. 

  317. 				<p>
    318. 

  318. 					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/GLTFLoader.js" target="_blank" rel="noopener" translate="no">examples/jsm/loaders/GLTFLoader.js</a>
    319. 

  319. 				</p>
    320. 

  320. 			</article>
    321. 

  321. 		</section>
    322. 

  322. <script src="../scripts/linenumber.js"></script>
    323. 

  323. <script src="../scripts/page.js"></script>
    324. 

  324. </body>
    325. 

  325. </html>
    326.
粤ICP备19079148号