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.
109 lines
3.6 KiB
109 lines
3.6 KiB
2 years ago
|
<!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] →
|
||
|
|
|
||
|
|
<h1>[name]</h1>
|
||
|
|
|
||
|
|
<p class="desc">A loader for loading a `.obj` resource.<br />
|
||
|
|
The <a href="https://en.wikipedia.org/wiki/Wavefront_.obj_file">OBJ file format</a> is a simple data-format
|
||
|
|
that represents 3D geometry in a human readable format as the position of each vertex, the UV position of
|
||
|
|
each texture coordinate vertex, vertex normals, and the faces that make each polygon defined as a list of
|
||
|
|
vertices, and texture vertices.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h2>Code Example</h2>
|
||
|
|
|
||
|
|
<code>
|
||
|
|
// instantiate a loader
|
||
|
|
const loader = new OBJLoader();
|
||
|
|
|
||
|
|
// load a resource
|
||
|
|
loader.load(
|
||
|
|
// resource URL
|
||
|
|
'models/monster.obj',
|
||
|
|
// called when resource is loaded
|
||
|
|
function ( object ) {
|
||
|
|
|
||
|
|
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_obj]
|
||
|
|
</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 `.obj` file.<br />
|
||
|
|
[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.<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:Object3D parse]( [param:String text] )</h3>
|
||
|
|
<p>
|
||
|
|
[page:String text] — The textual `obj` structure to parse.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Returns an [page:Object3D]. It contains the parsed meshes as [page:Mesh] and lines as [page:LineSegments].<br />
|
||
|
|
All geometry is created as [page:BufferGeometry]. Default materials are created as [page:MeshPhongMaterial].<br />
|
||
|
|
If an `obj` object or group uses multiple materials while declaring faces, geometry groups and an array of materials are used.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h3>[method:this setMaterials]( [param:MTLLoader.MaterialCreator materials] )</h3>
|
||
|
|
<p>
|
||
|
|
[page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator materials] - A MaterialCreator instance.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Sets materials loaded by MTLLoader or any other supplier of a [page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator].
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h2>Source</h2>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/OBJLoader.js examples/jsm/loaders/OBJLoader.js]
|
||
|
|
</p>
|
||
|
|
</body>
|
||
|
|
</html>
|