com.bonzaiengine.procedural.util

Enum Interpolator

java.lang.Object

java.lang.Enum<Interpolator>

com.bonzaiengine.procedural.util.Interpolator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Interpolator>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
HERMITE
LINEAR
QUINTIC

Method Summary

Modifier and Type	Method and Description
double	interpolate(double cur, double next, double t)
double	interpolator(double t) f(t), f being the interpolator function
double	interpolatorDerivative(double t) df/dt, f being the interpolator function
double	interpolatorMultTDerivative(double t) d(f*t)/dt, f being the interpolator function
static Interpolator	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Interpolator[]	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

LINEAR

public static final Interpolator LINEAR

HERMITE

public static final Interpolator HERMITE

QUINTIC

public static final Interpolator QUINTIC

Method Detail

values

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

Returns:

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

valueOf

public static Interpolator 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

interpolator

public double interpolator(double t)

f(t), f being the interpolator function

Returns:

value of the interpolator function at t

interpolatorDerivative

public double interpolatorDerivative(double t)

df/dt, f being the interpolator function

Returns:

value of the derivative function at t

interpolatorMultTDerivative

public double interpolatorMultTDerivative(double t)

d(f*t)/dt, f being the interpolator function

Returns:

value of the derivative of the function multiplied by t at t

interpolate

public double interpolate(double cur,
                          double next,
                          double t)