qd-changjing/public/static/Build/Documentation/WebMercatorTilingScheme.html

1736 lines
70 KiB
HTML
Raw Normal View History

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>WebMercatorTilingScheme - 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>
WebMercatorTilingScheme
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="WebMercatorTilingScheme">
<a href="#WebMercatorTilingScheme" class="doc-link"></a>
new Cesium.WebMercatorTilingScheme<span class="signature">(<span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/WebMercatorTilingScheme.js#L31">Core/WebMercatorTilingScheme.js 31</a>
</div>
</h4>
</div>
<div class="description">
A tiling scheme for geometry referenced to a <a href="WebMercatorProjection.html"><code>WebMercatorProjection</code></a>, EPSG:3857. This is
the tiling scheme used by Google Maps, Microsoft Bing Maps, and most of ESRI ArcGIS Online.
</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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object with the following properties:
<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>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 whose surface is being tiled. Defaults to
the WGS84 ellipsoid.</td>
</tr>
<tr>
<td class="name"><code>numberOfLevelZeroTilesX</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">1</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The number of tiles in the X direction at level zero of
the tile tree.</td>
</tr>
<tr>
<td class="name"><code>numberOfLevelZeroTilesY</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">1</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The number of tiles in the Y direction at level zero of
the tile tree.</td>
</tr>
<tr>
<td class="name"><code>rectangleSouthwestInMeters</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The southwest corner of the rectangle covered by the
tiling scheme, in meters. If this parameter or rectangleNortheastInMeters is not specified, the entire
globe is covered in the longitude direction and an equal distance is covered in the latitude
direction, resulting in a square projection.</td>
</tr>
<tr>
<td class="name"><code>rectangleNortheastInMeters</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The northeast corner of the rectangle covered by the
tiling scheme, in meters. If this parameter or rectangleSouthwestInMeters is not specified, the entire
globe is covered in the longitude direction and an equal distance is covered in the latitude
direction, resulting in a square projection.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<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.91/Source/Core/WebMercatorTilingScheme.js#L84">Core/WebMercatorTilingScheme.js 84</a>
</div>
</h4>
</div>
<div class="description">
Gets the ellipsoid that is tiled by this tiling scheme.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="projection">
<a href="#projection" class="doc-link"></a>
projection<span class="type-signature"> : <a href="MapProjection.html">MapProjection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/WebMercatorTilingScheme.js#L106">Core/WebMercatorTilingScheme.js 106</a>
</div>
</h4>
</div>
<div class="description">
Gets the map projection used by this tiling scheme.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rectangle">
<a href="#rectangle" class="doc-link"></a>
rectangle<span class="type-signature"> : <a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/WebMercatorTilingScheme.js#L95">Core/WebMercatorTilingScheme.js 95</a>
</div>
</h4>
</div>
<div class="description">
Gets the rectangle, in radians, covered by this tiling scheme.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="getNumberOfXTilesAtLevel">
<a href="#getNumberOfXTilesAtLevel" class="doc-link"></a>
getNumberOfXTilesAtLevel<span class="signature">(level)</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/WebMercatorTilingScheme.js#L119">Core/WebMercatorTilingScheme.js 119</a>
</div>
</h4>
</div>
<div class="description">
Gets the total number of tiles in the X direction at a specified level-of-detail.
</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>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The level-of-detail.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The number of tiles in the X direction at the given level.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getNumberOfYTilesAtLevel">
<a href="#getNumberOfYTilesAtLevel" class="doc-link"></a>
getNumberOfYTilesAtLevel<span class="signature">(level)</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/WebMercatorTilingScheme.js#L129">Core/WebMercatorTilingScheme.js 129</a>
</div>
</h4>
</div>
<div class="description">
Gets the total number of tiles in the Y direction at a specified level-of-detail.
</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>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The level-of-detail.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The number of tiles in the Y direction at the given level.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="positionToTileXY">
<a href="#positionToTileXY" class="doc-link"></a>
positionToTileXY<span class="signature">(position, level, <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.91/Source/Core/WebMercatorTilingScheme.js#L251">Core/WebMercatorTilingScheme.js 251</a>
</div>
</h4>
</div>
<div class="description">
Calculates the tile x, y coordinates of the tile containing
a given cartographic position.
</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>position</code></td>
<td class="type">
<span class="param-type"><a href="Cartographic.html">Cartographic</a></span>
</td>
<td class="description last">
The position.</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 tile level-of-detail. Zero is the least detailed.</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 instance to which to copy the result, or undefined if a new instance
should be created.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The specified 'result', or a new object containing the tile x, y coordinates
if 'result' is undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rectangleToNativeRectangle">
<a href="#rectangleToNativeRectangle" class="doc-link"></a>
rectangleToNativeRectangle<span class="signature">(rectangle, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/WebMercatorTilingScheme.js#L143">Core/WebMercatorTilingScheme.js 143</a>
</div>
</h4>
</div>
<div class="description">
Transforms a rectangle specified in geodetic radians to the native coordinate system
of this tiling scheme.
</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>rectangle</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="description last">
The rectangle to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The instance to which to copy the result, or undefined if a new instance
should be created.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The specified 'result', or a new object containing the native rectangle if 'result'
is undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileXYToNativeRectangle">
<a href="#tileXYToNativeRectangle" class="doc-link"></a>
tileXYToNativeRectangle<span class="signature">(x, y, level, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/WebMercatorTilingScheme.js#L174">Core/WebMercatorTilingScheme.js 174</a>
</div>
</h4>
</div>
<div class="description">
Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates
of the tiling scheme.
</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The integer x coordinate of the tile.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The integer y coordinate of the tile.</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 tile level-of-detail. Zero is the least detailed.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The instance to which to copy the result, or undefined if a new instance
should be created.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The specified 'result', or a new object containing the rectangle
if 'result' is undefined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileXYToRectangle">
<a href="#tileXYToRectangle" class="doc-link"></a>
tileXYToRectangle<span class="signature">(x, y, level, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/WebMercatorTilingScheme.js#L217">Core/WebMercatorTilingScheme.js 217</a>
</div>
</h4>
</div>
<div class="description">
Converts tile x, y coordinates and level to a cartographic rectangle in radians.
</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The integer x coordinate of the tile.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The integer y coordinate of the tile.</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 tile level-of-detail. Zero is the least detailed.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The instance to which to copy the result, or undefined if a new instance
should be created.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The specified 'result', or a new object containing the rectangle
if 'result' is undefined.
</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>