LWOLoader.html 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>LWOLoader - 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">LWOLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the LWO format.</p>
  17. <p>LWO3 and LWO2 formats are supported.</p>
  18. <p>References:</p>
  19. <ul>
  20. <li><a href="https://static.lightwave3d.com/sdk/2019/html/filefmts/lwo3.html" target="_blank" rel="noopener">LWO3 format specification</a></li>
  21. <li><a href="https://static.lightwave3d.com/sdk/2019/html/filefmts/lwo2.html" target="_blank" rel="noopener">LWO2 format specification</a></li>
  22. </ul></div>
  23. <h2>Code Example</h2>
  24. <div translate="no"><pre><code class="language-js">const loader = new LWOLoader();
  25. const lwoData = await loader.loadAsync( 'models/lwo/Objects/LWO3/Demo.lwo' );
  26. const mesh = object.meshes[ 0 ];
  27. scene.add( mesh );
  28. </code></pre></div>
  29. </header>
  30. <article>
  31. <h2 class="subsection-title">Import</h2>
  32. <p><span translate="no">LWOLoader</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>
  33. <pre><code class="language-js">import { LWOLoader } from 'three/addons/loaders/LWOLoader.js';</code></pre>
  34. <div class="container-overview">
  35. <h2>Constructor</h2>
  36. <h3 class="name name-method" id="LWOLoader" translate="no">new <a href="#LWOLoader">LWOLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>
  37. <div class="method">
  38. <div class="description">
  39. <p>Constructs a new LWO loader.</p>
  40. </div>
  41. <table class="params">
  42. <tbody>
  43. <tr>
  44. <td class="name">
  45. <strong translate="no">manager</strong>
  46. </td>
  47. <td class="description last">
  48. <p>The loading manager.</p>
  49. </td>
  50. </tr>
  51. </tbody>
  52. </table>
  53. <dl class="details">
  54. <dt class="important tag-deprecated"><strong>Deprecated:</strong> since r185.</dt>
  55. </dl>
  56. </div>
  57. </div>
  58. <h2 class="subsection-title">Methods</h2>
  59. <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>
  60. <div class="method">
  61. <div class="description">
  62. <p>Starts loading from the given URL and passes the loaded LWO asset
  63. to the <code>onLoad()</code> callback.</p>
  64. </div>
  65. <table class="params">
  66. <tbody>
  67. <tr>
  68. <td class="name">
  69. <strong translate="no">url</strong>
  70. </td>
  71. <td class="description last">
  72. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  73. </td>
  74. </tr>
  75. <tr>
  76. <td class="name">
  77. <strong translate="no">onLoad</strong>
  78. </td>
  79. <td class="description last">
  80. <p>Executed when the loading process has been finished.</p>
  81. </td>
  82. </tr>
  83. <tr>
  84. <td class="name">
  85. <strong translate="no">onProgress</strong>
  86. </td>
  87. <td class="description last">
  88. <p>Executed while the loading is in progress.</p>
  89. </td>
  90. </tr>
  91. <tr>
  92. <td class="name">
  93. <strong translate="no">onError</strong>
  94. </td>
  95. <td class="description last">
  96. <p>Executed when errors occur.</p>
  97. </td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. <dl class="details">
  102. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  103. </dl>
  104. </div>
  105. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( iffBuffer : <span class="param-type">ArrayBuffer</span>, path : <span class="param-type">string</span>, modelName : <span class="param-type">string</span> )</span><span class="type-signature"> : Object</span> </h3>
  106. <div class="method">
  107. <div class="description">
  108. <p>Parses the given LWO data and returns the resulting meshes and materials.</p>
  109. </div>
  110. <table class="params">
  111. <tbody>
  112. <tr>
  113. <td class="name">
  114. <strong translate="no">iffBuffer</strong>
  115. </td>
  116. <td class="description last">
  117. <p>The raw LWO data as an array buffer.</p>
  118. </td>
  119. </tr>
  120. <tr>
  121. <td class="name">
  122. <strong translate="no">path</strong>
  123. </td>
  124. <td class="description last">
  125. <p>The URL base path.</p>
  126. </td>
  127. </tr>
  128. <tr>
  129. <td class="name">
  130. <strong translate="no">modelName</strong>
  131. </td>
  132. <td class="description last">
  133. <p>The model name.</p>
  134. </td>
  135. </tr>
  136. </tbody>
  137. </table>
  138. <dl class="details">
  139. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  140. </dl>
  141. <dl class="details">
  142. <dt class="tag-returns"><strong>Returns:</strong> An object holding the parse meshes and materials.</dt>
  143. </dl>
  144. </div>
  145. <h2 class="subsection-title">Source</h2>
  146. <p>
  147. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/LWOLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/LWOLoader.js</a>
  148. </p>
  149. </article>
  150. </section>
  151. <script src="../scripts/linenumber.js"></script>
  152. <script src="../scripts/page.js"></script>
  153. </body>
  154. </html>
粤ICP备19079148号