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

// 设置相机以查看新添加的瓦片集
viewer.camera.viewBoundingSphere(tileset.boundingSphere, new Cesium.HeadingPitchRange(0, -0.5, 0));

Default Value: 536870912

See:

• Cesium3DTileset#totalMemoryUsageInBytes

Default Value: undefined

Experimental

此功能使用的是 3D Tiles 规范中尚未最终确定的部分，可能会在没有 Cesium 标准弃用政策的情况下发生变化。

Default Value: 0.5

Default Value: Cesium3DTileColorBlendMode.HIGHLIGHT

Default Value: true

Default Value: 60.0

Default Value: undefined

Experimental

此功能使用的是 3D Tiles 规范中尚未最终确定的部分，可能会在没有 Cesium 标准弃用政策的情况下发生变化。

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

此功能使用了3D Tiles规范中的部分内容，该规范尚未定稿，可能会在不遵循Cesium标准弃用政策的情况下发生更改。

See:

• 3D Tiles 规范中的 Extras。

Experimental

此功能使用的是 3D Tiles 规范中尚未最终确定的部分，可能会在没有 Cesium 标准弃用政策的情况下发生变化。

Default Value: 0.3

Default Value: 0.0

Default Value: true

Default Value: 0.2

Default Value: false

Default Value: new Event()

Example:

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

See:

• Cesium3DTileset#allTilesLoaded

Experimental

此功能使用的是 3D Tiles 规范中尚未最终确定的部分，可能会在没有 Cesium 标准弃用政策的情况下发生变化。

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

此功能使用的是 3D Tiles 规范中尚未最终确定的部分，可能会在没有 Cesium 标准弃用政策的情况下发生变化。

Default Value: false

Experimental

此功能使用的是 3D Tiles 规范中尚未最终确定的部分，可能会在没有 Cesium 标准弃用政策的情况下发生变化。

Methods

Returns:

Throws:

• RuntimeError : 当瓦片集资产版本不是 0.0、1.0 或 1.1， 或者当瓦片集包含未支持的必需扩展时。

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 : 当瓦片集资产版本不是 0.0、1.0 或 1.1， 或者当瓦片集包含未支持的必需扩展时。

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	确定瓦片集是否可见。
modelMatrix	Matrix4	<optional>	Matrix4.IDENTITY	变换矩阵，用于转换瓦片集的根瓦片。
modelUpAxis	Axis	<optional>	Axis.Y	加载瓦片内容模型时，哪个轴被视为向上。
modelForwardAxis	Axis	<optional>	Axis.X	加载瓦片内容模型时，哪个轴被视为向前。
shadows	ShadowMode	<optional>	ShadowMode.ENABLED	确定瓦片集是投射阴影还是接收光源的阴影。
maximumScreenSpaceError	number	<optional>	16	用于驱动细节级别优化的最大屏幕空间误差。
cacheBytes	number	<optional>	536870912	瓦片缓存将被修剪的大小（以字节为单位），如果缓存中包含当前视图不需要的瓦片。
maximumCacheOverflowBytes	number	<optional>	536870912	允许的最大额外内存（以字节为单位），用于缓存冗余空间，如果当前视图需要的内存超过 Cesium3DTileset#cacheBytes。
cullWithChildrenBounds	boolean	<optional>	true	优化选项。是否使用子瓦片的边界体积的联合来剔除瓦片。
cullRequestsWhileMoving	boolean	<optional>	true	优化选项。在相机移动时不要请求可能未使用的瓦片。当相机处于静止状态时，此优化适用。
cullRequestsWhileMovingMultiplier	number	<optional>	60.0	优化选项。在移动时剔除请求所用的乘数。更大的值会导致更激进的剔除，更小的值则导致剔除较少。
preloadWhenHidden	boolean	<optional>	false	当 tileset.show 为 false 时预加载瓦片。加载瓦片就像瓦片集可见一样，但不渲染这些瓦片。
preloadFlightDestinations	boolean	<optional>	true	优化选项。在相机飞行时预加载相机飞行目标处的瓦片。
preferLeaves	boolean	<optional>	false	优化选项。优先加载叶子瓦片。
dynamicScreenSpaceError	boolean	<optional>	true	优化选项。对于街道级景观视图，远离相机的地方使用较低分辨率的瓦片。这将减少加载的数据量，并在视觉质量稍有下降的情况下提高瓦片集的加载时间。
dynamicScreenSpaceErrorDensity	number	<optional>	2.0e-4	类似于 Fog#density，此选项控制 Cesium3DTileset#dynamicScreenSpaceError 优化应用的相机距离。较大的值将导致离相机更近的瓦片受到影响。
dynamicScreenSpaceErrorFactor	number	<optional>	24.0	控制 Cesium3DTileset#dynamicScreenSpaceError 优化在地平线瓦片上的强度的参数。较大的值会导致加载较低分辨率的瓦片，提高运行时性能，但在视觉质量上会稍有下降。
dynamicScreenSpaceErrorHeightFalloff	number	<optional>	0.25	瓦片集高度的比例，确定“街道级”相机视图的位置。当相机位于此高度以下时，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 为真时，用于控制确定哪些瓦片被延迟的锥形大小。处于锥形内的瓦片会立即加载。处于锥形外的瓦片会根据它们距锥形的远近及其屏幕空间误差进行延迟。这由 Cesium3DTileset#foveatedInterpolationCallback 和 Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 控制。将其设置为 0.0 意味着锥形将由相机位置和视角形成的直线。将其设置为 1.0 意味着锥形将包含相机的整个视野，禁用此效果。
foveatedMinimumScreenSpaceErrorRelaxation	number	<optional>	0.0	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为真时，用于控制锥形外瓦片的起始屏幕空间误差放松。屏幕空间误差将根据提供的 Cesium3DTileset#foveatedInterpolationCallback 从瓦片集值提升到 Cesium3DTileset#maximumScreenSpaceError。
foveatedInterpolationCallback	Cesium3DTileset.foveatedInterpolationCallback	<optional>	Math.lerp	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为真时，用于控制在锥形外提升屏幕空间误差的程度，从 Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 插值到 Cesium3DTileset#maximumScreenSpaceError。
foveatedTimeDelay	number	<optional>	0.2	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为真时，用于控制在相机停止移动后等待多少秒再开始加载延迟的瓦片。这个时间延迟可以防止在相机移动时请求屏幕边缘附近的瓦片。将其设置为 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>		用于选择性禁用瓦片集呈现的 ClippingPlaneCollection。
clippingPolygons	ClippingPolygonCollection	<optional>		用于选择性禁用瓦片集呈现的 ClippingPolygonCollection。
classificationType	ClassificationType	<optional>		确定地形、3D 瓷砖或两者将由此瓦片集分类。有关限制和限制的详细信息，请参见 Cesium3DTileset#classificationType。
ellipsoid	Ellipsoid	<optional>	Ellipsoid.WGS84	确定地球大小和形状的椭球体。
pointCloudShading	object	<optional>		用于构造 PointCloudShading 对象以基于几何误差和光照控制点衰减的选项。
lightColor	Cartesian3	<optional>		着色模型时的光源颜色。当 undefined 时，将使用场景的光源颜色。
imageBasedLighting	ImageBasedLighting	<optional>		用于管理此瓦片集的图像基照明的属性。
backFaceCulling	boolean	<optional>	true	是否剔除背面的几何体。当为真时，背面剔除由 glTF 材料的 doubleSided 属性决定；当为假时，将禁用背面剔除。
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	表示仅应使用瓷砖集的向量瓦片进行分类。
vectorKeepDecodedPositions	boolean	<optional>	false	向量瓦片是否应将解码的位置保留在内存中。此选项与 Cesium3DTileFeature.getPolylinePositions 一起使用。
featureIdLabel	string | number	<optional>	"featureId_0"	用于拾取和样式设置的特征 ID 集的标签。对于 EXT_mesh_features，这是特征 ID 的标签属性，或在未指定的情况下为 "featureId_N"（其中 N 是特征 ID 数组中的索引）。EXT_feature_metadata 没有标签字段，因此此类特征 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	是否在屏幕上显示此瓦片集的版权信息。
splitDirection	SplitDirection	<optional>	SplitDirection.NONE	要应用于此瓦片集的 SplitDirection 分割。
enableCollision	boolean	<optional>	false	当 true 时，启用相机或 CPU 拾取的碰撞检测。当 true 时，相机将被阻止在瓦片集表面以下移动，如果 ScreenSpaceCameraController#enableCollisionDetection 为 true。
projectTo2D	boolean	<optional>	false	是否准确地将瓦片集投影到 2D。如果为真，则瓦片集将在 2D 中准确投影，但将使用更多内存。如果为假，瓦片集将使用更少的内存，并且仍将在 2D / CV 模式中呈现，但其投影位置可能不准确。此选项在瓦片集创建后无法设置。
enablePick	boolean	<optional>	false	是否允许在使用 WebGL 1 时与 pick 进行碰撞和 CPU 拾取。如果使用 WebGL 2 或更高版本，则将忽略此选项。如果使用 WebGL 1 且此选项为真，pick 操作将正常工作，但将使用更多内存。如果在 WebGL 1 中运行且此选项为假，模型将使用更少的内存，但 pick 将始终返回 undefined。此选项在瓦片集加载后无法设置。
debugHeatmapTilePropertyName	string	<optional>		用于作为热图着色的瓦片变量。所有渲染的瓦片将相对于彼此指定的变量值着色。
debugFreezeFrame	boolean	<optional>	false	仅用于调试。确定是否仅使用前一帧的瓦片进行渲染。
debugColorizeTiles	boolean	<optional>	false	仅用于调试。当为真时，为每个瓦片分配随机颜色。
enableDebugWireframe	boolean	<optional>	false	仅用于调试。此选项必须为真才能在 WebGL1 中有效。此选项在瓦片集创建后无法设置。
debugWireframe	boolean	<optional>	false	仅用于调试。当为真时，以线框的形式渲染每个瓦片的内容。
debugShowBoundingVolume	boolean	<optional>	false	仅用于调试。当为真时，渲染每个瓦片的边界体积。
debugShowContentBoundingVolume	boolean	<optional>	false	仅用于调试。当为真时，渲染每个瓦片内容的边界体积。
debugShowViewerRequestVolume	boolean	<optional>	false	仅用于调试。当为真时，渲染每个瓦片的查看请求体积。
debugShowGeometricError	boolean	<optional>	false	仅用于调试。当为真时，绘制标签以指示每个瓦片的几何误差。
debugShowRenderingStatistics	boolean	<optional>	false	仅用于调试。当为真时，绘制标签以指示每个瓦片的命令数量、点数、三角形和特征数量。
debugShowMemoryUsage	boolean	<optional>	false	仅用于调试。当为真时，绘制标签以指示每个瓦片使用的纹理和几何体内存（以兆字节为单位）。
debugShowUrl	boolean	<optional>	false	仅用于调试。当为真时，绘制标签以指示每个瓦片的 URL。

Returns:

Default Value: Math.lerp