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

1175 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>Cesium3DTileContent - 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>
Cesium3DTileContent
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Cesium3DTileContent">
<a href="#Cesium3DTileContent" class="doc-link"></a>
new Cesium.Cesium3DTileContent<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L22">Scene/Cesium3DTileContent.js 22</a>
</div>
</h4>
</div>
<div class="description">
The content of a tile in a <a href="Cesium3DTileset.html"><code>Cesium3DTileset</code></a>. <p> Derived classes of this interface provide access to individual features in the tile. Access derived objects through <a href="Cesium3DTile.html#content"><code>Cesium3DTile#content</code></a>. </p> <p> This type describes an interface and is not intended to be instantiated directly. </p>
</div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="batchTableByteLength">
<a href="#batchTableByteLength" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>batchTableByteLength<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L123">Scene/Cesium3DTileContent.js 123</a>
</div>
</h4>
</div>
<div class="description">
Gets the amount of memory used by the batch table textures, in bytes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="featuresLength">
<a href="#featuresLength" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>featuresLength<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L47">Scene/Cesium3DTileContent.js 47</a>
</div>
</h4>
</div>
<div class="description">
Gets the number of features in the tile.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="geometryByteLength">
<a href="#geometryByteLength" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>geometryByteLength<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L95">Scene/Cesium3DTileContent.js 95</a>
</div>
</h4>
</div>
<div class="description">
Gets the tile's geometry memory in bytes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="innerContents">
<a href="#innerContents" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>innerContents<span class="type-signature"> : Array</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L140">Scene/Cesium3DTileContent.js 140</a>
</div>
</h4>
</div>
<div class="description">
Gets the array of <a href="Cesium3DTileContent.html"><code>Cesium3DTileContent</code></a> objects that represent the content a composite's inner tiles, which can also be composites.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification/TileFormats/Composite">https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification/TileFormats/Composite</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="pointsLength">
<a href="#pointsLength" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>pointsLength<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L67">Scene/Cesium3DTileContent.js 67</a>
</div>
</h4>
</div>
<div class="description">
Gets the number of points in the tile. <p> Only applicable for tiles with Point Cloud content. This is different than <a href="Cesium3DTileContent.html#featuresLength"><code>Cesium3DTileContent#featuresLength</code></a> which equals the number of groups of points as distinguished by the <code>BATCH_ID</code> feature table semantic. </p>
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification/TileFormats/PointCloud#batched-points">https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification/TileFormats/PointCloud#batched-points</a></li>
</ul>
</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;<a href="Cesium3DTileContent.html">Cesium3DTileContent</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L154">Scene/Cesium3DTileContent.js 154</a>
</div>
</h4>
</div>
<div class="description">
Gets the promise that will be resolved when the tile's content is ready to render.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="texturesByteLength">
<a href="#texturesByteLength" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>texturesByteLength<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L109">Scene/Cesium3DTileContent.js 109</a>
</div>
</h4>
</div>
<div class="description">
Gets the tile's texture memory in bytes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tile">
<a href="#tile" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>tile<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/Cesium3DTileContent.js#L182">Scene/Cesium3DTileContent.js 182</a>
</div>
</h4>
</div>
<div class="description">
Gets the tile containing this content.
</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/Cesium3DTileContent.js#L168">Scene/Cesium3DTileContent.js 168</a>
</div>
</h4>
</div>
<div class="description">
Gets the tileset for this tile.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="trianglesLength">
<a href="#trianglesLength" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>trianglesLength<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L81">Scene/Cesium3DTileContent.js 81</a>
</div>
</h4>
</div>
<div class="description">
Gets the number of triangles in the tile.
</div>
<dl class="details">
</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/Scene/Cesium3DTileContent.js#L195">Scene/Cesium3DTileContent.js 195</a>
</div>
</h4>
</div>
<div class="description">
Gets the url of the tile's content.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="getFeature">
<a href="#getFeature" class="doc-link"></a>
getFeature<span class="signature">(batchId)</span> &rarr; <span class="type-signature returnType"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L247">Scene/Cesium3DTileContent.js 247</a>
</div>
</h4>
</div>
<div class="description">
Returns the <a href="Cesium3DTileFeature.html"><code>Cesium3DTileFeature</code></a> object for the feature with the given <code>batchId</code>. This object is used to get and modify the feature's properties. <p> Features in a tile are ordered by <code>batchId</code>, an index used to retrieve their metadata from the batch table. </p>
</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>batchId</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The batchId for the feature.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The corresponding <a href="Cesium3DTileFeature.html"><code>Cesium3DTileFeature</code></a> object.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: batchId must be between zero and <a href="Cesium3DTileContent.html#featuresLength"><code>Cesium3DTileContent#featuresLength</code></a> - 1.
</div>
</li>
</ul>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification/TileFormats/BatchTable">https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification/TileFormats/BatchTable</a>.</li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="hasProperty">
<a href="#hasProperty" class="doc-link"></a>
hasProperty<span class="signature">(batchId, name)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Scene/Cesium3DTileContent.js#L228">Scene/Cesium3DTileContent.js 228</a>
</div>
</h4>
</div>
<div class="description">
Determines if the tile's batch table has a property. If it does, each feature in the tile will have the property.
</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>batchId</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The batchId for the feature.</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The case-sensitive name of the property.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the property exists; otherwise, <code>false</code>.
</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>