FileLoader.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. <!DOCTYPE html>
  2. <html lang="zh">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:Loader] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. 使用XMLHttpRequest来加载资源的低级类,并由大多数加载器内部使用。
  14. 它也可以直接用于加载任何没有对应加载器的文件类型。
  15. </p>
  16. <h2>代码示例</h2>
  17. <code>
  18. const loader = new THREE.FileLoader();
  19. //加载一个文本文件,并把结果输出到控制台上
  20. loader.load(
  21. // resource URL
  22. 'example.txt',
  23. // onLoad回调
  24. function ( data ) {
  25. // output the text to the console
  26. console.log( data )
  27. },
  28. // onProgress回调
  29. function ( xhr ) {
  30. console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
  31. },
  32. // onError回调
  33. function ( err ) {
  34. console.error( 'An error happened' );
  35. }
  36. );
  37. </code>
  38. <p>
  39. <em>注意:</em>
  40. 必须启用缓存
  41. <code>THREE.Cache.enabled = true;</code>
  42. 这是一个全局属性,只需要设置一次,供内部使用FileLoader的所有加载器使用。
  43. [page:Cache Cache] 是​​一个缓存模块,用于保存通过此加载器发出的每个请求的响应,因此每个文件都会被请求一次。
  44. </p>
  45. <h2>构造函数</h2>
  46. <h3>[name] ( [param:LoadingManager manager] )</h3>
  47. <p>
  48. [page:LoadingManager manager] — [page:LoadingManager loadingManager] 是加载器所使用的加载管理器。
  49. 默认为 [page:DefaultLoadingManager].
  50. </p>
  51. <h2>属性</h2>
  52. <p>共有属性请参见其基类[page:Loader]。</p>
  53. <h3>[property:String mimeType]</h3>
  54. <p>
  55. 详情 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType].
  56. 请参考 [page:.setMimeType]。默认为 *undefined*。
  57. </p>
  58. <h3>[property:String responseType]</h3>
  59. <p>请求的响应类型。 请参考 [page:.setResponseType]. 默认为 *undefined*.</p>
  60. <h3>[property:String withCredentials]</h3>
  61. <p>
  62. XMLHttpRequest是否使用证书。 请参考 [page:.setWithCredentials].
  63. 默认为 *undefined*.
  64. </p>
  65. <h2>方法</h2>
  66. <p>共有方法请参见其基类[page:Loader]。</p>
  67. <h3>[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  68. <p>
  69. [page:String url] — 文件的URL或者路径,也可以为
  70. [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].<br />
  71. [page:Function onLoad] (可选) — 加载完成时将调用。回调参数将是加载的响应。<br />
  72. [page:Function onProgress] (可选) — 将在加载过程中进行调用。参数将是XMLHttpRequest实例,
  73. 其中包含 [page:Integer total] 和 [page:Integer loaded] 字节<br />
  74. [page:Function onError] (可选) — 在加载错误时被调用。<br /><br />
  75. 加载URL并将响应传递给onLoad函数。
  76. </p>
  77. <h3>[method:this setMimeType]( [param:String mimeType] )</h3>
  78. <p>
  79. 设置正在加载的文件预期类型 [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types mimeType]
  80. 。请注意,在许多情况下,这将自动确定,因此默认情况下它是 *undefined* 。
  81. </p>
  82. <h3>[method:this setResponseType]( [param:String responseType] )</h3>
  83. <p>
  84. 改变响应的类型,其类型有效值如下:<br />
  85. [page:String text] 或者空 string (默认) - 返回的数据类型为 [page:String string].<br />
  86. [page:String arraybuffer] - 加载的数据类型到一个数组buffer中 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer ArrayBuffer] 并进行返回。<br />
  87. [page:String blob] - 返回的数据为 [link:https://developer.mozilla.org/en/docs/Web/API/Blob Blob]。<br />
  88. [page:String document] - 使用 [link:https://developer.mozilla.org/en-US/docs/Web/API/DOMParser DOMParser] 解析文件。<br />
  89. [page:String json] - 将文件解析为 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse JSON.parse].<br />
  90. </p>
  91. <h2>源</h2>
  92. <p>
  93. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  94. </p>
  95. </body>
  96. </html>