wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/AxisAlignedBoundingBox.html

1824 lines
72 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>AxisAlignedBoundingBox - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
AxisAlignedBoundingBox
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="AxisAlignedBoundingBox">
<a href="#AxisAlignedBoundingBox" class="doc-link"></a>
new Cesium.AxisAlignedBoundingBox<span class="signature">(<span class="optional">minimum</span>, <span class="optional">maximum</span>, <span class="optional">center</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L19">Core/AxisAlignedBoundingBox.js 19</a>
</div>
</h4>
</div>
<div class="description">
Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>minimum</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="default">
<code class="language-javascript">Cartesian3.ZERO</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The minimum point along the x, y, and z axes.</td>
</tr>
<tr>
<td class="name"><code>maximum</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="default">
<code class="language-javascript">Cartesian3.ZERO</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum point along the x, y, and z axes.</td>
</tr>
<tr>
<td class="name"><code>center</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The center of the box; automatically computed if not supplied.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="BoundingSphere.html">BoundingSphere</a></li>
<li><a href="BoundingRectangle.html">BoundingRectangle</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="center">
<a href="#center" class="doc-link"></a>
center<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L45">Core/AxisAlignedBoundingBox.js 45</a>
</div>
</h4>
</div>
<div class="description">
The center point of the bounding box.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="maximum">
<a href="#maximum" class="doc-link"></a>
maximum<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L32">Core/AxisAlignedBoundingBox.js 32</a>
</div>
</h4>
</div>
<div class="description">
The maximum point defining the bounding box.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="Cartesian3.html#.ZERO"><code>Cartesian3.ZERO</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="minimum">
<a href="#minimum" class="doc-link"></a>
minimum<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L25">Core/AxisAlignedBoundingBox.js 25</a>
</div>
</h4>
</div>
<div class="description">
The minimum point defining the bounding box.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="Cartesian3.html#.ZERO"><code>Cartesian3.ZERO</code></a></code>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".clone">
<a href="#.clone" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.AxisAlignedBoundingBox.clone<span class="signature">(box, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L146">Core/AxisAlignedBoundingBox.js 146</a>
</div>
</h4>
</div>
<div class="description">
Duplicates a AxisAlignedBoundingBox instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>box</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
The bounding box to duplicate.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new AxisAlignedBoundingBox instance if none was provided. (Returns undefined if box is undefined)
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".equals">
<a href="#.equals" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.AxisAlignedBoundingBox.equals<span class="signature">(<span class="optional">left</span>, <span class="optional">right</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L169">Core/AxisAlignedBoundingBox.js 169</a>
</div>
</h4>
</div>
<div class="description">
Compares the provided AxisAlignedBoundingBox componentwise and returns
<code>true</code> if they are equal, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>left</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The first AxisAlignedBoundingBox.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The second AxisAlignedBoundingBox.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if left and right are equal, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fromCorners">
<a href="#.fromCorners" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.AxisAlignedBoundingBox.fromCorners<span class="signature">(minimum, maximum, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L60">Core/AxisAlignedBoundingBox.js 60</a>
</div>
</h4>
</div>
<div class="description">
Creates an instance of an AxisAlignedBoundingBox from its corners.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>minimum</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The minimum point along the x, y, and z axes.</td>
</tr>
<tr>
<td class="name"><code>maximum</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The maximum point along the x, y, and z axes.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Compute an axis aligned bounding box from the two corners.
const box = Cesium.AxisAlignedBoundingBox.fromCorners(new Cesium.Cartesian3(-1, -1, -1), new Cesium.Cartesian3(1, 1, 1));</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".fromPoints">
<a href="#.fromPoints" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.AxisAlignedBoundingBox.fromPoints<span class="signature">(positions, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L89">Core/AxisAlignedBoundingBox.js 89</a>
</div>
</h4>
</div>
<div class="description">
Computes an instance of an AxisAlignedBoundingBox. The box is determined by
finding the points spaced the farthest apart on the x, y, and z axes.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>positions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
</td>
<td class="description last">
List of points that the bounding box will enclose. Each point must have a <code>x</code>, <code>y</code>, and <code>z</code> properties.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Compute an axis aligned bounding box enclosing two points.
const box = Cesium.AxisAlignedBoundingBox.fromPoints([new Cesium.Cartesian3(2, 0, 0), new Cesium.Cartesian3(-2, 0, 0)]);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".intersectPlane">
<a href="#.intersectPlane" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.AxisAlignedBoundingBox.intersectPlane<span class="signature">(box, plane)</span> &rarr; <span class="type-signature returnType"><a href="global.html#Intersect">Intersect</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L191">Core/AxisAlignedBoundingBox.js 191</a>
</div>
</h4>
</div>
<div class="description">
Determines which side of a plane a box is located.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>box</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
The bounding box to test.</td>
</tr>
<tr>
<td class="name"><code>plane</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</a></span>
</td>
<td class="description last">
The plane to test against.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<a href="global.html#Intersect#.INSIDE"><code>Intersect.INSIDE</code></a> if the entire box is on the side of the plane
the normal is pointing, <a href="global.html#Intersect#.OUTSIDE"><code>Intersect.OUTSIDE</code></a> if the entire box is
on the opposite side, and <a href="global.html#Intersect#.INTERSECTING"><code>Intersect.INTERSECTING</code></a> if the box
intersects the plane.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L232">Core/AxisAlignedBoundingBox.js 232</a>
</div>
</h4>
</div>
<div class="description">
Duplicates this AxisAlignedBoundingBox instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="equals">
<a href="#equals" class="doc-link"></a>
equals<span class="signature">(<span class="optional">right</span>)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L256">Core/AxisAlignedBoundingBox.js 256</a>
</div>
</h4>
</div>
<div class="description">
Compares this AxisAlignedBoundingBox against the provided AxisAlignedBoundingBox componentwise and returns
<code>true</code> if they are equal, <code>false</code> otherwise.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The right hand side AxisAlignedBoundingBox.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if they are equal, <code>false</code> otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="intersectPlane">
<a href="#intersectPlane" class="doc-link"></a>
intersectPlane<span class="signature">(plane)</span> &rarr; <span class="type-signature returnType"><a href="global.html#Intersect">Intersect</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/AxisAlignedBoundingBox.js#L245">Core/AxisAlignedBoundingBox.js 245</a>
</div>
</h4>
</div>
<div class="description">
Determines which side of a plane this box is located.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>plane</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</a></span>
</td>
<td class="description last">
The plane to test against.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<a href="global.html#Intersect#.INSIDE"><code>Intersect.INSIDE</code></a> if the entire box is on the side of the plane
the normal is pointing, <a href="global.html#Intersect#.OUTSIDE"><code>Intersect.OUTSIDE</code></a> if the entire box is
on the opposite side, and <a href="global.html#Intersect#.INTERSECTING"><code>Intersect.INTERSECTING</code></a> if the box
intersects the plane.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>