optional
Determines whether the tileset casts or receives shadows from each light source.

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.

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.

skipLevelOfDetail

Boolean

true

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.

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.

colorBlendAmount : Number

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.

debugColorizeTiles : Boolean

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.

debugShowBoundingVolume : Boolean

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; otherwise, it is red. Tiles that don't meet the
screen space error and are still refining to their descendants are yellow.

dynamicScreenSpaceError : Boolean

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

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

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

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.

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.

maximumMemoryUsage : Number

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

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.

show : Boolean

skipLevelOfDetail : Boolean

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:true

skipLevels : Number

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.

skipScreenSpaceErrorFactor : Number

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.

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.

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.

See:

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

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.

readonlytimeSinceLoad : Number

readonlytotalMemoryUsageInBytes : Number

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.

Returns:

destroy()

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.