KMZLoader.html 5.0 KB

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