1
0

FileLoader.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>FileLoader - 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">FileLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A low level class for loading resources with the Fetch API, used internally by
  17. most loaders. It can also be used directly to load any file type that does
  18. not have a loader.</p>
  19. <p>This loader supports caching. If you want to use it, add <code>THREE.Cache.enabled = true;</code>
  20. once to your application.</p></div>
  21. <h2>Code Example</h2>
  22. <div translate="no"><pre><code class="language-js">const loader = new THREE.FileLoader();
  23. const data = await loader.loadAsync( 'example.txt' );
  24. </code></pre></div>
  25. </header>
  26. <article>
  27. <div class="container-overview">
  28. <h2>Constructor</h2>
  29. <h3 class="name name-method" id="FileLoader" translate="no">new <a href="#FileLoader">FileLoader</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 file 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">Properties</h2>
  49. <div class="member">
  50. <h3 class="name" id="mimeType" translate="no">.<a href="#mimeType">mimeType</a><span class="type-signature"> : string</span> </h3>
  51. <div class="description">
  52. <p>The expected mime type. Valid values can be found
  53. <a href="hhttps://developer.mozilla.org/en-US/docs/Web/API/DOMParser/parseFromString#mimetype">here</a></p>
  54. </div>
  55. </div>
  56. <div class="member">
  57. <h3 class="name" id="responseType" translate="no">.<a href="#responseType">responseType</a><span class="type-signature"> : 'arraybuffer' | 'blob' | 'document' | 'json' | ''</span> </h3>
  58. <div class="description">
  59. <p>The expected response type.</p>
  60. <p>Default is <code>''</code>.</p>
  61. </div>
  62. </div>
  63. <h2 class="subsection-title">Methods</h2>
  64. <h3 class="name name-method" id="abort" translate="no">.<a href="#abort">abort</a><span class="signature">()</span><span class="type-signature"> : <a href="FileLoader.html">FileLoader</a></span> </h3>
  65. <div class="method">
  66. <div class="description">
  67. <p>Aborts ongoing fetch requests.</p>
  68. </div>
  69. <dl class="details">
  70. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#abort">Loader#abort</a></dt>
  71. </dl>
  72. <dl class="details">
  73. <dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
  74. </dl>
  75. </div>
  76. <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><span class="type-signature"> : <a href="global.html#any">any</a> | undefined</span> </h3>
  77. <div class="method">
  78. <div class="description">
  79. <p>Starts loading from the given URL and pass the loaded response to the <code>onLoad()</code> callback.</p>
  80. </div>
  81. <table class="params">
  82. <tbody>
  83. <tr>
  84. <td class="name">
  85. <strong>url</strong>
  86. </td>
  87. <td class="description last">
  88. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  89. </td>
  90. </tr>
  91. <tr>
  92. <td class="name">
  93. <strong>onLoad</strong>
  94. </td>
  95. <td class="description last">
  96. <p>Executed when the loading process has been finished.</p>
  97. </td>
  98. </tr>
  99. <tr>
  100. <td class="name">
  101. <strong>onProgress</strong>
  102. </td>
  103. <td class="description last">
  104. <p>Executed while the loading is in progress.</p>
  105. </td>
  106. </tr>
  107. <tr>
  108. <td class="name">
  109. <strong>onError</strong>
  110. </td>
  111. <td class="description last">
  112. <p>Executed when errors occur.</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#load">Loader#load</a></dt>
  119. </dl>
  120. <dl class="details">
  121. <dt class="tag-returns"><strong>Returns:</strong> The cached resource if available.</dt>
  122. </dl>
  123. </div>
  124. <h3 class="name name-method" id="setMimeType" translate="no">.<a href="#setMimeType">setMimeType</a><span class="signature">( value : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="FileLoader.html">FileLoader</a></span> </h3>
  125. <div class="method">
  126. <div class="description">
  127. <p>Sets the expected mime type of the loaded file.</p>
  128. </div>
  129. <table class="params">
  130. <tbody>
  131. <tr>
  132. <td class="name">
  133. <strong>value</strong>
  134. </td>
  135. <td class="description last">
  136. <p>The mime type.</p>
  137. </td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <dl class="details">
  142. <dt class="tag-returns"><strong>Returns:</strong> A reference to this file loader.</dt>
  143. </dl>
  144. </div>
  145. <h3 class="name name-method" id="setResponseType" translate="no">.<a href="#setResponseType">setResponseType</a><span class="signature">( value : <span class="param-type">'arraybuffer' | 'blob' | 'document' | 'json' | ''</span> )</span><span class="type-signature"> : <a href="FileLoader.html">FileLoader</a></span> </h3>
  146. <div class="method">
  147. <div class="description">
  148. <p>Sets the expected response type.</p>
  149. </div>
  150. <table class="params">
  151. <tbody>
  152. <tr>
  153. <td class="name">
  154. <strong>value</strong>
  155. </td>
  156. <td class="description last">
  157. <p>The response type.</p>
  158. </td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <dl class="details">
  163. <dt class="tag-returns"><strong>Returns:</strong> A reference to this file loader.</dt>
  164. </dl>
  165. </div>
  166. <h2 class="subsection-title">Source</h2>
  167. <p>
  168. <a href="https://github.com/mrdoob/three.js/blob/master/src/loaders/FileLoader.js" translate="no" target="_blank" rel="noopener">src/loaders/FileLoader.js</a>
  169. </p>
  170. </article>
  171. </section>
  172. <script src="../scripts/linenumber.js"></script>
  173. <script src="../scripts/page.js"></script>
  174. </body>
  175. </html>
粤ICP备19079148号