Cesium3DTileset

Members

Default Value: new Event()

Example:

tileset.allTilesLoaded.addEventListener(function() {
    console.log('All tiles are loaded');
});

See:

• Cesium3DTileset#tilesLoaded

Default Value: true

Deprecated: true

Default Value: 1024

Example:

const tileset = await Cesium.Cesium3DTileset.fromUrl("http://localhost:8002/tilesets/Seattle/tileset.json");

viewer.scene.primitives.add(tileset);

// Set the camera to view the newly added tileset
viewer.camera.viewBoundingSphere(tileset.boundingSphere, new Cesium.HeadingPitchRange(0, -0.5, 0));

Default Value: 536870912

See:

• Cesium3DTileset#totalMemoryUsageInBytes

Default Value: undefined

Experimental

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.

Default Value: 0.5

Default Value: Cesium3DTileColorBlendMode.HIGHLIGHT

Default Value: true

Default Value: 60.0

Default Value: undefined

Experimental

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.

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: 0.00278

Default Value: 4.0

Default Value: 0.25

Experimental

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.

See:

• Extras in the 3D Tiles specification.

Experimental

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.

Default Value: 0.3

Default Value: 0.0

Default Value: true

Default Value: 0.2

Default Value: false

Default Value: new Event()

Example:

tileset.initialTilesLoaded.addEventListener(function() {
    console.log('Initial tiles are loaded');
});

See:

• Cesium3DTileset#allTilesLoaded

Experimental

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.

Default Value: undefined

Default Value: new Event()

Example:

tileset.loadProgress.addEventListener(function(numberOfPendingRequests, numberOfTilesProcessing) {
    if ((numberOfPendingRequests === 0) && (numberOfTilesProcessing === 0)) {
        console.log('Stopped loading');
        return;
    }

    console.log(`Loading: requests: ${numberOfPendingRequests}, processing: ${numberOfTilesProcessing}`);
});

Default Value: false

Default Value: 536870912

See:

• Cesium3DTileset#totalMemoryUsageInBytes

Deprecated: true

Default Value: 512

See:

• Cesium3DTileset#totalMemoryUsageInBytes

Default Value: 16

Default Value: Matrix4.IDENTITY

Example:

// 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);

Default Value: Color.BLACK

Default Value: false

Default Value: true

Default Value: false

Default Value: 0.3

Example:

console.log(`Maximum building height: ${tileset.properties.height.maximum}`);
console.log(`Minimum building height: ${tileset.properties.height.minimum}`);

See:

• Cesium3DTileFeature#getProperty
• Cesium3DTileFeature#setProperty

Default Value: ShadowMode.ENABLED

Default Value: true

Default Value: false

Default Value: true

Default Value: false

Default Value: 1

Default Value: 16

Default Value: SplitDirection.NONE

Default Value: undefined

Example:

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}."'
   }
});

See:

• 3D Tiles Styling language

Default Value: new Event()

Example:

tileset.tileFailed.addEventListener(function(error) {
    console.log(`An error occurred loading tile: ${error.url}`);
    console.log(`Error: ${error.message}`);
});

Default Value: new Event()

Example:

tileset.tileLoad.addEventListener(function(tile) {
    console.log('A tile was loaded.');
});

Default Value: false

See:

• Cesium3DTileset#allTilesLoaded

Default Value: new Event()

Example:

tileset.tileUnload.addEventListener(function(tile) {
    console.log('A tile was unloaded from the cache.');
});

See:

• Cesium3DTileset#cacheBytes
• Cesium3DTileset#trimLoadedTiles

Default Value: new Event()

Examples:

tileset.tileVisible.addEventListener(function(tile) {
    if (tile.content instanceof Cesium.Model3DTileContent) {
        console.log('A 3D model tile is visible.');
    }
});

// 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 < featuresLength; i+=2) {
        content.getFeature(i).color = Cesium.Color.fromRandom();
    }
});

See:

• Cesium3DTileset#cacheBytes

Default Value: false

Experimental

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.

Default Value: false

Experimental

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.

Methods

Returns:

Throws:

• DeveloperError : The tileset must be 3D Tiles version 0.0 or 1.0.

Example:

// Load a Cesium3DTileset with a Cesium ion asset ID of 124624234
try {
  const tileset = await Cesium.Cesium3DTileset.fromIonAssetId(124624234);
  scene.primitives.add(tileset);
} catch (error) {
  console.error(`Error creating tileset: ${error}`);
}

See:

• Cesium3DTileset#fromUrl

Returns:

Throws:

• DeveloperError : The tileset must be 3D Tiles version 0.0 or 1.0.

Examples:

try {
  const tileset = await Cesium.Cesium3DTileset.fromUrl(
     "http://localhost:8002/tilesets/Seattle/tileset.json"
  );
  scene.primitives.add(tileset);
} catch (error) {
  console.error(`Error creating tileset: ${error}`);
}

// Common setting for the skipLevelOfDetail optimization
const tileset = await Cesium.Cesium3DTileset.fromUrl(
  "http://localhost:8002/tilesets/Seattle/tileset.json", {
     skipLevelOfDetail: true,
     baseScreenSpaceError: 1024,
     skipScreenSpaceErrorFactor: 16,
     skipLevels: 1,
     immediatelyLoadDesiredLevelOfDetail: false,
     loadSiblings: false,
     cullWithChildrenBounds: true
});
scene.primitives.add(tileset);

// Common settings for the dynamicScreenSpaceError optimization
const tileset = await Cesium.Cesium3DTileset.fromUrl(
  "http://localhost:8002/tilesets/Seattle/tileset.json", {
     dynamicScreenSpaceError: true,
     dynamicScreenSpaceErrorDensity: 0.00278,
     dynamicScreenSpaceErrorFactor: 4.0,
     dynamicScreenSpaceErrorHeightFalloff: 0.25
});
scene.primitives.add(tileset);

See:

• Cesium3DTileset#fromIonAssetId

Returns:

Throws:

• DeveloperError : This object was destroyed, i.e., destroy() was called.

Example:

tileset = tileset && tileset.destroy();

See:

• Cesium3DTileset#isDestroyed

Returns:

Returns:

See:

• Cesium3DTileset#destroy

Type Definitions

Properties:

Name	Type	Attributes	Default	Description
show	boolean	<optional>	true	Determines if the tileset will be shown.
modelMatrix	Matrix4	<optional>	Matrix4.IDENTITY	A 4x4 transformation matrix that transforms the tileset's root tile.
modelUpAxis	Axis	<optional>	Axis.Y	Which axis is considered up when loading models for tile contents.
modelForwardAxis	Axis	<optional>	Axis.X	Which axis is considered forward when loading models for tile contents.
shadows	ShadowMode	<optional>	ShadowMode.ENABLED	Determines whether the tileset casts or receives shadows from light sources.
maximumScreenSpaceError	number	<optional>	16	The maximum screen space error used to drive level of detail refinement.
maximumMemoryUsage	number	<optional>	512	The maximum amount of memory in MB that can be used by the tileset. Deprecated.
cacheBytes	number	<optional>	536870912	The size (in bytes) to which the tile cache will be trimmed, if the cache contains tiles not needed for the current view.
maximumCacheOverflowBytes	number	<optional>	536870912	The maximum additional memory (in bytes) to allow for cache headroom, if more than Cesium3DTileset#cacheBytes are needed for the current view.
cullWithChildrenBounds	boolean	<optional>	true	Optimization option. Whether to cull tiles using the union of their children bounding volumes.
cullRequestsWhileMoving	boolean	<optional>	true	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.
cullRequestsWhileMovingMultiplier	number	<optional>	60.0	Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
preloadWhenHidden	boolean	<optional>	false	Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
preloadFlightDestinations	boolean	<optional>	true	Optimization option. Preload tiles at the camera's flight destination while the camera is in flight.
preferLeaves	boolean	<optional>	false	Optimization option. Prefer loading of leaves first.
dynamicScreenSpaceError	boolean	<optional>	false	Optimization option. Reduce the screen space error for tiles that are further away from the camera.
dynamicScreenSpaceErrorDensity	number	<optional>	0.00278	Density used to adjust the dynamic screen space error, similar to fog density.
dynamicScreenSpaceErrorFactor	number	<optional>	4.0	A factor used to increase the computed dynamic screen space error.
dynamicScreenSpaceErrorHeightFalloff	number	<optional>	0.25	A ratio of the tileset's height at which the density starts to falloff.
progressiveResolutionHeightFraction	number	<optional>	0.3	Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load.
foveatedScreenSpaceError	boolean	<optional>	true	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 Cesium3DTileset#foveatedConeSize are loaded.
foveatedConeSize	number	<optional>	0.1	Optimization option. Used when Cesium3DTileset#foveatedScreenSpaceError 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 Cesium3DTileset#foveatedInterpolationCallback and Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation. 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.
foveatedMinimumScreenSpaceErrorRelaxation	number	<optional>	0.0	Optimization option. Used when Cesium3DTileset#foveatedScreenSpaceError 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 Cesium3DTileset#maximumScreenSpaceError based on the provided Cesium3DTileset#foveatedInterpolationCallback.
foveatedInterpolationCallback	Cesium3DTileset.foveatedInterpolationCallback	<optional>	Math.lerp	Optimization option. Used when Cesium3DTileset#foveatedScreenSpaceError is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation and Cesium3DTileset#maximumScreenSpaceError
foveatedTimeDelay	number	<optional>	0.2	Optimization option. Used when Cesium3DTileset#foveatedScreenSpaceError 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.
skipLevelOfDetail	boolean	<optional>	false	Optimization option. Determines if level of detail skipping should be applied during the traversal.
baseScreenSpaceError	number	<optional>	1024	When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail.
skipScreenSpaceErrorFactor	number	<optional>	16	When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip. Used in conjunction with skipLevels to determine which tiles to load.
skipLevels	number	<optional>	1	When skipLevelOfDetail is true, 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 skipScreenSpaceErrorFactor to determine which tiles to load.
immediatelyLoadDesiredLevelOfDetail	boolean	<optional>	false	When skipLevelOfDetail is 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.
loadSiblings	boolean	<optional>	false	When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal.
clippingPlanes	ClippingPlaneCollection	<optional>		The ClippingPlaneCollection used to selectively disable rendering the tileset.
classificationType	ClassificationType	<optional>		Determines whether terrain, 3D Tiles or both will be classified by this tileset. See Cesium3DTileset#classificationType for details about restrictions and limitations.
ellipsoid	Ellipsoid	<optional>	Ellipsoid.WGS84	The ellipsoid determining the size and shape of the globe.
pointCloudShading	object	<optional>		Options for constructing a PointCloudShading object to control point attenuation based on geometric error and lighting.
lightColor	Cartesian3	<optional>		The light color when shading models. When undefined the scene's light color is used instead.
imageBasedLighting	ImageBasedLighting	<optional>		The properties for managing image-based lighting for this tileset.
backFaceCulling	boolean	<optional>	true	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.
enableShowOutline	boolean	<optional>	true	Whether to enable outlines for models using the CESIUM_primitive_outline extension. This can be set to false to avoid the additional processing of geometry at load time. When false, the showOutlines and outlineColor options are ignored.
showOutline	boolean	<optional>	true	Whether to display the outline for models using the CESIUM_primitive_outline extension. When true, outlines are displayed. When false, outlines are not displayed.
outlineColor	Color	<optional>	Color.BLACK	The color to use when rendering outlines.
vectorClassificationOnly	boolean	<optional>	false	Indicates that only the tileset's vector tiles should be used for classification.
vectorKeepDecodedPositions	boolean	<optional>	false	Whether vector tiles should keep decoded positions in memory. This is used with Cesium3DTileFeature.getPolylinePositions.
featureIdLabel	string | number	<optional>	"featureId_0"	Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
instanceFeatureIdLabel	string | number	<optional>	"instanceFeatureId_0"	Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
showCreditsOnScreen	boolean	<optional>	false	Whether to display the credits of this tileset on screen.
splitDirection	SplitDirection	<optional>	SplitDirection.NONE	The SplitDirection split to apply to this tileset.
projectTo2D	boolean	<optional>	false	Whether to accurately project the tileset to 2D. If this is true, the tileset will be projected accurately to 2D, but it will use more memory to do so. If this is false, the tileset will use less memory and will still render in 2D / CV mode, but its projected positions may be inaccurate. This cannot be set after the tileset has loaded.
debugHeatmapTilePropertyName	string	<optional>		The tile variable to colorize as a heatmap. All rendered tiles will be colorized relative to each other's specified variable value.
debugFreezeFrame	boolean	<optional>	false	For debugging only. Determines if only the tiles from last frame should be used for rendering.
debugColorizeTiles	boolean	<optional>	false	For debugging only. When true, assigns a random color to each tile.
enableDebugWireframe	boolean	<optional>		For debugging only. This must be true for debugWireframe to work in WebGL1. This cannot be set after the tileset has loaded.
debugWireframe	boolean	<optional>	false	For debugging only. When true, render's each tile's content as a wireframe.
debugShowBoundingVolume	boolean	<optional>	false	For debugging only. When true, renders the bounding volume for each tile.
debugShowContentBoundingVolume	boolean	<optional>	false	For debugging only. When true, renders the bounding volume for each tile's content.
debugShowViewerRequestVolume	boolean	<optional>	false	For debugging only. When true, renders the viewer request volume for each tile.
debugShowGeometricError	boolean	<optional>	false	For debugging only. When true, draws labels to indicate the geometric error of each tile.
debugShowRenderingStatistics	boolean	<optional>	false	For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.
debugShowMemoryUsage	boolean	<optional>	false	For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.
debugShowUrl	boolean	<optional>	false	For debugging only. When true, draws labels to indicate the url of each tile.

Returns:

Default Value: Math.lerp