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

此功能使用的是 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:

// 将用于图块集环境贴图的地面颜色更改为森林绿色
const environmentMapManager = tileset.environmentMapManager;
environmentMapManager.groundColor = Cesium.Color.fromCssColorString("#203b34");

Experimental

此功能使用的是 3D Tiles 规范的一部分，该规范并非最终版本，并且可能会在没有 Cesium 标准弃用政策的情况下进行更改。

See:

• Extras in the 3D Tiles specification.

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

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

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	一个 4x4 变换矩阵，用于变换瓦片集的根瓦片。
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 为 true 时使用，以控制确定延迟哪些图块的圆锥体大小。此圆锥体内的切片将立即加载。圆锥体外的图块可能会根据它们在圆锥体外的距离及其屏幕空间误差而延迟。这由 Cesium3DTileset#foveatedInterpolationCallback 和 Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 控制。将此设置为 0.0 意味着圆锥体将是摄像机位置及其视图方向形成的线。将此设置为 1.0 意味着圆锥体包含摄像机的整个视野，从而禁用该效果。
foveatedMinimumScreenSpaceErrorRelaxation	number	<optional>	0.0	优化选项。当 Cesium3DTileset#foveatedScreenSpaceError 为 true 时使用，以控制凹圆锥体外磁贴的起始屏幕空间误差松弛。根据提供的 {@link@link 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>		用于选择性地禁用图块集渲染的 ClippingPlaneCollection。
clippingPolygons	ClippingPolygonCollection	<optional>		用于选择性地禁用渲染图块集的 ClippingPolygonCollection。
classificationType	ClassificationType	<optional>		确定地形和/或 3D 瓦片是否由此瓦片集进行分类。请参阅 Cesium3DTileset#classificationType 了解有关限制和限制的详细信息。
ellipsoid	Ellipsoid	<optional>	Ellipsoid.WGS84	决定地球大小和形状的椭球体。
pointCloudShading	object	<optional>		用于构建 PointCloudShading 对象的选项，以根据几何误差和照明控制点衰减。
lightColor	Cartesian3	<optional>		对模型进行着色时的光色。如果undefined，则使用场景的 light 颜色。
imageBasedLighting	ImageBasedLighting	<optional>		用于管理此图块集的基于图像的光照的属性。
environmentMapOptions	DynamicEnvironmentMapManager.ConstructorOptions	<optional>		用于管理此图块集上的动态环境地图的属性。
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	表示只应使用瓦片集的矢量瓦片进行分类。
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没有标注字段，因此此类要素 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 拾取启用碰撞。虽然这是真的，但如果 ScreenSpaceCameraController#enableCollisionDetection 为 true，则相机将无法低于图块集表面。
projectTo2D	boolean	<optional>	false	是否将瓦片集精确投影为 2D。如果为 true，则图块集将精确投影到 2D，但会使用更多内存来执行此操作。如果为 false，则图块集将使用较少的内存，并且仍将以 2D / CV 模式渲染，但其投影位置可能不准确。创建图块集后，无法设置此项。
enablePick	boolean	<optional>	false	在使用 WebGL 1 时，是否允许使用 pick 进行碰撞和 CPU 拾取。如果使用 WebGL 2 或更高版本，则此选项将被忽略。如果使用 WebGL 1 并且这是真的，则 pick 操作将正常工作，但它会使用更多内存来执行此操作。如果使用 WebGL 1 运行并且为 false，则模型将使用更少的内存，但 pick 将始终返回 undefined。加载图块集后无法设置此项。
debugHeatmapTilePropertyName	string	<optional>		要作为热图着色的图块变量。所有渲染的瓦片都将相对于彼此的指定变量值进行着色。
debugFreezeFrame	boolean	<optional>	false	仅用于调试。确定是否只应使用上一帧中的平铺进行渲染。
debugColorizeTiles	boolean	<optional>	false	仅用于调试。如果为 true，则为每个平铺分配随机颜色。
enableDebugWireframe	boolean	<optional>	false	仅用于调试。要使 debugWireframe 在 WebGL1 中工作，必须如此。创建图块集后，无法设置此项。
debugWireframe	boolean	<optional>	false	仅用于调试。如果为 true，则将每个图块的内容渲染为线框。
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，则绘制标签以指示每个图块使用的纹理和几何内存(以 MB 为单位)。
debugShowUrl	boolean	<optional>	false	仅用于调试。如果为 true，则绘制标签以指示每个图块的 URL。

Returns:

Default Value: Math.lerp