Cesium3DTileset

new Cesium.Cesium3DTileset(options)

A 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets.
This object is normally not instantiated directly, use Cesium3DTileset.fromUrl.
参数名称 类型 描述信息
options Cesium3DTileset.ConstructorOptions An object describing initialization options
Throws:
使用示例s:
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}`);
}
// 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);
参考:

成员(属性)

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.

默认值: new Event()
使用示例:
tileset.allTilesLoaded.addEventListener(function() {
    console.log('All tiles are loaded');
});
参考:
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

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.
默认值: true

readonly deprecated basePath : string

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

Deprecated: true

baseScreenSpaceError : number

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

Only used when Cesium3DTileset#skipLevelOfDetail is true.

默认值: 1024
The tileset's bounding sphere.
使用示例:
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));
The amount of GPU memory (in bytes) used to cache tiles. This memory usage 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 cacheBytes 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 cacheBytes by up to maximumCacheOverflowBytes. For example, if cacheBytes is 500000, but 600000 bytes of tiles are needed to meet the screen space error, then 600000 bytes of tiles may be loaded (if maximumCacheOverflowBytes is at least 100000). When these tiles go out of view, they will be unloaded.

默认值: 536870912
参考:
Determines whether terrain, 3D Tiles, or both will be classified by this tileset.

This option is only applied to tilesets containing batched 3D models, glTF content, geometry data, or vector data. Even when undefined, vector 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 and glTF tilesets, there are a few requirements/limitations on the glTF:

  • The glTF cannot contain morph targets, skins, or animations.
  • The glTF cannot contain the EXT_mesh_gpu_instancing extension.
  • Only meshes with TRIANGLES can be used to classify other assets.
  • The meshes must be watertight.
  • The POSITION semantic is required.
  • If _BATCHIDs and an index buffer are both present, all indices with the same batch id must occupy contiguous sections of the index buffer.
  • If _BATCHIDs are present with no index buffer, all positions with the same batch id must occupy contiguous sections of the position buffer.

Additionally, classification is not supported for points or instanced 3D models.

The 3D Tiles or terrain receiving the classification must be opaque.

默认值: 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.

The ClippingPlaneCollection used to selectively disable rendering the tileset.

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.
默认值: 0.5
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.
默认值: Cesium3DTileColorBlendMode.HIGHLIGHT

cullRequestsWhileMoving : boolean

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.
默认值: true

cullRequestsWhileMovingMultiplier : number

Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling.
默认值: 60.0
A custom shader to apply to all tiles in the tileset. Only used for contents that use Model. Using custom shaders with a Cesium3DTileStyle may lead to undefined behavior.
默认值: 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

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.

默认值: false

debugFreezeFrame : boolean

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.

默认值: false

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

默认值: false

debugShowContentBoundingVolume : boolean

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.

默认值: false

debugShowGeometricError : boolean

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.

默认值: false

debugShowMemoryUsage : boolean

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.

默认值: false

debugShowRenderingStatistics : boolean

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.

默认值: false
This property is for debugging only; it is not optimized for production use.

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

默认值: false

debugShowViewerRequestVolume : boolean

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

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

默认值: false
This property is for debugging only; it is not optimized for production use.

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

默认值: false

dynamicScreenSpaceError : boolean

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.

This optimization is strongest when the camera is close to the ground plane of the tileset and looking at the horizon. Furthermore, the results are more accurate for tightly fitting bounding volumes like box and region.

默认值: true

dynamicScreenSpaceErrorDensity : number

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. This value must be non-negative.

This optimization works by rolling off the tile screen space error (SSE) with camera distance like a bell curve. This has the effect of selecting lower resolution tiles far from the camera. Near the camera, no adjustment is made. For tiles further away, the SSE is reduced by up to Cesium3DTileset#dynamicScreenSpaceErrorFactor (measured in pixels of error).

Increasing the density makes the bell curve narrower so tiles closer to the camera are affected. This is analagous to moving fog closer to the camera.

When the density is 0, the optimization will have no effect on the tileset.

默认值: 2.0e-4

dynamicScreenSpaceErrorFactor : number

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. The value must be non-negative.

More specifically, this parameter represents the maximum adjustment to screen space error (SSE) in pixels for tiles far away from the camera. See Cesium3DTileset#dynamicScreenSpaceErrorDensity for more details about how this optimization works.

When the SSE factor is set to 0, the optimization will have no effect on the tileset.

默认值: 24.0

dynamicScreenSpaceErrorHeightFalloff : number

A ratio of the tileset's height that determines "street level" for the Cesium3DTileset#dynamicScreenSpaceError optimization. When the camera is below this height, the dynamic screen space error optimization will have the maximum effect, and it will roll off above this value. Valid values are between 0.0 and 1.0.

默认值: 0.25
Gets an ellipsoid describing the shape of the globe.

enableCollision : boolean

If true, allows collisions for camera collisions or picking. While this is true the camera will be prevented from going in or below the tileset surface if ScreenSpaceCameraController#enableCollisionDetection is true. This can have performance implecations if the tileset contains tile with a larger number of vertices.
默认值: false

examineVectorLinesFunction : function

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

Gets the tileset's extensions object property.
Returns the extras property at the top-level of the tileset JSON, which contains application specific metadata. Returns undefined if extras does not exist.
参考:
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.

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.
默认值: 0.3
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

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.
默认值: 0.0

foveatedScreenSpaceError : boolean

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.
默认值: true

foveatedTimeDelay : number

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.
默认值: 0.2
The properties for managing image-based lighting on this tileset.

immediatelyLoadDesiredLevelOfDetail : boolean

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.

默认值: false
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.

默认值: new Event()
使用示例:
tileset.initialTilesLoaded.addEventListener(function() {
    console.log('Initial tiles are loaded');
});
参考:

instanceFeatureIdLabel : string

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.

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

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

默认值: undefined
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.

默认值: new Event()
使用示例:
tileset.loadProgress.addEventListener(function(numberOfPendingRequests, numberOfTilesProcessing) {
    if ((numberOfPendingRequests === 0) && (numberOfTilesProcessing === 0)) {
        console.log('Stopped loading');
        return;
    }

    console.log(`Loading: requests: ${numberOfPendingRequests}, processing: ${numberOfTilesProcessing}`);
});
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.

默认值: false

maximumCacheOverflowBytes : number

The maximum additional amount of GPU memory (in bytes) that will be used to cache tiles.

If tiles sized more than cacheBytes plus maximumCacheOverflowBytes are needed to meet the desired screen space error, determined by Cesium3DTileset#maximumScreenSpaceError for the current view, then Cesium3DTileset#memoryAdjustedScreenSpaceError will be adjusted until the tiles required to meet the adjusted screen space error use less than cacheBytes plus maximumCacheOverflowBytes.

默认值: 536870912
参考:

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.

默认值: 16
A 4x4 transformation matrix that transforms the entire tileset.
默认值: Matrix4.IDENTITY
使用示例:
// 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);
The color to use when rendering outlines.
默认值: Color.BLACK
Options for controlling point size based on geometric error and eye dome lighting.
Optimization option. Prefer loading of leaves first.
默认值: false

preloadFlightDestinations : boolean

Optimization option. Fetch tiles at the camera's flight destination while the camera is in flight.
默认值: true

preloadWhenHidden : boolean

Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them.
默认值: false

progressiveResolutionHeightFraction : number

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.
默认值: 0.3

readonly properties : object

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.

使用示例:
console.log(`Maximum building height: ${tileset.properties.height.maximum}`);
console.log(`Minimum building height: ${tileset.properties.height.minimum}`);
参考:
The resource used to fetch the tileset JSON file
The root tile.
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.

默认值: ShadowMode.ENABLED
Determines if the tileset will be shown.
默认值: true

showCreditsOnScreen : boolean

Determines whether the credits of the tileset will be displayed on the screen
默认值: false
Whether to display the outline for models using the CESIUM_primitive_outline extension. When true, outlines are displayed. When false, outlines are not displayed.
默认值: true

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.

默认值: false
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.

默认值: 1

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.

Only used when Cesium3DTileset#skipLevelOfDetail is true.

默认值: 16
The SplitDirection to apply to this tileset.
默认值: SplitDirection.NONE
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.

默认值: undefined
使用示例:
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}."'
   }
});
参考:
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.

默认值: new Event()
使用示例:
tileset.tileFailed.addEventListener(function(error) {
    console.log(`An error occurred loading tile: ${error.url}`);
    console.log(`Error: ${error.message}`);
});
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.

默认值: new Event()
使用示例:
tileset.tileLoad.addEventListener(function(tile) {
    console.log('A tile was loaded.');
});

readonly tilesLoaded : boolean

When true, all tiles that meet the screen space error this frame are loaded. The tileset is completely loaded for this view.
默认值: false
参考:
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.

默认值: new Event()
使用示例:
tileset.tileUnload.addEventListener(function(tile) {
    console.log('A tile was unloaded from the cache.');
});
参考:
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.

默认值: new Event()
使用示例s:
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();
    }
});

readonly timeSinceLoad : number

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

readonly totalMemoryUsageInBytes : number

The total amount of GPU memory in bytes used by the tileset. This value is estimated from geometry, texture, batch table textures, and binary metadata of loaded tiles.
参考:

vectorClassificationOnly : boolean

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

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

方法

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

Creates a 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets, from a Cesium ion asset ID.
参数名称 类型 描述信息
assetId number The Cesium ion asset id.
options Cesium3DTileset.ConstructorOptions 可选 An object describing initialization options
返回值:
Throws:
  • RuntimeError : 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.
使用示例:
// 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}`);
}
参考:
  • Cesium3DTileset#fromUrl

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

Creates a 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets.
参数名称 类型 描述信息
url Resource | string The url to a tileset JSON file.
options Cesium3DTileset.ConstructorOptions 可选 An object describing initialization options
返回值:
Throws:
  • RuntimeError : 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.
使用示例s:
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);
参考:
  • Cesium3DTileset#fromIonAssetId

static Cesium.Cesium3DTileset.loadJson(tilesetUrl)Promise.<object>

Provides a hook to override the method used to request the tileset json useful when fetching tilesets from remote servers
参数名称 类型 描述信息
tilesetUrl Resource | string The url of the json file to be fetched
返回值:
A promise that resolves with the fetched json data
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.
使用示例:
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.
参数名称 类型 描述信息
cartographic Cartographic The cartographic for which to find the height.
scene Scene The scene where visualization is taking place.
返回值:
The height of the cartographic or undefined if it could not be found.
使用示例:
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.
参数名称 类型 描述信息
extensionName string The name of the extension to check.
返回值:
true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false.
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.
返回值:
true if this object was destroyed; otherwise, false.
参考:
Marks the tileset's Cesium3DTileset#style as dirty, which forces all features to re-evaluate the style in the next frame each is visible.
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.

定义的类型

Cesium.Cesium3DTileset.ConstructorOptions

Initialization options for the Cesium3DTileset constructor
属性:
属性名称 类型 可选 默认值 描述信息
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.
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.
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.

Cesium.Cesium3DTileset.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.
参数名称 类型 描述信息
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].
返回值:
The interpolated value.
默认值: Math.lerp