com.xalys.xgl.presto.animation

Class Animation

java.lang.Object

com.xalys.xgl.presto.animation.Animation

@JsType(namespace="xgl")
public abstract class Animation
extends Object

An Animation updates components over a period, progressively over time, using Presto to handle efficiently the updates.

Author:

Paul Sitarz

Constructor Summary

Constructors

Constructor and Description
Animation() Construct an animation with the default EasingFunction: Functions.EASE
Animation(EasingFunction easingFunction) Construct an animation with the specified easing function, or if null will default to Functions.EASE

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the animation: Presto schedules the measures defined in onCancelMeasure(), then performs the mutations defined in onCancelMutation()
AnimationPhase	getAnimationPhase() Gets the current animation phase.
EasingFunction	getEasingFunction() Gets the easing function used in the animation.
double	getStartTime() Gets the high-resolution start time stamp of the animation start time
boolean	isRunning() Returns true if the animation was started with run(int) and is not finished
protected void	onCancelMeasure() Override this method to specify measures Presto should perform when the animation is canceled.
protected void	onCancelMutation() Override this method to specify mutations Presto should perform when the animation is canceled.
protected void	onCompleteMeasure() Override this method to specify measures Presto should perform when the animation finishes.
protected void	onCompleteMutation() Override this method to specify mutations Presto should perform when the animation finishes.
protected void	onStartMeasure() Override this method to specify measures Presto should perform when the animation starts.
protected void	onStartMutation() Override this method to specify mutations Presto should perform when the animation starts.
protected void	onUpdateMeasure() Override this method to specify measures Presto should perform when the animation updates.
protected void	onUpdateMutation(double progress) Override this method to specify mutations Presto should perform when the animation updates.
void	run(int duration) Starts the animation in the next Presto's cycle.

Methods inherited from class java.lang.Object

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

Constructor Detail

Animation

@JsIgnore
public Animation()

Construct an animation with the default EasingFunction: Functions.EASE

Note: When building a with JavaScript support, do not use this constructor.

Animation

public Animation(@JsOptional
                 EasingFunction easingFunction)

Construct an animation with the specified easing function, or if null will default to Functions.EASE

Parameters:

easingFunction - The easing function to use, if null the animation will use Functions.EASE

Method Detail

getAnimationPhase

public AnimationPhase getAnimationPhase()

Gets the current animation phase.

Returns:

the current animationPhase

getStartTime

public double getStartTime()

Gets the high-resolution start time stamp of the animation start time

Returns:

the animation start time

isRunning

public boolean isRunning()

Returns true if the animation was started with run(int) and is not finished

Returns:

true if the animation is running

onCancelMeasure

protected void onCancelMeasure()

Override this method to specify measures Presto should perform when the animation is canceled.

onCancelMutation

protected void onCancelMutation()

Override this method to specify mutations Presto should perform when the animation is canceled.

onCompleteMeasure

protected void onCompleteMeasure()

Override this method to specify measures Presto should perform when the animation finishes.

onCompleteMutation

protected void onCompleteMutation()

Override this method to specify mutations Presto should perform when the animation finishes.

onStartMeasure

protected void onStartMeasure()

Override this method to specify measures Presto should perform when the animation starts.

onStartMutation

protected void onStartMutation()

Override this method to specify mutations Presto should perform when the animation starts.

onUpdateMeasure

protected void onUpdateMeasure()

Override this method to specify measures Presto should perform when the animation updates.

onUpdateMutation

protected void onUpdateMutation(double progress)

Override this method to specify mutations Presto should perform when the animation updates.

The progress value is already the result of the timing function, and is between 0.0 and 1.0.

Parameters:

progress - the progress of the animation (not necessarily between 0.0 and 1.0).

cancel

public void cancel()

Cancels the animation: Presto schedules the measures defined in onCancelMeasure(), then performs the mutations defined in onCancelMutation()

onCompleteMeasure() and onCompleteMutation() will not be called.

getEasingFunction

public EasingFunction getEasingFunction()

Gets the easing function used in the animation.

Returns:

the timing function

run

public void run(int duration)

Starts the animation in the next Presto's cycle. If the animation is already running, it will be canceled first.

Parameters:

duration - of the animation in milliseconds