Cesium3DTilesTerrainProvider

new Cesium.Cesium3DTilesTerrainProvider(options)

要构造 Cesium3DTilesTerrainProvider,请调用 Cesium3DTilesTerrainProvider.fromIonAssetIdCesium3DTilesTerrainProvider.fromUrl。不要直接调用构造函数。
以 3D Tiles 格式访问地形数据的 TerrainProvider
Name Type Description
options Cesium3DTilesTerrainProvider.ConstructorOptions optional 描述初始化选项的对象。
Experimental

此功能尚未最终确定,可能会在不遵循 Cesium 标准弃用政策的情况下更改。

See:
  • TerrainProvider
  • Cesium3DTilesTerrainProvider.fromUrl
  • Cesium3DTilesTerrainProvider.fromIonAssetId // 创建带顶点法线的 GTOPO30 try { const viewer = new Cesium.Viewer("cesiumContainer", { terrainProvider: await Cesium.Cesium3DTilesTerrainProvider.fromIonAssetId(2732686, { requestVertexNormals: true }) }); } catch (error) { console.log(error); }

Members

Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles.
Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain.
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.
Gets a value indicating whether or not the requested tiles include vertex normals.
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.
Gets the tiling scheme used by the provider.

Methods

static Cesium.Cesium3DTilesTerrainProvider.fromIonAssetId(assetId, options)Promise.<CesiumTerrainProvider>

Creates a TerrainProvider from a Cesium ion asset ID that accesses terrain data in a Cesium 3D Tiles format
Name Type Description
assetId number 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 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 GTOPO30 with vertex normals
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.Cesium3DTilesTerrainProvider.fromIonAssetId(2732686, {
        requestVertexNormals: true
    })
  });
} catch (error) {
  console.log(error);
}

static Cesium.Cesium3DTilesTerrainProvider.fromUrl(url, options)Promise.<Cesium3DTilesTerrainProvider>

Creates a TerrainProvider that accesses terrain data in a Cesium 3D Tiles format.
Name Type Description
url Resource | string | Promise.<Resource> | Promise.<string> The URL of the Cesium terrain server.
options Cesium3DTilesTerrainProvider.ConstructorOptions optional An object describing initialization options.
Returns:
A promise that resolves to the terrain provider.
Example:
// Create terrain with normals.
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.Cesium3DTilesTerrainProvider.fromUrl(
      Cesium.IonResource.fromAssetId(3956), {
        requestVertexNormals: true
    })
  });
} catch (error) {
  console.log(error);
}

getLevelMaximumGeometricError(level)number

Get 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

Determines whether data for a tile is available to be loaded.
Name Type Description
x number The X coordinate of the tile for which to request geometry.
y number The Y coordinate of the tile for which to request geometry.
level number The level of the tile for which to request geometry.
Returns:
Undefined if not supported or availability is unknown, otherwise true or false.

loadTileDataAvailability(_x, _y, _level)Promise.<void>|undefined

Make sure we load availability data for a tile
Name Type Description
_x number The X coordinate of the tile for which to request geometry.
_y number The Y coordinate of the tile for which to request geometry.
_level number The level of the tile for which to request geometry.
Returns:
Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded

requestTileGeometry(x, y, level, request)Promise.<Cesium3DTilesTerrainData>|undefined

Requests the geometry for a given tile. This function should not be called before Cesium3DTilesTerrainProvider#ready returns true. 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 The X coordinate of the tile for which to request geometry.
y number 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.Cesium3DTilesTerrainProvider.ConstructorOptions

Cesium3DTilesTerrainProvider 构造函数的初始化选项。
Properties:
Name Type Attributes Default Description
requestVertexNormals boolean <optional>
false 指示客户端是否应从服务器请求附加光照信息的标志,格式为逐顶点法线(如果可用)。
requestWaterMask boolean <optional>
false 指示客户端是否应从服务器请求逐瓦片水掩码的标志(如果可用)。
ellipsoid Ellipsoid <optional>
Ellipsoid.default 椭球体。如果未指定,则使用 WGS84 椭球体。
credit Credit | string <optional>
数据源的署名信息,显示在画布上。
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.