TDSLoader.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>TDSLoader - 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">TDSLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the 3DS format, based on lib3ds.</p>
  17. <p>Loads geometry with uv and materials basic properties with texture support.</p></div>
  18. <h2>Code Example</h2>
  19. <div translate="no"><pre><code class="language-js">const loader = new TDSLoader();
  20. loader.setResourcePath( 'models/3ds/portalgun/textures/' );
  21. const object = await loader.loadAsync( 'models/3ds/portalgun/portalgun.3ds' );
  22. scene.add( object );</code></pre></div>
  23. </header>
  24. <article>
  25. <h2 class="subsection-title">Import</h2>
  26. <p><span translate="no">TDSLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
  27. <pre><code class="language-js">import { TDSLoader } from 'three/addons/loaders/TDSLoader.js';</code></pre>
  28. <div class="container-overview">
  29. <h2>Constructor</h2>
  30. <h3 class="name name-method" id="TDSLoader" translate="no">new <a href="#TDSLoader">TDSLoader</a><span class="signature">( manager : <span class="param-type">LoadingManager</span> )</span> </h3>
  31. <div class="method">
  32. <div class="description">
  33. <p>Constructs a new 3DS loader.</p>
  34. </div>
  35. <table class="params">
  36. <tbody>
  37. <tr>
  38. <td class="name"><code>manager</code></td>
  39. <td class="description last"><p>The loading manager.</p></td>
  40. </tr>
  41. </tbody>
  42. </table>
  43. </div>
  44. </div>
  45. <h2 class="subsection-title">Properties</h2>
  46. <div class="member">
  47. <h3 class="name" id="debug" translate="no">.<a href="#debug">debug</a><span class="type-signature"> : boolean</span> </h3>
  48. <div class="description">
  49. <p>Whether debug mode should be enabled or not.<br/>Default is <code>false</code>.</p>
  50. </div>
  51. </div>
  52. <h2 class="subsection-title">Methods</h2>
  53. <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>
  54. <div class="method">
  55. <div class="description">
  56. <p>Starts loading from the given URL and passes the loaded 3DS asset
  57. to the <code>onLoad()</code> callback.</p>
  58. </div>
  59. <table class="params">
  60. <tbody>
  61. <tr>
  62. <td class="name"><code>url</code></td>
  63. <td class="description last"><p>The path/URL of the file to be loaded. This can also be a data URI.</p></td>
  64. </tr>
  65. <tr>
  66. <td class="name"><code>onLoad</code></td>
  67. <td class="description last"><p>Executed when the loading process has been finished.</p></td>
  68. </tr>
  69. <tr>
  70. <td class="name"><code>onProgress</code></td>
  71. <td class="description last"><p>Executed while the loading is in progress.</p></td>
  72. </tr>
  73. <tr>
  74. <td class="name"><code>onError</code></td>
  75. <td class="description last"><p>Executed when errors occur.</p></td>
  76. </tr>
  77. </tbody>
  78. </table>
  79. <dl class="details">
  80. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  81. </dl>
  82. </div>
  83. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( arraybuffer : <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>
  84. <div class="method">
  85. <div class="description">
  86. <p>Parses the given 3DS data and returns the resulting data.</p>
  87. </div>
  88. <table class="params">
  89. <tbody>
  90. <tr>
  91. <td class="name"><code>arraybuffer</code></td>
  92. <td class="description last"><p>The raw 3DS data as an array buffer.</p></td>
  93. </tr>
  94. <tr>
  95. <td class="name"><code>path</code></td>
  96. <td class="description last"><p>The asset path.</p></td>
  97. </tr>
  98. </tbody>
  99. </table>
  100. <dl class="details">
  101. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  102. </dl>
  103. <dl class="details">
  104. <dt class="tag-returns"><strong>Returns:</strong> The parsed asset represented as a group.</dt>
  105. </dl>
  106. </div>
  107. <h2 class="subsection-title">Source</h2>
  108. <p>
  109. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/TDSLoader.js" target="_blank" rel="noopener" translate="no">examples/jsm/loaders/TDSLoader.js</a>
  110. </p>
  111. </article>
  112. </section>
  113. <script src="../scripts/linenumber.js"></script>
  114. <script src="../scripts/page.js"></script>
  115. </body>
  116. </html>
粤ICP备19079148号