remixlab.fpstiming

Class AnimatorObject

java.lang.Object

remixlab.fpstiming.AnimatorObject

All Implemented Interfaces:

Animator

Direct Known Subclasses:

AbstractScene

public class AnimatorObject
extends Object
implements Animator

Class implementing the main Animator behavior.

Constructor Summary

Constructors

Constructor and Description
AnimatorObject() Constructs an animated object with a default animationPeriod() of 40 milliseconds (25Hz).
AnimatorObject(TimingHandler handler) Constructs an animated object with a default animationPeriod() of 40 milliseconds (25Hz).

Method Summary

Modifier and Type	Method and Description
void	animate() Main call back animated method.
long	animationPeriod() The animation loop period, in milliseconds.
boolean	animationStarted() Return true when the animation loop is started.
boolean	invokeAnimationHandler() Returns whether or not the animated method is defined externally, as when register it through reflection.
void	restartAnimation() Restart the animation.
void	setAnimationPeriod(long period) Convenience function that simply calls period(period, true).
void	setAnimationPeriod(long period, boolean restart) Sets the animationPeriod(), in milliseconds.
void	setTimingHandler(TimingHandler h) Sets the timing handler.
void	startAnimation() Starts the animation loop.
void	stopAnimation() Stops animation.
SeqTimer	timer() Returns the sequential timer.
TimingHandler	timingHandler() Returns the timing handler.
void	toggleAnimation() Calls startAnimation() or stopAnimation(), depending on animationStarted().

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimatorObject

public AnimatorObject()

Constructs an animated object with a default animationPeriod() of 40 milliseconds (25Hz). The handler should explicitly be defined afterwards ( setTimingHandler(TimingHandler)).

AnimatorObject

public AnimatorObject(TimingHandler handler)

Constructs an animated object with a default animationPeriod() of 40 milliseconds (25Hz).

Method Detail

setTimingHandler

public void setTimingHandler(TimingHandler h)

Description copied from interface: Animator

Sets the timing handler.

Specified by:

setTimingHandler in interface Animator

timingHandler

public TimingHandler timingHandler()

Description copied from interface: Animator

Returns the timing handler.

Specified by:

timingHandler in interface Animator

timer

public SeqTimer timer()

Description copied from interface: Animator

Returns the sequential timer.

Specified by:

timer in interface Animator

animationStarted

public boolean animationStarted()

Return true when the animation loop is started.

The timing handler will check when animationStarted() and then called the animation callback method every animationPeriod() milliseconds.

Use startAnimation(), stopAnimation() or toggleAnimation() to change this value.

Specified by:

animationStarted in interface Animator

See Also:

startAnimation(), animate()

animationPeriod

public long animationPeriod()

The animation loop period, in milliseconds. When animationStarted(), this is the delay that takes place between two consecutive iterations of the animation loop.

This delay defines a target frame rate that will only be achieved if your animate() methods is fast enough.

Default value is 40 milliseconds (25 Hz).

Note: This value is taken into account only the next time you call startAnimation(). If animationStarted(), you should stopAnimation() first. See restartAnimation() and setAnimationPeriod(long, boolean).

Specified by:

animationPeriod in interface Animator

See Also:

setAnimationPeriod(long, boolean)

setAnimationPeriod

public void setAnimationPeriod(long period)

Convenience function that simply calls period(period, true).

Specified by:

setAnimationPeriod in interface Animator

See Also:

setAnimationPeriod(long, boolean)

setAnimationPeriod

public void setAnimationPeriod(long period,
                               boolean restart)

Sets the animationPeriod(), in milliseconds. If restart is true and animationStarted() then restartAnimation() is called.

Specified by:

setAnimationPeriod in interface Animator

See Also:

startAnimation()

stopAnimation

public void stopAnimation()

Stops animation.

Specified by:

stopAnimation in interface Animator

See Also:

animationStarted()

startAnimation

public void startAnimation()

Starts the animation loop.

Specified by:

startAnimation in interface Animator

See Also:

animationStarted()

restartAnimation

public void restartAnimation()

Restart the animation.

Simply calls stopAnimation() and then startAnimation().

Specified by:

restartAnimation in interface Animator

toggleAnimation

public void toggleAnimation()

Calls startAnimation() or stopAnimation(), depending on animationStarted().

Specified by:

toggleAnimation in interface Animator

animate

public void animate()

Description copied from interface: Animator

Main call back animated method.

Specified by:

animate in interface Animator

invokeAnimationHandler

public boolean invokeAnimationHandler()

Description copied from interface: Animator

Returns whether or not the animated method is defined externally, as when register it through reflection.

Specified by:

invokeAnimationHandler in interface Animator