KBE3D / KBCore / Cesium / Cesium3DTilesTerrainProvider

类: Cesium3DTilesTerrainProvider

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

A TerrainProvider that accesses terrain data in a 3D Tiles format.

参数

An object describing initialization options

属性

errorEvent

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

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

tilingScheme: TilingScheme

Gets the tiling scheme used by the provider.

---

hasWaterMask

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

hasVertexNormals: boolean

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

---

availability

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.

方法

fromUrl()

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

Creates a TerrainProvider that accesses terrain data in a Cesium 3D Tiles format.

参数

url

The URL of the Cesium terrain server.

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

options?

ConstructorOptions

An object describing initialization options.

返回

Promise<Cesium3DTilesTerrainProvider>

A promise that resolves to the terrain provider.

示例

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

---

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 3D Tiles format

参数

assetId

number

The Cesium ion asset id.

options?

ConstructorOptions

An object describing initialization options.

返回

Promise<CesiumTerrainProvider>

示例

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

---

requestTileGeometry()

requestTileGeometry(x: number, y: number, level: number, request?: 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.

参数

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

---

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

Make 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

---

getLevelMaximumGeometricError()

getLevelMaximumGeometricError(level: number): number

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

构造函数

构造函数

new Cesium3DTilesTerrainProvider(options?: ConstructorOptions): Cesium3DTilesTerrainProvider

参数

options?

ConstructorOptions

返回

Cesium3DTilesTerrainProvider