package edu.princeton.cs.algs4.growingtree.framework; /* * @(#)TraverseBSTAnimation.java * * Last Modified: 9/15/01 */ import java.util.*; import java.awt.*; import java.awt.geom.*; /** * * The Animation object that defines the Searching in a BSTTree.
* * The object restores all values changed in the given nodes, however, if the object * is never allowed to finish, the restoring of values becomes impossible. On any exception occuring * elsewhere, the object may not restore the conditions correctly. * * @author Corey Sanders * @version 1.3 9/15/01 */ public class TraverseBSTAnimation
extends AbstractAnimation {
/**
* Constant that defines the starting location.
*/
private final int START = 0;
/**
* Constant the defines the final moving location.
*/
private int FINAL_MOVE;
/**
* Constant the defines the end location.
*/
private int END;
/**
* Color Scheme used for the animator, using one of the NodeSettings Schemes.
*/
private NodeSettings animatorScheme;
/**
* Color Scheme used for the key of the animator, using one of the KeySettings Schemes.
*/
private KeySettings keyAnimatorScheme;
/**
* Private doubles used to hold the current and previous location steps.
*/
private double currentLocation = 0.0;
private double previousLocation = 0.0;
/**
* Private int to hold the last step of the traversal.
*/
private int lastStep;
/**
* Refers to the list of AffineTransforms used to emphasize each given node.
*/
private AffineTransformList enlargeTransforms;
/**
* Refers to the linked list which will store the node of each step, used to draw the
* pass of each node.
*/
private LinkedList currentNode;
/**
* The constructor which initiates the status and prepares the colorSchemes. The node
* which is animating must be passed.
* @param AnimatorScheme the node) {
nodes.add(node);
node.addAnimator(this);
this.addAnimationListener(node);
}
/*********************/
/* Animation methods */
/*********************/
/**
* Draws the animation of the next step, using the status of the animation (Animation.PLAY, Animation.PAUSE and so forth).
* After completing the drawing, the Animation sends an AnimationEvent to all its listeners, indicating
* any information that the listerners may wish to use.
*
* @param g2 the graphics to which the animation step should be drawn.
* @param startingStatus the status used as the starting command of animation, if needed.
*/
public void drawAnimation(Graphics2D g2, String startingStatus) {
setStartingCommand(startingStatus);
// BEGIN status
if (getStatus().equals(Animation.BEGIN)) {
currentLocation = 0;
previousLocation = 0;
if (nodes.isEmpty()) {
setStatus(Animation.FINISH);
}
else {
currentNode = nodes.getFirst();
// Set transforms list
AffineTransform currentTransform = currentNode.getCurrentTransform();
AffineTransform enlargeScreenTransform = AffineTransform.getScaleInstance(g2.getClipBounds().getWidth() / 8.0, g2.getClipBounds().getHeight() / 8.0);
// Make initial enlarge transforms list.
enlargeTransforms.add(currentTransform);
enlargeTransforms.add(enlargeScreenTransform);
enlargeTransforms.add(currentTransform);
animationAction();
// Original message
messageAction(Animation.BEGIN + " traversal.");
// set starting status
setStatus(getStartingCommand());
// Draw all nodes
int size= nodes.size();
for(int i=0; i )nodes.get((int)(Math.ceil(currentLocation) / 2.0) - 1) );
lastStep -= 2;
//animator scheme exists
while (currentNode.isSettingsSaved()) {
currentNode.restoreSettings();
}
while (((DrawableKey)currentNode.getValue()).isSettingsSaved()) {
((DrawableKey)currentNode.getValue()).restoreSettings();
}
}
// Set transforms list
AffineTransform currentTransform = currentNode.getCurrentTransform();
AffineTransform enlargeScreenTransform = AffineTransform.getScaleInstance(g2.getClipBounds().getWidth() / 8.0, g2.getClipBounds().getHeight() / 8.0);
// Set enlarge transforms list.
enlargeTransforms.set(0,currentTransform);
enlargeTransforms.set(1,enlargeScreenTransform);
enlargeTransforms.set(2,currentTransform);
int size= nodes.size();
// Draw all non animating nodes
for(int i=0; i )nodes.get(i)).drawNodeAndLink(g2, enlargeTransforms.getTransformStep(currentLocation - FINAL_MOVE) );
}
}
}
// PAUSE status
if (getStatus().equals(Animation.PAUSE)) {
messageAction(Animation.PAUSE);
if (currentLocation < FINAL_MOVE) {
int size= nodes.size();
// Draw all non animating nodes
for(int i=0; i )nodes.get(i)).drawNodeAndLink(g2, enlargeTransforms.getTransformStep(currentLocation - FINAL_MOVE) );
}
}
}
// STOP status
if (getStatus().equals(Animation.STOP)) {
messageAction(Animation.STOP);
if (currentLocation < FINAL_MOVE) {
int size= nodes.size();
// Draw all non animating nodes
for(int i=0; i )nodes.get(i)).drawNodeAndLink(g2, enlargeTransforms.getTransformStep(currentLocation - FINAL_MOVE) );
}
}
}
// FINISH status
if (getStatus().equals(Animation.FINISH)) {
restore();
messageAction(Animation.FINISH);
messageAction("*--------Traversal of Tree--------*");
animationAction();
return;
}
// Call listeners
animationAction();
}
/**
* Restores the settings of all nodes encountered during the animation. Usually called at
* the end of the animation (Animation.FINISH) to restore all settings changed throughout
* the animation. This also restores the animator node.
*/
private void restore() {
//int size = nodes.size();
for(int i=0; i < nodes.size(); i++) {
GrowingTreeNode currentNode = ((GrowingTreeNode )nodes.get(i));
while (currentNode.isSettingsSaved()) {
currentNode.restoreSettings();
}
while (((DrawableKey)currentNode.getValue()).isSettingsSaved()) {
((DrawableKey)currentNode.getValue()).restoreSettings();
}
}
}
/**
* Calls all of the listeners of the current Animation and passed information regarding the
* progress and status of the current Animation. Additionally, the id of the type of animation is
* passed. Within, the NodeSettings
associated with a color scheme for a passed node.
* @param KeyAnimatorScheme the KeySettings
associated with a color scheme according to KeySettings.
* @param startingCmd the Animation command that this should start.
* @param stepTime the time for each step of the Animation. Sets the initial value.
*/
public TraverseBSTAnimation(NodeSettings AnimatorScheme, KeySettings KeyAnimatorScheme, String startingCmd, int stepTime) {
super();
if (AnimatorScheme == null) {
AnimatorScheme = new NodeSettings();
}
if (KeyAnimatorScheme == null) {
KeyAnimatorScheme = new KeySettings();
}
// init enlargeTransforms
enlargeTransforms = new AffineTransformList();
// init nodes
nodes = new LinkedListanimationEventPerformed
method is called.
*
* @param cmd String Animation command passed instead of the current Status.
* @param description String description for messages.
*/
protected void animationAction(String cmd, String description) {
super.animationAction(AnimationEvent.TRAVERSE_BST_ANIMATION, cmd, description, currentLocation / (double)nodes.size());
}
}