agi.foundation.graphics.advanced

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

Enum SimulationAnimationCycle

java.lang.Object

java.lang.Enum<SimulationAnimationCycle>

agi.foundation.graphics.advanced.SimulationAnimationCycle

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SimulationAnimationCycle>

public enum SimulationAnimationCycle
extends Enum<SimulationAnimationCycle>
implements Enumeration

Defines the next animation time that will happen when the start and end times are reached.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE Animation will continue past the time.
LOOP Animation will loop back when reaching the time.
STOP Animation will stop at the time.

Method Summary

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

LOOP

public static final SimulationAnimationCycle LOOP

Animation will loop back when reaching the time.

STOP

public static final SimulationAnimationCycle STOP

Animation will stop at the time.

CONTINUE

public static final SimulationAnimationCycle CONTINUE

Animation will continue past the time.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.