Cesium3DTileset

new Cesium.Cesium3DTileset(options)
Scene/Cesium3DTileset.js 154

A 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets.
Name Type Description
options Object Object with the following properties:
Name Type Default Description
url Resource | String | Promise.<Resource> | Promise.<String> The url to a tileset JSON file.
show Boolean true optional Determines if the tileset will be shown.
modelMatrix Matrix4 Matrix4.IDENTITY optional A 4x4 transformation matrix that transforms the tileset's root tile.
shadows ShadowMode ShadowMode.ENABLED optional Determines whether the tileset casts or receives shadows from light sources.
maximumScreenSpaceError Number 16 optional The maximum screen space error used to drive level of detail refinement.
maximumMemoryUsage Number 512 optional The maximum amount of memory in MB that can be used by the tileset.
cullWithChildrenBounds Boolean true optional Optimization option. Whether to cull tiles using the union of their children bounding volumes.
cullRequestsWhileMoving Boolean true optional 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 60.0 optional Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
preloadWhenHidden Boolean false optional Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
preloadFlightDestinations Boolean true optional Optimization option. Preload tiles at the camera's flight destination while the camera is in flight.
preferLeaves Boolean false optional Optimization option. Prefer loading of leaves first.
dynamicScreenSpaceError Boolean false optional Optimization option. Reduce the screen space error for tiles that are further away from the camera.
dynamicScreenSpaceErrorDensity Number 0.00278 optional Density used to adjust the dynamic screen space error, similar to fog density.
dynamicScreenSpaceErrorFactor Number 4.0 optional A factor used to increase the computed dynamic screen space error.
dynamicScreenSpaceErrorHeightFalloff Number 0.25 optional A ratio of the tileset's height at which the density starts to falloff.
progressiveResolutionHeightFraction Number 0.3 optional 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 true optional 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 0.1 optional 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 0.0 optional 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 Math.lerp optional 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 0.2 optional 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 false optional Optimization option. Determines if level of detail skipping should be applied during the traversal.
baseScreenSpaceError Number 1024 optional When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail.
skipScreenSpaceErrorFactor Number 16 optional 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 1 optional 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 false optional 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 false optional 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 Ellipsoid.WGS84 optional 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.
imageBasedLightingFactor Cartesian2 new Cartesian2(1.0, 1.0) optional Scales the diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox. Deprecated in Cesium 1.92, will be removed in Cesium 1.94.
luminanceAtZenith Number 0.2 optional The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. Deprecated in Cesium 1.92, will be removed in Cesium 1.94.
sphericalHarmonicCoefficients Array.<Cartesian3> optional The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. Deprecated in Cesium 1.92, will be removed in Cesium 1.94.
specularEnvironmentMaps String optional A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps. Deprecated in Cesium 1.92, will be removed in Cesium 1.94.
backFaceCulling Boolean true optional 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.
showOutline Boolean true optional Whether to display the outline for models using the CESIUM_primitive_outline extension. When true, outlines are displayed. When false, outlines are not displayed.
vectorClassificationOnly Boolean false optional Indicates that only the tileset's vector tiles should be used for classification.
vectorKeepDecodedPositions Boolean false optional Whether vector tiles should keep decoded positions in memory. This is used with Cesium3DTileFeature.getPolylinePositions.
featureIdLabel String | Number "featureId_0" optional 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 "instanceFeatureId_0" optional 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 false optional Whether to display the credits of this tileset on screen.
splitDirection SplitDirection SplitDirection.NONE optional The SplitDirection split to apply to this tileset.
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 false optional For debugging only. Determines if only the tiles from last frame should be used for rendering.
debugColorizeTiles Boolean false optional For debugging only. When true, assigns a random color to each tile.
debugWireframe Boolean false optional For debugging only. When true, render's each tile's content as a wireframe.
debugShowBoundingVolume Boolean false optional For debugging only. When true, renders the bounding volume for each tile.
debugShowContentBoundingVolume Boolean false optional For debugging only. When true, renders the bounding volume for each tile's content.
debugShowViewerRequestVolume Boolean false optional For debugging only. When true, renders the viewer request volume for each tile.
debugShowGeometricError Boolean false optional For debugging only. When true, draws labels to indicate the geometric error of each tile.
debugShowRenderingStatistics Boolean false optional For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.
debugShowMemoryUsage Boolean false optional For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.
debugShowUrl Boolean false optional For debugging only. When true, draws labels to indicate the url of each tile.
Throws:
Examples:
const tileset = scene.primitives.add(new Cesium.Cesium3DTileset({
     url : 'http://localhost:8002/tilesets/Seattle/tileset.json'
}));
// 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
}));
// 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
}));
See:

Members

allTilesLoaded : Event
Scene/Cesium3DTileset.js 512

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.

This event is fired at the end of the frame after the scene is rendered.

Default Value: new Event()
Example:
tileset.allTilesLoaded.addEventListener(function() {
    console.log('All tiles are loaded');
});
See:

readonly asset : Object
Scene/Cesium3DTileset.js 1103

Gets the tileset's asset object property, which contains metadata about the tileset.

See the asset schema reference in the 3D Tiles spec for the full set of properties.

backFaceCulling : Boolean
Scene/Cesium3DTileset.js 772

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.
Default Value: true

readonly deprecated basePath : String
Scene/Cesium3DTileset.js 1279

The base path that non-absolute paths in tileset JSON file are relative to.

Deprecated: true

baseScreenSpaceError : Number
Scene/Cesium3DTileset.js 666

The screen space error that must be reached before skipping levels of detail.

Only used when Cesium3DTileset#skipLevelOfDetail is true.

Default Value: 1024

readonly boundingSphere : BoundingSphere
Scene/Cesium3DTileset.js 1569

The tileset's bounding sphere.
Example:
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));
});

readonly classificationType : ClassificationType
Scene/Cesium3DTileset.js 1715

Determines whether terrain, 3D Tiles or both will be classified by this tileset.

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.

When enabled for batched 3D model tilesets, there are a few requirements/limitations on the glTF:

  • POSITION and _BATCHID semantics are required.
  • All indices with the same batch id must occupy contiguous sections of the index buffer.
  • All shaders and techniques are ignored. The generated shader simply multiplies the position by the model-view-projection matrix.
  • The only supported extensions are CESIUM_RTC and WEB3D_quantized_attributes.
  • Only one node is supported.
  • Only one mesh per node is supported.
  • Only one primitive per mesh is supported.

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.

clippingPlanes : ClippingPlaneCollection
Scene/Cesium3DTileset.js 1148

The ClippingPlaneCollection used to selectively disable rendering the tileset.

colorBlendAmount : Number
Scene/Cesium3DTileset.js 463

Defines the value used to linearly interpolate between the source color and feature color when the Cesium3DTileset#colorBlendMode is MIX. 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.
Default Value: 0.5

colorBlendMode : Cesium3DTileColorBlendMode
Scene/Cesium3DTileset.js 453

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.
Default Value: Cesium3DTileColorBlendMode.HIGHLIGHT

cullRequestsWhileMoving : Boolean
Scene/Cesium3DTileset.js 243

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.
Default Value: true

cullRequestsWhileMovingMultiplier : Number
Scene/Cesium3DTileset.js 255

Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
Default Value: 60.0

customShader : CustomShader|undefined
Scene/Cesium3DTileset.js 1359

A custom shader to apply to all tiles in the tileset. Only used for contents that use ModelExperimental. Using custom shaders with a Cesium3DTileStyle may lead to undefined behavior.

To enable ModelExperimental, set ExperimentalFeatures.enableModelExperimental or tileset.enableModelExperimental to true.

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.

debugColorizeTiles : Boolean
Scene/Cesium3DTileset.js 821

This property is for debugging only; it is not optimized for production use.

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.

Default Value: false

debugFreezeFrame : Boolean
Scene/Cesium3DTileset.js 808

This property is for debugging only; it is not optimized for production use.

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.

Default Value: false

debugShowBoundingVolume : Boolean
Scene/Cesium3DTileset.js 845

This property is for debugging only; it is not optimized for production use.

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.

Default Value: false

debugShowContentBoundingVolume : Boolean
Scene/Cesium3DTileset.js 860

This property is for debugging only; it is not optimized for production use.

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.

Default Value: false

debugShowGeometricError : Boolean
Scene/Cesium3DTileset.js 893

This property is for debugging only; it is not optimized for production use.

When true, draws labels to indicate the geometric error of each tile.

Default Value: false

debugShowMemoryUsage : Boolean
Scene/Cesium3DTileset.js 921

This property is for debugging only; it is not optimized for production use.

When true, draws labels to indicate the geometry and texture memory usage of each tile.

Default Value: false

debugShowRenderingStatistics : Boolean
Scene/Cesium3DTileset.js 907

This property is for debugging only; it is not optimized for production use.

When true, draws labels to indicate the number of commands, points, triangles and features of each tile.

Default Value: false

debugShowUrl : Boolean
Scene/Cesium3DTileset.js 932

This property is for debugging only; it is not optimized for production use.

When true, draws labels to indicate the url of each tile.

Default Value: false

debugShowViewerRequestVolume : Boolean
Scene/Cesium3DTileset.js 874

This property is for debugging only; it is not optimized for production use.

When true, renders the viewer request volume for each tile.

Default Value: false

debugWireframe : Boolean
Scene/Cesium3DTileset.js 832

This property is for debugging only; it is not optimized for production use.

When true, renders each tile's content as a wireframe.

Default Value: false

dynamicScreenSpaceError : Boolean
Scene/Cesium3DTileset.js 335

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.
Default Value: false

dynamicScreenSpaceErrorDensity : Number
Scene/Cesium3DTileset.js 398

A scalar that determines the density used to adjust the dynamic screen space error, similar to Fog. 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.

The dynamic error is in the range [0.0, 1.0) and is multiplied by dynamicScreenSpaceErrorFactor to produce the final dynamic error. This dynamic error is then subtracted from the tile's actual screen space error.

Increasing dynamicScreenSpaceErrorDensity has the effect of moving the error midpoint closer to the camera. It is analogous to moving fog closer to the camera.

Default Value: 0.00278

dynamicScreenSpaceErrorFactor : Number
Scene/Cesium3DTileset.js 407

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.
Default Value: 4.0

dynamicScreenSpaceErrorHeightFalloff : Number
Scene/Cesium3DTileset.js 420

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.

Valid values are between 0.0 and 1.0.

Default Value: 0.25

readonly ellipsoid : Ellipsoid
Scene/Cesium3DTileset.js 1729

Gets an ellipsoid describing the shape of the globe.

examineVectorLinesFunction : function
Scene/Cesium3DTileset.js 941

Function for examining vector lines as they are being streamed.
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.

readonly extensions : Object
Scene/Cesium3DTileset.js 1127

Gets the tileset's extensions object property.

readonly extras : *
Scene/Cesium3DTileset.js 1803

Returns the extras property at the top-level of the tileset JSON, which contains application specific metadata. Returns undefined if extras does not exist.
See:

featureIdLabel : String
Scene/Cesium3DTileset.js 2000

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 set to 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.

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.

foveatedConeSize : Number
Scene/Cesium3DTileset.js 1745

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 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, essentially disabling the effect.
Default Value: 0.3

foveatedInterpolationCallback : Cesium3DTileset.foveatedInterpolationCallback
Scene/Cesium3DTileset.js 364

Gets or sets a callback to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation and Cesium3DTileset#maximumScreenSpaceError.

foveatedMinimumScreenSpaceErrorRelaxation : Number
Scene/Cesium3DTileset.js 1768

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 this value up to Cesium3DTileset#maximumScreenSpaceError based on the provided Cesium3DTileset#foveatedInterpolationCallback.
Default Value: 0.0

foveatedScreenSpaceError : Boolean
Scene/Cesium3DTileset.js 348

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.
Default Value: true

foveatedTimeDelay : Number
Scene/Cesium3DTileset.js 378

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.
Default Value: 0.2

imageBasedLighting : ImageBasedLighting
Scene/Cesium3DTileset.js 1824

The properties for managing image-based lighting on this tileset.

imageBasedLightingFactor : Cartesian2
Scene/Cesium3DTileset.js 1854

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.
Default Value: Cartesian2(1.0, 1.0)

immediatelyLoadDesiredLevelOfDetail : Boolean
Scene/Cesium3DTileset.js 706

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.

Only used when Cesium3DTileset#skipLevelOfDetail is true.

Default Value: false

initialTilesLoaded : Event
Scene/Cesium3DTileset.js 531

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.

This event is fired at the end of the frame after the scene is rendered.

Default Value: new Event()
Example:
tileset.initialTilesLoaded.addEventListener(function() {
    console.log('Initial tiles are loaded');
});
See:

instanceFeatureIdLabel : String
Scene/Cesium3DTileset.js 2032

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.

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.

lightColor : Cartesian3
Scene/Cesium3DTileset.js 763

The light color when shading models. When undefined the scene's light color is used instead.

For example, disabling additional light sources by setting model.imageBasedLighting.imageBasedLightingFactor = new Cartesian2(0.0, 0.0) will make the model much darker. Here, increasing the intensity of the light source will make the model brighter.

Default Value: undefined

loadProgress : Event
Scene/Cesium3DTileset.js 493

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.

The number of pending tile requests, numberOfPendingRequests, and number of tiles processing, numberOfTilesProcessing are passed to the event listener.

This event is fired at the end of the frame after the scene is rendered.

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

loadSiblings : Boolean
Scene/Cesium3DTileset.js 721

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.

Only used when Cesium3DTileset#skipLevelOfDetail is true.

Default Value: false

luminanceAtZenith : Number
Scene/Cesium3DTileset.js 1872

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 Cesium3DTileset#specularEnvironmentMaps and Cesium3DTileset#sphericalHarmonicCoefficients are not defined.
Default Value: 0.2

maximumMemoryUsage : Number
Scene/Cesium3DTileset.js 1493

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.

Tiles not in view are unloaded to enforce this.

If decreasing this value results in unloading tiles, the tiles are unloaded the next frame.

If tiles sized more than maximumMemoryUsage are needed to meet the desired screen space error, determined by Cesium3DTileset#maximumScreenSpaceError, for the current view, then the memory usage of the tiles loaded will exceed maximumMemoryUsage. 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.

Default Value: 512
See:

maximumScreenSpaceError : Number
Scene/Cesium3DTileset.js 1449

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.

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 geometric error were rendered at the tile's position. If this value exceeds maximumScreenSpaceError the tile refines to its descendants.

Depending on the tileset, maximumScreenSpaceError may need to be tweaked to achieve the right balance. Higher values provide better performance but lower visual quality.

Default Value: 16

modelMatrix : Matrix4
Scene/Cesium3DTileset.js 1602

A 4x4 transformation matrix that transforms the entire tileset.
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);

pointCloudShading : PointCloudShading
Scene/Cesium3DTileset.js 1513

Options for controlling point size based on geometric error and eye dome lighting.

preferLeaves : Boolean
Scene/Cesium3DTileset.js 278

Optimization option. Prefer loading of leaves first.
Default Value: false

preloadFlightDestinations : Boolean
Scene/Cesium3DTileset.js 319

Optimization option. Fetch tiles at the camera's flight destination while the camera is in flight.
Default Value: true

preloadWhenHidden : Boolean
Scene/Cesium3DTileset.js 311

Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
Default Value: false

progressiveResolutionHeightFraction : Number
Scene/Cesium3DTileset.js 266

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.
Default Value: 0.3

readonly properties : Object
Scene/Cesium3DTileset.js 1178

Gets the tileset's properties dictionary object, which contains metadata about per-feature properties.

See the properties schema reference in the 3D Tiles spec for the full set of properties.

Example:
console.log('Maximum building height: ' + tileset.properties.height.maximum);
console.log('Minimum building height: ' + tileset.properties.height.minimum);
See:

readonly ready : Boolean
Scene/Cesium3DTileset.js 1203

When true, the tileset's root tile is loaded and the tileset is ready to render. This is set to true right before Cesium3DTileset#readyPromise is resolved.
Default Value: false

readonly readyPromise : Promise.<Cesium3DTileset>
Scene/Cesium3DTileset.js 1231

Gets the promise that will be resolved when the tileset's root tile is loaded and the tileset is ready to render.

This promise is resolved at the end of the frame before the first frame the tileset is rendered in.

Example:
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]);
        }
    }
});

readonly resource : Resource
Scene/Cesium3DTileset.js 1264

The resource used to fetch the tileset JSON file

readonly root : Cesium3DTile
Scene/Cesium3DTileset.js 1535

The root tile.

shadows : ShadowMode
Scene/Cesium3DTileset.js 436

Determines whether the tileset casts or receives shadows from light sources.

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.

Shadows are rendered only when Viewer#shadows is true.

Default Value: ShadowMode.ENABLED

show : Boolean
Scene/Cesium3DTileset.js 444

Determines if the tileset will be shown.
Default Value: true

showCreditsOnScreen : Boolean
Scene/Cesium3DTileset.js 1969

Determines whether the credits of the tileset will be displayed on the screen
Default Value: false

readonly showOutline : Boolean
Scene/Cesium3DTileset.js 784

Whether to display the outline for models using the CESIUM_primitive_outline extension. When true, outlines are displayed. When false, outlines are not displayed.
Default Value: true

skipLevelOfDetail : Boolean
Scene/Cesium3DTileset.js 653

Optimization option. Determines if level of detail skipping should be applied during the traversal.

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.

Default Value: false

skipLevels : Number
Scene/Cesium3DTileset.js 694

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.

Only used when Cesium3DTileset#skipLevelOfDetail is true.

Default Value: 1

skipScreenSpaceErrorFactor : Number
Scene/Cesium3DTileset.js 679

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 <= 100 / skipScreenSpaceErrorFactor.

Only used when Cesium3DTileset#skipLevelOfDetail is true.

Default Value: 16

specularEnvironmentMaps : String
Scene/Cesium3DTileset.js 1919

A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
Demo:
See:

sphericalHarmonicCoefficients : Array.<Cartesian3>
Scene/Cesium3DTileset.js 1900

The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. When undefined, a diffuse irradiance computed from the atmosphere color is used.

There are nine Cartesian3 coefficients. The order of the coefficients is: L0,0, L1,-1, L1,0, L1,1, L2,-2, L2,-1, L2,0, L2,1, L2,2

These values can be obtained by preprocessing the environment map using the cmgen tool of Google's Filament project. This will also generate a KTX file that can be supplied to Cesium3DTileset#specularEnvironmentMaps.
Demo:
See:

splitDirection : SplitDirection
Scene/Cesium3DTileset.js 792

The SplitDirection to apply to this tileset.
Default Value: SplitDirection.NONE

style : Cesium3DTileStyle|undefined
Scene/Cesium3DTileset.js 1334

The style, defined using the 3D Tiles Styling language, applied to each feature in the tileset.

Assign undefined to remove the style, which will restore the visual appearance of the tileset to its default when no style was applied.

The style is applied to a tile before the Cesium3DTileset#tileVisible event is raised, so code in tileVisible 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.

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.

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:

tileFailed : Event
Scene/Cesium3DTileset.js 602

The event fired to indicate that a tile's content failed to load.

If there are no event listeners, error messages will be logged to the console.

The error object passed to the listener contains two properties:

  • url: the url of the failed tile.
  • message: the error message.

If multiple contents are present, this event is raised once per inner content with errors.

Default Value: new Event()
Example:
tileset.tileFailed.addEventListener(function(error) {
    console.log('An error occurred loading tile: ' + error.url);
    console.log('Error: ' + error.message);
});

tileLoad : Event
Scene/Cesium3DTileset.js 552

The event fired to indicate that a tile's content was loaded.

The loaded Cesium3DTile is passed to the event listener.

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.

Default Value: new Event()
Example:
tileset.tileLoad.addEventListener(function(tile) {
    console.log('A tile was loaded.');
});

readonly tilesLoaded : Boolean
Scene/Cesium3DTileset.js 1250

When true, all tiles that meet the screen space error this frame are loaded. The tileset is completely loaded for this view.
Default Value: false
See:

tileUnload : Event
Scene/Cesium3DTileset.js 576

The event fired to indicate that a tile's content was unloaded.

The unloaded Cesium3DTile is passed to the event listener.

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.

Default Value: new Event()
Example:
tileset.tileUnload.addEventListener(function(tile) {
    console.log('A tile was unloaded from the cache.');
});
See:

tileVisible : Event
Scene/Cesium3DTileset.js 639

This event fires once for each visible tile in a frame. This can be used to manually style a tileset.

The visible Cesium3DTile is passed to the event listener.

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.

Default Value: new Event()
Examples:
tileset.tileVisible.addEventListener(function(tile) {
    if (tile.content instanceof Cesium.Batched3DModel3DTileContent) {
        console.log('A Batched 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();
    }
});

readonly timeSinceLoad : Number
Scene/Cesium3DTileset.js 1619

Returns the time, in milliseconds, since the tileset was loaded and first updated.

readonly totalMemoryUsageInBytes : Number
Scene/Cesium3DTileset.js 1637

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.
See:

vectorClassificationOnly : Boolean
Scene/Cesium3DTileset.js 1938

Indicates that only the tileset's vector tiles should be used for classification.
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.

vectorKeepDecodedPositions : Boolean
Scene/Cesium3DTileset.js 1955

Whether vector tiles should keep decoded positions in memory. This is used with Cesium3DTileFeature.getPolylinePositions.
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

static Cesium.Cesium3DTileset.loadJson(tilesetUrl) → Promise.<Object>
Scene/Cesium3DTileset.js 2057

Provides a hook to override the method used to request the tileset json useful when fetching tilesets from remote servers
Name Type Description
tilesetUrl Resource | String The url of the json file to be fetched
Returns:
A promise that resolves with the fetched json data

destroy()
Scene/Cesium3DTileset.js 3132

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.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
tileset = tileset && tileset.destroy();
See:

hasExtension(extensionName) → Boolean
Scene/Cesium3DTileset.js 3095

true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false.
Name Type Description
extensionName String The name of the extension to check.
Returns:
true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false.

isDestroyed() → Boolean
Scene/Cesium3DTileset.js 3113

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:

makeStyleDirty()
Scene/Cesium3DTileset.js 2066

Marks the tileset's Cesium3DTileset#style as dirty, which forces all features to re-evaluate the style in the next frame each is visible.

trimLoadedTiles()
Scene/Cesium3DTileset.js 2879

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 Cesium3DTileset#maximumMemoryUsage.

Tile unloads occur at the next frame to keep all the WebGL delete calls within the render loop.

Type Definitions

Cesium.Cesium3DTileset.foveatedInterpolationCallback(p, q, time) → Number
Scene/Cesium3DTileset.js 3198

Optimization option. Used as a callback 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.
Name Type Description
p Number The start value to interpolate.
q Number The end value to interpolate.
time Number The time of interpolation generally in the range [0.0, 1.0].
Returns:
The interpolated value.
Default Value: Math.lerp
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.