2
0

FileLoader.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. A low level class for loading resources with XMLHttpRequest, used internaly by most loaders.
  14. It can also be used directly to load any file type that does not have a loader.
  15. </p>
  16. <h2>Example</h2>
  17. <code>
  18. var loader = new THREE.FileLoader();
  19. //load a text file and output the result to the console
  20. loader.load(
  21. // resource URL
  22. 'example.txt',
  23. // onLoad callback
  24. function ( data ) {
  25. // output the text to the console
  26. console.log( data )
  27. },
  28. // onProgress callback
  29. function ( xhr ) {
  30. console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
  31. },
  32. // onError callback
  33. function ( err ) {
  34. console.error( 'An error happened' );
  35. }
  36. );
  37. </code>
  38. <p>
  39. <em>Note:</em> The cache must be enabled using
  40. <code>THREE.Cache.enabled = true;</code>
  41. This is a global property and only needs to be set once to be used by all loaders that use FileLoader internally.
  42. [page:Cache Cache] is a cache module that holds the response from each request made through this loader, so each file is requested once.
  43. </p>
  44. <h2>Constructor</h2>
  45. <h3>[name] ( [param:LoadingManager manager] )</h3>
  46. <p>
  47. [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use.
  48. Default is [page:DefaultLoadingManager].
  49. </p>
  50. <h2>Properties</h2>
  51. <h3>[property:LoadingManager manager]</h3>
  52. <p>
  53. The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
  54. </p>
  55. <h3>[property:String mimeType]</h3>
  56. <p>
  57. The expected [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType].
  58. See [page:.setMimeType]. Default is *undefined*.
  59. </p>
  60. <h3>[property:String path]</h3>
  61. <p>The base path from which files will be loaded. See [page:.setPath]. Default is *undefined*.</p>
  62. <h3>[property:Object requestHeader]</h3>
  63. <p>The [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request. See [page:.setRequestHeader]. Default is *undefined*.</p>
  64. <h3>[property:String responseType]</h3>
  65. <p>The expected response type. See [page:.setResponseType]. Default is *undefined*.</p>
  66. <h3>[property:String withCredentials]</h3>
  67. <p>
  68. Whether the XMLHttpRequest uses credentials. See [page:.setWithCredentials].
  69. Default is *undefined*.
  70. </p>
  71. <h2>Methods</h2>
  72. <h3>[method:XMLHttpRequest load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  73. <p>
  74. [page:String url] — the path or URL to the file. This can also be a
  75. [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].<br />
  76. [page:Function onLoad] (optional) — Will be called when loading completes. The argument will be the loaded response.<br />
  77. [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the XMLHttpRequest instance,
  78. which contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
  79. [page:Function onError] (optional) — Will be called if an error occurs.<br /><br />
  80. Load the URL and pass the response to the onLoad function.
  81. </p>
  82. <h3>[method:FileLoader setMimeType]( [param:String mimeType] )</h3>
  83. <p>
  84. Set the expected [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType]
  85. of the file being loaded. Note that in many cases this will be determined automatically, so by default it is *undefined*.
  86. </p>
  87. <h3>[method:FileLoader setPath]( [param:String path] )</h3>
  88. <p>
  89. Set the base path or URL from which to load files. This can be useful if
  90. you are loading many models from the same directory.
  91. </p>
  92. <h3>[method:FileLoader setRequestHeader]( [param:Object requestHeader] )</h3>
  93. <p>
  94. [page:object requestHeader] - key: The name of the header whose value is to be set. value: The value to set as the body of the header.<br /><br />
  95. Set the [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request.
  96. </p>
  97. <h3>[method:FileLoader setResponseType]( [param:String responseType] )</h3>
  98. <p>
  99. Change the response type. Valid values are:<br />
  100. [page:String text] or empty string (default) - returns the data as [page:String String].<br />
  101. [page:String arraybuffer] - loads the data into a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ArrayBuffer] and returns that.<br />
  102. [page:String blob] - returns the data as a [link:https://developer.mozilla.org/en/docs/Web/API/Blob Blob].<br />
  103. [page:String document] - parses the file using the [link:https://developer.mozilla.org/en-US/docs/Web/API/DOMParser DOMParser].<br />
  104. [page:String json] - parses the file using [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse JSON.parse].<br />
  105. </p>
  106. <h3>[method:FileLoader setWithCredentials]( [param:Boolean value] )</h3>
  107. <p>
  108. Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or
  109. TLS client certificates. See [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].<br />
  110. Note that this has no effect if you are loading files locally or from the same domain.
  111. </p>
  112. <h2>Source</h2>
  113. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  114. </body>
  115. </html>