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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>CSMHelper - 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="Group.html">Group</a> → </p>
	<h1 translate="no">CSMHelper</h1>
		<section>
			<header>
				<div class="class-description"><p>A helper for visualizing the cascades of a CSM instance.</p></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">CSMHelper</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 { CSMHelper } from 'three/addons/csm/CSMHelper.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="CSMHelper" translate="no">new <a href="#CSMHelper">CSMHelper</a><span class="signature">( csm : <span class="param-type"><a href="CSM.html">CSM</a> | <a href="CSMShadowNode.html">CSMShadowNode</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new CSM helper.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>csm</strong>
									</td>
									<td class="description last">
										<p>The CSM instance to visualize.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="csm" translate="no">.<a href="#csm">csm</a><span class="type-signature"> : <a href="CSM.html">CSM</a> | <a href="CSMShadowNode.html">CSMShadowNode</a></span> </h3>
					<div class="description">
						<p>The CSM instance to visualize.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="displayFrustum" translate="no">.<a href="#displayFrustum">displayFrustum</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to display the CSM frustum or not.</p>
						<p>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="displayPlanes" translate="no">.<a href="#displayPlanes">displayPlanes</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to display the cascade planes or not.</p>
						<p>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="displayShadowBounds" translate="no">.<a href="#displayShadowBounds">displayShadowBounds</a><span class="type-signature"> : boolean</span> </h3>
					<div class="description">
						<p>Whether to display the shadow bounds or not.</p>
						<p>Default is <code>true</code>.</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>
					</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>Updates the helper. This method should be called in the app's animation loop.</p>
						</div>
					</div>
					<h3 class="name name-method" id="updateVisibility" translate="no">.<a href="#updateVisibility">updateVisibility</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>This method must be called if one of the <code>display*</code> properties is changed at runtime.</p>
						</div>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/csm/CSMHelper.js" translate="no" target="_blank" rel="noopener">examples/jsm/csm/CSMHelper.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>