From c53e97ea6428f4fd70184a4f09258af246d3d821 Mon Sep 17 00:00:00 2001 From: Jordy van Dortmont Date: Wed, 13 Apr 2022 22:00:11 +0200 Subject: [PATCH] FileLoader: Update documentation for onProgress callback --- docs/api/en/loaders/AnimationLoader.html | 2 +- docs/api/en/loaders/AudioLoader.html | 2 +- docs/api/en/loaders/BufferGeometryLoader.html | 2 +- docs/api/en/loaders/CompressedTextureLoader.html | 2 +- docs/api/en/loaders/DataTextureLoader.html | 2 +- docs/api/en/loaders/FileLoader.html | 2 +- docs/api/en/loaders/Loader.html | 2 +- docs/api/en/loaders/MaterialLoader.html | 2 +- docs/api/en/loaders/ObjectLoader.html | 2 +- docs/examples/en/loaders/3DMLoader.html | 2 +- docs/examples/en/loaders/DRACOLoader.html | 2 +- docs/examples/en/loaders/FontLoader.html | 2 +- docs/examples/en/loaders/GLTFLoader.html | 2 +- docs/examples/en/loaders/KTX2Loader.html | 2 +- docs/examples/en/loaders/LDrawLoader.html | 2 +- docs/examples/en/loaders/MMDLoader.html | 6 +++--- docs/examples/en/loaders/MTLLoader.html | 2 +- docs/examples/en/loaders/OBJLoader.html | 2 +- docs/examples/en/loaders/PCDLoader.html | 2 +- docs/examples/en/loaders/PDBLoader.html | 2 +- docs/examples/en/loaders/PRWMLoader.html | 2 +- docs/examples/en/loaders/SVGLoader.html | 2 +- docs/examples/en/loaders/TGALoader.html | 2 +- docs/examples/zh/loaders/DRACOLoader.html | 2 +- docs/examples/zh/loaders/PDBLoader.html | 2 +- docs/examples/zh/loaders/PRWMLoader.html | 2 +- docs/examples/zh/loaders/SVGLoader.html | 2 +- docs/examples/zh/loaders/TGALoader.html | 2 +- 28 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/api/en/loaders/AnimationLoader.html b/docs/api/en/loaders/AnimationLoader.html index 136006b16518d0..af1096452058ad 100644 --- a/docs/api/en/loaders/AnimationLoader.html +++ b/docs/api/en/loaders/AnimationLoader.html @@ -64,7 +64,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:AnimationClip animation clips].
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called if load errors.

Begin loading from url and pass the loaded animation to onLoad. diff --git a/docs/api/en/loaders/AudioLoader.html b/docs/api/en/loaders/AudioLoader.html index 1a29147d6c7971..85ea5d5d22d01b 100644 --- a/docs/api/en/loaders/AudioLoader.html +++ b/docs/api/en/loaders/AudioLoader.html @@ -81,7 +81,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded text response.
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called when load errors.

diff --git a/docs/api/en/loaders/BufferGeometryLoader.html b/docs/api/en/loaders/BufferGeometryLoader.html index 72aeea2cf27db5..28ccc9d15f5e86 100644 --- a/docs/api/en/loaders/BufferGeometryLoader.html +++ b/docs/api/en/loaders/BufferGeometryLoader.html @@ -73,7 +73,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].d
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:BufferGeometry].
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called when load errors.

diff --git a/docs/api/en/loaders/CompressedTextureLoader.html b/docs/api/en/loaders/CompressedTextureLoader.html index 067a8a9081979d..b580724a34842f 100644 --- a/docs/api/en/loaders/CompressedTextureLoader.html +++ b/docs/api/en/loaders/CompressedTextureLoader.html @@ -45,7 +45,7 @@

[method:CompressedTexture load]( [param:String url], [param:Function onLoad] [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] (optional) — Will be called when load completes. The argument will be the loaded texture.
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called when load errors.

diff --git a/docs/api/en/loaders/DataTextureLoader.html b/docs/api/en/loaders/DataTextureLoader.html index f269f522de80e8..3561588ad25c04 100644 --- a/docs/api/en/loaders/DataTextureLoader.html +++ b/docs/api/en/loaders/DataTextureLoader.html @@ -45,7 +45,7 @@

[method:DataTexture load]( [param:String url], [param:Function onLoad], [par [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] (optional) — Will be called when load completes. The argument will be the loaded texture.
- [page:Function onProgress] (optional) — Will be called while load progresses.The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called when load errors.

diff --git a/docs/api/en/loaders/FileLoader.html b/docs/api/en/loaders/FileLoader.html index 5d3365621243fe..54e5a98ab9cffe 100644 --- a/docs/api/en/loaders/FileLoader.html +++ b/docs/api/en/loaders/FileLoader.html @@ -79,7 +79,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] (optional) — Will be called when loading completes. The argument will be the loaded response.
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called if an error occurs.

Load the URL and pass the response to the onLoad function. diff --git a/docs/api/en/loaders/Loader.html b/docs/api/en/loaders/Loader.html index a1f1dc45204fd5..20877e19b2a57d 100644 --- a/docs/api/en/loaders/Loader.html +++ b/docs/api/en/loaders/Loader.html @@ -70,7 +70,7 @@

[method:undefined load]()

[method:Promise loadAsync]( [param:String url], [param:Function onProgress] )

[page:String url] — A string containing the path/URL of the file to be loaded.
- [page:Function onProgress] (optional) — A function to be called while the loading is in progress. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].

This method is equivalent to [page:.load], but returns a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise]. diff --git a/docs/api/en/loaders/MaterialLoader.html b/docs/api/en/loaders/MaterialLoader.html index 687be36c61cfb7..bda69aaf1d2659 100644 --- a/docs/api/en/loaders/MaterialLoader.html +++ b/docs/api/en/loaders/MaterialLoader.html @@ -67,7 +67,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Material].
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called when load errors.

Begin loading from url. diff --git a/docs/api/en/loaders/ObjectLoader.html b/docs/api/en/loaders/ObjectLoader.html index afd1edcf02efff..ce1712b5fba136 100644 --- a/docs/api/en/loaders/ObjectLoader.html +++ b/docs/api/en/loaders/ObjectLoader.html @@ -77,7 +77,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Object3D object].
- [page:Function onProgress] (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] (optional) — Will be called when load errors.

diff --git a/docs/examples/en/loaders/3DMLoader.html b/docs/examples/en/loaders/3DMLoader.html index a2b90b23200723..a5aeab910e804c 100644 --- a/docs/examples/en/loaders/3DMLoader.html +++ b/docs/examples/en/loaders/3DMLoader.html @@ -165,7 +165,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .3dm file.
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/DRACOLoader.html b/docs/examples/en/loaders/DRACOLoader.html index 76e4d2da15dc01..36f3fe37a27da4 100644 --- a/docs/examples/en/loaders/DRACOLoader.html +++ b/docs/examples/en/loaders/DRACOLoader.html @@ -108,7 +108,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .drc file.
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/FontLoader.html b/docs/examples/en/loaders/FontLoader.html index 5aa300b0d7ad33..fb318e84ed53ea 100644 --- a/docs/examples/en/loaders/FontLoader.html +++ b/docs/examples/en/loaders/FontLoader.html @@ -71,7 +71,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param [page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded font.
- [page:Function onProgress] — Will be called while load progresses. The argument will be the XMLHttpRequest instance, which contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — Will be called when load errors.

Begin loading from url and pass the loaded [page:Texture texture] to onLoad. diff --git a/docs/examples/en/loaders/GLTFLoader.html b/docs/examples/en/loaders/GLTFLoader.html index 57b8cbcc11cfce..d29ae576ecc92d 100644 --- a/docs/examples/en/loaders/GLTFLoader.html +++ b/docs/examples/en/loaders/GLTFLoader.html @@ -193,7 +193,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .gltf or .glb file.
[page:Function onLoad] — A function to be called after the loading is successfully completed. The function receives the loaded JSON response returned from [page:Function parse].
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/KTX2Loader.html b/docs/examples/en/loaders/KTX2Loader.html index 60113d61966301..e6e4e59af1441d 100644 --- a/docs/examples/en/loaders/KTX2Loader.html +++ b/docs/examples/en/loaders/KTX2Loader.html @@ -84,7 +84,7 @@

[method:CompressedTexture load]( [param:String url], [param:Function onLoad]

[page:String url] — A string containing the path/URL of the .basis file.
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/LDrawLoader.html b/docs/examples/en/loaders/LDrawLoader.html index 5c60ed29d49c17..321fe0a8523182 100644 --- a/docs/examples/en/loaders/LDrawLoader.html +++ b/docs/examples/en/loaders/LDrawLoader.html @@ -144,7 +144,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the LDraw file.
[page:Function onLoad] — A function to be called after the loading is successfully completed. The function receives the loaded JSON response returned from [page:Function parse].
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/MMDLoader.html b/docs/examples/en/loaders/MMDLoader.html index 20570eeceaaa8d..ccf603e2bc9806 100644 --- a/docs/examples/en/loaders/MMDLoader.html +++ b/docs/examples/en/loaders/MMDLoader.html @@ -75,7 +75,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .pmd or .pmx file.
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

@@ -87,7 +87,7 @@

[method:undefined loadAnimation]( [param:String url], [param:Object3D object [page:String url] — A string or an array of string containing the path/URL of the .vmd file(s).If two or more files are specified, they'll be merged.
[page:Object3D object] — [page:SkinnedMesh] or [page:Camera]. Clip and its tracks will be fitting to this object.
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

@@ -99,7 +99,7 @@

[method:undefined loadWithAnimation]( [param:String modelUrl], [param:String [page:String modelUrl] — A string containing the path/URL of the .pmd or .pmx file.
[page:String vmdUrl] — A string or an array of string containing the path/URL of the .vmd file(s).
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/MTLLoader.html b/docs/examples/en/loaders/MTLLoader.html index 88d11f5039a29d..ea2ef2e27ae1f5 100644 --- a/docs/examples/en/loaders/MTLLoader.html +++ b/docs/examples/en/loaders/MTLLoader.html @@ -36,7 +36,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .mtl file.
[page:Function onLoad] — (optional) A function to be called after the loading is successfully completed. The function receives the loaded [page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator] instance.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/en/loaders/OBJLoader.html b/docs/examples/en/loaders/OBJLoader.html index b20adb1b91cac0..3e89f50a7119ad 100644 --- a/docs/examples/en/loaders/OBJLoader.html +++ b/docs/examples/en/loaders/OBJLoader.html @@ -74,7 +74,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .obj file.
[page:Function onLoad] — (optional) A function to be called after the loading is successfully completed. The function receives the loaded [page:Object3D] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The function receives a XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/PCDLoader.html b/docs/examples/en/loaders/PCDLoader.html index 575a656358d6c7..dd63df25df1611 100644 --- a/docs/examples/en/loaders/PCDLoader.html +++ b/docs/examples/en/loaders/PCDLoader.html @@ -78,7 +78,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .pcd file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives loaded [page:Object3D] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/en/loaders/PDBLoader.html b/docs/examples/en/loaders/PDBLoader.html index c6f5239168a7a2..58fb3525504635 100644 --- a/docs/examples/en/loaders/PDBLoader.html +++ b/docs/examples/en/loaders/PDBLoader.html @@ -75,7 +75,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .pdb file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives the object having the following properties. [page:BufferGeometry geometryAtoms], [page:BufferGeometry geometryBonds] and the [page:Object JSON] structure.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/en/loaders/PRWMLoader.html b/docs/examples/en/loaders/PRWMLoader.html index a8c3f786c52c5f..394ab9633c80da 100644 --- a/docs/examples/en/loaders/PRWMLoader.html +++ b/docs/examples/en/loaders/PRWMLoader.html @@ -76,7 +76,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .prwm file. Any * character in the URL will be automatically replaced by le or be depending on the platform endianness.
[page:Function onLoad] — (optional) A function to be called after the loading is successfully completed. The function receives the loaded [page:BufferGeometry] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The function receives a XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/en/loaders/SVGLoader.html b/docs/examples/en/loaders/SVGLoader.html index a0394f41446c17..e7900b5e785338 100644 --- a/docs/examples/en/loaders/SVGLoader.html +++ b/docs/examples/en/loaders/SVGLoader.html @@ -97,7 +97,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .svg file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives an array of [page:ShapePath] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/en/loaders/TGALoader.html b/docs/examples/en/loaders/TGALoader.html index 99c95ff808c328..30d63b1257c02b 100644 --- a/docs/examples/en/loaders/TGALoader.html +++ b/docs/examples/en/loaders/TGALoader.html @@ -76,7 +76,7 @@

[method:DataTexture load]( [param:String url], [param:Function onLoad], [par

[page:String url] — A string containing the path/URL of the .tga file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives loaded [page:DataTexture] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains .[page:Integer total] and .[page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/zh/loaders/DRACOLoader.html b/docs/examples/zh/loaders/DRACOLoader.html index 5377e9d39438cf..e06373889aaa98 100644 --- a/docs/examples/zh/loaders/DRACOLoader.html +++ b/docs/examples/zh/loaders/DRACOLoader.html @@ -103,7 +103,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .drc file.
[page:Function onLoad] — A function to be called after the loading is successfully completed.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/zh/loaders/PDBLoader.html b/docs/examples/zh/loaders/PDBLoader.html index 4ccd2565524414..c04a879a37daed 100644 --- a/docs/examples/zh/loaders/PDBLoader.html +++ b/docs/examples/zh/loaders/PDBLoader.html @@ -75,7 +75,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .pdb file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives the object having the following properties. [page:BufferGeometry geometryAtoms], [page:BufferGeometry geometryBonds] and the [page:Object JSON] structure.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/zh/loaders/PRWMLoader.html b/docs/examples/zh/loaders/PRWMLoader.html index 3058ccc706c371..6b36ccc96dace8 100644 --- a/docs/examples/zh/loaders/PRWMLoader.html +++ b/docs/examples/zh/loaders/PRWMLoader.html @@ -76,7 +76,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .prwm file. Any * character in the URL will be automatically replaced by le or be depending on the platform endianness.
[page:Function onLoad] — (optional) A function to be called after the loading is successfully completed. The function receives the loaded [page:BufferGeometry] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The function receives a XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.

diff --git a/docs/examples/zh/loaders/SVGLoader.html b/docs/examples/zh/loaders/SVGLoader.html index a589fc2971d0d4..1606c066ac09c4 100644 --- a/docs/examples/zh/loaders/SVGLoader.html +++ b/docs/examples/zh/loaders/SVGLoader.html @@ -97,7 +97,7 @@

[method:undefined load]( [param:String url], [param:Function onLoad], [param

[page:String url] — A string containing the path/URL of the .svg file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives an array of [page:ShapePath] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.

diff --git a/docs/examples/zh/loaders/TGALoader.html b/docs/examples/zh/loaders/TGALoader.html index 2c0761f12a5e75..6b85cf1ad346a6 100644 --- a/docs/examples/zh/loaders/TGALoader.html +++ b/docs/examples/zh/loaders/TGALoader.html @@ -76,7 +76,7 @@

[method:DataTexture load]( [param:String url], [param:Function onLoad], [par

[page:String url] — A string containing the path/URL of the .tga file.
[page:Function onLoad] — (optional) A function to be called after loading is successfully completed. The function receives loaded [page:DataTexture] as an argument.
- [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains .[page:Integer total] and .[page:Integer loaded] bytes.
+ [page:Function onProgress] (optional) — Will be called while load progresses. The first argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0. The second argument will be the [link:https://developer.mozilla.org/en-US/docs/Web/API/Response/headers response headers].
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.