ThreeMFLoader.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>ThreeMFLoader - 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">ThreeMFLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the <a href="https://3mf.io/specification/" target="_blank" rel="noopener">3D Manufacturing Format (3MF)</a> format.</p>
  17. <p>The following features from the core specification are supported:</p>
  18. <ul>
  19. <li>3D Models</li>
  20. <li>Object Resources (Meshes and Components)</li>
  21. <li>Material Resources (Base Materials)</li>
  22. </ul>
  23. <p>3MF Materials and Properties Extension are only partially supported.</p>
  24. <ul>
  25. <li>Texture 2D</li>
  26. <li>Texture 2D Groups</li>
  27. <li>Color Groups (Vertex Colors)</li>
  28. <li>Metallic Display Properties (PBR)</li>
  29. </ul></div>
  30. <h2>Code Example</h2>
  31. <div translate="no"><pre><code class="language-js">const loader = new ThreeMFLoader();
  32. const object = await loader.loadAsync( './models/3mf/truck.3mf' );
  33. object.rotation.set( - Math.PI / 2, 0, 0 ); // z-up conversion
  34. scene.add( object );
  35. </code></pre></div>
  36. </header>
  37. <article>
  38. <h2 class="subsection-title">Import</h2>
  39. <p><span translate="no">ThreeMFLoader</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 { ThreeMFLoader } from 'three/addons/loaders/3MFLoader.js';</code></pre>
  41. <div class="container-overview">
  42. <h2>Constructor</h2>
  43. <h3 class="name name-method" id="ThreeMFLoader" translate="no">new <a href="#ThreeMFLoader">ThreeMFLoader</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 3MF 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">Properties</h2>
  63. <div class="member">
  64. <h3 class="name" id="availableExtensions" translate="no">.<a href="#availableExtensions">availableExtensions</a><span class="type-signature"> : Array.&lt;Object></span> </h3>
  65. <div class="description">
  66. <p>An array of available extensions.</p>
  67. </div>
  68. </div>
  69. <h2 class="subsection-title">Methods</h2>
  70. <h3 class="name name-method" id="addExtension" translate="no">.<a href="#addExtension">addExtension</a><span class="signature">( extension : <span class="param-type">Object</span> )</span> </h3>
  71. <div class="method">
  72. <div class="description">
  73. <p>Adds a 3MF extension.</p>
  74. </div>
  75. <table class="params">
  76. <tbody>
  77. <tr>
  78. <td class="name">
  79. <strong>extension</strong>
  80. </td>
  81. <td class="description last">
  82. <p>The extension to add.</p>
  83. </td>
  84. </tr>
  85. </tbody>
  86. </table>
  87. </div>
  88. <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>
  89. <div class="method">
  90. <div class="description">
  91. <p>Starts loading from the given URL and passes the loaded 3MF asset
  92. to the <code>onLoad()</code> callback.</p>
  93. </div>
  94. <table class="params">
  95. <tbody>
  96. <tr>
  97. <td class="name">
  98. <strong>url</strong>
  99. </td>
  100. <td class="description last">
  101. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  102. </td>
  103. </tr>
  104. <tr>
  105. <td class="name">
  106. <strong>onLoad</strong>
  107. </td>
  108. <td class="description last">
  109. <p>Executed when the loading process has been finished.</p>
  110. </td>
  111. </tr>
  112. <tr>
  113. <td class="name">
  114. <strong>onProgress</strong>
  115. </td>
  116. <td class="description last">
  117. <p>Executed while the loading is in progress.</p>
  118. </td>
  119. </tr>
  120. <tr>
  121. <td class="name">
  122. <strong>onError</strong>
  123. </td>
  124. <td class="description last">
  125. <p>Executed when errors occur.</p>
  126. </td>
  127. </tr>
  128. </tbody>
  129. </table>
  130. <dl class="details">
  131. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  132. </dl>
  133. </div>
  134. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( data : <span class="param-type">ArrayBuffer</span> )</span><span class="type-signature"> : <a href="Group.html">Group</a></span> </h3>
  135. <div class="method">
  136. <div class="description">
  137. <p>Parses the given 3MF data and returns the resulting group.</p>
  138. </div>
  139. <table class="params">
  140. <tbody>
  141. <tr>
  142. <td class="name">
  143. <strong>data</strong>
  144. </td>
  145. <td class="description last">
  146. <p>The raw 3MF asset data as an array buffer.</p>
  147. </td>
  148. </tr>
  149. </tbody>
  150. </table>
  151. <dl class="details">
  152. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  153. </dl>
  154. <dl class="details">
  155. <dt class="tag-returns"><strong>Returns:</strong> A group representing the parsed asset.</dt>
  156. </dl>
  157. </div>
  158. <h2 class="subsection-title">Source</h2>
  159. <p>
  160. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/3MFLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/3MFLoader.js</a>
  161. </p>
  162. </article>
  163. </section>
  164. <script src="../scripts/linenumber.js"></script>
  165. <script src="../scripts/page.js"></script>
  166. </body>
  167. </html>
粤ICP备19079148号