ColladaLoader.html 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>ColladaLoader - 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">ColladaLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the Collada format.</p>
  17. <p>The Collada format is very complex so this loader only supports a subset of what
  18. is defined in the <a href="https://www.khronos.org/files/collada_spec_1_5.pdf" target="_blank" rel="noopener">official specification</a>.</p>
  19. <p>Assets with a Z-UP coordinate system are transformed it into Y-UP by a simple rotation.
  20. The vertex data are not converted.</p></div>
  21. <h2>Code Example</h2>
  22. <div translate="no"><pre><code class="language-js">const loader = new ColladaLoader();
  23. const result = await loader.loadAsync( './models/collada/elf/elf.dae' );
  24. scene.add( result.scene );
  25. </code></pre></div>
  26. </header>
  27. <article>
  28. <h2 class="subsection-title">Import</h2>
  29. <p><span translate="no">ColladaLoader</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>
  30. <pre><code class="language-js">import { ColladaLoader } from 'three/addons/loaders/ColladaLoader.js';</code></pre>
  31. <div class="container-overview">
  32. <h2>Constructor</h2>
  33. <h3 class="name name-method" id="ColladaLoader" translate="no">new <a href="#ColladaLoader">ColladaLoader</a><span class="signature">()</span> </h3>
  34. <div class="method">
  35. </div>
  36. </div>
  37. <h2 class="subsection-title">Methods</h2>
  38. <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>
  39. <div class="method">
  40. <div class="description">
  41. <p>Starts loading from the given URL and passes the loaded Collada asset
  42. to the <code>onLoad()</code> callback.</p>
  43. </div>
  44. <table class="params">
  45. <tbody>
  46. <tr>
  47. <td class="name">
  48. <strong>url</strong>
  49. </td>
  50. <td class="description last">
  51. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  52. </td>
  53. </tr>
  54. <tr>
  55. <td class="name">
  56. <strong>onLoad</strong>
  57. </td>
  58. <td class="description last">
  59. <p>Executed when the loading process has been finished.</p>
  60. </td>
  61. </tr>
  62. <tr>
  63. <td class="name">
  64. <strong>onProgress</strong>
  65. </td>
  66. <td class="description last">
  67. <p>Executed while the loading is in progress.</p>
  68. </td>
  69. </tr>
  70. <tr>
  71. <td class="name">
  72. <strong>onError</strong>
  73. </td>
  74. <td class="description last">
  75. <p>Executed when errors occur.</p>
  76. </td>
  77. </tr>
  78. </tbody>
  79. </table>
  80. <dl class="details">
  81. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  82. </dl>
  83. </div>
  84. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( text : <span class="param-type">string</span>, path : <span class="param-type">string</span> )</span><span class="type-signature"> : Object</span> </h3>
  85. <div class="method">
  86. <div class="description">
  87. <p>Parses the given Collada data and returns a result object holding the parsed scene,
  88. an array of animation clips and kinematics.</p>
  89. </div>
  90. <table class="params">
  91. <tbody>
  92. <tr>
  93. <td class="name">
  94. <strong>text</strong>
  95. </td>
  96. <td class="description last">
  97. <p>The raw Collada data as a string.</p>
  98. </td>
  99. </tr>
  100. <tr>
  101. <td class="name">
  102. <strong>path</strong>
  103. </td>
  104. <td class="description last">
  105. <p>The asset path.</p>
  106. </td>
  107. </tr>
  108. </tbody>
  109. </table>
  110. <dl class="details">
  111. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  112. </dl>
  113. <dl class="details">
  114. <dt class="tag-returns"><strong>Returns:</strong> An object representing the parsed asset.</dt>
  115. </dl>
  116. </div>
  117. <h2 class="subsection-title">Source</h2>
  118. <p>
  119. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/ColladaLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/ColladaLoader.js</a>
  120. </p>
  121. </article>
  122. </section>
  123. <script src="../scripts/linenumber.js"></script>
  124. <script src="../scripts/page.js"></script>
  125. </body>
  126. </html>
粤ICP备19079148号