TerrainData - Cesium Documentation

# TerrainData

#### new TerrainData()

  Terrain data for a single tile. This type describes an interface and is not intended to be instantiated directly.

  ##### See:

  - HeightmapTerrainData
  - QuantizedMeshTerrainData
  Source: Core/TerrainData.js, line 20

### Members

#### waterMask :Uint8Array|Image|Canvas

  The water mask included in this terrain data, if any. A water mask is a rectangular Uint8Array or image where a value of 255 indicates water and a value of 0 indicates land. Values in between 0 and 255 are allowed as well to smoothly blend between land and water.
  Source: Core/TerrainData.js, line 32

### Methods

#### createMesh(tilingScheme, x, y, level) → Promise.<TerrainMesh>|undefined

  Creates a `TerrainMesh` from this terrain data.

  Name | Type | Description
  --- | --- | ---
  `tilingScheme` | TilingScheme | The tiling scheme to which this tile belongs.
  `x` | Number | The X coordinate of the tile for which to create the terrain data.
  `y` | Number | The Y coordinate of the tile for which to create the terrain data.
  `level` | Number | The level of the tile for which to create the terrain data.

  ##### Returns:

  A promise for the terrain mesh, or undefined if too many asynchronous mesh creations are already in progress and the operation should be retried later.
  Source: Core/TerrainData.js, line 77

#### interpolateHeight(rectangle, longitude, latitude) → Number

  Computes the terrain height at a specified longitude and latitude.

  Name | Type | Description
  --- | --- | ---
  `rectangle` | Rectangle | The rectangle covered by this terrain data.
  `longitude` | Number | The longitude in radians.
  `latitude` | Number | The latitude in radians.

  ##### Returns:

  The terrain height at the specified position. If the position is outside the rectangle, this method will extrapolate the height, which is likely to be wildly incorrect for positions far outside the rectangle.
  Source: Core/TerrainData.js, line 48

#### isChildAvailable(thisX, thisY, childX, childY) → Boolean

  Determines if a given child tile is available, based on the `TerrainData#childTileMask`. The given child tile coordinates are assumed to be one of the four children of this tile. If non-child tile coordinates are given, the availability of the southeast child tile is returned.

  Name | Type | Description
  --- | --- | ---
  `thisX` | Number | The tile X coordinate of this (the parent) tile.
  `thisY` | Number | The tile Y coordinate of this (the parent) tile.
  `childX` | Number | The tile X coordinate of the child tile to check for availability.
  `childY` | Number | The tile Y coordinate of the child tile to check for availability.

  ##### Returns:

  True if the child tile is available; otherwise, false.
  Source: Core/TerrainData.js, line 63

#### upsample(tilingScheme, thisX, thisY, thisLevel, descendantX, descendantY, descendantLevel) → Promise.<TerrainData>|undefined

  Upsamples this terrain data for use by a descendant tile.

  Name | Type | Description
  --- | --- | ---
  `tilingScheme` | TilingScheme | The tiling scheme of this terrain data.
  `thisX` | Number | The X coordinate of this tile in the tiling scheme.
  `thisY` | Number | The Y coordinate of this tile in the tiling scheme.
  `thisLevel` | Number | The level of this tile in the tiling scheme.
  `descendantX` | Number | The X coordinate within the tiling scheme of the descendant tile for which we are upsampling.
  `descendantY` | Number | The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling.
  `descendantLevel` | Number | The level within the tiling scheme of the descendant tile for which we are upsampling.

  ##### Returns:

  A promise for upsampled terrain data for the descendant tile, or undefined if too many asynchronous upsample operations are in progress and the request has been deferred.
  Source: Core/TerrainData.js, line 94

#### wasCreatedByUpsampling() → Boolean

  Gets a value indicating whether or not this terrain data was created by upsampling lower resolution terrain data. If this value is false, the data was obtained from some other source, such as by downloading it from a remote server. This method should return true for instances returned from a call to `TerrainData#upsample`.

  ##### Returns:

  True if this instance was created by upsampling; otherwise, false.
  Source: Core/TerrainData.js, line 105