Class AnimationTimer

java.lang.Object

ch.swingfx.timer.AnimationTimer

public class AnimationTimer
extends Object

Class for simple animation. Example:

AnimationTimer at = new AnimationTimer(FrameRate.FPS_25);
at.setDuration(2500); // 2500 milliseconds
at.setAnimationTarget(new AnimationTarget() {
                public void event(AnimationTimer timer, float fraction) {
                // between begin and end.
                // fraction represents the time passed (0f = 0%, 1f = 100%)
        }
        public void begin(AnimationTimer timer) {
                // start of the animation                       
        }
        public void end(AnimationTimer timer) {
                // end of the animation
        }
});
at.start();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnimationTimer.AnimationTarget	Used with AnimationTimer.setAnimationTarget(). Implement this interface to receive events from the AnimationTimer
static enum	AnimationTimer.FrameRate	Frame rates for the AnimationTimer Note: These frame rates are approximations.
private class	AnimationTimer.TimerActionListener	Handles the calculation of the time that has elapsed since the start and sends it to the AnimationTimer.AnimationTarget

Field Summary

Fields

Modifier and Type	Field	Description
private long	fAnimationStartTime	Stores the start time of the animation so we can calculate the fraction
private AnimationTimer.AnimationTarget	fAnimationTarget	Animation events get sent to this target
private long	fDuration	Duration of the animation in milliseconds
private final Timer	fTimer	The timer for the animation

Constructor Summary

Constructors

Constructor	Description
AnimationTimer()	Creates an AnimationTimer with a default frame rate of 25
AnimationTimer(AnimationTimer.FrameRate fps)	Creates an AnimationTimer with an specified frame rate

Method Summary

Modifier and Type	Method	Description
void	setAnimationTarget(AnimationTimer.AnimationTarget target)	Set the animation target
void	setDuration(long duration)	Set the duration of the animation
void	start()	Start the animation
void	stop()	End the animation before duration has passed

Methods inherited from class Object

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

Field Details

fTimer

private final Timer fTimer

The timer for the animation

fAnimationTarget

private AnimationTimer.AnimationTarget fAnimationTarget

Animation events get sent to this target

fAnimationStartTime

private long fAnimationStartTime

Stores the start time of the animation so we can calculate the fraction

fDuration

private long fDuration

Duration of the animation in milliseconds

Constructor Details

AnimationTimer

public AnimationTimer()

Creates an AnimationTimer with a default frame rate of 25

AnimationTimer

public AnimationTimer(AnimationTimer.FrameRate fps)

Creates an AnimationTimer with an specified frame rate

Parameters:

fps - AnimationTimer.FrameRate we want to use for this AnimationTimer

Method Details

setDuration

public void setDuration(long duration)

Set the duration of the animation

Parameters:

duration - the duration of the animation

start

public void start()

Start the animation

stop

public void stop()

End the animation before duration has passed

setAnimationTarget

public void setAnimationTarget(AnimationTimer.AnimationTarget target)

Set the animation target

Parameters:

target - the animation target