cesium-examples/map/3d/static/Cesium/Build/Documentation/GoogleEarthEnterpriseMetada...

1234 lines
58 KiB
HTML
Raw Normal View History

<!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>GoogleEarthEnterpriseMetadata - 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>
GoogleEarthEnterpriseMetadata
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GoogleEarthEnterpriseMetadata">
<a href="#GoogleEarthEnterpriseMetadata" class="doc-link"></a>
new Cesium.GoogleEarthEnterpriseMetadata<span class="signature">(resourceOrUrl)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L64">Core/GoogleEarthEnterpriseMetadata.js 64</a>
</div>
</h4>
</div>
<div class="description">
Provides metadata using the Google Earth Enterprise REST API. This is used by the GoogleEarthEnterpriseImageryProvider and GoogleEarthEnterpriseTerrainProvider to share metadata requests.
</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>resourceOrUrl</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">String</span>
</td>
<td class="description last">
The url of the Google Earth Enterprise server hosting the imagery</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="GoogleEarthEnterpriseImageryProvider.html">GoogleEarthEnterpriseImageryProvider</a></li>
<li><a href="GoogleEarthEnterpriseTerrainProvider.html">GoogleEarthEnterpriseTerrainProvider</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="imageryPresent">
<a href="#imageryPresent" class="doc-link"></a>
imageryPresent<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L88">Core/GoogleEarthEnterpriseMetadata.js 88</a>
</div>
</h4>
</div>
<div class="description">
True if imagery is available.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="key">
<a href="#key" class="doc-link"></a>
key<span class="type-signature"> : ArrayBuffer</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L129">Core/GoogleEarthEnterpriseMetadata.js 129</a>
</div>
</h4>
</div>
<div class="description">
Key used to decode packets
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="negativeAltitudeExponentBias">
<a href="#negativeAltitudeExponentBias" class="doc-link"></a>
negativeAltitudeExponentBias<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L109">Core/GoogleEarthEnterpriseMetadata.js 109</a>
</div>
</h4>
</div>
<div class="description">
Exponent used to compute constant to calculate negative height values.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">32</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="negativeAltitudeThreshold">
<a href="#negativeAltitudeThreshold" class="doc-link"></a>
negativeAltitudeThreshold<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L116">Core/GoogleEarthEnterpriseMetadata.js 116</a>
</div>
</h4>
</div>
<div class="description">
Threshold where any numbers smaller are actually negative values. They are multiplied by -2^negativeAltitudeExponentBias.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">EPSILON12</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="protoImagery">
<a href="#protoImagery" class="doc-link"></a>
protoImagery<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L95">Core/GoogleEarthEnterpriseMetadata.js 95</a>
</div>
</h4>
</div>
<div class="description">
True if imagery is sent as a protocol buffer, false if sent as plain images. If undefined we will try both.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="providers">
<a href="#providers" class="doc-link"></a>
providers<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L123">Core/GoogleEarthEnterpriseMetadata.js 123</a>
</div>
</h4>
</div>
<div class="description">
Dictionary of provider id to copyright strings.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">{}</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="proxy">
<a href="#proxy" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>proxy<span class="type-signature"> : Proxy</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L169">Core/GoogleEarthEnterpriseMetadata.js 169</a>
</div>
</h4>
</div>
<div class="description">
Gets the proxy used for metadata requests.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="readyPromise">
<a href="#readyPromise" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>readyPromise<span class="type-signature"> : Promise.&lt;Boolean></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L193">Core/GoogleEarthEnterpriseMetadata.js 193</a>
</div>
</h4>
</div>
<div class="description">
Gets a promise that resolves to true when the metadata is ready for use.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="resource">
<a href="#resource" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>resource<span class="type-signature"> : <a href="Resource.html">Resource</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L181">Core/GoogleEarthEnterpriseMetadata.js 181</a>
</div>
</h4>
</div>
<div class="description">
Gets the resource used for metadata requests.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="terrainPresent">
<a href="#terrainPresent" class="doc-link"></a>
terrainPresent<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L102">Core/GoogleEarthEnterpriseMetadata.js 102</a>
</div>
</h4>
</div>
<div class="description">
True if terrain is available.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="url">
<a href="#url" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>url<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L157">Core/GoogleEarthEnterpriseMetadata.js 157</a>
</div>
</h4>
</div>
<div class="description">
Gets the name of the Google Earth Enterprise server.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".quadKeyToTileXY">
<a href="#.quadKeyToTileXY" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GoogleEarthEnterpriseMetadata.quadKeyToTileXY<span class="signature">(quadkey)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L247">Core/GoogleEarthEnterpriseMetadata.js 247</a>
</div>
</h4>
</div>
<div class="description">
Converts a tile's quadkey used to request an image from a Google Earth Enterprise server into the (x, y, level) 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>quadkey</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The tile's quad key</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li>GoogleEarthEnterpriseMetadata#tileXYToQuadKey</li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id=".tileXYToQuadKey">
<a href="#.tileXYToQuadKey" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.GoogleEarthEnterpriseMetadata.tileXYToQuadKey<span class="signature">(x, y, level)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/GoogleEarthEnterpriseMetadata.js#L210">Core/GoogleEarthEnterpriseMetadata.js 210</a>
</div>
</h4>
</div>
<div class="description">
Converts a tiles (x, y, level) position into a quadkey used to request an image from a Google Earth Enterprise server.
</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 tile's x coordinate.</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 tile's y coordinate.</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's zoom level.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li>GoogleEarthEnterpriseMetadata#quadKeyToTileXY</li>
</ul>
</dl>
</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>