org.dishevelled.piccolo.ease

Class EasingActivity

java.lang.Object

org.piccolo2d.activities.PActivity

org.piccolo2d.activities.PInterpolatingActivity

org.dishevelled.piccolo.ease.EasingActivity

public class EasingActivity
extends org.piccolo2d.activities.PInterpolatingActivity

Easing activity.

Version:

$Revision$ $Date$

Author:

Michael Heuer

Nested Class Summary

Nested classes/interfaces inherited from class org.piccolo2d.activities.PActivity

org.piccolo2d.activities.PActivity.PActivityDelegate

Field Summary

Fields inherited from class org.piccolo2d.activities.PInterpolatingActivity

DESTINATION_TO_SOURCE, SOURCE_TO_DESTINATION, SOURCE_TO_DESTINATION_TO_SOURCE

Fields inherited from class org.piccolo2d.activities.PActivity

TERMINATE_AND_FINISH, TERMINATE_AND_FINISH_IF_STEPPING, TERMINATE_WITHOUT_FINISHING

Constructor Summary

Constructors

Constructor and Description
EasingActivity(EasingFunction easingFunction, long duration) Create a new easing activity with the specified easing function and duration in milliseconds.
EasingActivity(EasingFunction easingFunction, long duration, long stepRate, long startTime, int loopCount, int mode) Create a new easing activity with the specified easing function and duration in milliseconds.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activityFinished()
protected void	activityStarted()
protected void	activityStep(long elapsed)
void	setRelativeTargetValue(float value)
protected void	setRelativeTargetValueAdjustingForMode(float value)
void	setSlowInSlowOut(boolean slowInSlowOut)

Methods inherited from class org.piccolo2d.activities.PInterpolatingActivity

computeSlowInSlowOut, getFirstLoop, getLoopCount, getMode, getSlowInSlowOut, setDuration, setFirstLoop, setLoopCount, setMode, terminate

Methods inherited from class org.piccolo2d.activities.PActivity

getActivityScheduler, getDelegate, getDuration, getNextStepTime, getStartTime, getStepRate, getStopTime, isAnimation, isStepping, processStep, setActivityScheduler, setDelegate, setStartTime, setStepRate, startAfter, terminate

Methods inherited from class java.lang.Object

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

Constructor Detail

EasingActivity

public EasingActivity(EasingFunction easingFunction,
              long duration)

Create a new easing activity with the specified easing function and duration in milliseconds.

Parameters:

easingFunction - easing function, must not be null

duration - duration in milliseconds, must be at least 1 ms

EasingActivity

public EasingActivity(EasingFunction easingFunction,
              long duration,
              long stepRate,
              long startTime,
              int loopCount,
              int mode)

Create a new easing activity with the specified easing function and duration in milliseconds.

Parameters:

easingFunction - easing function, must not be null

duration - duration in milliseconds, must be at least 1 ms

stepRate - step rate in milliseconds

startTime - start time in milliseconds, relative to System.currentTimeMillis()

loopCount - number of times this easing activity should reschedule itself

mode - defines how this easing activity interpolates between states

Method Detail

setSlowInSlowOut

public final void setSlowInSlowOut(boolean slowInSlowOut)

Overridden to throw an UnsupportedOperationException. Use the easing function specified in this class' constructor instead.

Overrides:

setSlowInSlowOut in class org.piccolo2d.activities.PInterpolatingActivity

setRelativeTargetValue

public void setRelativeTargetValue(float value)

The typical interval for interpolated activities is 0.0f to 1.0f, inclusive. An easing interpolation function allows for overshooting this interval range in both directions, so the valid interval for the specified value is -1.0f to 2.0f, inclusive.

Overrides:

setRelativeTargetValue in class org.piccolo2d.activities.PInterpolatingActivity

activityStarted

protected void activityStarted()

If subclasses override this method, they must call super.activityStarted().

Overrides:

activityStarted in class org.piccolo2d.activities.PInterpolatingActivity

activityStep

protected final void activityStep(long elapsed)

This method has been made final to prevent subclasses from overriding its behaviour.

Overrides:

activityStep in class org.piccolo2d.activities.PInterpolatingActivity

activityFinished

protected void activityFinished()

If subclasses override this method, they must call super.activityFinished().

Overrides:

activityFinished in class org.piccolo2d.activities.PInterpolatingActivity

setRelativeTargetValueAdjustingForMode

protected final void setRelativeTargetValueAdjustingForMode(float value)

Overridden to evaluate the easing function against the specified value.

Overrides:

setRelativeTargetValueAdjustingForMode in class org.piccolo2d.activities.PInterpolatingActivity