Package team.lodestar.lodestone.systems.easing

Class Easing

java.lang.Object

team.lodestar.lodestone.systems.easing.Easing

Direct Known Subclasses:

Easing.Back, Easing.Elastic

public abstract class Easing
extends Object

The Easing class holds a set of general-purpose motion tweening functions by Robert Penner. This class is essentially a port from Penner's ActionScript utility, with a few added tweaks.

Examples:

    //no tween
    Easing e1 = Easing.LINEAR;

    //backOut tween, the overshoot is Easing.Back.DEFAULT_OVERSHOOT
    Easing e2 = Easing.BACK_OUT;

    //backOut tween, the overshoot is 1.85f
    Easing.Back e3 = new Easing.BackOut(1.85f);
 

Robert Penner's Easing Functions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Easing.Back	A base class for Back easings.
static class	Easing.BackIn	Back easing in - backtracking slightly, then reversing direction and moving to target.
static class	Easing.BackInOut	Back easing in/out - backtracking slightly, then reversing direction and moving to target, then overshooting target, reversing, and finally coming back to target.
static class	Easing.BackOut	Back easing out - moving towards target, overshooting it slightly, then reversing and coming back to target.
static class	Easing.Elastic	A base class for elastic easings.
static class	Easing.ElasticIn	An Elastic easing used for ElasticIn functions.
static class	Easing.ElasticInOut	An Elastic easing used for ElasticInOut functions.
static class	Easing.ElasticOut	An Elastic easing used for ElasticOut functions.

Field Summary

Fields

Modifier and Type	Field	Description
static final Easing.Back	BACK_IN	An instance of BackIn using the default overshoot.
static final Easing.Back	BACK_IN_OUT	An instance of BackInOut using the default overshoot.
static final Easing.Back	BACK_OUT	An instance of BackOut using the default overshoot.
static final Easing	BOUNCE_IN	Bounce easing in.
static final Easing	BOUNCE_IN_OUT	Bounce easing in/out.
static final Easing	BOUNCE_OUT	Bounce easing out.
static final Easing	CIRC_IN	Circular easing in - accelerating from zero velocity.
static final Easing	CIRC_IN_OUT	Circular easing in/out - acceleration until halfway, then deceleration.
static final Easing	CIRC_OUT	Circular easing out - decelerating to zero velocity.
static final com.mojang.serialization.Codec<Easing>	CODEC
static final Easing	CUBIC_IN	Cubic easing in - accelerating from zero velocity.
static final Easing	CUBIC_IN_OUT	Cubic easing in/out - acceleration until halfway, then deceleration.
static final Easing	CUBIC_OUT	Cubic easing out - decelerating to zero velocity.
static final HashMap<String,Easing>	EASINGS
static final Easing.Elastic	ELASTIC_IN	An EasingIn instance using the default values.
static final Easing.Elastic	ELASTIC_IN_OUT	An ElasticInOut instance using the default values.
static final Easing.Elastic	ELASTIC_OUT	An ElasticOut instance using the default values.
static final Easing	EXPO_IN	Exponential easing in - accelerating from zero velocity.
static final Easing	EXPO_IN_OUT	Exponential easing in/out - accelerating until halfway, then decelerating.
static final Easing	EXPO_OUT	Exponential easing out - decelerating to zero velocity.
static final Easing	LINEAR	Simple linear tweening - no easing.
final String	name
static final Easing	QUAD_IN	Quadratic easing in - accelerating from zero velocity.
static final Easing	QUAD_IN_OUT	Quadratic easing in/out - acceleration until halfway, then deceleration
static final Easing	QUAD_OUT	Quadratic easing out - decelerating to zero velocity.
static final Easing	QUARTIC_IN	Quartic easing in - accelerating from zero velocity.
static final Easing	QUARTIC_IN_OUT	Quartic easing in/out - acceleration until halfway, then deceleration.
static final Easing	QUARTIC_OUT	Quartic easing out - decelerating to zero velocity.
static final Easing	QUINTIC_IN	Quintic easing in - accelerating from zero velocity.
static final Easing	QUINTIC_IN_OUT	Quintic easing in/out - acceleration until halfway, then deceleration.
static final Easing	QUINTIC_OUT	Quintic easing out - decelerating to zero velocity.
static final Easing	SINE_IN	Sinusoidal easing in - accelerating from zero velocity.
static final Easing	SINE_IN_OUT	Sinusoidal easing in/out - accelerating until halfway, then decelerating.
static final Easing	SINE_OUT	Sinusoidal easing out - decelerating to zero velocity.

Constructor Summary

Constructors

Constructor	Description
Easing(String name)

Method Summary

Modifier and Type	Method	Description
float	clamped(double value, double min, double max)
float	clamped(double value, double min, double max, double time)
float	clamped(float value, float min, float max)
float	clamped(float value, float min, float max, float time)
float	ease(double value, double min, double max)
float	ease(double value, double min, double max, double time)
float	ease(float value, float min, float max)
abstract float	ease(float value, float min, float max, float time)	The basic function for easing.
static Easing	valueOf(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CODEC

public static final com.mojang.serialization.Codec<Easing> CODEC

EASINGS

public static final HashMap<String,Easing> EASINGS

name

public final String name

LINEAR

public static final Easing LINEAR

Simple linear tweening - no easing.

QUAD_IN

public static final Easing QUAD_IN

Quadratic easing in - accelerating from zero velocity.

QUAD_OUT

public static final Easing QUAD_OUT

Quadratic easing out - decelerating to zero velocity.

QUAD_IN_OUT

public static final Easing QUAD_IN_OUT

Quadratic easing in/out - acceleration until halfway, then deceleration

CUBIC_IN

public static final Easing CUBIC_IN

Cubic easing in - accelerating from zero velocity.

CUBIC_OUT

public static final Easing CUBIC_OUT

Cubic easing out - decelerating to zero velocity.

CUBIC_IN_OUT

public static final Easing CUBIC_IN_OUT

Cubic easing in/out - acceleration until halfway, then deceleration.

QUARTIC_IN

public static final Easing QUARTIC_IN

Quartic easing in - accelerating from zero velocity.

QUARTIC_OUT

public static final Easing QUARTIC_OUT

Quartic easing out - decelerating to zero velocity.

QUARTIC_IN_OUT

public static final Easing QUARTIC_IN_OUT

Quartic easing in/out - acceleration until halfway, then deceleration.

QUINTIC_IN

public static final Easing QUINTIC_IN

Quintic easing in - accelerating from zero velocity.

QUINTIC_OUT

public static final Easing QUINTIC_OUT

Quintic easing out - decelerating to zero velocity.

QUINTIC_IN_OUT

public static final Easing QUINTIC_IN_OUT

Quintic easing in/out - acceleration until halfway, then deceleration.

SINE_IN

public static final Easing SINE_IN

Sinusoidal easing in - accelerating from zero velocity.

SINE_OUT

public static final Easing SINE_OUT

Sinusoidal easing out - decelerating to zero velocity.

SINE_IN_OUT

public static final Easing SINE_IN_OUT

Sinusoidal easing in/out - accelerating until halfway, then decelerating.

EXPO_IN

public static final Easing EXPO_IN

Exponential easing in - accelerating from zero velocity.

EXPO_OUT

public static final Easing EXPO_OUT

Exponential easing out - decelerating to zero velocity.

EXPO_IN_OUT

public static final Easing EXPO_IN_OUT

Exponential easing in/out - accelerating until halfway, then decelerating.

CIRC_IN

public static final Easing CIRC_IN

Circular easing in - accelerating from zero velocity.

CIRC_OUT

public static final Easing CIRC_OUT

Circular easing out - decelerating to zero velocity.

CIRC_IN_OUT

public static final Easing CIRC_IN_OUT

Circular easing in/out - acceleration until halfway, then deceleration.

ELASTIC_IN

public static final Easing.Elastic ELASTIC_IN

An EasingIn instance using the default values.

ELASTIC_OUT

public static final Easing.Elastic ELASTIC_OUT

An ElasticOut instance using the default values.

ELASTIC_IN_OUT

public static final Easing.Elastic ELASTIC_IN_OUT

An ElasticInOut instance using the default values.

BACK_IN

public static final Easing.Back BACK_IN

An instance of BackIn using the default overshoot.

BACK_OUT

public static final Easing.Back BACK_OUT

An instance of BackOut using the default overshoot.

BACK_IN_OUT

public static final Easing.Back BACK_IN_OUT

An instance of BackInOut using the default overshoot.

BOUNCE_IN

public static final Easing BOUNCE_IN

Bounce easing in.

BOUNCE_OUT

public static final Easing BOUNCE_OUT

Bounce easing out.

BOUNCE_IN_OUT

public static final Easing BOUNCE_IN_OUT

Bounce easing in/out.

Constructor Details

Easing

public Easing(String name)

Method Details

valueOf

public static Easing valueOf(String name)

ease

public abstract float ease(float value,
 float min,
 float max,
 float time)

The basic function for easing.

Parameters:

value - the time (either frames or in seconds/milliseconds)

min - the beginning value

max - the value changed

time - the duration time

Returns:

the eased value

ease

public float ease(double value,
 double min,
 double max,
 double time)

ease

public float ease(float value,
 float min,
 float max)

ease

public float ease(double value,
 double min,
 double max)

clamped

public float clamped(float value,
 float min,
 float max,
 float time)

clamped

public float clamped(double value,
 double min,
 double max,
 double time)

clamped

public float clamped(float value,
 float min,
 float max)

clamped

public float clamped(double value,
 double min,
 double max)