net.ilexiconn.llibrary.client.model.tools

Class ControlledAnimation

java.lang.Object

net.ilexiconn.llibrary.client.model.tools.ControlledAnimation

public class ControlledAnimation
extends java.lang.Object

This is a timer that can be used to easily animate models between poses. You have to set the number of ticks between poses, increase or decrease the timer, and get the percentage using a specific function.

Since:

1.4.0

Constructor Summary

Constructors

Constructor and Description
ControlledAnimation(int d)

Method Summary

Modifier and Type	Method and Description
boolean	canDecreaseTimer() Checks if the timer can be decreased
boolean	canIncreaseTimer() Checks if the timer can be increased
void	decreaseTimer() Decreases the timer by 1.
void	decreaseTimer(int time) Decreases the timer by a specific value.
float	getAnimationFraction() Returns a float that represents a fraction of the animation, a value between 0.0F and 1.0F.
float	getAnimationProgressArcTan() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressPoly2() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressPoly3() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressPolyN(int n) Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressSin() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressSinPowerOf(int i) Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressSinSqrt() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressSinToTen() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressSinToTenWithoutReturn()
float	getAnimationProgressSmooth() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressSteep() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressTemporary() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressTemporaryFS() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
float	getAnimationProgressTemporaryInvesed() Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation.
int	getTimer() Returns the timer of this animation.
void	increaseTimer() Increases the timer by 1.
void	increaseTimer(int time) Increases the timer by a specific value.
void	resetTimer() Sets the timer to 0.
void	setDuration(int d) Sets the duration of the animation in ticks.
void	setTimer(int time) Sets the timer to a specific value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlledAnimation

public ControlledAnimation(int d)

Method Detail

setDuration

public void setDuration(int d)

Sets the duration of the animation in ticks. Try values around 50.

Parameters:

d - is the maximum number of ticks that the timer can reach.

getTimer

public int getTimer()

Returns the timer of this animation. Useful to save the progress of the animation.

setTimer

public void setTimer(int time)

Sets the timer to a specific value.

Parameters:

time - is the number of ticks to be set.

resetTimer

public void resetTimer()

Sets the timer to 0.

increaseTimer

public void increaseTimer()

Increases the timer by 1.

canIncreaseTimer

public boolean canIncreaseTimer()

Checks if the timer can be increased

increaseTimer

public void increaseTimer(int time)

Increases the timer by a specific value.

Parameters:

time - is the number of ticks to be increased in the timer

decreaseTimer

public void decreaseTimer()

Decreases the timer by 1.

canDecreaseTimer

public boolean canDecreaseTimer()

Checks if the timer can be decreased

decreaseTimer

public void decreaseTimer(int time)

Decreases the timer by a specific value.

Parameters:

time - is the number of ticks to be decreased in the timer

getAnimationFraction

public float getAnimationFraction()

Returns a float that represents a fraction of the animation, a value between 0.0F and 1.0F.

getAnimationProgressSmooth

public float getAnimationProgressSmooth()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using 1/(1 + e^(4-8*x)). It is quite uniform but slow, and needs if statements.

getAnimationProgressSteep

public float getAnimationProgressSteep()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using 1/(1 + e^(6-12*x)). It is quite uniform, but fast.

getAnimationProgressSin

public float getAnimationProgressSin()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using a sine function. It is fast in the beginning and slow in the end.

getAnimationProgressSinSqrt

public float getAnimationProgressSinSqrt()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using a sine function squared. It is very smooth.

getAnimationProgressSinToTen

public float getAnimationProgressSinToTen()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using a sine function to the power of ten. It is slow in the beginning and fast in the end.

getAnimationProgressSinToTenWithoutReturn

public float getAnimationProgressSinToTenWithoutReturn()

getAnimationProgressSinPowerOf

public float getAnimationProgressSinPowerOf(int i)

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using a sine function to a specific power "i."

Parameters:

i - is the power of the sine function.

getAnimationProgressPoly2

public float getAnimationProgressPoly2()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using x^2 / (x^2 + (1-x)^2). It is smooth.

getAnimationProgressPoly3

public float getAnimationProgressPoly3()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using x^3 / (x^3 + (1-x)^3). It is steep.

getAnimationProgressPolyN

public float getAnimationProgressPolyN(int n)

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using x^n / (x^n + (1-x)^n). It is steeper when n increases.

Parameters:

n - is the power of the polynomial function.

getAnimationProgressArcTan

public float getAnimationProgressArcTan()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. It reaches 1.0F using 0.5 + arctan(PI * (x - 0.5)) / 2.00776964. It is super smooth.

getAnimationProgressTemporary

public float getAnimationProgressTemporary()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. This value starts at 1.0F and ends at 1.0F. The equation used is 0.5 - 0.5 * cos(2 * PI * x + sin(2 * PI * x)). It is smooth.

getAnimationProgressTemporaryFS

public float getAnimationProgressTemporaryFS()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. This value starts at 0.0F and ends at 0.0F. The equation used is sin(x * PI + sin(x * PI)). It is fast in the beginning and slow in the end.

getAnimationProgressTemporaryInvesed

public float getAnimationProgressTemporaryInvesed()

Returns a value between 0.0F and 1.0F depending on the timer and duration of the animation. This value starts at 1.0F and ends at 1.0F. The equation used is 0.5 + 0.5 * cos(2 PI * x + sin(2 * PI * x)). It is smooth.