You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

107 lines
3.5 KiB

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Loader] &rarr;
<h1>[name]</h1>
<p class="desc">A loader for loading a `.prwm` resource.<br />
Packed Raw WebGL Model is an open-source binary file format for nD geometries specifically designed for
JavaScript and WebGL with a strong focus on fast parsing (from 1ms to 0.1ms in Chrome 59
on a MBP Late 2013). The parsing of PRWM file is especially fast when the endianness of the file is
the same as the endianness of the client platform. More information
on this <a href="https://github.com/kchapelier/PRWM">here</a>.
</p>
<h2>Code Example</h2>
<code>
// instantiate a loader
const loader = new PRWMLoader();
// load a resource
loader.load(
// resource URL
'models/nefertiti.le.prwm',
// called when resource is loaded
function ( bufferGeometry ) {
const object = new THREE.Mesh( bufferGeometry, new THREE.MeshNormalMaterial() );
scene.add( object );
},
// called when loading is in progresses
function ( xhr ) {
console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' );
},
// called when loading has errors
function ( error ) {
console.log( 'An error happened' );
}
);
</code>
<h2>Examples</h2>
<p>
[example:webgl_loader_prwm]
</p>
<h2>Constructor</h2>
<h3>[name]( [param:LoadingManager manager] )</h3>
<p>
[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
</p>
<p>
Creates a new [name].
</p>
<h2>Properties</h2>
<p>See the base [page:Loader] class for common properties.</p>
<h2>Methods</h2>
<p>See the base [page:Loader] class for common methods.</p>
<h3>[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
<p>
[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.<br />
[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.<br />
[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.<br />
[page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.<br />
</p>
<p>
Begin loading from url and call onLoad with the parsed response content.
</p>
<h3>[method:BufferGeometry parse]( [param:ArrayBuffer arrayBuffer] )</h3>
<p>
[page:ArrayBuffer arrayBuffer] — ArrayBuffer containing the `prwm` data.
</p>
<p>
Parse a `prwm` file passed as an ArrayBuffer and directly return an instance of [page:BufferGeometry].
</p>
<h3>PRWMLoader.isBigEndianPlatform( )</h3>
<p>
Return true if the endianness of the platform is Big Endian, false otherwise.
</p>
<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/PRWMLoader.js examples/jsm/loaders/PRWMLoader.js]
</p>
</body>
</html>