FileLoader.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  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. [page:Loader] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">
  14. 使用XMLHttpRequest来加载资源的低级类,并由大多数加载器内部使用。
  15. 它也可以直接用于加载任何没有对应加载器的文件类型。
  16. </p>
  17. <h2>例子</h2>
  18. <p>
  19. [example:webgl_loader_msgpack WebGL / loader / msgpack]<br />
  20. [example:webgl_morphtargets_human WebGL / morphtargets / human]<br />
  21. </p>
  22. <code>
  23. var loader = new THREE.FileLoader();
  24. //加载一个文本文件,并把结果输出到控制台上
  25. loader.load(
  26. // resource URL
  27. 'example.txt',
  28. // onLoad回调
  29. function ( data ) {
  30. // output the text to the console
  31. console.log( data )
  32. },
  33. // onProgress回调
  34. function ( xhr ) {
  35. console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
  36. },
  37. // onError回调
  38. function ( err ) {
  39. console.error( 'An error happened' );
  40. }
  41. );
  42. </code>
  43. <p>
  44. <em>注意:</em>
  45. 必须启用缓存
  46. <code>THREE.Cache.enabled = true;</code>
  47. 这是一个全局属性,只需要设置一次,供内部使用FileLoader的所有加载器使用。
  48. [page:Cache Cache] 是​​一个缓存模块,用于保存通过此加载器发出的每个请求的响应,因此每个文件都会被请求一次。
  49. </p>
  50. <h2>构造函数</h2>
  51. <h3>[name] ( [param:LoadingManager manager] )</h3>
  52. <p>
  53. [page:LoadingManager manager] — [page:LoadingManager loadingManager] 是加载器所使用的加载管理器。
  54. 默认为 [page:DefaultLoadingManager].
  55. </p>
  56. <h2>属性</h2>
  57. <p>共有属性请参见其基类[page:Loader]。</p>
  58. <h3>[property:String mimeType]</h3>
  59. <p>
  60. 详情 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType].
  61. 请参考 [page:.setMimeType]。默认为 *undefined*。
  62. </p>
  63. <h3>[property:object requestHeader]</h3>
  64. <p>[link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] 在HTTP 请求中使用。 请参考 [page:.setRequestHeader]。 默认为 *undefined*.</p>
  65. <h3>[property:String responseType]</h3>
  66. <p>请求的响应类型。 请参考 [page:.setResponseType]. 默认为 *undefined*.</p>
  67. <h3>[property:String withCredentials]</h3>
  68. <p>
  69. XMLHttpRequest是否使用证书。 请参考 [page:.setWithCredentials].
  70. 默认为 *undefined*.
  71. </p>
  72. <h2>方法</h2>
  73. <p>共有方法请参见其基类[page:Loader]。</p>
  74. <h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  75. <p>
  76. [page:String url] — 文件的URL或者路径,也可以为
  77. [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].<br />
  78. [page:Function onLoad] (可选) — 加载完成时将调用。回调参数将是加载的响应。<br />
  79. [page:Function onProgress] (可选) — 将在加载过程中进行调用。参数将是XMLHttpRequest实例,
  80. 其中包含 [page:Integer total] 和 [page:Integer loaded] 字节<br />
  81. [page:Function onError] (可选) — 在加载错误时被调用。<br /><br />
  82. 加载URL并将响应传递给onLoad函数。
  83. </p>
  84. <h3>[method:FileLoader setMimeType]( [param:String mimeType] )</h3>
  85. <p>
  86. 设置正在加载的文件预期类型 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType]
  87. 。请注意,在许多情况下,这将自动确定,因此默认情况下它是 *undefined* 。
  88. </p>
  89. <h3>[method:FileLoader setRequestHeader]( [param:object requestHeader] )</h3>
  90. <p>
  91. [page:object requestHeader] - key: 要设置header的名称。 value:要设置header的值。<br /><br />
  92. 请参考在HTTP 请求中的 [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header]。
  93. </p>
  94. <h3>[method:FileLoader setResponseType]( [param:String responseType] )</h3>
  95. <p>
  96. 改变响应的类型,其类型有效值如下:<br />
  97. [page:String text] 或者空 string (默认) - 返回的数据类型为 [page:String string].<br />
  98. [page:String arraybuffer] - 加载的数据类型到一个数组buffer中 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ArrayBuffer] 并进行返回。<br />
  99. [page:String blob] - 返回的数据为 [link:https://developer.mozilla.org/en/docs/Web/API/Blob Blob]。<br />
  100. [page:String document] - 使用 [link:https://developer.mozilla.org/en-US/docs/Web/API/DOMParser DOMParser] 解析文件。<br />
  101. [page:String json] - 将文件解析为 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse JSON.parse].<br />
  102. </p>
  103. <h3>[method:FileLoader setWithCredentials]( [param:Boolean value] )</h3>
  104. <p>
  105. XMLHttpRequest是否使用cookie、授权头或TLS客户端证书等凭据。 请参考 [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].<br />
  106. 请注意,当您在本地或从同一域加载文件,则该方法无效。
  107. </p>
  108. <h2>源</h2>
  109. <p>
  110. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  111. </p>
  112. </body>
  113. </html>