agi.foundation.cesium

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

Enum ClockStep

java.lang.Object

java.lang.Enum<ClockStep>

agi.foundation.cesium.ClockStep

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ClockStep>

public enum ClockStep
extends Enum<ClockStep>
implements Enumeration

Defines how a simulated clock advances in time.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SYSTEM_CLOCK The clock always matches the system clock.
SYSTEM_CLOCK_MULTIPLIER The clock advances by the elapsed system time between ticks, multiplied by a user specified value.
TICK_DEPENDENT The clock advances by a fixed step each tick.

Method Summary

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

SYSTEM_CLOCK

public static final ClockStep SYSTEM_CLOCK

The clock always matches the system clock.

SYSTEM_CLOCK_MULTIPLIER

public static final ClockStep SYSTEM_CLOCK_MULTIPLIER

The clock advances by the elapsed system time between ticks, multiplied by a user specified value.

TICK_DEPENDENT

public static final ClockStep TICK_DEPENDENT

The clock advances by a fixed step each tick.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.