diff --git a/docs/examples/loaders/DRACOLoader.html b/docs/examples/loaders/DRACOLoader.html new file mode 100644 index 0000000000000000000000000000000000000000..f9a21419bfce3647121b5bde472f3d60d7cb569b --- /dev/null +++ b/docs/examples/loaders/DRACOLoader.html @@ -0,0 +1,145 @@ + + + + + + + + + + + [page:Loader] → +

[name]

+ +

+ A loader for geometry compressed with the Draco library.

+ [link:https://google.github.io/draco/ Draco] is an open source library for compressing and + decompressing 3D meshes and point clouds. Compressed geometry can be significantly smaller, + at the cost of additional decoding time on the client device. +

+ +

+ Standalone Draco files have a .drc extension, and contain vertex positions, + normals, colors, and other attributes. Draco files do not contain materials, + textures, animation, or node hierarchies – to use these features, embed Draco geometry + inside of a glTF file. A normal glTF file can be converted to a Draco-compressed glTF file + using [link:https://github.com/AnalyticalGraphicsInc/gltf-pipeline glTF-Pipeline]. When + using Draco with glTF, an instance of DRACOLoader will be used internally by [page:GLTFLoader]. +

+ +

Example

+ + + // Instantiate a loader + var loader = new THREE.DRACOLoader(); + + // Specify path to a folder containing WASM/JS decoding libraries. + THREE.DRACOLoader.setDecoderPath( '/examples/js/libs/draco' ); + + // Optional: Pre-fetch Draco WASM/JS module. + THREE.DRACOLoader.getDecoderModule(); + + // Load a Draco geometry + loader.load( + // resource URL + 'model.drc', + // called when the resource is loaded + function ( geometry ) { + + var material = new THREE.MeshStandardMaterial( { color: 0x606060 } ); + var mesh = new THREE.Mesh( geometry, material ); + scene.add( mesh ); + + }, + // called as loading progresses + function ( xhr ) { + + console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' ); + + }, + // called when loading has errors + function ( error ) { + + console.log( 'An error happened' ); + + } + ); + + + [example:webgl_loader_draco] + +

Browser compatibility

+ +

DRACOLoader relies on ES6 [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promises], + which are not supported in IE11. To use the loader in IE11, you must + [link:https://github.com/stefanpenner/es6-promise include a polyfill] + providing a Promise replacement. DRACOLoader will automatically use + either the JS or the WASM decoding library, based on browser + capabilities.

+ +
+
+ +

Constructor

+ +

[name]( [param:LoadingManager manager] )

+

+ [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager]. +

+

+ Creates a new [name]. +

+ +

Static Methods

+ +

[method:null setDecoderPath]( [param:String value] )

+

+ [page:String value] — Path to folder containing the JS and WASM decoder libraries. +

+ +

[method:null setDecoderConfig]( [param:Object config] )

+

+ [page:String config.type] - (Optional) "js" or "wasm".
+

+

+ Provides configuration for the decoder libraries. Configuration cannot be changed + after loading the decoders. +

+ +

[method:Promise getDecoderModule]()

+

+ Requests the decoder libraries, if not already loaded. +

+ +

[method:null releaseDecoderModule]()

+

+ Disposes of the decoder library and deallocates memory. The decoder + [link:https://github.com/google/draco/issues/349 cannot be reloaded afterward]. +

+ +

Methods

+ +

[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )

+

+ [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 onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.
+

+

+ Begin loading from url and call the onLoad function with the decompressed geometry. +

+ +

[method:DRACOLoader setPath]( [param:String path] )

+

+ [page:String path] — Base path. +

+

+ Set the base path for the .drc file. +

+ +

Source

+ + [link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/DRACOLoader.js examples/js/loaders/DRACOLoader.js] + + diff --git a/docs/list.js b/docs/list.js index e4d60b8e8f5cd70675c51d0ca7136e6a64d1a938..1f034922b792ca2ad0a03f6475309c28e3a63631 100644 --- a/docs/list.js +++ b/docs/list.js @@ -363,6 +363,7 @@ var list = { "Loaders": { "BabylonLoader": "examples/loaders/BabylonLoader", + "DRACOLoader": "examples/loaders/DRACOLoader", "GLTFLoader": "examples/loaders/GLTFLoader", "MMDLoader": "examples/loaders/MMDLoader", "MTLLoader": "examples/loaders/MTLLoader",