KBE3D / KBCore / Cesium / CesiumTerrainProvider

类: CesiumTerrainProvider

<div class="notice"> To construct a CesiumTerrainProvider, call CesiumTerrainProvider.fromIonAssetId or CesiumTerrainProvider.fromUrl. Do not call the constructor directly. </div>

A TerrainProvider that accesses terrain data in a Cesium terrain format. Terrain formats can be one of the following: <ul> <li> Quantized Mesh

</li> <li> Height Map

</li> </ul>

示例

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

参数

An object describing initialization options

属性

errorEvent

readonly errorEvent: Event

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.

---

credit

readonly credit: Credit

Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain.

---

tilingScheme

readonly tilingScheme: GeographicTilingScheme

Gets the tiling scheme used by this provider.

---

hasWaterMask

readonly hasWaterMask: boolean

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.

---

hasVertexNormals

readonly hasVertexNormals: boolean

Gets a value indicating whether or not the requested tiles include vertex normals.

---

hasMetadata

readonly hasMetadata: boolean

Gets a value indicating whether or not the requested tiles include metadata.

---

requestVertexNormals

readonly requestVertexNormals: boolean

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.

---

requestWaterMask

readonly requestWaterMask: boolean

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.

---

requestMetadata

readonly requestMetadata: boolean

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.

---

availability

readonly availability: TileAvailability | undefined

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.

方法

fromIonAssetId()

static fromIonAssetId(assetId: number, options?: ConstructorOptions): Promise<CesiumTerrainProvider>

Creates a TerrainProvider from a Cesium ion asset ID that accesses terrain data in a Cesium terrain format Terrain formats can be one of the following: <ul> <li> Quantized Mesh

</li> <li> Height Map

</li> </ul>

参数

assetId

number

The Cesium ion asset id.

options?

ConstructorOptions

An object describing initialization options.

返回

Promise<CesiumTerrainProvider>

示例

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

---

fromUrl()

static fromUrl(url: string | Resource | Promise<string> | Promise<Resource>, options?: ConstructorOptions): Promise<CesiumTerrainProvider>

Creates a TerrainProvider that accesses terrain data in a Cesium terrain format. Terrain formats can be one of the following: <ul> <li> Quantized Mesh

</li> <li> Height Map

</li> </ul>

参数

url

The URL of the Cesium terrain server.

string | Resource | Promise<string> | Promise<Resource>

options?

ConstructorOptions

An object describing initialization options.

返回

Promise<CesiumTerrainProvider>

示例

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

---

requestTileGeometry()

requestTileGeometry(x: number, y: number, level: number, request?: Request): Promise<TerrainData> | undefined

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.

参数

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

The request object. Intended for internal use only.

返回

Promise<TerrainData> | undefined

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.

---

getLevelMaximumGeometricError()

getLevelMaximumGeometricError(level: number): number

Gets the maximum geometric error allowed in a tile at a given level.

参数

level

number

The tile level for which to get the maximum geometric error.

返回

number

The maximum geometric error.

---

getTileDataAvailable()

getTileDataAvailable(x: number, y: number, level: number): boolean | undefined

Determines whether data for a tile is available to be loaded.

参数

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.

返回

boolean | undefined

Undefined if not supported or availability is unknown, otherwise true or false.

---

loadTileDataAvailability()

loadTileDataAvailability(x: number, y: number, level: number): Promise<void> | undefined

Makes sure we load availability data for a tile

参数

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.

返回

Promise<void> | undefined

Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded

构造函数

构造函数

new CesiumTerrainProvider(options?: ConstructorOptions): CesiumTerrainProvider

参数

options?

ConstructorOptions

返回

CesiumTerrainProvider