FileLoader

优质
小牛编辑
131浏览
2023-12-01

使用XMLHttpRequest来加载资源的低级类,并由大多数加载器内部使用。 它也可以直接用于加载任何没有对应加载器的文件类型。

代码示例

const loader = new THREE.FileLoader();
//加载一个文本文件,并把结果输出到控制台上
loader.load(
  // resource URL
  'example.txt',
  // onLoad回调
  function ( data ) {
    // output the text to the console
    console.log( data )
  },
  // onProgress回调
  function ( xhr ) {
    console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
  },
  // onError回调
  function ( err ) {
    console.error( 'An error happened' );
  }
);

注意: 必须启用缓存

THREE.Cache.enabled = true;
这是一个全局属性,只需要设置一次,供内部使用FileLoader的所有加载器使用。 Cache 是​​一个缓存模块,用于保存通过此加载器发出的每个请求的响应,因此每个文件都会被请求一次。

构造函数

FileLoader ( manager : LoadingManager )

managerloadingManager 是加载器所使用的加载管理器。 默认为 DefaultLoadingManager.

属性

共有属性请参见其基类Loader

.mimeType : String

详情 mimeType. 请参考 .setMimeType。默认为 undefined

.responseType : String

请求的响应类型。 请参考 .setResponseType. 默认为 undefined.

.withCredentials : String

XMLHttpRequest是否使用证书。 请参考 .setWithCredentials. 默认为 undefined.

方法

共有方法请参见其基类Loader

.load ( url : String, onLoad : Function, onProgress : Function, onError : Function ) : null

url — 文件的URL或者路径,也可以为 Data URI.
onLoad (可选) — 加载完成时将调用。回调参数将是加载的响应。
onProgress (可选) — 将在加载过程中进行调用。参数将是XMLHttpRequest实例, 其中包含 totalloaded 字节
onError (可选) — 在加载错误时被调用。

加载URL并将响应传递给onLoad函数。

.setMimeType ( mimeType : String ) : FileLoader

设置正在加载的文件预期类型 mimeType 。请注意,在许多情况下,这将自动确定,因此默认情况下它是 undefined

.setRequestHeader ( requestHeader : Object ) : FileLoader

requestHeader - key: 要设置header的名称。 value:要设置header的值。

请参考在HTTP 请求中的 request header

.setResponseType ( responseType : String ) : FileLoader

改变响应的类型,其类型有效值如下:
text 或者空 string (默认) - 返回的数据类型为 string.
arraybuffer - 加载的数据类型到一个数组buffer中 ArrayBuffer 并进行返回。
blob - 返回的数据为 Blob
document - 使用 DOMParser 解析文件。
json - 将文件解析为 JSON.parse.

.setWithCredentials ( value : Boolean ) : FileLoader

XMLHttpRequest是否使用cookie、授权头或TLS客户端证书等凭据。 请参考 XMLHttpRequest.withCredentials.
请注意,当您在本地或从同一域加载文件,则该方法无效。

src/loaders/FileLoader.js