qiusj
/
learning_cesium
0
0
Fork 0
Code Issues Issues Pull Requests Packages Projects Releases Wiki Wiki Activity
learning_cesium/Build168/Documentation/EllipsoidTangentPlane.html

1806 lines
66 KiB
HTML
Raw Normal View History

init project
2024-03-19 18:06:25 +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>EllipsoidTangentPlane - 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>
EllipsoidTangentPlane
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="EllipsoidTangentPlane">
<a href="#EllipsoidTangentPlane" class="doc-link"></a>
new Cesium.EllipsoidTangentPlane<span class="signature">(origin, <span class="optional">ellipsoid</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L29">Core/EllipsoidTangentPlane.js 29</a>
</div>
</h4>
</div>
<div class="description">
A plane tangent to the provided ellipsoid at the provided origin.
If origin is not on the surface of the ellipsoid, it's surface projection will be used.
If origin is at the center of the ellipsoid, an exception will be thrown.
</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>origin</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">
The point on the surface of the ellipsoid where the tangent plane touches.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
</td>
<td class="default">
<code class="language-javascript">Ellipsoid.WGS84</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The ellipsoid to use.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: origin must not be at the center of the ellipsoid.
</div>
</li>
</ul>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="ellipsoid">
<a href="#ellipsoid" class="doc-link"></a>
ellipsoid<span class="type-signature"> : <a href="Ellipsoid.html">Ellipsoid</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L59">Core/EllipsoidTangentPlane.js 59</a>
</div>
</h4>
</div>
<div class="description">
Gets the ellipsoid.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="origin">
<a href="#origin" class="doc-link"></a>
origin<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.68/Source/Core/EllipsoidTangentPlane.js#L70">Core/EllipsoidTangentPlane.js 70</a>
</div>
</h4>
</div>
<div class="description">
Gets the origin.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="plane">
<a href="#plane" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>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.68/Source/Core/EllipsoidTangentPlane.js#L82">Core/EllipsoidTangentPlane.js 82</a>
</div>
</h4>
</div>
<div class="description">
Gets the plane which is tangent to the ellipsoid.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="xAxis">
<a href="#xAxis" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>xAxis<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.68/Source/Core/EllipsoidTangentPlane.js#L94">Core/EllipsoidTangentPlane.js 94</a>
</div>
</h4>
</div>
<div class="description">
Gets the local X-axis (east) of the tangent plane.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="yAxis">
<a href="#yAxis" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>yAxis<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.68/Source/Core/EllipsoidTangentPlane.js#L106">Core/EllipsoidTangentPlane.js 106</a>
</div>
</h4>
</div>
<div class="description">
Gets the local Y-axis (north) of the tangent plane.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".fromPoints">
<a href="#.fromPoints" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.EllipsoidTangentPlane.fromPoints<span class="signature">(cartesians, <span class="optional">ellipsoid</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L133">Core/EllipsoidTangentPlane.js 133</a>
</div>
</h4>
</div>
<div class="description">
Creates a new instance from the provided ellipsoid and the center
point of the provided Cartesians.
</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>cartesians</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">
The list of positions surrounding the center point.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
</td>
<td class="default">
<code class="language-javascript">Ellipsoid.WGS84</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The ellipsoid to use.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="projectPointOntoEllipsoid">
<a href="#projectPointOntoEllipsoid" class="doc-link"></a>
projectPointOntoEllipsoid<span class="signature">(cartesian, <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.68/Source/Core/EllipsoidTangentPlane.js#L283">Core/EllipsoidTangentPlane.js 283</a>
</div>
</h4>
</div>
<div class="description">
Computes the projection of the provided 2D position onto the 3D ellipsoid.
</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>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="description last">
The points to project.</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 Cartesian3 instance to store result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new Cartesian3 instance if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="projectPointOntoPlane">
<a href="#projectPointOntoPlane" class="doc-link"></a>
projectPointOntoPlane<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L152">Core/EllipsoidTangentPlane.js 152</a>
</div>
</h4>
</div>
<div class="description">
Computes the projection of the provided 3D position onto the 2D plane, radially outward from the <code>EllipsoidTangentPlane.ellipsoid</code> coordinate system origin.
</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>cartesian</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.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</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 Cartesian2 instance if none was provided. Undefined if there is no intersection point
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="projectPointsOntoEllipsoid">
<a href="#projectPointsOntoEllipsoid" class="doc-link"></a>
projectPointsOntoEllipsoid<span class="signature">(cartesians, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L314">Core/EllipsoidTangentPlane.js 314</a>
</div>
</h4>
</div>
<div class="description">
Computes the projection of the provided 2D positions onto the 3D ellipsoid.
</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>cartesians</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian2.html">Cartesian2</a>></span>
</td>
<td class="description last">
The array of points to project.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The array of Cartesian3 instances onto which to store results.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new array of Cartesian3 instances if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="projectPointsOntoPlane">
<a href="#projectPointsOntoPlane" class="doc-link"></a>
projectPointsOntoPlane<span class="signature">(cartesians, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Cartesian2.html">Cartesian2</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L192">Core/EllipsoidTangentPlane.js 192</a>
</div>
</h4>
</div>
<div class="description">
Computes the projection of the provided 3D positions onto the 2D plane (where possible), radially outward from the global origin.
The resulting array may be shorter than the input array - if a single projection is impossible it will not be included.
</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>cartesians</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
</td>
<td class="description last">
The array of points to project.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian2.html">Cartesian2</a>></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The array of Cartesian2 instances onto which to store results.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new array of Cartesian2 instances if none was provided.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li>EllipsoidTangentPlane.projectPointOntoPlane</li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="projectPointsToNearestOnPlane">
<a href="#projectPointsToNearestOnPlane" class="doc-link"></a>
projectPointsToNearestOnPlane<span class="signature">(cartesians, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Cartesian2.html">Cartesian2</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L258">Core/EllipsoidTangentPlane.js 258</a>
</div>
</h4>
</div>
<div class="description">
Computes the projection of the provided 3D positions onto the 2D plane, along the plane normal.
</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>cartesians</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
</td>
<td class="description last">
The array of points to project.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian2.html">Cartesian2</a>></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The array of Cartesian2 instances onto which to store results.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new array of Cartesian2 instances if none was provided. This will have the same length as <code>cartesians</code>.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li>EllipsoidTangentPlane.projectPointToNearestOnPlane</li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="projectPointToNearestOnPlane">
<a href="#projectPointToNearestOnPlane" class="doc-link"></a>
projectPointToNearestOnPlane<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Core/EllipsoidTangentPlane.js#L221">Core/EllipsoidTangentPlane.js 221</a>
</div>
</h4>
</div>
<div class="description">
Computes the projection of the provided 3D position onto the 2D plane, along the plane normal.
</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>cartesian</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.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</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 Cartesian2 instance if none was provided.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</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="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-
</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>