Cesium3DTileset

Members

Default Value: new Event()

Example:

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

See:

• Cesium3DTileset#tilesLoaded

Default Value: true

Deprecated: true

Default Value: 1024

Example:

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

Default Value: 536870912

See:

• Cesium3DTileset#totalMemoryUsageInBytes

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.

Default Value: 0.5

Default Value: Cesium3DTileColorBlendMode.HIGHLIGHT

Default Value: true

Default Value: 60.0

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.

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: false

Default Value: true

Default Value: 2.0e-4

Default Value: 24.0

Default Value: 0.25

Default Value: EdgeDisplayMode.SURFACES_ONLY

Experimental

This feature is using part of the glTF spec that is not yet final and is subject to change without Cesium's standard deprecation policy.

Default Value: false

Example:

// Change the ground color used for a tileset's environment map to a forest green
const environmentMapManager = tileset.environmentMapManager;
environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");

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.

See:

• Extras in the 3D Tiles specification.

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.

Default Value: 0.3

Default Value: 0.0

Default Value: true

Default Value: 0.2

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.

Example:

// Drape Bing Maps Aerial imagery over the tileset
const imageryProvider = await Cesium.createWorldImageryAsync({
  style: Cesium.IonWorldImageryStyle.AERIAL,
});
const imageryLayer = new ImageryLayer(imageryProvider);
tileset.imageryLayers.add(imageryLayer);

Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

See:

• ImageryLayer

Default Value: false

Default Value: new Event()

Example:

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

See:

• Cesium3DTileset#allTilesLoaded

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.

Default Value: undefined

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

Default Value: false

Default Value: 536870912

See:

• Cesium3DTileset#totalMemoryUsageInBytes

Default Value: 16

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

Default Value: Color.BLACK

Default Value: false

Default Value: true

Default Value: false

Default Value: 0.3

Example:

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

See:

• Cesium3DTileFeature#getProperty
• Cesium3DTileFeature#setProperty

Default Value: undefined

Default Value: ShadowMode.ENABLED

Default Value: true

Default Value: false

Default Value: true

Default Value: false

Default Value: 1

Default Value: 16

Default Value: SplitDirection.NONE

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:

• 3D Tiles Styling language

Default Value: new Event()

Example:

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

Default Value: new Event()

Example:

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

Default Value: false

See:

• Cesium3DTileset#allTilesLoaded

Default Value: new Event()

Example:

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

See:

• Cesium3DTileset#cacheBytes
• Cesium3DTileset#trimLoadedTiles

Default Value: new Event()

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

See:

• Cesium3DTileset#cacheBytes

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.

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

Returns:

Throws:

• RuntimeError ：当 tileset 资源版本不是 0.0、1.0 或 1.1，或者当 tileset 包含不受支持的可选扩展时。

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

See:

• Cesium3DTileset#fromUrl

Returns:

Throws:

• RuntimeError ：当 tileset 资源版本不是 0.0、1.0 或 1.1，或者当 tileset 包含不受支持的可选扩展时。

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

See:

• Cesium3DTileset#fromIonAssetId

Returns:

Throws:

• DeveloperError ：此对象已被销毁，即已调用 destroy()。

Example:

tileset = tileset && tileset.destroy();

See:

• Cesium3DTileset#isDestroyed

Returns:

Example:

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

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

Returns:

Returns:

See:

• Cesium3DTileset#destroy

Type Definitions

Properties:

Name	Type	Attributes	Default	Description
show	boolean	<optional>	true	确定 tileset 是否会显示。
modelMatrix	Matrix4	<optional>	Matrix4.IDENTITY	变换 tileset 根瓦片的 4x4 变换矩阵。
modelUpAxis	Axis	<optional>	Axis.Y	加载瓦片内容的模型时，哪个轴被视为上方向。
modelForwardAxis	Axis	<optional>	Axis.X	加载瓦片内容的模型时，哪个轴被视为前方向。
shadows	ShadowMode	<optional>	ShadowMode.ENABLED	确定 tileset 是否投射或接收来自光源的阴影。
maximumScreenSpaceError	number	<optional>	16	用于驱动细节层次细化的最大屏幕空间误差。
cacheBytes	number	<optional>	536870912	如果缓存中包含当前视图不需要的瓦片，则瓦片缓存将被修剪到的尺寸（以字节为单位）。
maximumCacheOverflowBytes	number	<optional>	536870912	如果当前视图需要超过 Cesium3DTileset#cacheBytes 的内存，则允许用于缓存余量的额外最大内存（以字节为单位）。
cullWithChildrenBounds	boolean	<optional>	true	优化选项。是否使用其子节点包围体的并集来剔除瓦片。
cullRequestsWhileMoving	boolean	<optional>	true	优化选项。不要请求那些由于相机移动而在返回时很可能不会被使用的瓦片。此优化仅适用于静止的 tilesets。
cullRequestsWhileMovingMultiplier	number	<optional>	60.0	优化选项。在移动时进行剔除请求所用的乘数。值越大剔除越激进，值越小剔除越保守。
preloadWhenHidden	boolean	<optional>	false	当 tileset.show 为 false 时预加载瓦片。以 tileset 可见的方式加载瓦片，但不渲染它们。
preloadFlightDestinations	boolean	<optional>	true	优化选项。在相机飞行过程中，在其飞行目的地预加载瓦片。
preferLeaves	boolean	<optional>	false	优化选项。优先加载叶节点。
dynamicScreenSpaceError	boolean	<optional>	true	优化选项。对于街道级别的视平线视图，使用距离相机较远的较低分辨率瓦片。这减少了加载的数据量，并改善了 tileset 加载时间，但远处视觉质量略有下降。
dynamicScreenSpaceErrorDensity	number	<optional>	2.0e-4	类似于 Fog#density，此选项控制 Cesium3DTileset#dynamicScreenSpaceError 优化生效的相机距离。值越大，距离相机越近的瓦片会受到影响。
dynamicScreenSpaceErrorFactor	number	<optional>	24.0	一个控制位于视平线上的瓦片的 Cesium3DTileset#dynamicScreenSpaceError 优化强度的参数。值越大，加载的分辨率越低的瓦片，以略微降低视觉质量为代价来提高运行时性能。
dynamicScreenSpaceErrorHeightFalloff	number	<optional>	0.25	tileset 高度的一个比例，用于确定“街道级别”相机视图出现的位置。当相机低于此高度时，Cesium3DTileset#dynamicScreenSpaceError 优化将产生最大效果，高于此值时效果会衰减。
progressiveResolutionHeightFraction	number	<optional>	0.3	优化选项。如果在 (0.0, 0.5] 之间，则优先加载达到或高于 progressiveResolutionHeightFraction*screenHeight 降低的屏幕分辨率的屏幕空间误差的瓦片。这有助于在完整分辨率瓦片继续加载的同时快速获取一层瓦片。
foveatedScreenSpaceError	boolean	<optional>	true	优化选项。通过临时提高屏幕边缘周围瓦片的屏幕空间误差，优先加载屏幕中央的瓦片。一旦由 Cesium3DTileset#foveatedConeSize 确定的屏幕中央的所有瓦片加载完成，屏幕空间误差将恢复正常。
foveatedConeSize	number	<optional>	0.1	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为 true 时，用于控制确定哪些瓦片被延迟的锥体大小。位于此锥体内部的瓦片会立即加载。位于锥体外部的瓦片会根据它们超出锥体的程度及其屏幕空间误差被延迟。这由 Cesium3DTileset#foveatedInterpolationCallback 和 Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 控制。将此值设置为 0.0 表示锥体将是由相机位置和其视图方向形成的直线。将此值设置为 1.0 表示锥体涵盖相机的整个视野，实质上禁用了该效果。
foveatedMinimumScreenSpaceErrorRelaxation	number	<optional>	0.0	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为 true 时，用于控制注视点锥体外部瓦片的起始屏幕空间误差松弛。屏幕空间误差将从 tileset 的值开始，根据提供的 Cesium3DTileset#foveatedInterpolationCallback 提高到 Cesium3DTileset#maximumScreenSpaceError。
foveatedInterpolationCallback	Cesium3DTileset.foveatedInterpolationCallback	<optional>	Math.lerp	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为 true 时，用于控制对注视点锥体外部瓦片的屏幕空间误差提高多少，在 Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 和 Cesium3DTileset#maximumScreenSpaceError 之间进行插值
foveatedTimeDelay	number	<optional>	0.2	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为 true 时，用于控制相机停止移动后，延迟瓦片开始加载之前等待的秒数。此时间延迟可防止在相机移动时请求屏幕边缘周围的瓦片。将此值设置为 0.0 将立即请求任何给定视图中的所有瓦片。
skipLevelOfDetail	boolean	<optional>	false	优化选项。确定在遍历过程中是否应用细节层次跳过。
baseScreenSpaceError	number	<optional>	1024	当 skipLevelOfDetail 为 true 时，在跳过细节层次之前必须达到的屏幕空间误差。
skipScreenSpaceErrorFactor	number	<optional>	16	当 skipLevelOfDetail 为 true 时，定义要跳过的最小屏幕空间误差的乘数。与 skipLevels 结合使用以确定要加载哪些瓦片。
skipLevels	number	<optional>	1	当 skipLevelOfDetail 为 true 时，定义加载瓦片时要跳过的最小层级数的常量。当它为 0 时，不跳过任何层级。与 skipScreenSpaceErrorFactor 结合使用以确定要加载哪些瓦片。
immediatelyLoadDesiredLevelOfDetail	boolean	<optional>	false	当 skipLevelOfDetail 为 true 时，只会下载达到最大屏幕空间误差的瓦片。跳过因子被忽略，仅加载所需的瓦片。
loadSiblings	boolean	<optional>	false	当 skipLevelOfDetail 为 true 时，确定在遍历过程中是否始终下载可见瓦片的同级瓦片。
clippingPlanes	ClippingPlaneCollection	<optional>		用于选择性禁用 tileset 渲染的 ClippingPlaneCollection。
clippingPolygons	ClippingPolygonCollection	<optional>		用于选择性禁用 tileset 渲染的 ClippingPolygonCollection。
classificationType	ClassificationType	<optional>		确定地形、3D Tiles 或两者是否将由该 tileset 进行分类。有关限制和局限性的详细信息，请参见 Cesium3DTileset#classificationType。
heightReference	HeightReference	<optional>		为矢量 tilesets 中的点要素设置 HeightReference。
scene	Scene	<optional>		tileset 将在其中渲染的 CesiumWidget#scene，对于指定了 heightReference 值以将 3D Tiles 矢量数据内容（如点、线和标签）贴合到地形或 3D Tiles 的 tilesets 是必需的。
ellipsoid	Ellipsoid	<optional>	Ellipsoid.WGS84	确定地球大小和形状的椭球体。
pointCloudShading	object	<optional>		用于构造 PointCloudShading 对象的选项，以基于几何误差和光照控制点的衰减。
lightColor	Cartesian3	<optional>		对模型着色时的光照颜色。当为 undefined 时，将改用场景的光照颜色。
imageBasedLighting	ImageBasedLighting	<optional>		用于管理此 tileset 上基于图像的照明的属性。
environmentMapOptions	DynamicEnvironmentMapManager.ConstructorOptions	<optional>		用于管理此 tileset 上动态环境贴图的属性。
backFaceCulling	boolean	<optional>	true	是否剔除背面几何。当为 true 时，背面剔除由 glTF 材质的 doubleSided 属性决定；当为 false 时，背面剔除被禁用。
enableShowOutline	boolean	<optional>	true	是否对使用 CESIUM_primitive_outline 扩展的模型启用轮廓。可以将其设置为 false 以避免在加载时对几何进行额外的处理。当为 false 时，showOutlines 和 outlineColor 选项将被忽略。
showOutline	boolean	<optional>	true	是否显示使用 CESIUM_primitive_outline 扩展的模型的轮廓。当为 true 时显示轮廓，当为 false 时不显示轮廓。
outlineColor	Color	<optional>	Color.BLACK	渲染轮廓时使用的颜色。
vectorClassificationOnly	boolean	<optional>	false	指示仅应使用 tileset 的矢量瓦片进行分类。
vectorKeepDecodedPositions	boolean	<optional>	false	矢量瓦片是否应在内存中保留已解码的位置。这与 Cesium3DTileFeature.getPolylinePositions 一起使用。
featureIdLabel	string | number	<optional>	"featureId_0"	用于拾取和样式设置的要素 ID 集合的标签。对于 EXT_mesh_features，这是要素 ID 的 label 属性；如果未指定，则为 "featureId_N"（其中 N 是 featureIds 数组中的索引）。EXT_feature_metadata 没有 label 字段，因此此类要素 ID 集合始终标记为 "featureId_N"，其中 N 是所有要素 ID 列表中的索引，要素 ID 属性列在要素 ID 纹理之前。如果 featureIdLabel 设置为整数 N，它会自动转换为字符串 "featureId_N"。如果同时存在逐基元和逐实例要素 ID，则实例要素 ID 优先。
instanceFeatureIdLabel	string | number	<optional>	"instanceFeatureId_0"	用于拾取和样式设置的实例要素 ID 集合的标签。如果 instanceFeatureIdLabel 设置为整数 N，它会自动转换为字符串 "instanceFeatureId_N"。如果同时存在逐基元和逐实例要素 ID，则实例要素 ID 优先。
showCreditsOnScreen	boolean	<optional>	false	是否在屏幕上显示此 tileset 的署名。
splitDirection	SplitDirection	<optional>	SplitDirection.NONE	应用于此 tileset 的 SplitDirection 分割。
enableCollision	boolean	<optional>	false	当为 true 时，启用相机或 CPU 拾取的碰撞检测。当此值为 true 时，如果 ScreenSpaceCameraController#enableCollisionDetection 为 true，相机将被阻止进入 tileset 表面以下。这还会影响将对象贴合到 3D Tiles 表面时 HeightReference.CLAMP_TO_GROUND 的行为。如果 enableCollision 为 false，实体可能无法正确贴合到 tileset 几何上。
projectTo2D	boolean	<optional>	false	是否将 tileset 精确投影到 2D。如果为 true，tileset 将被精确投影到 2D，但会使用更多内存。如果为 false，tileset 将使用更少的内存，并且仍会在 2D / CV 模式下渲染，但其投影位置可能不准确。这不能在 tileset 创建后设置。
enablePick	boolean	<optional>	false	在使用 WebGL 1 时是否允许通过 pick 进行碰撞和 CPU 拾取。如果使用 WebGL 2 或更高版本，此选项将被忽略。如果使用 WebGL 1 且此选项为 true，则 pick 操作将正常工作，但会使用更多内存。如果使用 WebGL 1 且此选项为 false，模型将使用更少的内存，但 pick 将始终返回 undefined。这不能在 tileset 加载后设置。
asynchronouslyLoadImagery	boolean	<optional>	false	覆盖在 tileset 上的影像的加载是否应异步进行。如果为 true，则瓦片内容将在其原始纹理下显示，直到影像纹理加载完成。如果为 false，则在影像准备就绪之前不会显示瓦片内容。
debugHeatmapTilePropertyName	string	<optional>		要作为热力图着色的瓦片变量。所有渲染的瓦片将相对于彼此指定的变量值进行着色。
debugFreezeFrame	boolean	<optional>	false	仅用于调试。确定是否仅使用上一帧的瓦片进行渲染。
debugColorizeTiles	boolean	<optional>	false	仅用于调试。当为 true 时，为每个瓦片分配一个随机颜色。
enableDebugWireframe	boolean	<optional>	false	仅用于调试。要使 debugWireframe 在 WebGL1 中生效，此值必须为 true。这不能在 tileset 创建后设置。
debugWireframe	boolean	<optional>	false	仅用于调试。当为 true 时，将每个瓦片的内容渲染为线框。
edgeDisplayMode	EdgeDisplayMode	<optional>	EdgeDisplayMode.SURFACES_ONLY	控制来自 EXT_mesh_primitive_edge_visibility glTF 扩展的边相对于表面几何的渲染方式。
debugShowBoundingVolume	boolean	<optional>	false	仅用于调试。当为 true 时，渲染每个瓦片的包围体。
debugShowContentBoundingVolume	boolean	<optional>	false	仅用于调试。当为 true 时，渲染每个瓦片内容的包围体。
debugShowViewerRequestVolume	boolean	<optional>	false	仅用于调试。当为 true 时，渲染每个瓦片的查看器请求体。
debugShowGeometricError	boolean	<optional>	false	仅用于调试。当为 true 时，绘制标签以指示每个瓦片的几何误差。
debugShowRenderingStatistics	boolean	<optional>	false	仅用于调试。当为 true 时，绘制标签以指示每个瓦片的命令数、点数、三角形数和要素数。
debugShowMemoryUsage	boolean	<optional>	false	仅用于调试。当为 true 时，绘制标签以指示每个瓦片使用的纹理和几何内存（以兆字节为单位）。
debugShowUrl	boolean	<optional>	false	仅用于调试。当为 true 时，绘制标签以指示每个瓦片的 url。

Returns:

Default Value: Math.lerp