fr.inria.zvtm.animation

Class AnimationManager

java.lang.Object

fr.inria.zvtm.animation.AnimationManager

public class AnimationManager
extends Object

A class that manages Animation instances.

Author:

Romain Primet

Constructor Summary

Constructors

Constructor and Description
AnimationManager(VirtualSpaceManager vsm) Creates a new AnimationManager.

Method Summary

Modifier and Type	Method and Description
void	cancelAnimation(Animation anim) Cancels an animation.
AnimationFactory	getAnimationFactory() Get the AnimationFactory associated with this AnimationManager.
boolean	pauseAnimation(Animation anim) Pauses an animation.
boolean	resumeAnimation(Animation anim) Resumes an animation.
void	setResolution(int resolution) Sets the timing events period, in milliseconds.
void	start() Starts this AnimationManager.
void	startAnimation(Animation anim, boolean force) Starts an animation.
void	stop() Stops this AnimationManager After calling this method, all animations handled by this AnimationManager will stop.
void	stopAnimation(Animation anim) Stops an animation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimationManager

public AnimationManager(VirtualSpaceManager vsm)

Creates a new AnimationManager. Clients are expected to retrieve an existing AnimationManager by calling the appropriate operation on their application's VirtualSpaceManager, and not to create an AnimationManager themselves.

Parameters:

vsm - the VirtualSpaceManager in charge of this UI (a singleton: VirtualSpaceManager.INSTANCE).

Method Detail

start

public void start()

Starts this AnimationManager. This method must be called for animations to start. This method may be called multiple times from multiple threads; only the first one will be taken in consideration, and subsequent calls will have no effect.

stop

public void stop()

Stops this AnimationManager After calling this method, all animations handled by this AnimationManager will stop. This method must be called once and only once, otherwise AnimationManager will complain loudly (i.e. throw an IllegalThreadStateException). This AnimationManager should not be used after stop() has been called.

Throws:

IllegalStateException - if called more than once

getAnimationFactory

public AnimationFactory getAnimationFactory()

Get the AnimationFactory associated with this AnimationManager.

Returns:

the AnimationFactory object.

startAnimation

public void startAnimation(Animation anim,
                           boolean force)

Starts an animation.

Parameters:

anim - animation to start (must have been created by calling createAnimation on the same AnimationManager).

force - if true, any previously started and conflicting animations will be cancelled. Queued conflicting animations that did not yet start are cancelled. Two animations conflict if they target the same subject and animate the same dimension. Note that the end() action of a cancelled animation will not be executed.

stopAnimation

public void stopAnimation(Animation anim)

Stops an animation. The end() action of an animation will be executed if the animation has been started beforehand.

Parameters:

anim - animation to stop (must have been created by calling createAnimation on the same AnimationManager).

cancelAnimation

public void cancelAnimation(Animation anim)

Cancels an animation.

Parameters:

anim - animation to cancel (must have been created by calling createAnimation on the same AnimationManager). Note that the end() action of a cancelled animation will not be executed.

pauseAnimation

public boolean pauseAnimation(Animation anim)

Pauses an animation. An animation that is paused still prevents conflicting animations to run.

Parameters:

anim - animation to pause

Returns:

true if the animation was actually paused (ie was running prior to the user call), false otherwise.

resumeAnimation

public boolean resumeAnimation(Animation anim)

Resumes an animation.

Parameters:

anim - animation to resume

Returns:

true if the animation was actually resumed, false otherwise.

setResolution

public void setResolution(int resolution)

Sets the timing events period, in milliseconds. This is not a guaranteed resolution but rather a minimal value.

Parameters:

resolution - minimal tick interval, in milliseconds. All animations handled by this AnimationManager share the same resolution.