VTKLoader.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>VTKLoader - 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">VTKLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the VTK format.</p>
  17. <p>This loader only supports the <code>POLYDATA</code> dataset format so far. Other formats
  18. (structured points, structured grid, rectilinear grid, unstructured grid, appended)
  19. are not supported.</p></div>
  20. <h2>Code Example</h2>
  21. <div translate="no"><pre><code class="language-js">const loader = new VTKLoader();
  22. const geometry = await loader.loadAsync( 'models/vtk/liver.vtk' );
  23. geometry.computeVertexNormals();
  24. const mesh = new THREE.Mesh( geometry, new THREE.MeshLambertMaterial() );
  25. scene.add( mesh );
  26. </code></pre></div>
  27. </header>
  28. <article>
  29. <h2 class="subsection-title">Import</h2>
  30. <p><span translate="no">VTKLoader</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 { VTKLoader } from 'three/addons/loaders/VTKLoader.js';</code></pre>
  32. <div class="container-overview">
  33. <h2>Constructor</h2>
  34. <h3 class="name name-method" id="VTKLoader" translate="no">new <a href="#VTKLoader">VTKLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>
  35. <div class="method">
  36. <div class="description">
  37. <p>Constructs a new VTK loader.</p>
  38. </div>
  39. <table class="params">
  40. <tbody>
  41. <tr>
  42. <td class="name">
  43. <strong>manager</strong>
  44. </td>
  45. <td class="description last">
  46. <p>The loading manager.</p>
  47. </td>
  48. </tr>
  49. </tbody>
  50. </table>
  51. </div>
  52. </div>
  53. <h2 class="subsection-title">Methods</h2>
  54. <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>
  55. <div class="method">
  56. <div class="description">
  57. <p>Starts loading from the given URL and passes the loaded VRML asset
  58. to the <code>onLoad()</code> callback.</p>
  59. </div>
  60. <table class="params">
  61. <tbody>
  62. <tr>
  63. <td class="name">
  64. <strong>url</strong>
  65. </td>
  66. <td class="description last">
  67. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  68. </td>
  69. </tr>
  70. <tr>
  71. <td class="name">
  72. <strong>onLoad</strong>
  73. </td>
  74. <td class="description last">
  75. <p>Executed when the loading process has been finished.</p>
  76. </td>
  77. </tr>
  78. <tr>
  79. <td class="name">
  80. <strong>onProgress</strong>
  81. </td>
  82. <td class="description last">
  83. <p>Executed while the loading is in progress.</p>
  84. </td>
  85. </tr>
  86. <tr>
  87. <td class="name">
  88. <strong>onError</strong>
  89. </td>
  90. <td class="description last">
  91. <p>Executed when errors occur.</p>
  92. </td>
  93. </tr>
  94. </tbody>
  95. </table>
  96. <dl class="details">
  97. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  98. </dl>
  99. </div>
  100. <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="BufferGeometry.html">BufferGeometry</a></span> </h3>
  101. <div class="method">
  102. <div class="description">
  103. <p>Parses the given VTK data and returns the resulting geometry.</p>
  104. </div>
  105. <table class="params">
  106. <tbody>
  107. <tr>
  108. <td class="name">
  109. <strong>data</strong>
  110. </td>
  111. <td class="description last">
  112. <p>The raw VTK data as an array buffer</p>
  113. </td>
  114. </tr>
  115. </tbody>
  116. </table>
  117. <dl class="details">
  118. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  119. </dl>
  120. <dl class="details">
  121. <dt class="tag-returns"><strong>Returns:</strong> The parsed geometry.</dt>
  122. </dl>
  123. </div>
  124. <h2 class="subsection-title">Source</h2>
  125. <p>
  126. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/VTKLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/VTKLoader.js</a>
  127. </p>
  128. </article>
  129. </section>
  130. <script src="../scripts/linenumber.js"></script>
  131. <script src="../scripts/page.js"></script>
  132. </body>
  133. </html>
粤ICP备19079148号