1
0

GCodeLoader.html 5.4 KB

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