fr.inria.zvtm.animation

Class DefaultTimingHandler

java.lang.Object

fr.inria.zvtm.animation.DefaultTimingHandler

All Implemented Interfaces:

TimingHandler

public abstract class DefaultTimingHandler
extends Object
implements TimingHandler

A class that overrides most TimingHandler methods with dummy (empty) ones. The only method that is not overriden (ie left abstract) is timingEvent(float, java.lang.Object, fr.inria.zvtm.animation.Animation.Dimension). This is because a handler that does not respond to timing events is likely useless. Users should override any TimingHandler methods that they need (and are compelled to provide an implementation for timingEvent).
Note: it is heartily advised to annotate all method overrides in subclasses with @Override, which could help avoid much frustration.

Author:

Romain Primet

See Also:

TimingHandler, Animation

Constructor Summary

Constructors

Constructor and Description
DefaultTimingHandler()

Method Summary

Modifier and Type	Method and Description
void	begin(Object subject, Animation.Dimension dim) Called when the animation begins.
void	end(Object subject, Animation.Dimension dim) Called when the animation ends.
void	repeat(Object subject, Animation.Dimension dim) Called when the animation repeats a cycle.
abstract void	timingEvent(float fraction, Object subject, Animation.Dimension dim) This method will receive all of the timing events from an Animation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTimingHandler

public DefaultTimingHandler()

Method Detail

begin

public void begin(Object subject,
                  Animation.Dimension dim)

Description copied from interface: TimingHandler

Called when the animation begins. This provides a chance to perform any setup required at animation start time.

Specified by:

begin in interface TimingHandler

Parameters:

subject - the object being animated.

dim - tells which visual variable of this object is being animated.

end

public void end(Object subject,
                Animation.Dimension dim)

Description copied from interface: TimingHandler

Called when the animation ends.

Specified by:

end in interface TimingHandler

Parameters:

subject - the object being animated.

dim - tells which visual variable of this object is being animated.

repeat

public void repeat(Object subject,
                   Animation.Dimension dim)

Description copied from interface: TimingHandler

Called when the animation repeats a cycle.

Specified by:

repeat in interface TimingHandler

Parameters:

subject - the object being animated.

dim - tells which visual variable of this object is being animated.

timingEvent

public abstract void timingEvent(float fraction,
                                 Object subject,
                                 Animation.Dimension dim)

Description copied from interface: TimingHandler

This method will receive all of the timing events from an Animation. The fraction is the percent elapsed (0 to 1) of the current animation cycle.

Specified by:

timingEvent in interface TimingHandler

Parameters:

fraction - the fraction of completion between the start and end of the current cycle. Note that on reversing cycles (Animator.Direction.BACKWARD) the fraction decreases from 1.0 to 0 on backwards-running cycles. Note also that animations with a duration of INFINITE will call timingEvent with an undefined value for fraction, since there is no fraction that makes sense if the animation has no defined length.

subject - the subject that will be animated.

dim - Dimension of the animation