Class

cesium

HeightmapTerrainData

Related Doc: package cesium

Permalink

class HeightmapTerrainData extends Object with TerrainData

Terrain data for a single tile where the terrain data is represented as a heightmap. A heightmap is a rectangular array of heights in row-major order from south to north and west to east.

alias HeightmapTerrainData

- The options object takes the following properties - {TypedArray} options.buffer The buffer containing height data. - {Number} options.width The width (longitude direction) of the heightmap, in samples. - {Number} options.height The height (latitude direction) of the heightmap, in samples. - {Number} [options.childTileMask=15] 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 PositionBit ValueChild Tile
01Southwest
12Southeast
24Northwest
38Northeast
- {Object} [options.structure] An object describing the structure of the height data. - {Number} [options.structure.heightScale=1.0] The factor by which to multiply height samples in order to obtain the height above the heightOffset, in meters. The heightOffset is added to the resulting height after multiplying by the scale. - {Number} [options.structure.heightOffset=0.0] The offset to add to the scaled height to obtain the final height in meters. The offset is added after the height sample is multiplied by the heightScale. - {Number} [options.structure.elementsPerHeight=1] The number of elements in the buffer that make up a single height sample. This is usually 1, indicating that each element is a separate height sample. If it is greater than 1, that number of elements together form the height sample, which is computed according to the structure.elementMultiplier and structure.isBigEndian properties. - {Number} [options.structure.stride=1] The number of elements to skip to get from the first element of one height to the first element of the next height. - {Number} [options.structure.elementMultiplier=256.0] The multiplier used to compute the height value when the stride property is greater than 1. For example, if the stride is 4 and the strideMultiplier is 256, the height is computed as follows: height = buffer[index] + buffer[index + 1] * 256 + buffer[index + 2] * 256 * 256 + buffer[index + 3] * 256 * 256 * 256 This is assuming that the isBigEndian property is false. If it is true, the order of the elements is reversed. - {Boolean} [options.structure.isBigEndian=false] Indicates endianness of the elements in the buffer when the stride property is greater than 1. If this property is false, the first element is the low-order element. If it is true, the first element is the high-order element. - {Boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; otherwise, false.

Annotations
@RawJSType() @native() @JSName( "Cesium.HeightmapTerrainData" )
Example:
  1. var buffer = ... var heightBuffer = new Uint16Array(buffer, 0, that._heightmapWidth * that._heightmapWidth); var childTileMask = new Uint8Array(buffer, heightBuffer.byteLength, 1)[0]; var waterMask = new Uint8Array(buffer, heightBuffer.byteLength + 1, buffer.byteLength - heightBuffer.byteLength - 1); var terrainData = new Cesium.HeightmapTerrainData({ buffer : heightBuffer, width : 65, height : 65, childTileMask : childTileMask, waterMask : waterMask });

See also

QuantizedMeshTerrainData

TerrainData

Linear Supertypes
TerrainData, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HeightmapTerrainData
  2. TerrainData
  3. Object
  4. Any
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HeightmapTerrainData(options: HeightmapTerrainDataOptions)

    Permalink
  2. new HeightmapTerrainData()

    Permalink
    Attributes
    protected

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def interpolateHeight(rectangle: Rectangle, longitude: Double, latitude: Double): Double

    Permalink
    Definition Classes
    TerrainData
  13. def isChildAvailable(thisX: Double, thisY: Double, childX: Double, childY: Double): Boolean

    Permalink
    Definition Classes
    TerrainData
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. def upsample(tilingScheme: TilingScheme, thisX: Double, thisY: Double, thisLevel: Double, descendantX: Double, descendantY: Double, descendantLevel: Double): |[Promise[TerrainData], Unit]

    Permalink
    Definition Classes
    TerrainData
  24. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def wasCreatedByUpsampling(): Boolean

    Permalink
    Definition Classes
    TerrainData
  29. var waterMask: |[|[Uint8Array, HTMLImageElement], HTMLCanvasElement]

    Permalink
    Definition Classes
    TerrainData

Inherited from TerrainData

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped