agi.foundation.cesium

(agi.foundation.cesium-2025r1.jar)

Enum CesiumHeightReference

java.lang.Object

java.lang.Enum<CesiumHeightReference>

agi.foundation.cesium.CesiumHeightReference

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CesiumHeightReference>

public enum CesiumHeightReference
extends Enum<CesiumHeightReference>
implements Enumeration

The height reference of an object, which indicates if the object's position is relative to terrain or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLAMP_TO_GROUND The position is clamped to the terrain.
NONE The position is absolute.
RELATIVE_TO_GROUND The position height is the height above the terrain.

Method Summary

Modifier and Type	Method and Description
static CesiumHeightReference	getDefault() Get the enum constant that is considered to be the default.
static CesiumHeightReference	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CesiumHeightReference	valueOf(String name) Returns the enum constant of this type with the specified name.
static CesiumHeightReference[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final CesiumHeightReference NONE

The position is absolute.

CLAMP_TO_GROUND

public static final CesiumHeightReference CLAMP_TO_GROUND

The position is clamped to the terrain.

RELATIVE_TO_GROUND

public static final CesiumHeightReference RELATIVE_TO_GROUND

The position height is the height above the terrain.

Method Detail

values

public static CesiumHeightReference[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CesiumHeightReference c : CesiumHeightReference.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CesiumHeightReference valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CesiumHeightReference getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CesiumHeightReference getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.