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

1788 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>EllipsoidRhumbLine - 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>
EllipsoidRhumbLine
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="EllipsoidRhumbLine">
<a href="#EllipsoidRhumbLine" class="doc-link"></a>
new Cesium.EllipsoidRhumbLine<span class="signature">(<span class="optional">start</span>, <span class="optional">end</span>, <span class="optional">ellipsoid</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L386">Core/EllipsoidRhumbLine.js 386</a>
</div>
</h4>
</div>
<div class="description">
Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.
</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>start</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The initial planetodetic point on the path.</td>
</tr>
<tr>
<td class="name"><code>end</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The final planetodetic point on the path.</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 on which the rhumb line lies.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: angle between start and end must be at least 0.0125 radians.
</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>
<span class="type-signature attribute-readonly">readonly</span> 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.91/Source/Core/EllipsoidRhumbLine.js#L409">Core/EllipsoidRhumbLine.js 409</a>
</div>
</h4>
</div>
<div class="description">
Gets the ellipsoid.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="end">
<a href="#end" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> end<span class="type-signature"> : <a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L449">Core/EllipsoidRhumbLine.js 449</a>
</div>
</h4>
</div>
<div class="description">
Gets the final planetodetic point on the path.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="heading">
<a href="#heading" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> heading<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L461">Core/EllipsoidRhumbLine.js 461</a>
</div>
</h4>
</div>
<div class="description">
Gets the heading from the start point to the end point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="start">
<a href="#start" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> start<span class="type-signature"> : <a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L437">Core/EllipsoidRhumbLine.js 437</a>
</div>
</h4>
</div>
<div class="description">
Gets the initial planetodetic point on the path.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="surfaceDistance">
<a href="#surfaceDistance" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> surfaceDistance<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L421">Core/EllipsoidRhumbLine.js 421</a>
</div>
</h4>
</div>
<div class="description">
Gets the surface distance between the start and end point
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".fromStartHeadingDistance">
<a href="#.fromStartHeadingDistance" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.EllipsoidRhumbLine.fromStartHeadingDistance<span class="signature">(start, heading, distance, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="EllipsoidRhumbLine.html">EllipsoidRhumbLine</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L482">Core/EllipsoidRhumbLine.js 482</a>
</div>
</h4>
</div>
<div class="description">
Create a rhumb line using an initial position with a heading and distance.
</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>start</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The initial planetodetic point on the path.</td>
</tr>
<tr>
<td class="name"><code>heading</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
The heading in radians.</td>
</tr>
<tr>
<td class="name"><code>distance</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
The rhumb line distance between the start and end 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 on which the rhumb line lies.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="EllipsoidRhumbLine.html">EllipsoidRhumbLine</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The object in which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The EllipsoidRhumbLine object.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="findIntersectionWithLatitude">
<a href="#findIntersectionWithLatitude" class="doc-link"></a>
findIntersectionWithLatitude<span class="signature">(intersectionLatitude, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L701">Core/EllipsoidRhumbLine.js 701</a>
</div>
</h4>
</div>
<div class="description">
Provides the location of a point at the indicated latitude along the rhumb line.
If the latitude is outside the range of start and end points, the first intersection with the latitude from that start point in the direction of the heading is returned. This follows the spiral property of a rhumb line.
</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>intersectionLatitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The latitude, in radians, at which to find the intersection point from the starting point using the heading.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object in which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: start and end must be set before calling function findIntersectionWithLongitude.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="findIntersectionWithLongitude">
<a href="#findIntersectionWithLongitude" class="doc-link"></a>
findIntersectionWithLongitude<span class="signature">(intersectionLongitude, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L597">Core/EllipsoidRhumbLine.js 597</a>
</div>
</h4>
</div>
<div class="description">
Provides the location of a point at the indicated longitude along the rhumb line.
If the longitude is outside the range of start and end points, the first intersection with the longitude from the start point in the direction of the heading is returned. This follows the spiral property of a rhumb line.
</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>intersectionLongitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The longitude, in radians, at which to find the intersection point from the starting point using the heading.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object in which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: start and end must be set before calling function findIntersectionWithLongitude.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="interpolateUsingFraction">
<a href="#interpolateUsingFraction" class="doc-link"></a>
interpolateUsingFraction<span class="signature">(fraction, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L545">Core/EllipsoidRhumbLine.js 545</a>
</div>
</h4>
</div>
<div class="description">
Provides the location of a point at the indicated portion along the rhumb line.
</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>fraction</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The portion of the distance between the initial and final points.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object in which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The location of the point along the rhumb line.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="interpolateUsingSurfaceDistance">
<a href="#interpolateUsingSurfaceDistance" class="doc-link"></a>
interpolateUsingSurfaceDistance<span class="signature">(distance, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L564">Core/EllipsoidRhumbLine.js 564</a>
</div>
</h4>
</div>
<div class="description">
Provides the location of a point at the indicated distance along the rhumb line.
</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>distance</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The distance from the inital point to the point of interest along the rhumbLine.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object in which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The location of the point along the rhumb line.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: start and end must be set before calling function interpolateUsingSurfaceDistance
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="setEndPoints">
<a href="#setEndPoints" class="doc-link"></a>
setEndPoints<span class="signature">(start, end)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/EllipsoidRhumbLine.js#L529">Core/EllipsoidRhumbLine.js 529</a>
</div>
</h4>
</div>
<div class="description">
Sets the start and end points of the rhumb line.
</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>start</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
The initial planetodetic point on the path.</td>
</tr>
<tr>
<td class="name"><code>end</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
The final planetodetic point on the path.</td>
</tr>
</tbody>
</table>
<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>