English中文

CesiumTerrainProvider

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

要构造一个 CesiumTerrainProvider，请调用 To construct a CesiumTerrainProvider, call CesiumTerrainProvider.fromIonAssetId or CesiumTerrainProvider.fromUrl。不要直接调用构造函数。 . Do not call the constructor directly.
A TerrainProvider 以 Cesium 地形格式访问地形数据。地形格式可以是以下之一： that accesses terrain data in a Cesium terrain format. Terrain formats can be one of the following:
名称 Name 类型 Type 说明 Description
options CesiumTerrainProvider.ConstructorOptions 可选 optional 描述初始化选项的对象 An object describing initialization options
示例： 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|undefined
engine/Source/Core/CesiumTerrainProvider.js 1135

获取一个对象，该对象可用于确定此提供者提供的地形的可用性，例如点和矩形中的地形。如果可用性信息不可用，则此属性可能未定义。请注意，这反映了当前已知可用的图块。将来可能会发现其他可用的图块，例如可用性信息是否存在于树的更深处，而不是在根部都可以发现。但是，现在可用的图块将来不会变得不可用。 Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles. This property may be undefined if availability information is not available. Note that this reflects tiles that are known to be available currently. Additional tiles may be discovered to be available in the future, e.g. if availability information exists deeper in the tree rather than it all being discoverable at the root. However, a tile that is available now will not become unavailable in the future.

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

获取此地形提供程序处于活动状态时要显示的积分。通常，这用于证明地形的来源。 Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain.

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

获取当地形提供程序遇到异步错误时引发的事件。通过订阅该事件，您将收到错误通知，并有可能从中恢复。事件监听器传递一个实例 Gets an event that is raised when the terrain provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

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

获取一个值，该值指示请求的图块是否包含元数据。 Gets a value indicating whether or not the requested tiles include metadata.

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

获取一个值，该值指示请求的切片是否包含顶点法线。 Gets a value indicating whether or not the requested tiles include vertex normals.

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

获取一个值，该值指示提供程序是否包含水罩。水掩模指示地球的哪些区域是水而不是陆地，因此可以将它们渲染为带有动画波浪的反射表面。 Gets a value indicating whether or not the provider includes a water mask. The water mask indicates which areas of the globe are water rather than land, so they can be rendered as a reflective surface with animated waves.

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

布尔标志，指示客户端是否应从服务器请求元数据。仅当客户端请求元数据并且服务器提供元数据时，元数据才会附加到标准图块网格数据。 Boolean flag that indicates if the client should request metadata from the server. Metadata is appended to the standard tile mesh data only if the client requests the metadata and if the server provides a metadata.

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

布尔标志，指示客户端是否应从服务器请求顶点法线。仅当客户端请求顶点法线并且服务器提供顶点法线时，顶点法线数据才会附加到标准切片网格数据。 Boolean flag that indicates if the client should request vertex normals from the server. Vertex normals data is appended to the standard tile mesh data only if the client requests the vertex normals and if the server provides vertex normals.

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

布尔标志，指示客户端是否应向服务器请求水掩码。仅当客户端请求水掩模并且服务器提供水掩模时，水掩模数据才会附加到标准切片网格数据。 Boolean flag that indicates if the client should request a watermask from the server. Watermask data is appended to the standard tile mesh data only if the client requests the watermask and if the server provides a watermask.

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

获取此提供程序使用的切片方案。 Gets the tiling scheme used by this provider.

方法 Methods

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

创建一个 Creates a TerrainProvider 来自以 Cesium 地形格式访问地形数据的 Cesium ion asset ID 地形格式可以是以下之一： from a Cesium ion asset ID that accesses terrain data in a Cesium terrain format Terrain formats can be one of the following:
名称 Name 类型 Type 说明 Description
assetId number Cesium离子资产 ID。 The Cesium ion asset id.
options CesiumTerrainProvider.ConstructorOptions 可选 optional 描述初始化选项的对象。 An object describing initialization options.
返回： Returns:
抛出： Throws:
  • RuntimeError : layer.json does not specify a format
  • RuntimeError : layer.json specifies an unknown format
  • RuntimeError ：layer.json 指定不支持的量化网格版本 : layer.json specifies an unsupported quantized-mesh version
  • RuntimeError ：layer.json没有指定tiles属性，或者指定了一个空数组 : layer.json does not specify a tiles property, or specifies an empty array
  • RuntimeError ：layer.json 未指定任何图块 URL 模板 : 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 1224

创建一个 Creates a TerrainProvider 以 Cesium 地形格式访问地形数据。地形格式可以是以下之一： that accesses terrain data in a Cesium terrain format. Terrain formats can be one of the following:
名称 Name 类型 Type 说明 Description
url Resource | string | Promise.<Resource> | Promise.<string> Cesium地形服务器的URL。 The URL of the Cesium terrain server.
options CesiumTerrainProvider.ConstructorOptions 可选 optional 描述初始化选项的对象。 An object describing initialization options.
返回： Returns:
抛出： Throws:
  • RuntimeError : layer.json does not specify a format
  • RuntimeError : layer.json specifies an unknown format
  • RuntimeError ：layer.json 指定不支持的量化网格版本 : layer.json specifies an unsupported quantized-mesh version
  • RuntimeError ：layer.json没有指定tiles属性，或者指定了一个空数组 : layer.json does not specify a tiles property, or specifies an empty array
  • RuntimeError ：layer.json 未指定任何图块 URL 模板 : 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.fromUrl(
      Cesium.IonResource.fromAssetId(3956), {
        requestVertexNormals: true
    })
  });
} catch (error) {
  console.log(error);
}

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

获取给定级别的图块中允许的最大几何误差。 Gets the maximum geometric error allowed in a tile at a given level.
名称 Name 类型 Type 说明 Description
level number 获得最大几何误差的图块级别。 The tile level for which to get the maximum geometric error.
返回： Returns:
最大几何误差。 The maximum geometric error.

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

确定图块的数据是否可供加载。 Determines whether data for a tile is available to be loaded.
名称 Name 类型 Type 说明 Description
x number 请求几何图形的图块的 X 坐标。 The X coordinate of the tile for which to request geometry.
y number 请求几何图形的图块的 Y 坐标。 The Y coordinate of the tile for which to request geometry.
level number 请求几何图形的图块的级别。 The level of the tile for which to request geometry.
返回： Returns:
如果不支持或可用性未知，则未定义，否则 true 或 false。 Undefined if not supported or availability is unknown, otherwise true or false.

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

确保我们加载图块的可用性数据 Makes sure we load availability data for a tile
名称 Name 类型 Type 说明 Description
x number 请求几何图形的图块的 X 坐标。 The X coordinate of the tile for which to request geometry.
y number 请求几何图形的图块的 Y 坐标。 The Y coordinate of the tile for which to request geometry.
level number 请求几何图形的图块的级别。 The level of the tile for which to request geometry.
返回： Returns:
如果不需要加载任何内容，或者在加载所有必需的图块时解析的 Promise，则为未定义 Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded

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

请求给定图块的几何形状。结果必须包括地形数据，并且可以选择包括水掩模和哪些子图块可用的指示。 Requests the geometry for a given tile. The result must include terrain data and may optionally include a water mask and an indication of which child tiles are available.
名称 Name 类型 Type 说明 Description
x number 请求几何图形的图块的 X 坐标。 The X coordinate of the tile for which to request geometry.
y number 请求几何图形的图块的 Y 坐标。 The Y coordinate of the tile for which to request geometry.
level number 请求几何图形的图块的级别。 The level of the tile for which to request geometry.
request Request 可选 optional 请求对象。仅供内部使用。 The request object. Intended for internal use only.
返回： Returns:
对所要求的几何形状的承诺。如果此方法返回未定义而不是承诺，则表明已有太多请求处于待处理状态，稍后将重试该请求。 A promise for the requested geometry. If this method returns undefined instead of a promise, it is an indication that too many requests are already pending and the request will be retried later.

类型定义 Type Definitions

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

CesiumTerrainProvider 构造函数的初始化选项 Initialization options for the CesiumTerrainProvider constructor
属性： Properties:
名称 Name 类型 Type Attributes 默认值 Default 说明 Description
requestVertexNormals boolean <可选> &lt;optional>
 false 指示客户端是否应从服务器请求附加照明信息的标志，以每个顶点法线的形式（如果可用）。 Flag that indicates if the client should request additional lighting information from the server, in the form of per vertex normals if available.
requestWaterMask boolean <可选> &lt;optional>
 false 指示客户端是否应向服务器请求每块水掩模（如果可用）的标志。 Flag that indicates if the client should request per tile water masks from the server, if available.
requestMetadata boolean <可选> &lt;optional>
 true 指示客户端是否应从服务器请求每个图块元数据（如果可用）的标志。 Flag that indicates if the client should request per tile metadata from the server, if available.
ellipsoid Ellipsoid <可选> &lt;optional>
 Ellipsoid.default 椭球体。如果未指定，则使用默认椭球体。 The ellipsoid. If not specified, the default ellipsoid is used.
credit Credit | string <可选> &lt;optional>
 数据源的来源，显示在画布上。 A credit for the data source, which is displayed on the canvas.
需要帮助吗？获得答案的最快方法是从社区和团队那里获得答案 Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets