samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>OBJLoader - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
	<h1 translate="no">OBJLoader</h1>
		<section>
			<header>
				<div class="class-description"><p>A loader for the OBJ format.</p>
<p>The <a href="https://en.wikipedia.org/wiki/Wavefront_.obj_file">OBJ 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></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const loader = new OBJLoader();
const object = await loader.loadAsync( 'models/monster.obj' );
scene.add( object );
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">OBJLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { OBJLoader } from 'three/addons/loaders/OBJLoader.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="OBJLoader" translate="no">new <a href="#OBJLoader">OBJLoader</a><span class="signature">( manager : <span class="param-type">LoadingManager</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new OBJ loader.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>manager</code></td>
									<td class="description last"><p>The loading manager.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="materials" translate="no">.<a href="#materials">materials</a><span class="type-signature"> : MaterialCreator</span> </h3>
					<div class="description">
						<p>A reference to a material creator.<br/>Default is <code>null</code>.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type">onProgressCallback</span>, onError : <span class="param-type">onErrorCallback</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Starts loading from the given URL and passes the loaded OBJ asset
to the <code>onLoad()</code> callback.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>url</code></td>
									<td class="description last"><p>The path/URL of the file to be loaded. This can also be a data URI.</p></td>
								</tr>
								<tr>
									<td class="name"><code>onLoad</code></td>
									<td class="description last"><p>Executed when the loading process has been finished.</p></td>
								</tr>
								<tr>
									<td class="name"><code>onProgress</code></td>
									<td class="description last"><p>Executed while the loading is in progress.</p></td>
								</tr>
								<tr>
									<td class="name"><code>onError</code></td>
									<td class="description last"><p>Executed when errors occur.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( text : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Group.html">Group</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Parses the given OBJ data and returns the resulting group.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>text</code></td>
									<td class="description last"><p>The raw OBJ data as a string.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
						</dl>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The parsed OBJ.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setMaterials" translate="no">.<a href="#setMaterials">setMaterials</a><span class="signature">( materials : <span class="param-type">MaterialCreator</span> )</span><span class="type-signature"> : <a href="OBJLoader.html">OBJLoader</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the material creator for this OBJ. This object is loaded via <a href="MTLLoader.html">MTLLoader</a>.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>materials</code></td>
									<td class="description last"><p>An object that creates the materials for this OBJ.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/OBJLoader.js" target="_blank" rel="noopener" translate="no">examples/jsm/loaders/OBJLoader.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>