agi.foundation.cesium

(agi.foundation.cesium-2024r3.jar)

Enum CesiumSensorVolumePortionToDisplay

java.lang.Object

java.lang.Enum<CesiumSensorVolumePortionToDisplay>

agi.foundation.cesium.CesiumSensorVolumePortionToDisplay

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CesiumSensorVolumePortionToDisplay>

public enum CesiumSensorVolumePortionToDisplay
extends Enum<CesiumSensorVolumePortionToDisplay>
implements Enumeration

Specifies which parts of a sensor are to be displayed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE_ELLIPSOID_HORIZON Only the part of the sensor projection above the ellipsoid horizon is shown.
BELOW_ELLIPSOID_HORIZON Only the part of the sensor projection below the ellipsoid horizon is shown.
COMPLETE The entire sensor projection is shown.

Method Summary

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

COMPLETE

public static final CesiumSensorVolumePortionToDisplay COMPLETE

The entire sensor projection is shown.

BELOW_ELLIPSOID_HORIZON

public static final CesiumSensorVolumePortionToDisplay BELOW_ELLIPSOID_HORIZON

Only the part of the sensor projection below the ellipsoid horizon is shown.

ABOVE_ELLIPSOID_HORIZON

public static final CesiumSensorVolumePortionToDisplay ABOVE_ELLIPSOID_HORIZON

Only the part of the sensor projection above the ellipsoid horizon is shown.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.