agi.foundation.terrain

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

Enum TerrainRegionStatus

java.lang.Object

java.lang.Enum<TerrainRegionStatus>

agi.foundation.terrain.TerrainRegionStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TerrainRegionStatus>

public enum TerrainRegionStatus
extends Enum<TerrainRegionStatus>
implements Enumeration

Indicates the status of a region of terrain.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOADED The region has been loaded into the cache and is ready to use.
LOADING The region is being loaded but is not yet ready for use.
REQUESTED It has been requested that this region be loaded into the cache, but that has not happened yet.

Method Summary

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

REQUESTED

public static final TerrainRegionStatus REQUESTED

It has been requested that this region be loaded into the cache, but that has not happened yet.

LOADING

public static final TerrainRegionStatus LOADING

The region is being loaded but is not yet ready for use.

LOADED

public static final TerrainRegionStatus LOADED

The region has been loaded into the cache and is ready to use.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.