samien
/
three.js
зеркало из https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>USDComposer - 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>
	<h1 translate="no">USDComposer</h1>
		<section>
			<header>
				<div class="class-description"><p>USDComposer handles scene composition from parsed USD data.
This includes reference resolution, variant selection, transform handling,
and building the Three.js scene graph.</p>
<p>Works with specsByPath format from USDCParser.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="USDComposer" translate="no">new <a href="#USDComposer">USDComposer</a><span class="signature">()</span> </h3>
					<div class="method">
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="_applyMaterialBinding" translate="no">.<a href="#_applyMaterialBinding">_applyMaterialBinding</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Apply material binding from a prim path to a mesh.
Used when merging referenced geometry into a prim that has material binding.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_applyTextureOrValue" translate="no">.<a href="#_applyTextureOrValue">_applyTextureOrValue</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Shared helper for applying texture or value from shader attribute.
Reduces duplication between _applyPreviewSurface and _applyOpenPBRSurface.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_buildCamera" translate="no">.<a href="#_buildCamera">_buildCamera</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Build a camera from a Camera spec.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_buildGeomPrimitive" translate="no">.<a href="#_buildGeomPrimitive">_buildGeomPrimitive</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Build a mesh from a USD geometric primitive (Cube, Sphere, Cylinder, Cone, Capsule).</p>
						</div>
					</div>
					<h3 class="name name-method" id="_buildHierarchy" translate="no">.<a href="#_buildHierarchy">_buildHierarchy</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Build the scene hierarchy recursively.
Uses childrenByPath index for O(1) child lookup instead of O(n) iteration.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_buildIndexes" translate="no">.<a href="#_buildIndexes">_buildIndexes</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Build indexes for efficient lookups.
Called once during compose() to avoid O(n) scans per lookup.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_buildLight" translate="no">.<a href="#_buildLight">_buildLight</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Build a light from a UsdLux light spec.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_buildMesh" translate="no">.<a href="#_buildMesh">_buildMesh</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Build a mesh from a Mesh spec.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_colorTemperature" translate="no">.<a href="#_colorTemperature">_colorTemperature</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Convert a color temperature in Kelvin to an RGB Color.
Based on Tanner Helland's algorithm.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_computeVertexNormals" translate="no">.<a href="#_computeVertexNormals">_computeVertexNormals</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Compute per-vertex normals from indexed triangle data.
Accumulates area-weighted face normals at each shared vertex and normalizes.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_findSingleMesh" translate="no">.<a href="#_findSingleMesh">_findSingleMesh</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Find a single mesh in the group's shallow hierarchy.
Only returns a mesh if it's at depth 0 or 1, not deeply nested.
This preserves transforms in complex hierarchies like Kitchen Set
while supporting USDZExporter round-trip (Xform &gt; Xform &gt; Mesh pattern).</p>
						</div>
					</div>
					<h3 class="name name-method" id="_getAttributes" translate="no">.<a href="#_getAttributes">_getAttributes</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Get attributes for a path from attribute specs.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_getBasePath" translate="no">.<a href="#_getBasePath">_getBasePath</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Get the base path (directory) from a file path.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_getLocalVariantSelections" translate="no">.<a href="#_getLocalVariantSelections">_getLocalVariantSelections</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Extract variant selections from a spec's fields.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_getMaterialBindingTarget" translate="no">.<a href="#_getMaterialBindingTarget">_getMaterialBindingTarget</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Get material binding target path, checking variant paths if needed.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_getMaterialPath" translate="no">.<a href="#_getMaterialPath">_getMaterialPath</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Get the material path for a mesh, checking various binding sources.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_getReferences" translate="no">.<a href="#_getReferences">_getReferences</a><span class="signature">()</span><span class="type-signature"> : Array.&lt;string></span> </h3>
					<div class="method">
						<div class="description">
							<p>Get all reference values from a prim spec.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Array of reference strings like &quot;@path@&quot; or &quot;@path@<prim>&quot;</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="_getVariantPaths" translate="no">.<a href="#_getVariantPaths">_getVariantPaths</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Get variant paths for a parent path based on variant selections.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_hasNonIdentityTransform" translate="no">.<a href="#_hasNonIdentityTransform">_hasNonIdentityTransform</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Check if an object has a non-identity local transform.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_isDirectChild" translate="no">.<a href="#_isDirectChild">_isDirectChild</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Check if a path is a direct child of parentPath.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_resolveFilePath" translate="no">.<a href="#_resolveFilePath">_resolveFilePath</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Resolve a file path relative to basePath.</p>
						</div>
					</div>
					<h3 class="name name-method" id="_resolveReference" translate="no">.<a href="#_resolveReference">_resolveReference</a><span class="signature">( refValue : <span class="param-type">string</span>, localVariants : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Group.html">Group</a> | null</span> </h3>
					<div class="method">
						<div class="description">
							<p>Resolve a USD reference and return the composed content.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">refValue</strong>
									</td>
									<td class="description last">
										<p>Reference value like &quot;@./path/to/file.usdc@&quot;</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">localVariants</strong>
									</td>
									<td class="description last">
										<p>Variant selections to apply</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Composed content or null</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="applyTransform" translate="no">.<a href="#applyTransform">applyTransform</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Apply USD transforms to a Three.js object.
Handles xformOpOrder with proper matrix composition.
USD uses row-vector convention, Three.js uses column-vector.</p>
						</div>
					</div>
					<h3 class="name name-method" id="compose" translate="no">.<a href="#compose">compose</a><span class="signature">( parsedData : <span class="param-type">Object</span>, assets : <span class="param-type">Object</span>, variantSelections : <span class="param-type">Object</span>, basePath : <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>Compose a Three.js scene from parsed USD data.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">parsedData</strong>
									</td>
									<td class="description last">
										<p>Data from USDCParser or USDAParser</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">assets</strong>
									</td>
									<td class="description last">
										<p>Dictionary of referenced assets (specsByPath or blob URLs)</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">variantSelections</strong>
									</td>
									<td class="description last">
										<p>External variant selections</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">basePath</strong>
									</td>
									<td class="description last">
										<p>Base path for resolving relative references</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Three.js scene graph</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/usd/USDComposer.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/usd/USDComposer.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>