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

854 lines
53 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>Cesium3DTile - 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>
Cesium3DTile
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Cesium3DTile">
<a href="#Cesium3DTile" class="doc-link"></a>
new Cesium.Cesium3DTile<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L91">Scene/Cesium3DTile.js 91</a>
</div>
</h4>
</div>
<div class="description">
A tile in a <a href="Cesium3DTileset.html"><code>Cesium3DTileset</code></a>. When a tile is first created, its content is not loaded; the content is loaded on-demand when needed based on the view. <p> Do not construct this directly, instead access tiles through <a href="Cesium3DTileset.html#tileVisible"><code>Cesium3DTileset#tileVisible</code></a>. </p>
</div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="boundingSphere">
<a href="#boundingSphere" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>boundingSphere<span class="type-signature"> : <a href="BoundingSphere.html">BoundingSphere</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L448">Scene/Cesium3DTile.js 448</a>
</div>
</h4>
</div>
<div class="description">
Get the bounding sphere derived from the tile's bounding volume.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="children">
<a href="#children" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>children<span class="type-signature"> : Array.&lt;<a href="Cesium3DTile.html">Cesium3DTile</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L179">Scene/Cesium3DTile.js 179</a>
</div>
</h4>
</div>
<div class="description">
Gets the tile's children.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="computedTransform">
<a href="#computedTransform" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>computedTransform<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L113">Scene/Cesium3DTile.js 113</a>
</div>
</h4>
</div>
<div class="description">
The final computed transform of this tile.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="content">
<a href="#content" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>content<span class="type-signature"> : <a href="Cesium3DTileContent.html">Cesium3DTileContent</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L402">Scene/Cesium3DTile.js 402</a>
</div>
</h4>
</div>
<div class="description">
The tile's content. This represents the actual tile's payload, not the content's metadata in the tileset JSON file.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="expireDate">
<a href="#expireDate" class="doc-link"></a>
expireDate<span class="type-signature"> : <a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L286">Scene/Cesium3DTile.js 286</a>
</div>
</h4>
</div>
<div class="description">
The date when the content expires and new content is requested.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="expireDuration">
<a href="#expireDuration" class="doc-link"></a>
expireDuration<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L279">Scene/Cesium3DTile.js 279</a>
</div>
</h4>
</div>
<div class="description">
The time in seconds after the tile's content is ready when the content expires and new content is requested.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="extras">
<a href="#extras" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>extras<span class="type-signature"> : *</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L464">Scene/Cesium3DTile.js 464</a>
</div>
</h4>
</div>
<div class="description">
Returns the <code>extras</code> property in the tileset JSON for this tile, which contains application specific metadata. Returns <code>undefined</code> if <code>extras</code> does not exist.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification#specifying-extensions-and-application-specific-extras">Extras in the 3D Tiles specification.</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="geometricError">
<a href="#geometricError" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>geometricError<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L144">Scene/Cesium3DTile.js 144</a>
</div>
</h4>
</div>
<div class="description">
The error, in meters, introduced if this tile is rendered and its children are not. This is used to compute screen space error, i.e., the error measured in pixels.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="parent">
<a href="#parent" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>parent<span class="type-signature"> : <a href="Cesium3DTile.html">Cesium3DTile</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L192">Scene/Cesium3DTile.js 192</a>
</div>
</h4>
</div>
<div class="description">
This tile's parent or <code>undefined</code> if this tile is the root. <p> When a tile's content points to an external tileset JSON file, the external tileset's root tile's parent is not <code>undefined</code>; instead, the parent references the tile (with its content pointing to an external tileset JSON file) as if the two tilesets were merged. </p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileset">
<a href="#tileset" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>tileset<span class="type-signature"> : <a href="Cesium3DTileset.html">Cesium3DTileset</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L387">Scene/Cesium3DTile.js 387</a>
</div>
</h4>
</div>
<div class="description">
The tileset containing this tile.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="transform">
<a href="#transform" class="doc-link"></a>
transform<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTile.js#L100">Scene/Cesium3DTile.js 100</a>
</div>
</h4>
</div>
<div class="description">
The local transform of this tile.
</div>
<dl class="details">
</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>