wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/Cesium3DTileset.html

8498 lines
190 KiB
HTML
Raw Normal View History

first commit
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>Cesium3DTileset - 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>
Cesium3DTileset
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Cesium3DTileset">
<a href="#Cesium3DTileset" class="doc-link"></a>
new Cesium.Cesium3DTileset<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L150">Scene/Cesium3DTileset.js 150</a>
</div>
</h4>
</div>
<div class="description">
A <a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification">3D Tiles tileset</a>,
used for streaming massive heterogeneous 3D geospatial datasets.
</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">
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>url</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">String</span>
|
<span class="param-type">Promise.&lt;<a href="Resource.html">Resource</a>></span>
|
<span class="param-type">Promise.&lt;String></span>
</td>
<td class="default">
</td>
<td class="description last">
The url to a tileset JSON file.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determines if the tileset will be shown.</td>
</tr>
<tr>
<td class="name"><code>modelMatrix</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="default">
<code class="language-javascript">Matrix4.IDENTITY</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A 4x4 transformation matrix that transforms the tileset's root tile.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ShadowMode">ShadowMode</a></span>
</td>
<td class="default">
<code class="language-javascript">ShadowMode.ENABLED</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determines whether the tileset casts or receives shadows from light sources.</td>
</tr>
<tr>
<td class="name"><code>maximumScreenSpaceError</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">16</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum screen space error used to drive level of detail refinement.</td>
</tr>
<tr>
<td class="name"><code>maximumMemoryUsage</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">512</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum amount of memory in MB that can be used by the tileset.</td>
</tr>
<tr>
<td class="name"><code>cullWithChildrenBounds</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Whether to cull tiles using the union of their children bounding volumes.</td>
</tr>
<tr>
<td class="name"><code>cullRequestsWhileMoving</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Don't request tiles that will likely be unused when they come back because of the camera's movement. This optimization only applies to stationary tilesets.</td>
</tr>
<tr>
<td class="name"><code>cullRequestsWhileMovingMultiplier</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">60.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.</td>
</tr>
<tr>
<td class="name"><code>preloadWhenHidden</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Preload tiles when <code>tileset.show</code> is <code>false</code>. Loads tiles as if the tileset is visible but does not render them.</td>
</tr>
<tr>
<td class="name"><code>preloadFlightDestinations</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Preload tiles at the camera's flight destination while the camera is in flight.</td>
</tr>
<tr>
<td class="name"><code>preferLeaves</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Prefer loading of leaves first.</td>
</tr>
<tr>
<td class="name"><code>dynamicScreenSpaceError</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Reduce the screen space error for tiles that are further away from the camera.</td>
</tr>
<tr>
<td class="name"><code>dynamicScreenSpaceErrorDensity</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.00278</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Density used to adjust the dynamic screen space error, similar to fog density.</td>
</tr>
<tr>
<td class="name"><code>dynamicScreenSpaceErrorFactor</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">4.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A factor used to increase the computed dynamic screen space error.</td>
</tr>
<tr>
<td class="name"><code>dynamicScreenSpaceErrorHeightFalloff</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.25</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A ratio of the tileset's height at which the density starts to falloff.</td>
</tr>
<tr>
<td class="name"><code>progressiveResolutionHeightFraction</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.3</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of <code>progressiveResolutionHeightFraction*screenHeight</code> will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.</td>
</tr>
<tr>
<td class="name"><code>foveatedScreenSpaceError</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the screen space error for tiles around the edge of the screen. Screen space error returns to normal once all the tiles in the center of the screen as determined by the <a href="Cesium3DTileset.html#foveatedConeSize"><code>Cesium3DTileset#foveatedConeSize</code></a> are loaded.</td>
</tr>
<tr>
<td class="name"><code>foveatedConeSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.1</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control the cone size that determines which tiles are deferred. Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and their screen space error. This is controlled by <a href="Cesium3DTileset.html#foveatedInterpolationCallback"><code>Cesium3DTileset#foveatedInterpolationCallback</code></a> and <a href="Cesium3DTileset.html#foveatedMinimumScreenSpaceErrorRelaxation"><code>Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation</code></a>. Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, disabling the effect.</td>
</tr>
<tr>
<td class="name"><code>foveatedMinimumScreenSpaceErrorRelaxation</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control the starting screen space error relaxation for tiles outside the foveated cone. The screen space error will be raised starting with tileset value up to <a href="Cesium3DTileset.html#maximumScreenSpaceError"><code>Cesium3DTileset#maximumScreenSpaceError</code></a> based on the provided <a href="Cesium3DTileset.html#foveatedInterpolationCallback"><code>Cesium3DTileset#foveatedInterpolationCallback</code></a>.</td>
</tr>
<tr>
<td class="name"><code>foveatedInterpolationCallback</code></td>
<td class="type">
<span class="param-type"><a href="Cesium3DTileset.html#.foveatedInterpolationCallback">Cesium3DTileset.foveatedInterpolationCallback</a></span>
</td>
<td class="default">
<code class="language-javascript">Math.lerp</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between <a href="Cesium3DTileset.html#foveatedMinimumScreenSpaceErrorRelaxation"><code>Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation</code></a> and <a href="Cesium3DTileset.html#maximumScreenSpaceError"><code>Cesium3DTileset#maximumScreenSpaceError</code></a></td>
</tr>
<tr>
<td class="name"><code>foveatedTimeDelay</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.2</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control how long in seconds to wait after the camera stops moving before deferred tiles start loading in. This time delay prevents requesting tiles around the edges of the screen when the camera is moving. Setting this to 0.0 will immediately request all tiles in any given view.</td>
</tr>
<tr>
<td class="name"><code>skipLevelOfDetail</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Optimization option. Determines if level of detail skipping should be applied during the traversal.</td>
</tr>
<tr>
<td class="name"><code>baseScreenSpaceError</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">1024</code>
</td>
<td class="description last">
<span class="optional">optional</span>
When <code>skipLevelOfDetail</code> is <code>true</code>, the screen space error that must be reached before skipping levels of detail.</td>
</tr>
<tr>
<td class="name"><code>skipScreenSpaceErrorFactor</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">16</code>
</td>
<td class="description last">
<span class="optional">optional</span>
When <code>skipLevelOfDetail</code> is <code>true</code>, a multiplier defining the minimum screen space error to skip. Used in conjunction with <code>skipLevels</code> to determine which tiles to load.</td>
</tr>
<tr>
<td class="name"><code>skipLevels</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>
When <code>skipLevelOfDetail</code> is <code>true</code>, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with <code>skipScreenSpaceErrorFactor</code> to determine which tiles to load.</td>
</tr>
<tr>
<td class="name"><code>immediatelyLoadDesiredLevelOfDetail</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
When <code>skipLevelOfDetail</code> is <code>true</code>, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded.</td>
</tr>
<tr>
<td class="name"><code>loadSiblings</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
When <code>skipLevelOfDetail</code> is <code>true</code>, determines whether siblings of visible tiles are always downloaded during traversal.</td>
</tr>
<tr>
<td class="name"><code>clippingPlanes</code></td>
<td class="type">
<span class="param-type"><a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The <a href="ClippingPlaneCollection.html"><code>ClippingPlaneCollection</code></a> used to selectively disable rendering the tileset.</td>
</tr>
<tr>
<td class="name"><code>classificationType</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ClassificationType">ClassificationType</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Determines whether terrain, 3D Tiles or both will be classified by this tileset. See <a href="Cesium3DTileset.html#classificationType"><code>Cesium3DTileset#classificationType</code></a> for details about restrictions and limitations.</td>
</tr>
<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 determining the size and shape of the globe.</td>
</tr>
<tr>
<td class="name"><code>pointCloudShading</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Options for constructing a <a href="PointCloudShading.html"><code>PointCloudShading</code></a> object to control point attenuation based on geometric error and lighting.</td>
</tr>
<tr>
<td class="name"><code>imageBasedLightingFactor</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
<code class="language-javascript">new Cartesian2(1.0, 1.0)</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Scales the diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox.</td>
</tr>
<tr>
<td class="name"><code>lightColor</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The light color when shading models. When <code>undefined</code> the scene's light color is used instead.</td>
</tr>
<tr>
<td class="name"><code>luminanceAtZenith</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.2</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.</td>
</tr>
<tr>
<td class="name"><code>sphericalHarmonicCoefficients</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.</td>
</tr>
<tr>
<td class="name"><code>specularEnvironmentMaps</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.</td>
</tr>
<tr>
<td class="name"><code>backFaceCulling</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to cull back-facing geometry. When true, back face culling is determined by the glTF material's doubleSided property; when false, back face culling is disabled.</td>
</tr>
<tr>
<td class="name"><code>showOutline</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to display the outline for models using the <a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline">CESIUM_primitive_outline</a> extension. When true, outlines are displayed. When false, outlines are not displayed.</td>
</tr>
<tr>
<td class="name"><code>vectorClassificationOnly</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Indicates that only the tileset's vector tiles should be used for classification.</td>
</tr>
<tr>
<td class="name"><code>vectorKeepDecodedPositions</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether vector tiles should keep decoded positions in memory. This is used with <code>Cesium3DTileFeature.getPolylinePositions</code>.</td>
</tr>
<tr>
<td class="name"><code>featureIdIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The index into the list of primitive feature IDs used for picking and styling. For EXT_feature_metadata, feature ID attributes are listed before feature ID textures. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.</td>
</tr>
<tr>
<td class="name"><code>instanceFeatureIdIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The index into the list of instance feature IDs used for picking and styling. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.</td>
</tr>
<tr>
<td class="name"><code>showCreditsOnScreen</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to display the credits of this tileset on screen.</td>
</tr>
<tr>
<td class="name"><code>debugHeatmapTilePropertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The tile variable to colorize as a heatmap. All rendered tiles will be colorized relative to each other's specified variable value.</td>
</tr>
<tr>
<td class="name"><code>debugFreezeFrame</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. Determines if only the tiles from last frame should be used for rendering.</td>
</tr>
<tr>
<td class="name"><code>debugColorizeTiles</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, assigns a random color to each tile.</td>
</tr>
<tr>
<td class="name"><code>debugWireframe</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, render's each tile's content as a wireframe.</td>
</tr>
<tr>
<td class="name"><code>debugShowBoundingVolume</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, renders the bounding volume for each tile.</td>
</tr>
<tr>
<td class="name"><code>debugShowContentBoundingVolume</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, renders the bounding volume for each tile's content.</td>
</tr>
<tr>
<td class="name"><code>debugShowViewerRequestVolume</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, renders the viewer request volume for each tile.</td>
</tr>
<tr>
<td class="name"><code>debugShowGeometricError</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, draws labels to indicate the geometric error of each tile.</td>
</tr>
<tr>
<td class="name"><code>debugShowRenderingStatistics</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.</td>
</tr>
<tr>
<td class="name"><code>debugShowMemoryUsage</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.</td>
</tr>
<tr>
<td class="name"><code>debugShowUrl</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
For debugging only. When true, draws labels to indicate the url of each tile.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: The tileset must be 3D Tiles version 0.0 or 1.0.
</div>
</li>
</ul>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({
url : 'http://localhost:8002/tilesets/Seattle/tileset.json'
}));</code></pre>
<pre><code class="language-javascript">// Common setting for the skipLevelOfDetail optimization
const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({
url : 'http://localhost:8002/tilesets/Seattle/tileset.json',
skipLevelOfDetail : true,
baseScreenSpaceError : 1024,
skipScreenSpaceErrorFactor : 16,
skipLevels : 1,
immediatelyLoadDesiredLevelOfDetail : false,
loadSiblings : false,
cullWithChildrenBounds : true
}));</code></pre>
<pre><code class="language-javascript">// Common settings for the dynamicScreenSpaceError optimization
const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({
url : 'http://localhost:8002/tilesets/Seattle/tileset.json',
dynamicScreenSpaceError : true,
dynamicScreenSpaceErrorDensity : 0.00278,
dynamicScreenSpaceErrorFactor : 4.0,
dynamicScreenSpaceErrorHeightFalloff : 0.25
}));</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification">3D Tiles specification</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="allTilesLoaded">
<a href="#allTilesLoaded" class="doc-link"></a>
allTilesLoaded<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L508">Scene/Cesium3DTileset.js 508</a>
</div>
</h4>
</div>
<div class="description">
The event fired to indicate that all tiles that meet the screen space error this frame are loaded. The tileset
is completely loaded for this view.
<p>
This event is fired at the end of the frame after the scene is rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.allTilesLoaded.addEventListener(function() {
console.log('All tiles are loaded');
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#tilesLoaded">Cesium3DTileset#tilesLoaded</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="asset">
<a href="#asset" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> asset<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1114">Scene/Cesium3DTileset.js 1114</a>
</div>
</h4>
</div>
<div class="description">
Gets the tileset's asset object property, which contains metadata about the tileset.
<p>
See the <a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification#reference-asset">asset schema reference</a>
in the 3D Tiles spec for the full set of properties.
</p>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="backFaceCulling">
<a href="#backFaceCulling" class="doc-link"></a>
backFaceCulling<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L785">Scene/Cesium3DTileset.js 785</a>
</div>
</h4>
</div>
<div class="description">
Whether to cull back-facing geometry. When true, back face culling is determined
by the glTF material's doubleSided property; when false, back face culling is disabled.
</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="basePath">
<a href="#basePath" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> <span class="type-signature attribute-deprecated">deprecated</span> basePath<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1290">Scene/Cesium3DTileset.js 1290</a>
</div>
</h4>
</div>
<div class="description">
The base path that non-absolute paths in tileset JSON file are relative to.
</div>
<dl class="details">
<p>
<span class="details-header important">Deprecated:</span>
<span>true</span>
</p>
</dl>
<div class="nameContainer">
<h4 class="name" id="baseScreenSpaceError">
<a href="#baseScreenSpaceError" class="doc-link"></a>
baseScreenSpaceError<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L662">Scene/Cesium3DTileset.js 662</a>
</div>
</h4>
</div>
<div class="description">
The screen space error that must be reached before skipping levels of detail.
<p>
Only used when <a href="Cesium3DTileset.html#skipLevelOfDetail"><code>Cesium3DTileset#skipLevelOfDetail</code></a> is <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1024</code>
</dl>
<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/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1519">Scene/Cesium3DTileset.js 1519</a>
</div>
</h4>
</div>
<div class="description">
The tileset's bounding sphere.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const tileset = viewer.scene.primitives.add(new Cesium.Cesium3DTileset({
url : 'http://localhost:8002/tilesets/Seattle/tileset.json'
}));
tileset.readyPromise.then(function(tileset) {
// Set the camera to view the newly added tileset
viewer.camera.viewBoundingSphere(tileset.boundingSphere, new Cesium.HeadingPitchRange(0, -0.5, 0));
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="classificationType">
<a href="#classificationType" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> classificationType<span class="type-signature"> : <a href="global.html#ClassificationType">ClassificationType</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1665">Scene/Cesium3DTileset.js 1665</a>
</div>
</h4>
</div>
<div class="description">
Determines whether terrain, 3D Tiles or both will be classified by this tileset.
<p>
This option is only applied to tilesets containing batched 3D models, geometry data, or vector data. Even when undefined, vector data and geometry data
must render as classifications and will default to rendering on both terrain and other 3D Tiles tilesets.
</p>
<p>
When enabled for batched 3D model tilesets, there are a few requirements/limitations on the glTF:
<ul>
<li>POSITION and _BATCHID semantics are required.</li>
<li>All indices with the same batch id must occupy contiguous sections of the index buffer.</li>
<li>All shaders and techniques are ignored. The generated shader simply multiplies the position by the model-view-projection matrix.</li>
<li>The only supported extensions are CESIUM_RTC and WEB3D_quantized_attributes.</li>
<li>Only one node is supported.</li>
<li>Only one mesh per node is supported.</li>
<li>Only one primitive per mesh is supported.</li>
</ul>
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="clippingPlanes">
<a href="#clippingPlanes" class="doc-link"></a>
clippingPlanes<span class="type-signature"> : <a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1159">Scene/Cesium3DTileset.js 1159</a>
</div>
</h4>
</div>
<div class="description">
The <a href="ClippingPlaneCollection.html"><code>ClippingPlaneCollection</code></a> used to selectively disable rendering the tileset.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="colorBlendAmount">
<a href="#colorBlendAmount" class="doc-link"></a>
colorBlendAmount<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L459">Scene/Cesium3DTileset.js 459</a>
</div>
</h4>
</div>
<div class="description">
Defines the value used to linearly interpolate between the source color and feature color when the <a href="Cesium3DTileset.html#colorBlendMode"><code>Cesium3DTileset#colorBlendMode</code></a> is <code>MIX</code>.
A value of 0.0 results in the source color while a value of 1.0 results in the feature color, with any value in-between
resulting in a mix of the source color and feature color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.5</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="colorBlendMode">
<a href="#colorBlendMode" class="doc-link"></a>
colorBlendMode<span class="type-signature"> : <a href="global.html#Cesium3DTileColorBlendMode">Cesium3DTileColorBlendMode</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L449">Scene/Cesium3DTileset.js 449</a>
</div>
</h4>
</div>
<div class="description">
Defines how per-feature colors set from the Cesium API or declarative styling blend with the source colors from
the original feature, e.g. glTF material or per-point color in the tile.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Cesium3DTileColorBlendMode.HIGHLIGHT</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="cullRequestsWhileMoving">
<a href="#cullRequestsWhileMoving" class="doc-link"></a>
cullRequestsWhileMoving<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L239">Scene/Cesium3DTileset.js 239</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Don't request tiles that will likely be unused when they come back because of the camera's movement. This optimization only applies to stationary tilesets.
</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="cullRequestsWhileMovingMultiplier">
<a href="#cullRequestsWhileMovingMultiplier" class="doc-link"></a>
cullRequestsWhileMovingMultiplier<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L251">Scene/Cesium3DTileset.js 251</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">60.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="customShader">
<a href="#customShader" class="doc-link"></a>
customShader<span class="type-signature"> : <a href="CustomShader.html">CustomShader</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1370">Scene/Cesium3DTileset.js 1370</a>
</div>
</h4>
</div>
<div class="description">
A custom shader to apply to all tiles in the tileset. Only used for
contents that use <a href="ModelExperimental.html"><code>ModelExperimental</code></a>. Using custom shaders with a
<a href="Cesium3DTileStyle.html"><code>Cesium3DTileStyle</code></a> may lead to undefined behavior.
<p>
To enable <a href="ModelExperimental.html"><code>ModelExperimental</code></a>, set <a href="global.html#ExperimentalFeatures#.enableModelExperimental"><code>ExperimentalFeatures.enableModelExperimental</code></a> or tileset.enableModelExperimental to <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugColorizeTiles">
<a href="#debugColorizeTiles" class="doc-link"></a>
debugColorizeTiles<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L823">Scene/Cesium3DTileset.js 823</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, assigns a random color to each tile. This is useful for visualizing
what features belong to what tiles, especially with additive refinement where features
from parent tiles may be interleaved with features from child tiles.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugFreezeFrame">
<a href="#debugFreezeFrame" class="doc-link"></a>
debugFreezeFrame<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L810">Scene/Cesium3DTileset.js 810</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
Determines if only the tiles from last frame should be used for rendering. This
effectively "freezes" the tileset to the previous frame so it is possible to zoom
out and see what was rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowBoundingVolume">
<a href="#debugShowBoundingVolume" class="doc-link"></a>
debugShowBoundingVolume<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L847">Scene/Cesium3DTileset.js 847</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, renders the bounding volume for each visible tile. The bounding volume is
white if the tile has a content bounding volume or is empty; otherwise, it is red. Tiles that don't meet the
screen space error and are still refining to their descendants are yellow.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowContentBoundingVolume">
<a href="#debugShowContentBoundingVolume" class="doc-link"></a>
debugShowContentBoundingVolume<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L862">Scene/Cesium3DTileset.js 862</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, renders the bounding volume for each visible tile's content. The bounding volume is
blue if the tile has a content bounding volume; otherwise it is red.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowGeometricError">
<a href="#debugShowGeometricError" class="doc-link"></a>
debugShowGeometricError<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L895">Scene/Cesium3DTileset.js 895</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, draws labels to indicate the geometric error of each tile.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowMemoryUsage">
<a href="#debugShowMemoryUsage" class="doc-link"></a>
debugShowMemoryUsage<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L923">Scene/Cesium3DTileset.js 923</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, draws labels to indicate the geometry and texture memory usage of each tile.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowRenderingStatistics">
<a href="#debugShowRenderingStatistics" class="doc-link"></a>
debugShowRenderingStatistics<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L909">Scene/Cesium3DTileset.js 909</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, draws labels to indicate the number of commands, points, triangles and features of each tile.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowUrl">
<a href="#debugShowUrl" class="doc-link"></a>
debugShowUrl<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L934">Scene/Cesium3DTileset.js 934</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, draws labels to indicate the url of each tile.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowViewerRequestVolume">
<a href="#debugShowViewerRequestVolume" class="doc-link"></a>
debugShowViewerRequestVolume<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L876">Scene/Cesium3DTileset.js 876</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, renders the viewer request volume for each tile.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="debugWireframe">
<a href="#debugWireframe" class="doc-link"></a>
debugWireframe<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L834">Scene/Cesium3DTileset.js 834</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not optimized for production use.
<p>
When true, renders each tile's content as a wireframe.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="dynamicScreenSpaceError">
<a href="#dynamicScreenSpaceError" class="doc-link"></a>
dynamicScreenSpaceError<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L331">Scene/Cesium3DTileset.js 331</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Whether the tileset should refine based on a dynamic screen space error. Tiles that are further
away will be rendered with lower detail than closer tiles. This improves performance by rendering fewer
tiles and making less requests, but may result in a slight drop in visual quality for tiles in the distance.
The algorithm is biased towards "street views" where the camera is close to the ground plane of the tileset and looking
at the horizon. In addition results are more accurate for tightly fitting bounding volumes like box and region.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="dynamicScreenSpaceErrorDensity">
<a href="#dynamicScreenSpaceErrorDensity" class="doc-link"></a>
dynamicScreenSpaceErrorDensity<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L394">Scene/Cesium3DTileset.js 394</a>
</div>
</h4>
</div>
<div class="description">
A scalar that determines the density used to adjust the dynamic screen space error, similar to <a href="Fog.html"><code>Fog</code></a>. Increasing this
value has the effect of increasing the maximum screen space error for all tiles, but in a non-linear fashion.
The error starts at 0.0 and increases exponentially until a midpoint is reached, and then approaches 1.0 asymptotically.
This has the effect of keeping high detail in the closer tiles and lower detail in the further tiles, with all tiles
beyond a certain distance all roughly having an error of 1.0.
<p>
The dynamic error is in the range [0.0, 1.0) and is multiplied by <code>dynamicScreenSpaceErrorFactor</code> to produce the
final dynamic error. This dynamic error is then subtracted from the tile's actual screen space error.
</p>
<p>
Increasing <code>dynamicScreenSpaceErrorDensity</code> has the effect of moving the error midpoint closer to the camera.
It is analogous to moving fog closer to the camera.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.00278</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="dynamicScreenSpaceErrorFactor">
<a href="#dynamicScreenSpaceErrorFactor" class="doc-link"></a>
dynamicScreenSpaceErrorFactor<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L403">Scene/Cesium3DTileset.js 403</a>
</div>
</h4>
</div>
<div class="description">
A factor used to increase the screen space error of tiles for dynamic screen space error. As this value increases less tiles
are requested for rendering and tiles in the distance will have lower detail. If set to zero, the feature will be disabled.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">4.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="dynamicScreenSpaceErrorHeightFalloff">
<a href="#dynamicScreenSpaceErrorHeightFalloff" class="doc-link"></a>
dynamicScreenSpaceErrorHeightFalloff<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L416">Scene/Cesium3DTileset.js 416</a>
</div>
</h4>
</div>
<div class="description">
A ratio of the tileset's height at which the density starts to falloff. If the camera is below this height the
full computed density is applied, otherwise the density falls off. This has the effect of higher density at
street level views.
<p>
Valid values are between 0.0 and 1.0.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.25</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="ellipsoid">
<a href="#ellipsoid" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> 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/Scene/Cesium3DTileset.js#L1679">Scene/Cesium3DTileset.js 1679</a>
</div>
</h4>
</div>
<div class="description">
Gets an ellipsoid describing the shape of the globe.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="enableModelExperimental">
<a href="#enableModelExperimental" class="doc-link"></a>
enableModelExperimental<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L966">Scene/Cesium3DTileset.js 966</a>
</div>
</h4>
</div>
<div class="description">
If true, <a href="ModelExperimental.html"><code>ModelExperimental</code></a> will be used instead of <a href="Model.html"><code>Model</code></a>
for each tile with a glTF or 3D Tiles 1.0 content (where applicable).
<p>
The value defaults to <a href="global.html#ExperimentalFeatures#.enableModelExperimental"><code>ExperimentalFeatures.enableModelExperimental</code></a>.
</p>
</div>
<dl class="details">
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="examineVectorLinesFunction">
<a href="#examineVectorLinesFunction" class="doc-link"></a>
examineVectorLinesFunction<span class="type-signature"> : function</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L943">Scene/Cesium3DTileset.js 943</a>
</div>
</h4>
</div>
<div class="description">
Function for examining vector lines as they are being streamed.
</div>
<dl class="details">
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="extensions">
<a href="#extensions" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> extensions<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1138">Scene/Cesium3DTileset.js 1138</a>
</div>
</h4>
</div>
<div class="description">
Gets the tileset's extensions object property.
</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/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1753">Scene/Cesium3DTileset.js 1753</a>
</div>
</h4>
</div>
<div class="description">
Returns the <code>extras</code> property at the top-level of the tileset JSON, 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/CesiumGS/3d-tiles/tree/main/specification#specifying-extensions-and-application-specific-extras">Extras in the 3D Tiles specification.</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="featureIdIndex">
<a href="#featureIdIndex" class="doc-link"></a>
featureIdIndex<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L980">Scene/Cesium3DTileset.js 980</a>
</div>
</h4>
</div>
<div class="description">
The index into the list of primitive feature IDs used for picking and
styling. For EXT_feature_metadata, feature ID attributes are listed before
feature ID textures. If both per-primitive and per-instance feature IDs are
present, the instance feature IDs take priority.
</div>
<dl class="details">
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="foveatedConeSize">
<a href="#foveatedConeSize" class="doc-link"></a>
foveatedConeSize<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1695">Scene/Cesium3DTileset.js 1695</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control the cone size that determines which tiles are deferred.
Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and <a href="Cesium3DTileset.html#foveatedInterpolationCallback"><code>Cesium3DTileset#foveatedInterpolationCallback</code></a> and <a href="Cesium3DTileset.html#foveatedMinimumScreenSpaceErrorRelaxation"><code>Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation</code></a>.
Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, essentially disabling the effect.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.3</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="foveatedInterpolationCallback">
<a href="#foveatedInterpolationCallback" class="doc-link"></a>
foveatedInterpolationCallback<span class="type-signature"> : <a href="Cesium3DTileset.html#.foveatedInterpolationCallback">Cesium3DTileset.foveatedInterpolationCallback</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L360">Scene/Cesium3DTileset.js 360</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a callback to control how much to raise the screen space error for tiles outside the foveated cone,
interpolating between <a href="Cesium3DTileset.html#foveatedMinimumScreenSpaceErrorRelaxation"><code>Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation</code></a> and <a href="Cesium3DTileset.html#maximumScreenSpaceError"><code>Cesium3DTileset#maximumScreenSpaceError</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="foveatedMinimumScreenSpaceErrorRelaxation">
<a href="#foveatedMinimumScreenSpaceErrorRelaxation" class="doc-link"></a>
foveatedMinimumScreenSpaceErrorRelaxation<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1718">Scene/Cesium3DTileset.js 1718</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control the starting screen space error relaxation for tiles outside the foveated cone.
The screen space error will be raised starting with this value up to <a href="Cesium3DTileset.html#maximumScreenSpaceError"><code>Cesium3DTileset#maximumScreenSpaceError</code></a> based on the provided <a href="Cesium3DTileset.html#foveatedInterpolationCallback"><code>Cesium3DTileset#foveatedInterpolationCallback</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="foveatedScreenSpaceError">
<a href="#foveatedScreenSpaceError" class="doc-link"></a>
foveatedScreenSpaceError<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L344">Scene/Cesium3DTileset.js 344</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the
screen space error for tiles around the edge of the screen. Screen space error returns to normal once all
the tiles in the center of the screen as determined by the <a href="Cesium3DTileset.html#foveatedConeSize"><code>Cesium3DTileset#foveatedConeSize</code></a> are loaded.
</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="foveatedTimeDelay">
<a href="#foveatedTimeDelay" class="doc-link"></a>
foveatedTimeDelay<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L374">Scene/Cesium3DTileset.js 374</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Used when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control
how long in seconds to wait after the camera stops moving before deferred tiles start loading in.
This time delay prevents requesting tiles around the edges of the screen when the camera is moving.
Setting this to 0.0 will immediately request all tiles in any given view.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.2</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="imageBasedLightingFactor">
<a href="#imageBasedLightingFactor" class="doc-link"></a>
imageBasedLightingFactor<span class="type-signature"> : <a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1776">Scene/Cesium3DTileset.js 1776</a>
</div>
</h4>
</div>
<div class="description">
Cesium adds lighting from the earth, sky, atmosphere, and star skybox. This cartesian is used to scale the final
diffuse and specular lighting contribution from those sources to the final color. A value of 0.0 will disable those light sources.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Cartesian2(1.0, 1.0)</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="immediatelyLoadDesiredLevelOfDetail">
<a href="#immediatelyLoadDesiredLevelOfDetail" class="doc-link"></a>
immediatelyLoadDesiredLevelOfDetail<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L702">Scene/Cesium3DTileset.js 702</a>
</div>
</h4>
</div>
<div class="description">
When true, only tiles that meet the maximum screen space error will ever be downloaded.
Skipping factors are ignored and just the desired tiles are loaded.
<p>
Only used when <a href="Cesium3DTileset.html#skipLevelOfDetail"><code>Cesium3DTileset#skipLevelOfDetail</code></a> is <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="initialTilesLoaded">
<a href="#initialTilesLoaded" class="doc-link"></a>
initialTilesLoaded<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L527">Scene/Cesium3DTileset.js 527</a>
</div>
</h4>
</div>
<div class="description">
The event fired to indicate that all tiles that meet the screen space error this frame are loaded. This event
is fired once when all tiles in the initial view are loaded.
<p>
This event is fired at the end of the frame after the scene is rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.initialTilesLoaded.addEventListener(function() {
console.log('Initial tiles are loaded');
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#allTilesLoaded">Cesium3DTileset#allTilesLoaded</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="instanceFeatureIdIndex">
<a href="#instanceFeatureIdIndex" class="doc-link"></a>
instanceFeatureIdIndex<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L990">Scene/Cesium3DTileset.js 990</a>
</div>
</h4>
</div>
<div class="description">
The index into the list of instance feature IDs used for picking and
styling. If both per-primitive and per-instance feature IDs are present,
the instance feature IDs take priority.
</div>
<dl class="details">
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="lightColor">
<a href="#lightColor" class="doc-link"></a>
lightColor<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L738">Scene/Cesium3DTileset.js 738</a>
</div>
</h4>
</div>
<div class="description">
The light color when shading models. When <code>undefined</code> the scene's light color is used instead.
<p>
For example, disabling additional light sources by setting <code>model.imageBasedLightingFactor = new Cartesian2(0.0, 0.0)</code> will make the
model much darker. Here, increasing the intensity of the light source will make the model brighter.
</p>
</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="loadProgress">
<a href="#loadProgress" class="doc-link"></a>
loadProgress<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L489">Scene/Cesium3DTileset.js 489</a>
</div>
</h4>
</div>
<div class="description">
The event fired to indicate progress of loading new tiles. This event is fired when a new tile
is requested, when a requested tile is finished downloading, and when a downloaded tile has been
processed and is ready to render.
<p>
The number of pending tile requests, <code>numberOfPendingRequests</code>, and number of tiles
processing, <code>numberOfTilesProcessing</code> are passed to the event listener.
</p>
<p>
This event is fired at the end of the frame after the scene is rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.loadProgress.addEventListener(function(numberOfPendingRequests, numberOfTilesProcessing) {
if ((numberOfPendingRequests === 0) &amp;&amp; (numberOfTilesProcessing === 0)) {
console.log('Stopped loading');
return;
}
console.log('Loading: requests: ' + numberOfPendingRequests + ', processing: ' + numberOfTilesProcessing);
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="loadSiblings">
<a href="#loadSiblings" class="doc-link"></a>
loadSiblings<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L717">Scene/Cesium3DTileset.js 717</a>
</div>
</h4>
</div>
<div class="description">
Determines whether siblings of visible tiles are always downloaded during traversal.
This may be useful for ensuring that tiles are already available when the viewer turns left/right.
<p>
Only used when <a href="Cesium3DTileset.html#skipLevelOfDetail"><code>Cesium3DTileset#skipLevelOfDetail</code></a> is <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="luminanceAtZenith">
<a href="#luminanceAtZenith" class="doc-link"></a>
luminanceAtZenith<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L749">Scene/Cesium3DTileset.js 749</a>
</div>
</h4>
</div>
<div class="description">
The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
This is used when <a href="Cesium3DTileset.html#specularEnvironmentMaps"><code>Cesium3DTileset#specularEnvironmentMaps</code></a> and <a href="Cesium3DTileset.html#sphericalHarmonicCoefficients"><code>Cesium3DTileset#sphericalHarmonicCoefficients</code></a> are not defined.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.2</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumMemoryUsage">
<a href="#maximumMemoryUsage" class="doc-link"></a>
maximumMemoryUsage<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1443">Scene/Cesium3DTileset.js 1443</a>
</div>
</h4>
</div>
<div class="description">
The maximum amount of GPU memory (in MB) that may be used to cache tiles. This value is estimated from
geometry, textures, and batch table textures of loaded tiles. For point clouds, this value also
includes per-point metadata.
<p>
Tiles not in view are unloaded to enforce this.
</p>
<p>
If decreasing this value results in unloading tiles, the tiles are unloaded the next frame.
</p>
<p>
If tiles sized more than <code>maximumMemoryUsage</code> are needed
to meet the desired screen space error, determined by <a href="Cesium3DTileset.html#maximumScreenSpaceError"><code>Cesium3DTileset#maximumScreenSpaceError</code></a>,
for the current view, then the memory usage of the tiles loaded will exceed
<code>maximumMemoryUsage</code>. For example, if the maximum is 256 MB, but
300 MB of tiles are needed to meet the screen space error, then 300 MB of tiles may be loaded. When
these tiles go out of view, they will be unloaded.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">512</code>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#totalMemoryUsageInBytes">Cesium3DTileset#totalMemoryUsageInBytes</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumScreenSpaceError">
<a href="#maximumScreenSpaceError" class="doc-link"></a>
maximumScreenSpaceError<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1399">Scene/Cesium3DTileset.js 1399</a>
</div>
</h4>
</div>
<div class="description">
The maximum screen space error used to drive level of detail refinement. This value helps determine when a tile
refines to its descendants, and therefore plays a major role in balancing performance with visual quality.
<p>
A tile's screen space error is roughly equivalent to the number of pixels wide that would be drawn if a sphere with a
radius equal to the tile's <b>geometric error</b> were rendered at the tile's position. If this value exceeds
<code>maximumScreenSpaceError</code> the tile refines to its descendants.
</p>
<p>
Depending on the tileset, <code>maximumScreenSpaceError</code> may need to be tweaked to achieve the right balance.
Higher values provide better performance but lower visual quality.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">16</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="modelMatrix">
<a href="#modelMatrix" class="doc-link"></a>
modelMatrix<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1552">Scene/Cesium3DTileset.js 1552</a>
</div>
</h4>
</div>
<div class="description">
A 4x4 transformation matrix that transforms the entire tileset.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Matrix4.IDENTITY</code>
<h5>Example:</h5>
<pre><code class="language-javascript">// Adjust a tileset's height from the globe's surface.
const heightOffset = 20.0;
const boundingSphere = tileset.boundingSphere;
const cartographic = Cesium.Cartographic.fromCartesian(boundingSphere.center);
const surface = Cesium.Cartesian3.fromRadians(cartographic.longitude, cartographic.latitude, 0.0);
const offset = Cesium.Cartesian3.fromRadians(cartographic.longitude, cartographic.latitude, heightOffset);
const translation = Cesium.Cartesian3.subtract(offset, surface, new Cesium.Cartesian3());
tileset.modelMatrix = Cesium.Matrix4.fromTranslation(translation);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="pointCloudShading">
<a href="#pointCloudShading" class="doc-link"></a>
pointCloudShading<span class="type-signature"> : <a href="PointCloudShading.html">PointCloudShading</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1463">Scene/Cesium3DTileset.js 1463</a>
</div>
</h4>
</div>
<div class="description">
Options for controlling point size based on geometric error and eye dome lighting.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="preferLeaves">
<a href="#preferLeaves" class="doc-link"></a>
preferLeaves<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L274">Scene/Cesium3DTileset.js 274</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Prefer loading of leaves first.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="preloadFlightDestinations">
<a href="#preloadFlightDestinations" class="doc-link"></a>
preloadFlightDestinations<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L315">Scene/Cesium3DTileset.js 315</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Fetch tiles at the camera's flight destination while the camera is in flight.
</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="preloadWhenHidden">
<a href="#preloadWhenHidden" class="doc-link"></a>
preloadWhenHidden<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L307">Scene/Cesium3DTileset.js 307</a>
</div>
</h4>
</div>
<div class="description">
Preload tiles when <code>tileset.show</code> is <code>false</code>. Loads tiles as if the tileset is visible but does not render them.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="progressiveResolutionHeightFraction">
<a href="#progressiveResolutionHeightFraction" class="doc-link"></a>
progressiveResolutionHeightFraction<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L262">Scene/Cesium3DTileset.js 262</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of <code>progressiveResolutionHeightFraction*screenHeight</code> will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.3</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="properties">
<a href="#properties" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> properties<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1189">Scene/Cesium3DTileset.js 1189</a>
</div>
</h4>
</div>
<div class="description">
Gets the tileset's properties dictionary object, which contains metadata about per-feature properties.
<p>
See the <a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification#reference-properties">properties schema reference</a>
in the 3D Tiles spec for the full set of properties.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">console.log('Maximum building height: ' + tileset.properties.height.maximum);
console.log('Minimum building height: ' + tileset.properties.height.minimum);</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileFeature.html#getProperty">Cesium3DTileFeature#getProperty</a></li>
<li><a href="Cesium3DTileFeature.html#setProperty">Cesium3DTileFeature#setProperty</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="ready">
<a href="#ready" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> ready<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1214">Scene/Cesium3DTileset.js 1214</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the tileset's root tile is loaded and the tileset is ready to render.
This is set to <code>true</code> right before <a href="Cesium3DTileset.html#readyPromise"><code>Cesium3DTileset#readyPromise</code></a> is resolved.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</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="Cesium3DTileset.html">Cesium3DTileset</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1242">Scene/Cesium3DTileset.js 1242</a>
</div>
</h4>
</div>
<div class="description">
Gets the promise that will be resolved when the tileset's root tile is loaded and the tileset is ready to render.
<p>
This promise is resolved at the end of the frame before the first frame the tileset is rendered in.
</p>
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.readyPromise.then(function(tileset) {
// tile.properties is not defined until readyPromise resolves.
const properties = tileset.properties;
if (Cesium.defined(properties)) {
for (const name in properties) {
console.log(properties[name]);
}
}
});</code></pre>
</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/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1275">Scene/Cesium3DTileset.js 1275</a>
</div>
</h4>
</div>
<div class="description">
The resource used to fetch the tileset JSON file
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="root">
<a href="#root" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> root<span class="type-signature"> : <a href="Cesium3DTile.html">Cesium3DTile</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1485">Scene/Cesium3DTileset.js 1485</a>
</div>
</h4>
</div>
<div class="description">
The root tile.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="shadows">
<a href="#shadows" class="doc-link"></a>
shadows<span class="type-signature"> : <a href="global.html#ShadowMode">ShadowMode</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L432">Scene/Cesium3DTileset.js 432</a>
</div>
</h4>
</div>
<div class="description">
Determines whether the tileset casts or receives shadows from light sources.
<p>
Enabling shadows has a performance impact. A tileset that casts shadows must be rendered twice, once from the camera and again from the light's point of view.
</p>
<p>
Shadows are rendered only when <a href="Viewer.html#shadows"><code>Viewer#shadows</code></a> is <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ShadowMode.ENABLED</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L440">Scene/Cesium3DTileset.js 440</a>
</div>
</h4>
</div>
<div class="description">
Determines if the tileset will be shown.
</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="showCreditsOnScreen">
<a href="#showCreditsOnScreen" class="doc-link"></a>
showCreditsOnScreen<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1849">Scene/Cesium3DTileset.js 1849</a>
</div>
</h4>
</div>
<div class="description">
Determines whether the credits of the tileset will be displayed on the screen
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="showOutline">
<a href="#showOutline" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> showOutline<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L797">Scene/Cesium3DTileset.js 797</a>
</div>
</h4>
</div>
<div class="description">
Whether to display the outline for models using the
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline">CESIUM_primitive_outline</a> extension.
When true, outlines are displayed. When false, outlines are not displayed.
</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="skipLevelOfDetail">
<a href="#skipLevelOfDetail" class="doc-link"></a>
skipLevelOfDetail<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L649">Scene/Cesium3DTileset.js 649</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Determines if level of detail skipping should be applied during the traversal.
<p>
The common strategy for replacement-refinement traversal is to store all levels of the tree in memory and require
all children to be loaded before the parent can refine. With this optimization levels of the tree can be skipped
entirely and children can be rendered alongside their parents. The tileset requires significantly less memory when
using this optimization.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="skipLevels">
<a href="#skipLevels" class="doc-link"></a>
skipLevels<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L690">Scene/Cesium3DTileset.js 690</a>
</div>
</h4>
</div>
<div class="description">
Constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped.
For example, if a tile is level 1, no tiles will be loaded unless they are at level greater than 2.
<p>
Only used when <a href="Cesium3DTileset.html#skipLevelOfDetail"><code>Cesium3DTileset#skipLevelOfDetail</code></a> is <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="skipScreenSpaceErrorFactor">
<a href="#skipScreenSpaceErrorFactor" class="doc-link"></a>
skipScreenSpaceErrorFactor<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L675">Scene/Cesium3DTileset.js 675</a>
</div>
</h4>
</div>
<div class="description">
Multiplier defining the minimum screen space error to skip.
For example, if a tile has screen space error of 100, no tiles will be loaded unless they
are leaves or have a screen space error <code><= 100 / skipScreenSpaceErrorFactor</code>.
<p>
Only used when <a href="Cesium3DTileset.html#skipLevelOfDetail"><code>Cesium3DTileset#skipLevelOfDetail</code></a> is <code>true</code>.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">16</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="specularEnvironmentMaps">
<a href="#specularEnvironmentMaps" class="doc-link"></a>
specularEnvironmentMaps<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L776">Scene/Cesium3DTileset.js 776</a>
</div>
</h4>
</div>
<div class="description">
A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
</div>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Image-Based%20Lighting.html">Sandcastle Image Based Lighting Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#sphericalHarmonicCoefficients">Cesium3DTileset#sphericalHarmonicCoefficients</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="sphericalHarmonicCoefficients">
<a href="#sphericalHarmonicCoefficients" class="doc-link"></a>
sphericalHarmonicCoefficients<span class="type-signature"> : Array.&lt;<a href="Cartesian3.html">Cartesian3</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L767">Scene/Cesium3DTileset.js 767</a>
</div>
</h4>
</div>
<div class="description">
The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. When <code>undefined</code>, a diffuse irradiance
computed from the atmosphere color is used.
<p>
There are nine <code>Cartesian3</code> coefficients.
The order of the coefficients is: L<sub>00</sub>, L<sub>1-1</sub>, L<sub>10</sub>, L<sub>11</sub>, L<sub>2-2</sub>, L<sub>2-1</sub>, L<sub>20</sub>, L<sub>21</sub>, L<sub>22</sub>
</p>
These values can be obtained by preprocessing the environment map using the <code>cmgen</code> tool of
<a href="https://github.com/google/filament/releases">Google's Filament project</a>. This will also generate a KTX file that can be
supplied to <a href="Cesium3DTileset.html#specularEnvironmentMaps"><code>Cesium3DTileset#specularEnvironmentMaps</code></a>.
</div>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Image-Based%20Lighting.html">Sandcastle Image Based Lighting Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://graphics.stanford.edu/papers/envmap/envmap.pdf">An Efficient Representation for Irradiance Environment Maps</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="style">
<a href="#style" class="doc-link"></a>
style<span class="type-signature"> : <a href="Cesium3DTileStyle.html">Cesium3DTileStyle</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1345">Scene/Cesium3DTileset.js 1345</a>
</div>
</h4>
</div>
<div class="description">
The style, defined using the
<a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling">3D Tiles Styling language</a>,
applied to each feature in the tileset.
<p>
Assign <code>undefined</code> to remove the style, which will restore the visual
appearance of the tileset to its default when no style was applied.
</p>
<p>
The style is applied to a tile before the <a href="Cesium3DTileset.html#tileVisible"><code>Cesium3DTileset#tileVisible</code></a>
event is raised, so code in <code>tileVisible</code> can manually set a feature's
properties (e.g. color and show) after the style is applied. When
a new style is assigned any manually set properties are overwritten.
</p>
<p>
Use an always "true" condition to specify the Color for all objects that are not
overridden by pre-existing conditions. Otherwise, the default color Cesium.Color.White
will be used. Similarly, use an always "true" condition to specify the show property
for all objects that are not overridden by pre-existing conditions. Otherwise, the
default show value true will be used.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.style = new Cesium.Cesium3DTileStyle({
color : {
conditions : [
['${Height} >= 100', 'color("purple", 0.5)'],
['${Height} >= 50', 'color("red")'],
['true', 'color("blue")']
]
},
show : '${Height} > 0',
meta : {
description : '"Building id ${id} has height ${Height}."'
}
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling">3D Tiles Styling language</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileFailed">
<a href="#tileFailed" class="doc-link"></a>
tileFailed<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L598">Scene/Cesium3DTileset.js 598</a>
</div>
</h4>
</div>
<div class="description">
The event fired to indicate that a tile's content failed to load.
<p>
If there are no event listeners, error messages will be logged to the console.
</p>
<p>
The error object passed to the listener contains two properties:
<ul>
<li><code>url</code>: the url of the failed tile.</li>
<li><code>message</code>: the error message.</li>
</ul>
<p>
If the <code>3DTILES_multiple_contents</code> extension is used, this event is raised once per inner content with errors.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.tileFailed.addEventListener(function(error) {
console.log('An error occurred loading tile: ' + error.url);
console.log('Error: ' + error.message);
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileLoad">
<a href="#tileLoad" class="doc-link"></a>
tileLoad<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L548">Scene/Cesium3DTileset.js 548</a>
</div>
</h4>
</div>
<div class="description">
The event fired to indicate that a tile's content was loaded.
<p>
The loaded <a href="Cesium3DTile.html"><code>Cesium3DTile</code></a> is passed to the event listener.
</p>
<p>
This event is fired during the tileset traversal while the frame is being rendered
so that updates to the tile take effect in the same frame. Do not create or modify
Cesium entities or primitives during the event listener.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.tileLoad.addEventListener(function(tile) {
console.log('A tile was loaded.');
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="tilesLoaded">
<a href="#tilesLoaded" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tilesLoaded<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1261">Scene/Cesium3DTileset.js 1261</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, all tiles that meet the screen space error this frame are loaded. The tileset is
completely loaded for this view.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#allTilesLoaded">Cesium3DTileset#allTilesLoaded</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileUnload">
<a href="#tileUnload" class="doc-link"></a>
tileUnload<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L572">Scene/Cesium3DTileset.js 572</a>
</div>
</h4>
</div>
<div class="description">
The event fired to indicate that a tile's content was unloaded.
<p>
The unloaded <a href="Cesium3DTile.html"><code>Cesium3DTile</code></a> is passed to the event listener.
</p>
<p>
This event is fired immediately before the tile's content is unloaded while the frame is being
rendered so that the event listener has access to the tile's content. Do not create
or modify Cesium entities or primitives during the event listener.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">tileset.tileUnload.addEventListener(function(tile) {
console.log('A tile was unloaded from the cache.');
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#maximumMemoryUsage">Cesium3DTileset#maximumMemoryUsage</a></li>
<li><a href="Cesium3DTileset.html#trimLoadedTiles">Cesium3DTileset#trimLoadedTiles</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileVisible">
<a href="#tileVisible" class="doc-link"></a>
tileVisible<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L635">Scene/Cesium3DTileset.js 635</a>
</div>
</h4>
</div>
<div class="description">
This event fires once for each visible tile in a frame. This can be used to manually
style a tileset.
<p>
The visible <a href="Cesium3DTile.html"><code>Cesium3DTile</code></a> is passed to the event listener.
</p>
<p>
This event is fired during the tileset traversal while the frame is being rendered
so that updates to the tile take effect in the same frame. Do not create or modify
Cesium entities or primitives during the event listener.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Examples:</h5>
<pre><code class="language-javascript">tileset.tileVisible.addEventListener(function(tile) {
if (tile.content instanceof Cesium.Batched3DModel3DTileContent) {
console.log('A Batched 3D Model tile is visible.');
}
});</code></pre>
<pre><code class="language-javascript">// Apply a red style and then manually set random colors for every other feature when the tile becomes visible.
tileset.style = new Cesium.Cesium3DTileStyle({
color : 'color("red")'
});
tileset.tileVisible.addEventListener(function(tile) {
const content = tile.content;
const featuresLength = content.featuresLength;
for (let i = 0; i &lt; featuresLength; i+=2) {
content.getFeature(i).color = Cesium.Color.fromRandom();
}
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="timeSinceLoad">
<a href="#timeSinceLoad" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> timeSinceLoad<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1569">Scene/Cesium3DTileset.js 1569</a>
</div>
</h4>
</div>
<div class="description">
Returns the time, in milliseconds, since the tileset was loaded and first updated.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="totalMemoryUsageInBytes">
<a href="#totalMemoryUsageInBytes" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> totalMemoryUsageInBytes<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1587">Scene/Cesium3DTileset.js 1587</a>
</div>
</h4>
</div>
<div class="description">
The total amount of GPU memory in bytes used by the tileset. This value is estimated from
geometry, texture, and batch table textures of loaded tiles. For point clouds, this value also
includes per-point metadata.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#maximumMemoryUsage">Cesium3DTileset#maximumMemoryUsage</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="vectorClassificationOnly">
<a href="#vectorClassificationOnly" class="doc-link"></a>
vectorClassificationOnly<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1818">Scene/Cesium3DTileset.js 1818</a>
</div>
</h4>
</div>
<div class="description">
Indicates that only the tileset's vector tiles should be used for classification.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<div class="nameContainer">
<h4 class="name" id="vectorKeepDecodedPositions">
<a href="#vectorKeepDecodedPositions" class="doc-link"></a>
vectorKeepDecodedPositions<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1835">Scene/Cesium3DTileset.js 1835</a>
</div>
</h4>
</div>
<div class="description">
Whether vector tiles should keep decoded positions in memory.
This is used with <code>Cesium3DTileFeature.getPolylinePositions</code>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".loadJson">
<a href="#.loadJson" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Cesium3DTileset.loadJson<span class="signature">(tilesetUrl)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Object></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1865">Scene/Cesium3DTileset.js 1865</a>
</div>
</h4>
</div>
<div class="description">
Provides a hook to override the method used to request the tileset json
useful when fetching tilesets from remote servers
</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>tilesetUrl</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 json file to be fetched</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise that resolves with the fetched json data
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L2929">Scene/Cesium3DTileset.js 2929</a>
</div>
</h4>
</div>
<div class="description">
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
release of WebGL resources, instead of relying on the garbage collector to destroy this object.
<br /><br />
Once an object is destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore,
assign the return value (<code>undefined</code>) to the object as done in the example.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">tileset = tileset &amp;&amp; tileset.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#isDestroyed">Cesium3DTileset#isDestroyed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="hasExtension">
<a href="#hasExtension" class="doc-link"></a>
hasExtension<span class="signature">(extensionName)</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L2892">Scene/Cesium3DTileset.js 2892</a>
</div>
</h4>
</div>
<div class="description">
<code>true</code> if the tileset JSON file lists the extension in extensionsUsed; otherwise, <code>false</code>.
</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>extensionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The name of the extension to check.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the tileset JSON file lists the extension in extensionsUsed; otherwise, <code>false</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isDestroyed">
<a href="#isDestroyed" class="doc-link"></a>
isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L2910">Scene/Cesium3DTileset.js 2910</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
<br /><br />
If this object was destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if this object was destroyed; otherwise, <code>false</code>.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Cesium3DTileset.html#destroy">Cesium3DTileset#destroy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="makeStyleDirty">
<a href="#makeStyleDirty" class="doc-link"></a>
makeStyleDirty<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L1874">Scene/Cesium3DTileset.js 1874</a>
</div>
</h4>
</div>
<div class="description">
Marks the tileset's <a href="Cesium3DTileset.html#style"><code>Cesium3DTileset#style</code></a> as dirty, which forces all
features to re-evaluate the style in the next frame each is visible.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="trimLoadedTiles">
<a href="#trimLoadedTiles" class="doc-link"></a>
trimLoadedTiles<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Cesium3DTileset.js#L2676">Scene/Cesium3DTileset.js 2676</a>
</div>
</h4>
</div>
<div class="description">
Unloads all tiles that weren't selected the previous frame. This can be used to
explicitly manage the tile cache and reduce the total number of tiles loaded below
<a href="Cesium3DTileset.html#maximumMemoryUsage"><code>Cesium3DTileset#maximumMemoryUsage</code></a>.
<p>
Tile unloads occur at the next frame to keep all the WebGL delete calls
within the render loop.
</p>
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".foveatedInterpolationCallback">
<a href="#.foveatedInterpolationCallback" class="doc-link"></a>
Cesium.Cesium3DTileset.foveatedInterpolationCallback<span class="signature">(p, q, time)</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/Scene/Cesium3DTileset.js#L2987">Scene/Cesium3DTileset.js 2987</a>
</div>
</h4>
</div>
<div class="description">
Optimization option. Used as a callback when <a href="Cesium3DTileset.html#foveatedScreenSpaceError"><code>Cesium3DTileset#foveatedScreenSpaceError</code></a> is true to control how much to raise the screen space error for tiles outside the foveated cone,
interpolating between <a href="Cesium3DTileset.html#foveatedMinimumScreenSpaceErrorRelaxation"><code>Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation</code></a> and <a href="Cesium3DTileset.html#maximumScreenSpaceError"><code>Cesium3DTileset#maximumScreenSpaceError</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>p</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The start value to interpolate.</td>
</tr>
<tr>
<td class="name"><code>q</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The end value to interpolate.</td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The time of interpolation generally in the range <code>[0.0, 1.0]</code>.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The interpolated value.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Math.lerp</code>
</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>