samien
/
three.js
réplica de https://github.com/mrdoob/three.js.git


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>LightProbeGridHelper - 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="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → <a href="Mesh.html">Mesh</a> → <a href="InstancedMesh.html">InstancedMesh</a> → </p>
	<h1 translate="no">LightProbeGridHelper</h1>
		<section>
			<header>
				<div class="class-description"><p>Visualizes an <a href="LightProbeGrid.html">LightProbeGrid</a> by rendering a sphere at each
probe position, shaded with the probe's L1 spherical harmonics.</p>
<p>Uses a single <code>InstancedMesh</code> draw call for all probes.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const helper = new LightProbeGridHelper( probes );
scene.add( helper );
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">LightProbeGridHelper</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { LightProbeGridHelper } from 'three/addons/helpers/LightProbeGridHelper.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="LightProbeGridHelper" translate="no">new <a href="#LightProbeGridHelper">LightProbeGridHelper</a><span class="signature">( probes : <span class="param-type"><a href="LightProbeGrid.html">LightProbeGrid</a></span>, sphereSize : <span class="param-type">number</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new irradiance probe grid helper.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">probes</strong>
									</td>
									<td class="description last">
										<p>The probe grid to visualize.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong translate="no">sphereSize</strong>
									</td>
									<td class="description last">
										<p>The radius of each probe sphere.</p>
										<p>Default is <code>0.12</code>.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="probes" translate="no">.<a href="#probes">probes</a><span class="type-signature"> : <a href="LightProbeGrid.html">LightProbeGrid</a></span> </h3>
					<div class="description">
						<p>The probe grid to visualize.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Frees the GPU-related resources allocated by this instance. Call this
method whenever this instance is no longer used in your app.</p>
						</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="InstancedMesh.html#dispose">InstancedMesh#dispose</a></dt>
						</dl>
					</div>
					<h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Rebuilds instance matrices and UVW attributes from the current probe grid.
Call this after changing <code>probes</code> or after re-baking.</p>
						</div>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/LightProbeGridHelper.js" translate="no" target="_blank" rel="noopener">examples/jsm/helpers/LightProbeGridHelper.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>