VOXLoader.html 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>VOXLoader - 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">VOXLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the VOX format.</p></div>
  17. <h2>Code Example</h2>
  18. <div translate="no"><pre><code class="language-js">const loader = new VOXLoader();
  19. const chunks = await loader.loadAsync( 'models/vox/monu10.vox' );
  20. for ( let i = 0; i &lt; chunks.length; i ++ ) {
  21. const chunk = chunks[ i ];
  22. const mesh = new VOXMesh( chunk );
  23. mesh.scale.setScalar( 0.0015 );
  24. scene.add( mesh );
  25. }
  26. </code></pre></div>
  27. </header>
  28. <article>
  29. <h2 class="subsection-title">Import</h2>
  30. <p><span translate="no">VOXLoader</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>
  31. <pre><code class="language-js">import { VOXLoader } from 'three/addons/loaders/VOXLoader.js';</code></pre>
  32. <div class="container-overview">
  33. <h2>Constructor</h2>
  34. <h3 class="name name-method" id="VOXLoader" translate="no">new <a href="#VOXLoader">VOXLoader</a><span class="signature">()</span> </h3>
  35. <div class="method">
  36. </div>
  37. </div>
  38. <h2 class="subsection-title">Methods</h2>
  39. <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>
  40. <div class="method">
  41. <div class="description">
  42. <p>Starts loading from the given URL and passes the loaded VOX asset
  43. to the <code>onLoad()</code> callback.</p>
  44. </div>
  45. <table class="params">
  46. <tbody>
  47. <tr>
  48. <td class="name">
  49. <strong>url</strong>
  50. </td>
  51. <td class="description last">
  52. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  53. </td>
  54. </tr>
  55. <tr>
  56. <td class="name">
  57. <strong>onLoad</strong>
  58. </td>
  59. <td class="description last">
  60. <p>Executed when the loading process has been finished.</p>
  61. </td>
  62. </tr>
  63. <tr>
  64. <td class="name">
  65. <strong>onProgress</strong>
  66. </td>
  67. <td class="description last">
  68. <p>Executed while the loading is in progress.</p>
  69. </td>
  70. </tr>
  71. <tr>
  72. <td class="name">
  73. <strong>onError</strong>
  74. </td>
  75. <td class="description last">
  76. <p>Executed when errors occur.</p>
  77. </td>
  78. </tr>
  79. </tbody>
  80. </table>
  81. <dl class="details">
  82. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  83. </dl>
  84. </div>
  85. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( buffer : <span class="param-type">ArrayBuffer</span> )</span><span class="type-signature"> : Array.&lt;Object></span> </h3>
  86. <div class="method">
  87. <div class="description">
  88. <p>Parses the given VOX data and returns the resulting chunks.</p>
  89. </div>
  90. <table class="params">
  91. <tbody>
  92. <tr>
  93. <td class="name">
  94. <strong>buffer</strong>
  95. </td>
  96. <td class="description last">
  97. <p>The raw VOX data as an array buffer.</p>
  98. </td>
  99. </tr>
  100. </tbody>
  101. </table>
  102. <dl class="details">
  103. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  104. </dl>
  105. <dl class="details">
  106. <dt class="tag-returns"><strong>Returns:</strong> The parsed chunks.</dt>
  107. </dl>
  108. </div>
  109. <h2 class="subsection-title">Source</h2>
  110. <p>
  111. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/VOXLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/VOXLoader.js</a>
  112. </p>
  113. </article>
  114. </section>
  115. <script src="../scripts/linenumber.js"></script>
  116. <script src="../scripts/page.js"></script>
  117. </body>
  118. </html>
粤ICP备19079148号