new Cesium3DTileset(options)

A 3D Tile set for streaming large-scale heterogeneous 3D geospatial datasets.

This object is usually not instantiated directly; use Cesium3DTileset.fromUrl。

Name	Type	Description
`options`	Cesium3DTileset.ConstructorOptions	Object describing initialization options

Throws:

The tile set must be 3D Tiles version 0.0 or 1.0.
Type DeveloperError

Examples

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

// Enable collision detection between the camera and the tile set.
try {
  const tileset = await Cesium.Cesium3DTileset.fromUrl(
     "http://localhost:8002/tilesets/Seattle/tileset.json",
     { enableCollision: true }
  );
  scene.primitives.add(tileset);
} catch (error) {
  console.error(`Error creating tileset: ${error}`);
}

// Common settings for 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 dynamicScreenSpaceError optimization
const tileset = await Cesium.Cesium3DTileset.fromUrl(
  "http://localhost:8002/tilesets/Seattle/tileset.json", {
     dynamicScreenSpaceError: true,
     dynamicScreenSpaceErrorDensity: 2.0e-4,
     dynamicScreenSpaceErrorFactor: 24.0,
     dynamicScreenSpaceErrorHeightFalloff: 0.25
});
scene.primitives.add(tileset);

Members

allTilesLoadedEvent

Used to indicate that all tiles in this frame that meet the screen space error have been loaded. At this point, the tile set has been fully loaded in this view.

This event is triggered at the end of the frame after rendering the scene.

Default Value:

See:

Cesium3DTileset#tilesLoaded

Example

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

readonly assetobject

Retrieve the asset object properties of the tile set, which contain metadata about the tile set.

For a complete set of attributes, please refer to the asset mode reference in the 3D Tiles specification.

backFaceCullingboolean

Should we exclude the back geometry. When true, the backside removal is determined by the doubleSided attribute of the glTF material; When false, backside removal is disabled.

Default Value:

(deprecated, readonly) basePathstring

The relative base path of non absolute paths in the tile set JSON file.

baseScreenSpaceErrornumber

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

Only used when Cesium3DTileset # skipLevelOfDetail is true.

Default Value:

readonly boundingSphereBoundingSphere

The boundary sphere of the tile set.

Example

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

viewer.scene.primitives.add(tileset);

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

cacheBytesnumber

The amount of GPU memory (in bytes) used for caching tiles. This memory usage is estimated based on the geometry, texture, and batch table texture of the loaded tiles. For point clouds, this value also includes metadata for each point.

Tiles that are not in the view will be unloaded to enforce this restriction.

If reducing this value results in unloading tiles, the tiles will be unloaded in the next frame.

If the current view requires tiles larger than the cache bytes size to meet the required screen space error determined by Cesium3DTileset # maximumScreenSpaceError, then the memory usage of the loaded tiles will exceed the maximum cache bytes of maximumCacheOverflow bytes. For example, if the cache bytes are 500000 but 600000 bytes of tiles are needed to meet the screen space error, then 600000 bytes of tiles may be loaded (if the maximum cache overflow bytes are at least 100000). When these tiles are removed from the view, they will be unloaded.

Default Value:

See:

Cesium3DTileset#totalMemoryUsageInBytes

readonly classificationTypeClassificationType

Determine whether terrain, 3D tiles, or both will be classified by this tile set.

This option is only applicable to tile sets that contain batch 3D models, glTF content, geometric data, or vector data. Even if undefined, vector and geometric data must be rendered as classification and will be rendered on terrain and other 3D Tile sets by default.

When enabling batch processing of 3D models and glTF tile sets, glTF has some requirements/limitations:

glTF cannot contain morph targets, skins, or animations.
glTF cannot contain the EXT_mesh_gpu_instancing extension.
Only meshes with TRIANGLES can be used to classify other assets.
The mesh must be watertight.
POSITION semantics are required.
If both _BATCHID and index buffer exist, all indices with the same batch ID must occupy a contiguous portion of the index buffer.
If _BATCHID exists but no index buffer, all positions with the same batch ID must occupy a contiguous portion of the position buffer.

In addition, point or instantiated 3D models do not support classification.

The 3D tiles or terrain that receive classification must be opaque.

Default Value:

clippingPlanesClippingPlaneCollection

The ClippingPlaneCollection used to selectively disable rendering the tileset.

colorBlendAmountnumber

Define the value used for linear interpolation between source color and feature color when Cesium3DTileset # colorBlendMode is MIX. When the value is 0.0, the result is the source color, and when the value is 1.0, the result is the feature color. Any value in between will result in a mixture of the source color and the feature color.

Default Value:

colorBlendModeCesium3DTileColorBlendMode

Define how the color of each feature set from Cesium API or declarative style blends with the source color of the original feature, such as the color of each point in glTF material or tile.

Default Value:

cullRequestsWhileMovingboolean

Optimize options. Do not request tiles that may not be used upon return due to camera movement. This optimization is only applicable to stationary tile sets.

Default Value:

cullRequestsWhileMovingMultipliernumber

Optimize options. The multiplier used to exclude requests during movement. The larger the value, the more actively it is eliminated; The smaller the value, the less proactive the exclusion.

Default Value:

customShaderCustomShader undefined

A custom shader applied to all tiles in the tile set. Only for use with Model content. Using custom shaders with Cesium3DTileStyle may result in undefined behavior.

Default Value: