295 lines
47 KiB
HTML
295 lines
47 KiB
HTML
|
<!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>sampleTerrain - 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>
|
||
|
|
sampleTerrain
|
||
|
|
<div class="titleCenterer"></div>
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="sampleTerrain">
|
||
|
|
<a href="#sampleTerrain" class="doc-link"></a>
|
||
|
|
sampleTerrain<span class="signature">(terrainProvider, level, positions)</span> → <span class="type-signature returnType">Promise.<Array.<<a href="Cartographic.html">Cartographic</a>>></span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/sampleTerrain.js#L45">Core/sampleTerrain.js 45</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Initiates a terrain height query for an array of <a href="Cartographic.html"><code>Cartographic</code></a> positions by
requesting tiles from a terrain provider, sampling, and interpolating. The interpolation
matches the triangles used to render the terrain at the specified level. The query
happens asynchronously, so this function returns a promise that is resolved when
the query completes. Each point height is modified in place. If a height can not be
determined because no terrain data is available for the specified level at that location,
or another error occurs, the height is set to undefined. As is typical of the
<a href="Cartographic.html"><code>Cartographic</code></a> type, the supplied height is a height above the reference ellipsoid
(such as <a href="Ellipsoid.html#.WGS84"><code>Ellipsoid.WGS84</code></a>) rather than an altitude above mean sea level. In other
words, it will not necessarily be 0.0 if sampled in the ocean. This function needs the
terrain level of detail as input, if you need to get the altitude of the terrain as precisely
as possible (i.e. with maximum level of detail) use <a href="sampleTerrainMostDetailed.html"><code>sampleTerrainMostDetailed</code></a>.
|
||
|
|
</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>terrainProvider</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><a href="TerrainProvider.html">TerrainProvider</a></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
|
||
|
|
The terrain provider from which to query heights.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>level</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">Number</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
|
||
|
|
The terrain level-of-detail from which to query terrain heights.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>positions</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">Array.<<a href="Cartographic.html">Cartographic</a>></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
|
||
|
|
The positions to update with terrain heights.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Returns:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
A promise that resolves to the provided list of positions when terrain the query has completed.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Example:</h5>
|
||
|
|
|
||
|
|
<pre><code class="language-javascript">// Query the terrain height of two Cartographic positions
var terrainProvider = Cesium.createWorldTerrain();
var positions = [
Cesium.Cartographic.fromDegrees(86.925145, 27.988257),
Cesium.Cartographic.fromDegrees(87.0, 28.0)
];
var promise = Cesium.sampleTerrain(terrainProvider, 11, positions);
Cesium.when(promise, function(updatedPositions) {
// positions[0].height and positions[1].height have been updated.
// updatedPositions is just a reference to positions.
});</code></pre>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>See:</h5>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="sampleTerrainMostDetailed.html">sampleTerrainMostDetailed</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</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="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-name="Cesium3DTileFeature"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></li><li data-name="Cesium3DTilePointFeature"><a href="Cesium3
|
||
|
|
</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>
|