Package team.lodestar.lodestone.systems.easing

Class Easing.Back

java.lang.Object

team.lodestar.lodestone.systems.easing.Easing

team.lodestar.lodestone.systems.easing.Easing.Back

Direct Known Subclasses:

Easing.BackIn, Easing.BackInOut, Easing.BackOut

Enclosing class:

Easing

public abstract static class Easing.Back
extends Easing

A base class for Back easings.

Nested Class Summary

Nested classes/interfaces inherited from class team.lodestar.lodestone.systems.easing.Easing

Easing.Back, Easing.BackIn, Easing.BackInOut, Easing.BackOut, Easing.Elastic, Easing.ElasticIn, Easing.ElasticInOut, Easing.ElasticOut

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_OVERSHOOT	The default overshoot is 10% (1.70158).

Fields inherited from class team.lodestar.lodestone.systems.easing.Easing

BACK_IN, BACK_IN_OUT, BACK_OUT, BOUNCE_IN, BOUNCE_IN_OUT, BOUNCE_OUT, CIRC_IN, CIRC_IN_OUT, CIRC_OUT, CODEC, CUBIC_IN, CUBIC_IN_OUT, CUBIC_OUT, EASINGS, ELASTIC_IN, ELASTIC_IN_OUT, ELASTIC_OUT, EXPO_IN, EXPO_IN_OUT, EXPO_OUT, LINEAR, name, QUAD_IN, QUAD_IN_OUT, QUAD_OUT, QUARTIC_IN, QUARTIC_IN_OUT, QUARTIC_OUT, QUINTIC_IN, QUINTIC_IN_OUT, QUINTIC_OUT, SINE_IN, SINE_IN_OUT, SINE_OUT

Constructor Summary

Constructors

Constructor	Description
Back(String name)	Creates a new Back instance with the default overshoot (1.70158).
Back(String name, float overshoot)	Creates a new Back instance with the specified overshoot.

Method Summary

Modifier and Type	Method	Description
float	getOvershoot()	Returns the overshoot for this easing.
void	setOvershoot(float overshoot)	Sets the overshoot to the given value.

Methods inherited from class team.lodestar.lodestone.systems.easing.Easing

clamped, clamped, clamped, clamped, ease, ease, ease, ease, valueOf

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_OVERSHOOT

public static final float DEFAULT_OVERSHOOT

The default overshoot is 10% (1.70158).

See Also:

• Constant Field Values

Constructor Details

Back

public Back(String name)

Creates a new Back instance with the default overshoot (1.70158).

Back

public Back(String name,
 float overshoot)

Creates a new Back instance with the specified overshoot.

Parameters:

overshoot - the amount to overshoot by -- higher number means more overshoot and an overshoot of 0 results in cubic easing with no overshoot

Method Details

setOvershoot

public void setOvershoot(float overshoot)

Sets the overshoot to the given value.

Parameters:

overshoot - the new overshoot

getOvershoot

public float getOvershoot()

Returns the overshoot for this easing.

Returns:

this easing's overshoot