Class: Cesium3DTileset

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

// Turn on camera collisions with the tileset.
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 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: 2.0e-4,
     dynamicScreenSpaceErrorFactor: 24.0,
     dynamicScreenSpaceErrorHeightFalloff: 0.25
});
scene.primitives.add(tileset);

Members

allTilesLoadedEvent

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()

See:

• Cesium3DTileset#tilesLoaded

Example

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

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

var provider = new SuperMap3D.SuperMapImageryProvider({url : URL_CONFIG.ZF_IMG});
provider.readyPromise.then(function() {
   tileset.imageryLayers.addImageryProvider(provider);      
});

Example

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

Example

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

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

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

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

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

Example

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

Example

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

Example

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

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

Methods

static fromIonAssetId(assetId, options){Promise.<Cesium3DTileset>}

Creates a 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets, from a Cesium ion asset ID.

Name	Type	Description
assetId	number	The Cesium ion asset id.
options	Cesium3DTileset.ConstructorOptions	可选 An object describing initialization options

See:

• Cesium3DTileset#fromUrl

Throws:

When the tileset asset version is not 0.0, 1.0, or 1.1, or when the tileset contains a required extension that is not supported.

Type

RuntimeError

Returns:

Type	Description
Promise.<Cesium3DTileset>

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

static fromUrl(url, options){Promise.<Cesium3DTileset>}

Creates a 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets.

Name	Type	Description
url	Resource | string	The url to a tileset JSON file.
options	Cesium3DTileset.ConstructorOptions	可选 An object describing initialization options

See:

• Cesium3DTileset#fromIonAssetId

Throws:

When the tileset asset version is not 0.0, 1.0, or 1.1, or when the tileset contains a required extension that is not supported.

Type

RuntimeError

Returns:

Type	Description
Promise.<Cesium3DTileset>

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: 2.0e-4,
     dynamicScreenSpaceErrorFactor: 24.0,
     dynamicScreenSpaceErrorHeightFalloff: 0.25
});
scene.primitives.add(tileset);

static loadJson(tilesetUrl){Promise.<object>}

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:

Type	Description
Promise.<object>	A promise that resolves with the fetched json data

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.

See:

• Cesium3DTileset#isDestroyed

Throws:

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

Type

DeveloperError

Example

tileset = tileset && tileset.destroy();

getHeight(cartographic, scene){number|undefined}

Get the height of the loaded surface at a given cartographic. This function will only take into account meshes for loaded tiles, not neccisarily the most detailed tiles available for a tileset. This function will always return undefined when sampling a point cloud.

Name	Type	Description
cartographic	Cartographic	The cartographic for which to find the height.
scene	Scene	The scene where visualization is taking place.

Returns:

Type	Description
number | undefined	The height of the cartographic or undefined if it could not be found.

Example

const tileset = await Cesium.Cesium3DTileset.fromIonAssetId(124624234);
scene.primitives.add(tileset);

const height = tileset.getHeight(scene.camera.positionCartographic, scene);

hasExtension(extensionName){boolean}

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:

Type	Description
boolean	true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false.

isDestroyed(){boolean}

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.

See:

• Cesium3DTileset#destroy

Returns:

Type	Description
boolean	true if this object was destroyed; otherwise, false.

makeStyleDirty()

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()

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#cacheBytes.

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

Type Definitions

ConstructorOptionsObject

Initialization options for the Cesium3DTileset constructor

Properties:

Name	Type	Default	Description
show	boolean	true	可选 Determines if the tileset will be shown.
modelMatrix	Matrix4	Matrix4.IDENTITY	可选 A 4x4 transformation matrix that transforms the tileset's root tile.
modelUpAxis	Axis	Axis.Y	可选 Which axis is considered up when loading models for tile contents.
modelForwardAxis	Axis	Axis.X	可选 Which axis is considered forward when loading models for tile contents.
shadows	ShadowMode	ShadowMode.ENABLED	可选 Determines whether the tileset casts or receives shadows from light sources.
maximumScreenSpaceError	number	16	可选 The maximum screen space error used to drive level of detail refinement.
cacheBytes	number	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	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	true	可选 Optimization option. Whether to cull tiles using the union of their children bounding volumes.
cullRequestsWhileMoving	boolean	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	60.0	可选 Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
preloadWhenHidden	boolean	false	可选 Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
preloadFlightDestinations	boolean	true	可选 Optimization option. Preload tiles at the camera's flight destination while the camera is in flight.
preferLeaves	boolean	false	可选 Optimization option. Prefer loading of leaves first.
dynamicScreenSpaceError	boolean	true	可选 Optimization option. For street-level horizon views, use lower resolution tiles far from the camera. This reduces the amount of data loaded and improves tileset loading time with a slight drop in visual quality in the distance.
dynamicScreenSpaceErrorDensity	number	2.0e-4	可选 Similar to Fog#density, this option controls the camera distance at which the Cesium3DTileset#dynamicScreenSpaceError optimization applies. Larger values will cause tiles closer to the camera to be affected.
dynamicScreenSpaceErrorFactor	number	24.0	可选 A parameter that controls the intensity of the Cesium3DTileset#dynamicScreenSpaceError optimization for tiles on the horizon. Larger values cause lower resolution tiles to load, improving runtime performance at a slight reduction of visual quality.
dynamicScreenSpaceErrorHeightFalloff	number	0.25	可选 A ratio of the tileset's height that determines where "street level" camera views occur. When the camera is below this height, the Cesium3DTileset#dynamicScreenSpaceError optimization will have the maximum effect, and it will roll off above this value.
progressiveResolutionHeightFraction	number	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	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	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	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	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	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	false	可选 Optimization option. Determines if level of detail skipping should be applied during the traversal.
baseScreenSpaceError	number	1024	可选 When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail.
skipScreenSpaceErrorFactor	number	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	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	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	false	可选 When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal.
clippingPlanes	ClippingPlaneCollection		可选 The ClippingPlaneCollection used to selectively disable rendering the tileset.
classificationType	ClassificationType		可选 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	可选 The ellipsoid determining the size and shape of the globe.
pointCloudShading	object		可选 Options for constructing a PointCloudShading object to control point attenuation based on geometric error and lighting.
lightColor	Cartesian3		可选 The light color when shading models. When undefined the scene's light color is used instead.
imageBasedLighting	ImageBasedLighting		可选 The properties for managing image-based lighting for this tileset.
backFaceCulling	boolean	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	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	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	Color.BLACK	可选 The color to use when rendering outlines.
vectorClassificationOnly	boolean	false	可选 Indicates that only the tileset's vector tiles should be used for classification.
vectorKeepDecodedPositions	boolean	false	可选 Whether vector tiles should keep decoded positions in memory. This is used with Cesium3DTileFeature.getPolylinePositions.
featureIdLabel	string | number	"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	"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	false	可选 Whether to display the credits of this tileset on screen.
splitDirection	SplitDirection	SplitDirection.NONE	可选 The SplitDirection split to apply to this tileset.
enableCollision	boolean	false	可选 When true, enables collisions for camera or CPU picking. While this is true the camera will be prevented from going below the tileset surface if ScreenSpaceCameraController#enableCollisionDetection is true.
disableCollision	boolean	true	可选 Whether to turn off collisions for camera collisions or picking. While this is true the camera will be allowed to go in or below the tileset surface if ScreenSpaceCameraController#enableCollisionDetection is true. Deprecated.
projectTo2D	boolean	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 been created.
enablePick	boolean	false	可选 Whether to allow collision and CPU picking with pick when using WebGL 1. If using WebGL 2 or above, this option will be ignored. If using WebGL 1 and this is true, the pick operation will work correctly, but it will use more memory to do so. If running with WebGL 1 and this is false, the model will use less memory, but pick will always return undefined. This cannot be set after the tileset has loaded.
asynchronouslyLoadImagery	boolean	false	可选 Whether loading imagery that is draped over the tileset should be done asynchronously. If this is true, then tile content will be displayed with its original texture until the imagery texture is loaded. If this is false, then the tile content will not be displayed until the imagery is ready.
debugHeatmapTilePropertyName	string		可选 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	可选 For debugging only. Determines if only the tiles from last frame should be used for rendering.
debugColorizeTiles	boolean	false	可选 For debugging only. When true, assigns a random color to each tile.
enableDebugWireframe	boolean	false	可选 For debugging only. This must be true for debugWireframe to work in WebGL1. This cannot be set after the tileset has been created.
debugWireframe	boolean	false	可选 For debugging only. When true, render's each tile's content as a wireframe.
debugShowBoundingVolume	boolean	false	可选 For debugging only. When true, renders the bounding volume for each tile.
debugShowContentBoundingVolume	boolean	false	可选 For debugging only. When true, renders the bounding volume for each tile's content.
debugShowViewerRequestVolume	boolean	false	可选 For debugging only. When true, renders the viewer request volume for each tile.
debugShowGeometricError	boolean	false	可选 For debugging only. When true, draws labels to indicate the geometric error of each tile.
debugShowRenderingStatistics	boolean	false	可选 For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile.
debugShowMemoryUsage	boolean	false	可选 For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile.
debugShowUrl	boolean	false	可选 For debugging only. When true, draws labels to indicate the url of each tile.

foveatedInterpolationCallback(p, q, time){number}

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].

Default Value:

Math.lerp

Returns: