Package swingtree.animation

Enum Class Stride

java.lang.Object

java.lang.Enum<Stride>

swingtree.animation.Stride

All Implemented Interfaces:

Serializable, Comparable<Stride>, Constable

public enum Stride
extends Enum<Stride>

Defines either an animation progresses from 0 to 1 or regresses from 1 to 0. This is used to determine the direction of the animation, which is important for animations that end with a fade out.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROGRESSIVE	The animation progress defined by AnimationStatus.progress() will start at 0 and end at 1.
REGRESSIVE	The animation progress defined by AnimationStatus.progress() will start at 1 and end at 0.

Method Summary

Modifier and Type	Method	Description
double	applyTo(double progress)	Applies this stride to the supplied progress value.
Stride	inverse()	There are only two possible values for this enum, which are PROGRESSIVE and REGRESSIVE.
static Stride	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Stride[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROGRESSIVE

public static final Stride PROGRESSIVE

The animation progress defined by AnimationStatus.progress() will start at 0 and end at 1.

REGRESSIVE

public static final Stride REGRESSIVE

The animation progress defined by AnimationStatus.progress() will start at 1 and end at 0.

Method Details

values

public static Stride[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Stride valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

inverse

public Stride inverse()

There are only two possible values for this enum, which are PROGRESSIVE and REGRESSIVE. So this returns the inverse of this stride, which is either PROGRESSIVE if this is REGRESSIVE or REGRESSIVE if this is PROGRESSIVE.

Returns:

The inverse of this stride.

applyTo

public double applyTo(double progress)

Applies this stride to the supplied progress value. If this is PROGRESSIVE, the progress is returned as is. If this is REGRESSIVE, the progress is inverted.

Parameters:

progress - The progress value to apply this stride to.

Returns:

The progress value after applying this stride.