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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>FrustumArray - 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">FrustumArray</h1>
		<section>
			<header>
				<div class="class-description"><p>FrustumArray is used to determine if an object is visible in at least one camera
from an array of cameras. This is particularly useful for multi-view renderers.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="FrustumArray" translate="no">new <a href="#FrustumArray">FrustumArray</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new frustum array.</p>
						</div>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="coordinateSystem" translate="no">.<a href="#coordinateSystem">coordinateSystem</a><span class="type-signature"> : <a href="global.html#WebGLCoordinateSystem">WebGLCoordinateSystem</a> | <a href="global.html#WebGPUCoordinateSystem">WebGPUCoordinateSystem</a></span> </h3>
					<div class="description">
						<p>The coordinate system to use.</p>
						<p>Default is <code>WebGLCoordinateSystem</code>.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="clone" translate="no">.<a href="#clone">clone</a><span class="signature">()</span><span class="type-signature"> : <a href="FrustumArray.html">FrustumArray</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns a new frustum array with copied values from this instance.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A clone of this instance.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="containsPoint" translate="no">.<a href="#containsPoint">containsPoint</a><span class="signature">( point : <span class="param-type"><a href="Vector3.html">Vector3</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the given point lies within any cached frustum.</p>
<p><a href="FrustumArray.html#setFromArrayCamera">FrustumArray#setFromArrayCamera</a> must be called once per render before this method.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">point</strong>
									</td>
									<td class="description last">
										<p>The point to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the point is visible in any camera.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="copy" translate="no">.<a href="#copy">copy</a><span class="signature">( frustumArray : <span class="param-type"><a href="FrustumArray.html">FrustumArray</a></span> )</span><span class="type-signature"> : <a href="FrustumArray.html">FrustumArray</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Copies the values of the given frustum array to this instance.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">frustumArray</strong>
									</td>
									<td class="description last">
										<p>The frustum array to copy.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this frustum array.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="intersectsBox" translate="no">.<a href="#intersectsBox">intersectsBox</a><span class="signature">( box : <span class="param-type"><a href="Box3.html">Box3</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the given bounding box is intersecting any cached frustum.</p>
<p><a href="FrustumArray.html#setFromArrayCamera">FrustumArray#setFromArrayCamera</a> must be called once per render before this method.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">box</strong>
									</td>
									<td class="description last">
										<p>The bounding box to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the box is visible in any camera.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="intersectsObject" translate="no">.<a href="#intersectsObject">intersectsObject</a><span class="signature">( object : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the 3D object's bounding sphere is intersecting any cached frustum.</p>
<p><a href="FrustumArray.html#setFromArrayCamera">FrustumArray#setFromArrayCamera</a> must be called once per render before this method.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">object</strong>
									</td>
									<td class="description last">
										<p>The 3D object to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the 3D object is visible in any camera.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="intersectsSphere" translate="no">.<a href="#intersectsSphere">intersectsSphere</a><span class="signature">( sphere : <span class="param-type"><a href="Sphere.html">Sphere</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the given bounding sphere is intersecting any cached frustum.</p>
<p><a href="FrustumArray.html#setFromArrayCamera">FrustumArray#setFromArrayCamera</a> must be called once per render before this method.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">sphere</strong>
									</td>
									<td class="description last">
										<p>The bounding sphere to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the sphere is visible in any camera.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="intersectsSprite" translate="no">.<a href="#intersectsSprite">intersectsSprite</a><span class="signature">( sprite : <span class="param-type"><a href="Sprite.html">Sprite</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the given sprite is intersecting any cached frustum.</p>
<p><a href="FrustumArray.html#setFromArrayCamera">FrustumArray#setFromArrayCamera</a> must be called once per render before this method.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">sprite</strong>
									</td>
									<td class="description last">
										<p>The sprite to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the sprite is visible in any camera.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setFromArrayCamera" translate="no">.<a href="#setFromArrayCamera">setFromArrayCamera</a><span class="signature">( cameraArray : <span class="param-type"><a href="ArrayCamera.html">ArrayCamera</a></span> )</span><span class="type-signature"> : <a href="FrustumArray.html">FrustumArray</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Computes and caches a frustum for each camera of the given array camera.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong translate="no">cameraArray</strong>
									</td>
									<td class="description last">
										<p>The array camera whose sub-cameras define the frustums.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this frustum array.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/math/FrustumArray.js" translate="no" target="_blank" rel="noopener">src/math/FrustumArray.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>