OBJLoader

A loader for loading a .obj resource.
The OBJ file format 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.

Example

// instantiate a loader var loader = new v3d.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'); } ); webgl_loader_obj

Constructor

OBJLoader(manager : LoadingManager)

manager — The loadingManager for the loader to use. Default is v3d.DefaultLoadingManager.

Creates a new OBJLoader.

Properties

Methods

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

url — A string containing the path/URL of the .obj file.
onLoad — (optional) A function to be called after the loading is successfully completed. The function receives the loaded Object3D as an argument.
onProgress — (optional) A function to be called while the loading is in progress. The function receives a XMLHttpRequest instance, which contains total and loaded bytes.
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 onLoad with the parsed response content.

.parse (text : String) : Object3D

text — The textual obj structure to parse.

Returns an Object3D. It contains the parsed meshes as Mesh and lines as LineSegments.
All geometry is created as BufferGeometry. Default materials are created as MeshPhongMaterial.
If an obj object or group uses multiple materials while declaring faces, geometry groups and an array of materials are used.

.setMaterials (materials : Array) : OBJLoader

materials - Array of Materials.

Sets materials loaded by MTLLoader or any other supplier of an Array of Materials.

.setPath (path : String) : OBJLoader

Sets the base path or URL from which to load files. This can be useful to avoid repetition if you are calling .load multiple times on the same directory.

Source

For more info on how to obtain the source code of this module see this page.