ej.motion.util

Class MotionAnimator

java.lang.Object

ej.motion.util.MotionAnimator

public class MotionAnimator
extends Object

Utility class to schedule a Motion on a Timer.

Constructor Summary

Constructors

Constructor and Description
MotionAnimator(List<Motion> motions, MotionListener listener, boolean loop) Creates a motion animator with the specified motion.
MotionAnimator(Motion motion, MotionListener listener) Creates a motion animator with the specified motion.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the animation.
void	start(Timer timer, long period) Starts the animation on the given timer.
void	stop() Stops the animation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MotionAnimator

public MotionAnimator(List<Motion> motions,
                      MotionListener listener,
                      boolean loop)

Creates a motion animator with the specified motion.

The given motion listener will be notified:

• at startup (see start(Timer, long),
• for each new value (see Motion.getCurrentValue(),
• when the motion is finished (see Motion.isFinished(),
• if the animator is stopped (see stop().

Parameters:

motions - the list of motions to animate.

listener - the listener to notify for each step.

loop - if true, then the motion should loop until stopped.

Throws:

IndexOutOfBoundsException - if there is no item in the motions list.

MotionAnimator

public MotionAnimator(Motion motion,
                      MotionListener listener)

Creates a motion animator with the specified motion.

The given motion listener will be notified:

• at startup (see start(Timer, long),
• for each new value (see Motion.getCurrentValue(),
• when the motion is finished (see Motion.isFinished(),
• if the animator is stopped (see stop().

Parameters:

motion - the motion to animate.

listener - the listener to notify for each step.

Method Detail

cancel

public void cancel()

Cancels the animation.

Calls MotionListener.cancel() on the registered listener.

start

public void start(Timer timer,
                  long period)

Starts the animation on the given timer.

Calls MotionListener.start(int) on the registered listener with the start value of the motion.

If the motion animator is already started, it is firstly stopped.

Parameters:

timer - the timer to schedule on.

period - time in milliseconds between motion steps.

See Also:

Timer.schedule(TimerTask, long, long), Motion.getStartValue()

stop

public void stop()

Stops the animation.

Calls MotionListener.stop(int) on the registered listener with the stop value of the motion.

See Also:

Motion.getStopValue()