ej.motion

Class AbstractMotion

java.lang.Object

ej.motion.AbstractMotion

All Implemented Interfaces:

Motion

Direct Known Subclasses:

AbstractBounceMotion, AbstractElasticMotion, BackEaseInMotion, BackEaseInOutMotion, BackEaseOutMotion, BounceMotion, CircEaseInMotion, CircEaseInOutMotion, CircEaseOutMotion, CubicEaseInMotion, CubicEaseInOutMotion, CubicEaseOutMotion, EaseInMotion, EaseInOutMotion, EaseOutMotion, ElasticEaseOutMotion, ElasticMotion, ExpoEaseInMotion, ExpoEaseInOutMotion, ExpoEaseOutMotion, LinearMotion, QuadEaseInMotion, QuadEaseInOutMotion, QuadEaseOutMotion, QuartEaseInMotion, QuartEaseInOutMotion, QuartEaseOutMotion, QuintEaseInMotion, QuintEaseInOutMotion, QuintEaseOutMotion, SineEaseInMotion, SineEaseInOutMotion, SineEaseOutMotion

public abstract class AbstractMotion
extends java.lang.Object
implements Motion

Common abstract implementation of a motion.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	duration Duration.
protected boolean	finished true if finished, false otherwise.
protected int	start Start value.
protected long	startTime Start time.
protected int	stop Stop value.

Constructor Summary

Constructors

Constructor and Description
AbstractMotion(int start, int stop, long duration) Creates a motion for a move from start to stop.

Method Summary

Modifier and Type	Method and Description
protected abstract int	computeCurrentValue(long elapsed) Computes current value.
int	getCurrentValue() Computes the current value of the motion.
long	getDuration() Gets the motion duration.
int	getStartValue() Gets the start value of the motion.
int	getStopValue() Gets the stop value of the motion.
int	getValue(long elapsed) Gets the value of the motion for a specific elapsed time.
boolean	isFinished() Gets whether the motion is finished or not.
protected boolean	isFinished(int value) Checks whether the motion is finished or not, considering the given value.
void	start() Starts (or starts again) the motion.

Methods inherited from class java.lang.Object

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

Field Detail

start

protected final int start

Start value.

stop

protected final int stop

Stop value.

duration

protected final long duration

Duration.

startTime

protected long startTime

Start time.

See Also:

start()

finished

protected boolean finished

true if finished, false otherwise.

See Also:

isFinished(), isFinished(int)

Constructor Detail

AbstractMotion

public AbstractMotion(int start,
                      int stop,
                      long duration)

Creates a motion for a move from start to stop.

Parameters:

start - the start value.

stop - the stop value.

duration - the maximum duration of the motion.

Method Detail

getDuration

public long getDuration()

Description copied from interface: Motion

Gets the motion duration.

Specified by:

getDuration in interface Motion

Returns:

the motion duration.

start

public void start()

Description copied from interface: Motion

Starts (or starts again) the motion.

Specified by:

start in interface Motion

isFinished

public boolean isFinished()

Description copied from interface: Motion

Gets whether the motion is finished or not.

A motion is finished when the current value is the stop one.

Specified by:

isFinished in interface Motion

Returns:

true if the motion is finished, false otherwise.

getStartValue

public int getStartValue()

Description copied from interface: Motion

Gets the start value of the motion.

Specified by:

getStartValue in interface Motion

Returns:

the start value.

getStopValue

public int getStopValue()

Description copied from interface: Motion

Gets the stop value of the motion.

Specified by:

getStopValue in interface Motion

Returns:

the stop value.

getCurrentValue

public int getCurrentValue()

Description copied from interface: Motion

Computes the current value of the motion.

If the motion is finished, returns the stop value.

Specified by:

getCurrentValue in interface Motion

Returns:

the current value.

See Also:

Motion.isFinished()

getValue

public int getValue(long elapsed)

Description copied from interface: Motion

Gets the value of the motion for a specific elapsed time.

Specified by:

getValue in interface Motion

Parameters:

elapsed - the absolute elapsed time.

Returns:

the value for the given time.

isFinished

protected boolean isFinished(int value)

Checks whether the motion is finished or not, considering the given value.

By default, the motion is finished if the value reach (or exceed) the stop value.

Parameters:

value - the value to check with.

Returns:

true if the motion is finished, false otherwise.

computeCurrentValue

protected abstract int computeCurrentValue(long elapsed)

Computes current value.

Parameters:

elapsed - the elapsed time since the beginning.

Returns:

the current value.