FBXLoader.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>FBXLoader - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
  13. <h1 translate="no">FBXLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the FBX format.</p>
  17. <p>Requires FBX file to be &gt;= 7.0 and in ASCII or &gt;= 6400 in Binary format.
  18. Versions lower than this may load but will probably have errors.</p>
  19. <p>Needs Support:</p>
  20. <ul>
  21. <li>Morph normals / blend shape normals</li>
  22. </ul>
  23. <p>FBX format references:</p>
  24. <ul>
  25. <li><a href="https://help.autodesk.com/view/FBX/2017/ENU/?guid=__cpp_ref_index_html" target="_blank" rel="noopener">C++ SDK reference</a></li>
  26. </ul>
  27. <p>Binary format specification:</p>
  28. <ul>
  29. <li><a href="https://code.blender.org/2013/08/fbx-binary-file-format-specification/" target="_blank" rel="noopener">FBX binary file format specification</a></li>
  30. </ul></div>
  31. <h2>Code Example</h2>
  32. <div translate="no"><pre><code class="language-js">const loader = new FBXLoader();
  33. const object = await loader.loadAsync( 'models/fbx/stanford-bunny.fbx' );
  34. scene.add( object );
  35. </code></pre></div>
  36. </header>
  37. <article>
  38. <h2 class="subsection-title">Import</h2>
  39. <p><span translate="no">FBXLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
  40. <pre><code class="language-js">import { FBXLoader } from 'three/addons/loaders/FBXLoader.js';</code></pre>
  41. <div class="container-overview">
  42. <h2>Constructor</h2>
  43. <h3 class="name name-method" id="FBXLoader" translate="no">new <a href="#FBXLoader">FBXLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>
  44. <div class="method">
  45. <div class="description">
  46. <p>Constructs a new FBX loader.</p>
  47. </div>
  48. <table class="params">
  49. <tbody>
  50. <tr>
  51. <td class="name">
  52. <strong>manager</strong>
  53. </td>
  54. <td class="description last">
  55. <p>The loading manager.</p>
  56. </td>
  57. </tr>
  58. </tbody>
  59. </table>
  60. </div>
  61. </div>
  62. <h2 class="subsection-title">Methods</h2>
  63. <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"><a href="global.html#onProgressCallback">onProgressCallback</a></span>, onError : <span class="param-type"><a href="global.html#onErrorCallback">onErrorCallback</a></span> )</span> </h3>
  64. <div class="method">
  65. <div class="description">
  66. <p>Starts loading from the given URL and passes the loaded FBX asset
  67. to the <code>onLoad()</code> callback.</p>
  68. </div>
  69. <table class="params">
  70. <tbody>
  71. <tr>
  72. <td class="name">
  73. <strong>url</strong>
  74. </td>
  75. <td class="description last">
  76. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  77. </td>
  78. </tr>
  79. <tr>
  80. <td class="name">
  81. <strong>onLoad</strong>
  82. </td>
  83. <td class="description last">
  84. <p>Executed when the loading process has been finished.</p>
  85. </td>
  86. </tr>
  87. <tr>
  88. <td class="name">
  89. <strong>onProgress</strong>
  90. </td>
  91. <td class="description last">
  92. <p>Executed while the loading is in progress.</p>
  93. </td>
  94. </tr>
  95. <tr>
  96. <td class="name">
  97. <strong>onError</strong>
  98. </td>
  99. <td class="description last">
  100. <p>Executed when errors occur.</p>
  101. </td>
  102. </tr>
  103. </tbody>
  104. </table>
  105. <dl class="details">
  106. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  107. </dl>
  108. </div>
  109. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( FBXBuffer : <span class="param-type">ArrayBuffer</span>, path : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Group.html">Group</a></span> </h3>
  110. <div class="method">
  111. <div class="description">
  112. <p>Parses the given FBX data and returns the resulting group.</p>
  113. </div>
  114. <table class="params">
  115. <tbody>
  116. <tr>
  117. <td class="name">
  118. <strong>FBXBuffer</strong>
  119. </td>
  120. <td class="description last">
  121. <p>The raw FBX data as an array buffer.</p>
  122. </td>
  123. </tr>
  124. <tr>
  125. <td class="name">
  126. <strong>path</strong>
  127. </td>
  128. <td class="description last">
  129. <p>The URL base path.</p>
  130. </td>
  131. </tr>
  132. </tbody>
  133. </table>
  134. <dl class="details">
  135. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  136. </dl>
  137. <dl class="details">
  138. <dt class="tag-returns"><strong>Returns:</strong> An object representing the parsed asset.</dt>
  139. </dl>
  140. </div>
  141. <h2 class="subsection-title">Source</h2>
  142. <p>
  143. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/FBXLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/FBXLoader.js</a>
  144. </p>
  145. </article>
  146. </section>
  147. <script src="../scripts/linenumber.js"></script>
  148. <script src="../scripts/page.js"></script>
  149. </body>
  150. </html>
粤ICP备19079148号