[name]

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'); } ); [example:webgl_loader_obj]

Constructor

[name]([param:LoadingManager manager])

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

Creates a new [name].

Properties

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 .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.
[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 onLoad with the parsed response content.

[method:Object3D parse]([param:String text])

[page:String text] — The textual obj structure to parse.

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

[method:OBJLoader setMaterials]([param:Array materials])

[page:Array materials] - Array of [page:Material Materials].

Sets materials loaded by MTLLoader or any other supplier of an Array of [page:Material Materials].

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

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

[sourceHint]