com.b3dgs.lionengine.drawable
Enum AnimState

java.lang.Object
  extended by java.lang.Enum<AnimState>
      extended by com.b3dgs.lionengine.drawable.AnimState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AnimState>

public enum AnimState
extends java.lang.Enum<AnimState>

List of standard animation states, used by an animated sprite.

See Also:
AnimatedSprite, Animator

Enum Constant Summary
ANIMATING
          Animation is currently animating.
FINISHED
          Animation is finished (only in play case).
READY
          Animation is ready to be played.
REVERSE_ANIMATING
          Animation is currently reversed.
 
Method Summary
static AnimState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AnimState[] 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

READY

public static final AnimState READY
Animation is ready to be played.


ANIMATING

public static final AnimState ANIMATING
Animation is currently animating.


REVERSE_ANIMATING

public static final AnimState REVERSE_ANIMATING
Animation is currently reversed.


FINISHED

public static final AnimState FINISHED
Animation is finished (only in play case).

Method Detail

values

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

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

valueOf

public static AnimState valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null