edu.umd.cs.piccolo.activities
Class PTransformActivity

java.lang.Object
  edu.umd.cs.piccolo.activities.PActivity
      edu.umd.cs.piccolo.activities.PInterpolatingActivity
          edu.umd.cs.piccolo.activities.PTransformActivity

public class PTransformActivity
extends PInterpolatingActivity

PTransformActivity interpolates between two transforms setting its target's transform as it goes. See PNode. animate*() for an example of this activity in used. The source transform is retrieved from the target just before the animation is scheduled to start.

Version:

1.0

Author:

Jesse Grosjean

Nested Class Summary

static interface

PTransformActivity.Target Target Objects that want to get transformed by the transform activity must implement this interface.

Nested classes/interfaces inherited from class edu.umd.cs.piccolo.activities.PActivity

PActivity.PActivityDelegate

Field Summary

Fields inherited from class edu.umd.cs.piccolo.activities.PInterpolatingActivity

DESTINATION_TO_SOURCE, SOURCE_TO_DESTINATION, SOURCE_TO_DESTINATION_TO_SOURCE

Fields inherited from class edu.umd.cs.piccolo.activities.PActivity

TERMINATE_AND_FINISH, TERMINATE_AND_FINISH_IF_STEPPING, TERMINATE_WITHOUT_FINISHING

Constructor Summary

PTransformActivity(long duration, long stepRate, int loopCount, int mode, PTransformActivity.Target aTarget, java.awt.geom.AffineTransform aDestination)
Create a new PTransformActivity.

PTransformActivity(long duration, long stepRate, PTransformActivity.Target aTarget)

PTransformActivity(long duration, long stepRate, PTransformActivity.Target aTarget, java.awt.geom.AffineTransform aDestination)

Method Summary

protected void	activityStarted() This method is called right before an activity is scheduled to start running.
double[]	getDestinationTransform() Return the final transform that will be set on the transform activities target when the transform activity stops stepping.
protected boolean	isAnimation() Return true if this activity is performing an animation.
protected java.lang.String	paramString() Returns a string representing the state of this activity.
void	setDestinationTransform(double[] newDestination) Set the final transform that will be set on the transform activities target when the transform activity stops stepping.
void	setRelativeTargetValue(float zeroToOne) Subclasses should override this method and set the value on their target (the object that they are modifying) accordingly.

Methods inherited from class edu.umd.cs.piccolo.activities.PInterpolatingActivity

activityFinished, activityStep, computeSlowInSlowOut, getFirstLoop, getLoopCount, getMode, getSlowInSlowOut, setDuration, setFirstLoop, setLoopCount, setMode, setRelativeTargetValueAdjustingForMode, setSlowInSlowOut, terminate

Methods inherited from class edu.umd.cs.piccolo.activities.PActivity

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PTransformActivity

public PTransformActivity(long duration,
                          long stepRate,
                          PTransformActivity.Target aTarget)

PTransformActivity

public PTransformActivity(long duration,
                          long stepRate,
                          PTransformActivity.Target aTarget,
                          java.awt.geom.AffineTransform aDestination)

PTransformActivity

public PTransformActivity(long duration,
                          long stepRate,
                          int loopCount,
                          int mode,
                          PTransformActivity.Target aTarget,
                          java.awt.geom.AffineTransform aDestination)

Create a new PTransformActivity.

Parameters:

duration - the length of one loop of the activity

stepRate - the amount of time between steps of the activity

loopCount - number of times the activity should reschedule itself

mode - defines how the activity interpolates between states

aTarget - the object that the activity will be applied to and where the source state will be taken from.

aDestination - the destination color state

Method Detail

isAnimation

protected boolean isAnimation()

Description copied from class: PActivity

Return true if this activity is performing an animation. This is used by the PCanvas to determine if it should set the render quality to PCanvas.animatingRenderQuality or not for each frame it renders.

Overrides:

isAnimation in class PActivity

getDestinationTransform

public double[] getDestinationTransform()

Return the final transform that will be set on the transform activities target when the transform activity stops stepping.

setDestinationTransform

public void setDestinationTransform(double[] newDestination)

Set the final transform that will be set on the transform activities target when the transform activity stops stepping.

activityStarted

protected void activityStarted()

Description copied from class: PActivity

This method is called right before an activity is scheduled to start running. After this method is called step() will be called until the activity finishes.

Overrides:

activityStarted in class PInterpolatingActivity

setRelativeTargetValue

public void setRelativeTargetValue(float zeroToOne)

Description copied from class: PInterpolatingActivity

Subclasses should override this method and set the value on their target (the object that they are modifying) accordingly.

Overrides:

setRelativeTargetValue in class PInterpolatingActivity

paramString

protected java.lang.String paramString()

Returns a string representing the state of this activity. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class PInterpolatingActivity

Returns:

a string representation of this activity's state