CesiumTerrainProvider

new Cesium.CesiumTerrainProvider(options)
engine/Source/Core/CesiumTerrainProvider.js 477

要构造一个CesiumTerrainProvider，调用 CesiumTerrainProvider.fromIonAssetId 或 CesiumTerrainProvider.fromUrl. 不要直接调用构造函数。
TerrainProvider 以cesium地形格式访问地形数据。 地形格式可以是以下其中一种:
Name Type Description
options CesiumTerrainProvider.ConstructorOptions optional An 描述初始化选项的对象
Example:
// Create Arctic DEM terrain with normals.
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.CesiumTerrainProvider.fromIonAssetId(3956, {
      requestVertexNormals: true
    })
  });
} catch (error) {
  console.log(error);
}
See:

Members

readonly availability : TileAvailability
engine/Source/Core/CesiumTerrainProvider.js 1138

获取一个对象，该对象可用于从此提供程序确定地形的可用性，例如 在点和矩形中。如果可用，此属性可能未定义 信息不可用。请注意，这反映了当前已知可用的磁贴。 将来可能会发现其他可用的瓷砖，例如可用性信息 存在于树的更深处，而不是在根节点都可以发现。然而，一个瓷砖 现在可用，将来不会不可用。

readonly credit : Credit
engine/Source/Core/CesiumTerrainProvider.js 1027

获取此地形提供程序处于活动状态时要显示的信用值。这通常用于信贷 地形的来源。

readonly errorEvent : Event
engine/Source/Core/CesiumTerrainProvider.js 1014

获取地形提供程序遇到异步错误时引发的事件。通过订阅 到事件，您将收到错误通知，并可能从中恢复。事件监听器 传递 TileProviderError 的实例.

readonly hasMetadata : boolean
engine/Source/Core/CesiumTerrainProvider.js 1078

获取一个值，该值指示所请求的磁贴是否包含元数据。

readonly hasVertexNormals : boolean
engine/Source/Core/CesiumTerrainProvider.js 1065

获取一个值，该值指示请求的贴图是否包含顶点法线。

readonly hasWaterMask : boolean
engine/Source/Core/CesiumTerrainProvider.js 1053

获取一个值，该值指示提供程序是否包含水掩码。水面罩 表示地球上哪些区域是水而不是陆地，因此它们可以被渲染 作为具有动画波的反射表面。

readonly requestMetadata : boolean
engine/Source/Core/CesiumTerrainProvider.js 1121

布尔标志，表示客户端是否应该从服务器请求元数据。 只有当客户端请求元数据和元数据时，才会将元数据添加到标准网格数据中 如果服务器提供元数据。

readonly requestVertexNormals : boolean
engine/Source/Core/CesiumTerrainProvider.js 1093

布尔标志，表示客户端是否应该从服务器请求顶点法线。 顶点法线数据只有在客户端请求顶点法线和顶点法线时才会添加到标准贴图网格数据中 如果服务器提供顶点法线。

readonly requestWaterMask : boolean
engine/Source/Core/CesiumTerrainProvider.js 1107

布尔标志，表示客户端是否应该从服务器请求一个水掩码。 只有当客户端请求水掩码和时，水掩码数据才会被附加到标准贴图网格数据中 如果服务器提供了一个掩码。

readonly tilingScheme : GeographicTilingScheme
engine/Source/Core/CesiumTerrainProvider.js 1039

获取此提供程序使用的平铺模式。

Methods

static Cesium.CesiumTerrainProvider.fromIonAssetId(assetId, options) → Promise.<CesiumTerrainProvider>
engine/Source/Core/CesiumTerrainProvider.js 1187

从cesium资产ID创建 TerrainProvider，以铯地形格式访问地形数据 地形格式可以是以下其中一种:
Name Type Description
assetId number The Cesium ion asset id.
options CesiumTerrainProvider.ConstructorOptions optional An 描述初始化选项的对象.
Returns:
Throws:
  • RuntimeError : layer.json does not specify a format
  • RuntimeError : layer.json specifies an unknown format
  • RuntimeError : layer.json specifies an unsupported quantized-mesh version
  • RuntimeError : layer.json does not specify a tiles property, or specifies an empty array
  • RuntimeError : layer.json does not specify any tile URL templates
Example:
// Create Arctic DEM terrain with normals.
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.CesiumTerrainProvider.fromIonAssetId(3956, {
        requestVertexNormals: true
    })
  });
} catch (error) {
  console.log(error);
}

static Cesium.CesiumTerrainProvider.fromUrl(url, options) → Promise.<CesiumTerrainProvider>
engine/Source/Core/CesiumTerrainProvider.js 1227

创建 TerrainProvider 以cesium地形格式访问地形数据。 地形格式可以是以下其中一种:
Name Type Description
url Resource | String | Promise.<Resource> | Promise.<String> Cesium 地形服务器的 URL。
options CesiumTerrainProvider.ConstructorOptions optional 描述初始化选项的对象
Returns:
Throws:
Example:
// Create Arctic DEM terrain with normals.
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.CesiumTerrainProvider.fromUrl(
      Cesium.IonResource.fromAssetId(3956), {
        requestVertexNormals: true
    })
  });
} catch (error) {
  console.log(error);
}

getLevelMaximumGeometricError(level) → number
engine/Source/Core/CesiumTerrainProvider.js 1151

获取给定级别的贴图中允许的最大几何误差。
Name Type Description
level number 要获得最大几何误差的瓦片水平。
Returns:
最大几何误差。

getTileDataAvailable(x, y, level) → boolean|undefined
engine/Source/Core/CesiumTerrainProvider.js 1261

确定是否可以加载磁贴的数据。
Name Type Description
x number 要为其请求几何图形的贴图的X坐标。
y number 要为其请求几何图形的贴图的Y坐标。
level number 要为其请求几何图形的贴图的级别。
Returns:
如果不支持或可用性未知，则未定义，否则为true或false。

loadTileDataAvailability(x, y, level) → undefined|Promise.<void>
engine/Source/Core/CesiumTerrainProvider.js 1299

确保我们为tile加载了可用性数据
Name Type Description
x number 要为其请求几何图形的贴图的X坐标。
y number 要为其请求几何图形的贴图的Y坐标。
level number 要为其请求几何图形的贴图的级别。
Returns:
如果不需要加载任何内容，则为Undefined;如果需要加载所有tile，则为Promise，该Promise在加载所有所需tile时解析

requestTileGeometry(x, y, level, request) → Promise.<TerrainData>|undefined
engine/Source/Core/CesiumTerrainProvider.js 854

请求给定贴图的几何图形。结果必须包括地形数据和 可选地包括一个水罩和指示哪些子瓦片可用。
Name Type Description
x number 要为其请求几何图形的贴图的X坐标。
y number 要为其请求几何图形的贴图的Y坐标。
level number 要为其请求几何图形的贴图的级别。
request Request optional 请求对象。仅供内部使用。
Returns:
对所请求几何图形的承诺。如果这种方法 返回未定义而不是承诺，这表明已经有太多请求 等待中，请求将稍后重试。

Type Definitions

Cesium.CesiumTerrainProvider.ConstructorOptions
engine/Source/Core/CesiumTerrainProvider.js 41

CesiumTerrainProvider构造函数的初始化选项
Properties:
Name Type Attributes Default Description
requestVertexNormals boolean <optional>
 false 标志，指示客户端是否应该从服务器请求额外的光照信息，如果可用，以每个顶点法线的形式。
requestWaterMask boolean <optional>
 false 标志，指示客户端是否应该请求每个瓷砖水掩码从服务器，如果可用。
requestMetadata boolean <optional>
 true 标志，指示客户端是否应该从服务器请求每个tile元数据(如果可用)。
ellipsoid Ellipsoid <optional>
 Ellipsoid.default 椭球。如果未指定，则使用默认的椭球体。
credit Credit | string <optional>
 数据源的信用记录，显示在画布上。
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets