XYZLoader.html 4.9 KB

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