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

1885 lines
71 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>Plane - 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>
Plane
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Plane">
<a href="#Plane" class="doc-link"></a>
new Cesium.Plane<span class="signature">(normal, distance)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L34">Core/Plane.js 34</a>
</div>
</h4>
</div>
<div class="description">
A plane in Hessian Normal Form defined by
<pre>
ax + by + cz + d = 0
</pre>
where (a, b, c) is the plane's <code>normal</code>, d is the signed
<code>distance</code> to the plane, and (x, y, z) is any point on
the plane.
</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>normal</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The plane's normal (normalized).</td>
</tr>
<tr>
<td class="name"><code>distance</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The shortest distance from the origin to the plane. The sign of
<code>distance</code> determines which side of the plane the origin
is on. If <code>distance</code> is positive, the origin is in the half-space
in the direction of the normal; if negative, the origin is in the half-space
opposite to the normal; if zero, the plane passes through the origin.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: Normal must be normalized
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// The plane x=0
const plane = new Cesium.Plane(Cesium.Cartesian3.UNIT_X, 0.0);</code></pre>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".ORIGIN_XY_PLANE">
<a href="#.ORIGIN_XY_PLANE" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.Plane.ORIGIN_XY_PLANE<span class="type-signature"> : <a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L295">Core/Plane.js 295</a>
</div>
</h4>
</div>
<div class="description">
A constant initialized to the XY plane passing through the origin, with normal in positive Z.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".ORIGIN_YZ_PLANE">
<a href="#.ORIGIN_YZ_PLANE" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.Plane.ORIGIN_YZ_PLANE<span class="type-signature"> : <a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L303">Core/Plane.js 303</a>
</div>
</h4>
</div>
<div class="description">
A constant initialized to the YZ plane passing through the origin, with normal in positive X.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".ORIGIN_ZX_PLANE">
<a href="#.ORIGIN_ZX_PLANE" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-constant">constant</span> Cesium.Plane.ORIGIN_ZX_PLANE<span class="type-signature"> : <a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L311">Core/Plane.js 311</a>
</div>
</h4>
</div>
<div class="description">
A constant initialized to the ZX plane passing through the origin, with normal in positive Y.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distance">
<a href="#distance" class="doc-link"></a>
distance<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L65">Core/Plane.js 65</a>
</div>
</h4>
</div>
<div class="description">
The shortest distance from the origin to the plane. The sign of
<code>distance</code> determines which side of the plane the origin
is on. If <code>distance</code> is positive, the origin is in the half-space
in the direction of the normal; if negative, the origin is in the half-space
opposite to the normal; if zero, the plane passes through the origin.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="normal">
<a href="#normal" class="doc-link"></a>
normal<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/Plane.js#L54">Core/Plane.js 54</a>
</div>
</h4>
</div>
<div class="description">
The plane's normal.
</div>
<dl class="details">
</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.Plane.clone<span class="signature">(plane, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L254">Core/Plane.js 254</a>
</div>
</h4>
</div>
<div class="description">
Duplicates a Plane 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>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 duplicate.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</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 Plane 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>
<span class="type-signature attribute-static">static</span> Cesium.Plane.equals<span class="signature">(left, right)</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/Plane.js#L277">Core/Plane.js 277</a>
</div>
</h4>
</div>
<div class="description">
Compares the provided Planes by normal and distance 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="Plane.html">Plane</a></span>
</td>
<td class="description last">
The first plane.</td>
</tr>
<tr>
<td class="name"><code>right</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</a></span>
</td>
<td class="description last">
The second plane.</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=".fromCartesian4">
<a href="#.fromCartesian4" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Plane.fromCartesian4<span class="signature">(coefficients, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L119">Core/Plane.js 119</a>
</div>
</h4>
</div>
<div class="description">
Creates a plane from the general equation
</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>coefficients</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian4.html">Cartesian4</a></span>
</td>
<td class="description last">
The plane's normal (normalized).</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</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">
A new plane instance or the modified result parameter.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: Normal must be normalized
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fromPointNormal">
<a href="#.fromPointNormal" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Plane.fromPointNormal<span class="signature">(point, normal, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L83">Core/Plane.js 83</a>
</div>
</h4>
</div>
<div class="description">
Creates a plane from a normal and a point on the plane.
</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>point</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The point on the plane.</td>
</tr>
<tr>
<td class="name"><code>normal</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The plane's normal (normalized).</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</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">
A new plane instance or the modified result parameter.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: Normal must be normalized
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const point = Cesium.Cartesian3.fromDegrees(-72.0, 40.0);
const normal = ellipsoid.geodeticSurfaceNormal(point);
const tangentPlane = Cesium.Plane.fromPointNormal(point, normal);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".getPointDistance">
<a href="#.getPointDistance" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Plane.getPointDistance<span class="signature">(plane, point)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L158">Core/Plane.js 158</a>
</div>
</h4>
</div>
<div class="description">
Computes the signed shortest distance of a point to a plane.
The sign of the distance determines which side of the plane the point
is on. If the distance is positive, the point is in the half-space
in the direction of the normal; if negative, the point is in the half-space
opposite to the normal; if zero, the plane passes through the point.
</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.</td>
</tr>
<tr>
<td class="name"><code>point</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The point.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The signed shortest distance of the point to the plane.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".projectPointOntoPlane">
<a href="#.projectPointOntoPlane" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Plane.projectPointOntoPlane<span class="signature">(plane, point, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L175">Core/Plane.js 175</a>
</div>
</h4>
</div>
<div class="description">
Projects a point onto the plane.
</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 project the point onto</td>
</tr>
<tr>
<td class="name"><code>point</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The point to project onto the plane</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The result point. If undefined, a new Cartesian3 will be created.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new Cartesian3 instance if one was not provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".transform">
<a href="#.transform" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Plane.transform<span class="signature">(plane, transform, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Plane.html">Plane</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Plane.js#L207">Core/Plane.js 207</a>
</div>
</h4>
</div>
<div class="description">
Transforms the plane by the given transformation matrix.
</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.</td>
</tr>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
The transformation matrix.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Plane.html">Plane</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object into which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The plane transformed by the given transformation matrix.
</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>