agi.foundation.graphics.advanced

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

Enum GlobeOverlayRole

java.lang.Object

java.lang.Enum<GlobeOverlayRole>

agi.foundation.graphics.advanced.GlobeOverlayRole

All Implemented Interfaces:

Enumeration, Serializable, Comparable<GlobeOverlayRole>

public enum GlobeOverlayRole
extends Enum<GlobeOverlayRole>
implements Enumeration

The role of a GlobeOverlay.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE The GlobeOverlay is a base image.
NIGHT The GlobeOverlay is a base image that is only displayed on the area of the CentralBody that is not lit by the sun.
NONE The role of the GlobeOverlay isn't set.
NORMAL The GlobeOverlay is a normal overlay without a special role.
SPECULAR The GlobeOverlay is a base image that shows the glint of the sun on the CentralBody.

Method Summary

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

BASE

public static final GlobeOverlayRole BASE

The GlobeOverlay is a base image.

NIGHT

public static final GlobeOverlayRole NIGHT

The GlobeOverlay is a base image that is only displayed on the area of the CentralBody that is not lit by the sun.

SPECULAR

public static final GlobeOverlayRole SPECULAR

The GlobeOverlay is a base image that shows the glint of the sun on the CentralBody.

NORMAL

public static final GlobeOverlayRole NORMAL

The GlobeOverlay is a normal overlay without a special role.

NONE

public static final GlobeOverlayRole NONE

The role of the GlobeOverlay isn't set.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.