agi.foundation.terrain

(agi.foundation.models-2024r2.jar)

Enum HeightReference

java.lang.Object

java.lang.Enum<HeightReference>

agi.foundation.terrain.HeightReference

All Implemented Interfaces:

Enumeration, Serializable, Comparable<HeightReference>

public enum HeightReference
extends Enum<HeightReference>
implements Enumeration

An enumeration that identifies the reference for the heights returned by TerrainProvider.getHeight(double, double).

Enum Constant Summary

Enum Constants

Enum Constant and Description
REFERENCE_SURFACE The returned height is relative to another surface identified by ReferenceSurface (get / set).
SHAPE The returned height is relative to the surface of the Shape (get / set).

Method Summary

Modifier and Type	Method and Description
static HeightReference	getDefault() Get the enum constant that is considered to be the default.
static HeightReference	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 HeightReference	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeightReference[]	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

SHAPE

public static final HeightReference SHAPE

The returned height is relative to the surface of the Shape (get / set).

REFERENCE_SURFACE

public static final HeightReference REFERENCE_SURFACE

The returned height is relative to another surface identified by ReferenceSurface (get / set).

Method Detail

values

public static HeightReference[] 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 (HeightReference c : HeightReference.values())
    System.out.println(c);

Returns:

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

valueOf

public static HeightReference 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 HeightReference 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 HeightReference getDefault()

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

Returns:

The default enum constant.