fr.lri.swingstates.animations

Class Animation

java.lang.Object

fr.lri.swingstates.animations.Animation

Direct Known Subclasses:

AnimationFillPaint, AnimationOutlinePaint, AnimationRotateBy, AnimationRotateTo, AnimationScaleBy, AnimationScaleTo, AnimationTranslateBy, AnimationTranslateTo, AnimationTransparency

public abstract class Animation
extends java.lang.Object

An animation to control a continuous change on a CElement: a CShape, a CTag or a Canvas. Animating a CTag or a Canvas means animating every CShape tagged by this tag or displayed in this canvas.

An animation lasts a given number of "laps". A "lap" lasts durationLap milliseconds (by default, 1000). During a "lap", the value of a parameter t starts at 0 and ends at 1 for odd laps (and starts at 1 and ends at 0 for even laps. Value of parameter t whose value is updated every delay milliseconds (by default, 40). t value follows a pacing funcyion (by default, a linear pacing function). An animation can be started, stopped, suspended and resumed.

You can also override the methods doStart(), doStop(), doSuspend() and doResume() to define specific treatments applied when calling respectively the methods start(), stop(), suspend() and resume(). For example, if you want to change the color of the animated elements when you start and stop an animation that rotate and translate:

 class AnimationRotateAndTranslateBy extends Animation {
        double rotate;
        double translatex, translatey;
 
        public AnimationRotateAndTranslateBy(double r, double tx, double ty) {
                super();
                rotate = r;
                translatex = tx;
                translatey = ty;
        }
 
        public void step(double t) {
                getAnimated().rotateBy(rotate).scaleBy(translatex, translatey);
        }
 
        public void doStart() {
                getAnimated().setFillPaint(Color.RED);
        }
 
        public void doStop() {
                getAnimated().setFillPaint(Color.LIGHT_GRAY);
        }
 }
 

Author:

Caroline Appert

Field Summary

Fields

Modifier and Type	Field and Description
static short	FUNCTION_LINEAR The constant to pass to the method setFunction(short) to have a linear pacing function.
static short	FUNCTION_SIGMOID The constant to pass to the method setFunction(short) to have a "sigmoid" pacing function.
static int	INFINITE_NUMBER_OF_LAPS The constant to pass to the method setNbLaps(int) to make an animation never stop.

Constructor Summary

Constructors

Constructor and Description
Animation() Builds an animation and registers it to the animation manager.

Method Summary

Methods

Modifier and Type	Method and Description
Animation	addTag(AExtensionalTag t) Adds a tag to this animation.
Animation	addTag(java.lang.String t) Adds a ANamedTag tag to this animation.
void	doResume() Method called when this animation is resumed.
void	doStart() Method called when this animation is started.
void	doStop() Method called when this animation is stopped.
void	doSuspend() Method called when this animation is suspended.
CElement	getAnimated()
int	getDelay()
long	getLapDuration()
int	getNbLaps()
short	getPacingFunction()
boolean	hasTag(ATag t) Tests whether this animation has a given tag.
boolean	hasTag(java.lang.String t) Tests whether this animation has a given ANamedTag tag.
boolean	isStarted()
boolean	isSuspended()
Animation	removeTag(AExtensionalTag t) Removes a tag from this animation.
Animation	removeTag(java.lang.String t) Removes a tag from this animation.
static void	resetAnimationManager() For internal use.
Animation	resume() Resumes this animation that has been resumed using the method resume().
Animation	setAnimatedElement(CElement ce) Sets the CElement that must be animated by this animation.
void	setCanvas(Canvas canvas)
Animation	setDelay(int d) Sets the delay between to successive values of the parameter t.
Animation	setFunction(short t) Sets the type of the pacing function, use the static constants Animation.FUNCTION_LINEAR or Animation.FUNCTION_SIGMOID.
Animation	setLapDuration(long d) Sets the duration of a "lap".
Animation	setNbLaps(int laps) Sets the number of laps of this animation.
Animation	start() Starts this animation.
abstract void	step(double t) Override this abstract to specify the effect of this animation.
Animation	stop() Stops this animation.
Animation	suspend() Suspends this animation.

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_LINEAR

public static short FUNCTION_LINEAR

The constant to pass to the method setFunction(short) to have a linear pacing function.

FUNCTION_SIGMOID

public static short FUNCTION_SIGMOID

The constant to pass to the method setFunction(short) to have a "sigmoid" pacing function. A sigmoid function corresponds to a slow-in/fast-out effect.

INFINITE_NUMBER_OF_LAPS

public static int INFINITE_NUMBER_OF_LAPS

The constant to pass to the method setNbLaps(int) to make an animation never stop.

Constructor Detail

Animation

public Animation()

Builds an animation and registers it to the animation manager.

Method Detail

resetAnimationManager

public static void resetAnimationManager()

For internal use. See class SwingStatesApplet.

See Also:

SwingStatesApplet.init()

setDelay

public Animation setDelay(int d)

Sets the delay between to successive values of the parameter t. By default, the value of the delay is 40 milliseconds.

Parameters:

d - The delay in milliseconds.

Returns:

this animation.

getLapDuration

public long getLapDuration()

Returns:

the duration (in milliseconds) of a lap of this animation.

setLapDuration

public Animation setLapDuration(long d)

Sets the duration of a "lap". By default, the value of the duration is 1000 milliseconds.

Parameters:

d - The duration in milliseconds.

Returns:

this animation.

setFunction

public Animation setFunction(short t)

Sets the type of the pacing function, use the static constants Animation.FUNCTION_LINEAR or Animation.FUNCTION_SIGMOID. By default, the type function is linear.

Parameters:

t - The type of the pacing function.

Returns:

this animation.

setNbLaps

public Animation setNbLaps(int laps)

Sets the number of laps of this animation. By default, an animation lasts one lap (i.e. the parameter starts at 0 and ends at 1). For example, if one sets the number of laps to 2, the parameter starts at 0 and ends at 0 passing by 1.

Parameters:

laps - The number of laps.

Returns:

this animation.

setAnimatedElement

public Animation setAnimatedElement(CElement ce)

Sets the CElement that must be animated by this animation. If the canvas that must received animation events has not yet been set, it is set to the canvas to which belongs this CElement.

Parameters:

ce - The CElement to animate.

Returns:

this animation.

doStart

public void doStart()

Method called when this animation is started. This method does nothing. It can be redefined in derived classes.

See Also:

start()

start

public final Animation start()

Starts this animation.

Returns:

This animation.

doStop

public void doStop()

Method called when this animation is stopped. This method does nothing. It can be redefined in derived classes.

See Also:

stop()

stop

public final Animation stop()

Stops this animation.

Returns:

This animation.

doSuspend

public void doSuspend()

Method called when this animation is suspended. This method does nothing. It can be redefined in derived classes.

See Also:

suspend()

suspend

public final Animation suspend()

Suspends this animation. Use the method resume() to resume the animation being suspended.

Returns:

This animation.

See Also:

resume()

doResume

public void doResume()

Method called when this animation is resumed. This method does nothing. It can be redefined in derived classes.

See Also:

resume()

resume

public final Animation resume()

Resumes this animation that has been resumed using the method resume().

Returns:

This animation.

See Also:

suspend()

step

public abstract void step(double t)

Override this abstract to specify the effect of this animation.

Parameters:

t - The parameter of this animation.

getAnimated

public CElement getAnimated()

Returns:

the CElement animated by this animation.

addTag

public Animation addTag(AExtensionalTag t)

Adds a tag to this animation.

Parameters:

t - The tag to be added

Returns:

this animation.

addTag

public Animation addTag(java.lang.String t)

Adds a ANamedTag tag to this animation.

Parameters:

t - The name of the tag to be added

Returns:

this animation.

removeTag

public Animation removeTag(AExtensionalTag t)

Removes a tag from this animation.

Parameters:

t - The tag to remove

Returns:

this animation.

removeTag

public Animation removeTag(java.lang.String t)

Removes a tag from this animation.

Parameters:

t - The name of the ANamedTag tag to remove

Returns:

this animation.

hasTag

public boolean hasTag(ATag t)

Tests whether this animation has a given tag.

Parameters:

t - The tag to be tested

Returns:

true if t tags this animation.

hasTag

public boolean hasTag(java.lang.String t)

Tests whether this animation has a given ANamedTag tag.

Parameters:

t - The name of the tag to be tested

Returns:

true if t tags this animation.

getPacingFunction

public short getPacingFunction()

Returns:

The pacing function for this Animation: Animation.FUNCTION_LINEAR or Animation.FUNCTION_SIGMOID.

getDelay

public int getDelay()

Returns:

The delay in milliseconds between two successive animation steps.

getNbLaps

public int getNbLaps()

Returns:

The number of laps in this animation.

isSuspended

public boolean isSuspended()

Returns:

True if this animation is suspended.

setCanvas

public void setCanvas(Canvas canvas)

Parameters:

canvas - Sets the canvas on which will be fired animation events.

isStarted

public boolean isStarted()

Returns:

True if this animation is started.