QuantizedMeshTerrainData - Cesium Documentation

# QuantizedMeshTerrainData

#### new QuantizedMeshTerrainData(options)

  Terrain data for a single tile where the terrain data is represented as a quantized mesh. A quantized mesh consists of three vertex attributes, longitude, latitude, and height. All attributes are expressed as 16-bit values in the range 0 to 32767. Longitude and latitude are zero at the southwest corner of the tile and 32767 at the northeast corner. Height is zero at the minimum height in the tile and 32767 at the maximum height in the tile.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `quantizedVertices` | Uint16Array |  | The buffer containing the quantized mesh.
  `indices` | Uint16Array | Uint32Array |  | The indices specifying how the quantized vertices are linked together into triangles. Each three indices specifies one triangle.
  `minimumHeight` | Number |  | The minimum terrain height within the tile, in meters above the ellipsoid.
  `maximumHeight` | Number |  | The maximum terrain height within the tile, in meters above the ellipsoid.
  `boundingSphere` | BoundingSphere |  | A sphere bounding all of the vertices in the mesh.
  `orientedBoundingBox` | OrientedBoundingBox |  | optional An OrientedBoundingBox bounding all of the vertices in the mesh.
  `horizonOcclusionPoint` | Cartesian3 |  | The horizon occlusion point of the mesh. If this point is below the horizon, the entire tile is assumed to be below the horizon as well. The point is expressed in ellipsoid-scaled coordinates.
  `westIndices` | Array.<Number> |  | The indices of the vertices on the western edge of the tile.
  `southIndices` | Array.<Number> |  | The indices of the vertices on the southern edge of the tile.
  `eastIndices` | Array.<Number> |  | The indices of the vertices on the eastern edge of the tile.
  `northIndices` | Array.<Number> |  | The indices of the vertices on the northern edge of the tile.
  `westSkirtHeight` | Number |  | The height of the skirt to add on the western edge of the tile.
  `southSkirtHeight` | Number |  | The height of the skirt to add on the southern edge of the tile.
  `eastSkirtHeight` | Number |  | The height of the skirt to add on the eastern edge of the tile.
  `northSkirtHeight` | Number |  | The height of the skirt to add on the northern edge of the tile.

  `childTileMask`

  Number

  `15`

  optional A bit mask indicating which of this tile's four children exist. If a child's bit is set, geometry will be requested for that tile as well when it is needed. If the bit is cleared, the child tile is not requested and geometry is instead upsampled from the parent. The bit values are as follows:

  Bit Position | Bit Value | Child Tile
  --- | --- | ---
  0 | 1 | Southwest
  1 | 2 | Southeast
  2 | 4 | Northwest
  3 | 8 | Northeast

  `createdByUpsampling` | Boolean | `false` | optional True if this instance was created by upsampling another instance; otherwise, false.
  `encodedNormals` | Uint8Array |  | optional The buffer containing per vertex normals, encoded using 'oct' encoding
  `waterMask` | Uint8Array |  | optional The buffer containing the watermask.

  ##### Example:

      var data = new Cesium.QuantizedMeshTerrainData({
          minimumHeight : -100,
          maximumHeight : 2101,
          quantizedVertices : new Uint16Array([// order is SW NW SE NE
                                               // longitude
                                               0, 0, 32767, 32767,
                                               // latitude
                                               0, 32767, 0, 32767,
                                               // heights
                                               16384, 0, 32767, 16384]),
          indices : new Uint16Array([0, 3, 1,
                                     0, 2, 3]),
          boundingSphere : new Cesium.BoundingSphere(new Cesium.Cartesian3(1.0, 2.0, 3.0), 10000),
          orientedBoundingBox : new Cesium.OrientedBoundingBox(new Cesium.Cartesian3(1.0, 2.0, 3.0), Matrix3.fromRotationX(Cesium.Math.PI, new Matrix3())),
          horizonOcclusionPoint : new Cesium.Cartesian3(3.0, 2.0, 1.0),
          westIndices : [0, 1],
          southIndices : [0, 1],
          eastIndices : [2, 3],
          northIndices : [1, 3],
          westSkirtHeight : 1.0,
          southSkirtHeight : 1.0,
          eastSkirtHeight : 1.0,
          northSkirtHeight : 1.0
      });

  ##### See:

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

### 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/QuantizedMeshTerrainData.js, line 203

### 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/QuantizedMeshTerrainData.js, line 242

#### 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. The position is clamped to the rectangle, so expect incorrect results for positions far outside the rectangle.
  Source: Core/QuantizedMeshTerrainData.js, line 425

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

  Determines if a given child tile is available, based on the `HeightmapTerrainData.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/QuantizedMeshTerrainData.js, line 474

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

  Upsamples this terrain data for use by a descendant tile. The resulting instance will contain a subset of the vertices in this instance, interpolated if necessary.

  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 heightmap 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/QuantizedMeshTerrainData.js, line 321

#### 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 `HeightmapTerrainData#upsample`.

  ##### Returns:

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