agi.foundation.cesium

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

Enum ClockRange

java.lang.Object

java.lang.Enum<ClockRange>

agi.foundation.cesium.ClockRange

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ClockRange>

public enum ClockRange
extends Enum<ClockRange>
implements Enumeration

Defines the behavior of a clock when its current time reaches its start or end point.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLAMPED The clock stops when either its start or end time is reached.
LOOP_STOP The clock stops when its start time is reached, but loops back to start when its end time is reached.
UNBOUNDED The clock can continue forever in either direction.

Method Summary

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

UNBOUNDED

public static final ClockRange UNBOUNDED

The clock can continue forever in either direction.

CLAMPED

public static final ClockRange CLAMPED

The clock stops when either its start or end time is reached.

LOOP_STOP

public static final ClockRange LOOP_STOP

The clock stops when its start time is reached, but loops back to start when its end time is reached.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.