HeightmapTerrainData

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 Position Bit Value Child Tile

0 1 Southwest

1 2 Southeast

2 4 Northwest

3 8 Northeast
{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.

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

Annotations: @RawJSType() @native() @JSName( "Cesium.HeightmapTerrainData" )
See also: QuantizedMeshTerrainData
TerrainData

Linear Supertypes

Object, Any, AnyRef, Any

Instance Constructors

new HeightmapTerrainData(options: HeightmapTerrainDataOptions)
new HeightmapTerrainData()

Attributes
protected

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

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

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
def interpolateHeight(rectangle: Rectangle, longitude: Double, latitude: Double): Double
def isChildAvailable(thisX: Double, thisY: Double, childX: Double, childY: Double): Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def propertyIsEnumerable(v: String): Boolean

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

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

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

Definition Classes
Object
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def wasCreatedByUpsampling(): Boolean
var waterMask: |[|[Uint8Array, HTMLImageElement], HTMLCanvasElement]

Related Doc: package cesium

class HeightmapTerrainData extends Object

Instance Constructors

new HeightmapTerrainData(options: HeightmapTerrainDataOptions)

new HeightmapTerrainData()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

def interpolateHeight(rectangle: Rectangle, longitude: Double, latitude: Double): Double

def isChildAvailable(thisX: Double, thisY: Double, childX: Double, childY: Double): Boolean

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def propertyIsEnumerable(v: String): Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def toLocaleString(): String

def toString(): String

def upsample(tilingScheme: TilingScheme, thisX: Double, thisY: Double, thisLevel: Double, descendantX: Double, descendantY: Double, descendantLevel: Double): |[Promise[HeightmapTerrainData], Unit]

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def wasCreatedByUpsampling(): Boolean

var waterMask: |[|[Uint8Array, HTMLImageElement], HTMLCanvasElement]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped