refactoring CoolMaze and StdDraw for TurtleMaze

Author: lynnlangit

src/main/java/org/teachingextensions/logo/utils/MazeUtils/CoolMaze.java

@@ -6,28 +6,20 @@ public class CoolMaze
 {
   public static void main(String[] args)
   {
-    int mazeComplexity = 10;
-    CoolMaze maze = new CoolMaze(mazeComplexity);
+    int mazeComplexityScale = 10;
+    CoolMaze maze = new CoolMaze(mazeComplexityScale);
     StdDraw.show(0);
     maze.drawWallsAndStartAndEndPoints();
     maze.solveThisMaze();
   }
-  public CoolMaze(int N)
+  public CoolMaze(int mazeComplexity)
   {
-    setMazeScale(N);
+    this.mazeComplexity = mazeComplexity;
+    StdDraw.setXscale(0, mazeComplexity + 2);
+    StdDraw.setYscale(0, mazeComplexity + 2);
     createMazeStructure();
     generateStartLocation(1, 1);
   }
-  public void solveThisMaze()
-  {
-    int startingX = 1;
-    int startingY = 1;
-    for (int x = startingX; x <= N; x++)
-      for (int y = startingY; y <= N; y++)
-        visited[x][y] = false;
-    done = false;
-    solve(startingX, startingY);
-  }
   public void drawWallsAndStartAndEndPoints()
   {
     Color colorOfStartAndEndPoints = StdDraw.RED;
@@ -37,32 +29,26 @@ public void drawWallsAndStartAndEndPoints()
     drawAndColorMazeWalls();
     StdDraw.show(1000);
   }
-  private void setMazeScale(int N)
-  {
-    this.N = N;
-    StdDraw.setXscale(0, N + 2);
-    StdDraw.setYscale(0, N + 2);
-  }
   private void createMazeStructure()
   {
-    visited = new boolean[N + 2][N + 2];
-    for (int x = 0; x < N + 2; x++)
+    visited = new boolean[mazeComplexity + 2][mazeComplexity + 2];
+    for (int x = 0; x < mazeComplexity + 2; x++)
     {
       visited[x][0] = true;
-      visited[x][N + 1] = true;
+      visited[x][mazeComplexity + 1] = true;
     }
-    for (int y = 0; y < N + 2; y++)
+    for (int y = 0; y < mazeComplexity + 2; y++)
     {
       visited[0][y] = true;
-      visited[N + 1][y] = true;
+      visited[mazeComplexity + 1][y] = true;
     }
-    north = new boolean[N + 2][N + 2];
-    east = new boolean[N + 2][N + 2];
-    south = new boolean[N + 2][N + 2];
-    west = new boolean[N + 2][N + 2];
-    for (int x = 0; x < N + 2; x++)
+    north = new boolean[mazeComplexity + 2][mazeComplexity + 2];
+    east = new boolean[mazeComplexity + 2][mazeComplexity + 2];
+    south = new boolean[mazeComplexity + 2][mazeComplexity + 2];
+    west = new boolean[mazeComplexity + 2][mazeComplexity + 2];
+    for (int x = 0; x < mazeComplexity + 2; x++)
     {
-      for (int y = 0; y < N + 2; y++)
+      for (int y = 0; y < mazeComplexity + 2; y++)
       {
         north[x][y] = true;
         east[x][y] = true;
@@ -110,28 +96,6 @@ else if (r == 3 && !visited[x - 1][y])
       }
     }
   }
-  private void solve(int x, int y)
-  {
-    if (x == 0 || y == 0 || x == N + 1 || y == N + 1)
-      return;
-    if (done || visited[x][y])
-      return;
-    visited[x][y] = true;
-    renderCorrectSolveDots(x, y);
-    if (x == N / 2 && y == N / 2)
-      done = true;
-    if (!north[x][y])
-      solve(x, y + 1);
-    if (!east[x][y])
-      solve(x + 1, y);
-    if (!south[x][y])
-      solve(x, y - 1);
-    if (!west[x][y])
-      solve(x - 1, y);
-    if (done)
-      return;
-    renderIncorrectSolveDots(x, y);
-  }
   private void renderCorrectSolveDots(int x, int y)
   {
     Color colorOfCorrectSolvePath = StdDraw.BLUE;
@@ -152,23 +116,23 @@ private void drawAndSizeSolvePath(int x, int y)
   }
   private void createAndSizeEndPoint()
   {
-    StdDraw.filledCircle(N / 2.0 + 0.5, N / 2.0 + 0.5, 0.375);
+    StdDraw.filledCircle(mazeComplexity / 2.0 + 0.5, mazeComplexity / 2.0 + 0.5, 0.375);
   }
   private void createAndSizeStartPoint()
   {
     StdDraw.filledCircle(1.5, 1.5, 0.375);
   }
   private void drawAndColorMazeWalls()
   {
-    Color colorOfMazeWalls = StdDraw.BLACK;
+    Color colorOfMazeWalls = StdDraw.DARK_GRAY;
     StdDraw.setPenColor(colorOfMazeWalls);
     drawMazeWalls();
   }
   private void drawMazeWalls()
   {
-    for (int x = 1; x <= N; x++)
+    for (int x = 1; x <= mazeComplexity; x++)
     {
-      for (int y = 1; y <= N; y++)
+      for (int y = 1; y <= mazeComplexity; y++)
       {
         if (south[x][y])
           StdDraw.line(x, y, x + 1, y);
@@ -181,7 +145,39 @@ private void drawMazeWalls()
       }
     }
   }
-  private int         N;
+  public void solveThisMaze()
+  {
+    int startingX = 1;
+    int startingY = 1;
+    for (int x = startingX; x <= mazeComplexity; x++)
+      for (int y = startingY; y <= mazeComplexity; y++)
+        visited[x][y] = false;
+    done = false;
+    solve(startingX, startingY);
+  }
+  private void solve(int x, int y)
+  {
+    if (x == 0 || y == 0 || x == mazeComplexity + 1 || y == mazeComplexity + 1)
+      return;
+    if (done || visited[x][y])
+      return;
+    visited[x][y] = true;
+    renderCorrectSolveDots(x, y);
+    if (x == mazeComplexity / 2 && y == mazeComplexity / 2)
+      done = true;
+    if (!north[x][y])
+      solve(x, y + 1);
+    if (!east[x][y])
+      solve(x + 1, y);
+    if (!south[x][y])
+      solve(x, y - 1);
+    if (!west[x][y])
+      solve(x - 1, y);
+    if (done)
+      return;
+    renderIncorrectSolveDots(x, y);
+  }
+  private int         mazeComplexity;
   private boolean[][] north;
   private boolean[][] east;
   private boolean[][] south;

src/main/java/org/teachingextensions/logo/utils/MazeUtils/StdDraw.java

@@ -1,28 +1,5 @@
 package org.teachingextensions.logo.utils.MazeUtils;
 
-/******************************************************************************
- *  Compilation:  javac StdDraw.java
- *  Execution:    java StdDraw
- *  Dependencies: none
- *
- *  Standard drawing library. This class provides a basic capability for
- *  creating drawings with your programs. It uses a simple graphics model that
- *  allows you to create drawings consisting of points, lines, and curves
- *  in a window on your computer and to save the drawings to a file.
- *
- *  Todo
- *  ----
- *    -  Add support for gradient fill, etc.
- *    -  Fix setCanvasSize() so that it can only be called once.
- *    -  On some systems, drawing a line (or other shape) that extends way
- *       beyond canvas (e.g., to infinity) dimensions does not get drawn.
- *
- *  Remarks
- *  -------
- *    -  don't use AffineTransform for rescaling since it inverts
- *       images and strings
- *
- ******************************************************************************/
 import java.awt.BasicStroke;
 import java.awt.Color;
 import java.awt.FileDialog;
@@ -65,22 +42,10 @@
 import javax.swing.KeyStroke;
 
 /**
- *  The {@code StdDraw} class provides a basic capability for
- *  creating drawings with your programs. It uses a simple graphics model that
- *  allows you to create drawings consisting of points, lines, squares,
- *  circles, and other geometric shapes in a window on your computer and
- *  to save the drawings to a file. Standard drawing also includes
- *  facilities for text, color, pictures, and animation, along with
- *  user interaction via the keyboard and mouse.
  *  <p>
  *  <b>Getting started.</b>
- *  To use standard drawing, you must have <tt>StdDraw.class</tt> in your
- *  Java classpath. If you used our autoinstaller, you should be all set.
- *  Otherwise, download
- *  <a href = "http://introcs.cs.princeton.edu/java/stdlib/StdDraw.java">StdDraw.java</a>
- *  and put a copy in your working directory.
  *  <p>
- *  Now, type the following short program into your editor:
+ *  Type the following short program into your editor:
  *  <pre>
  *   public class TestStdDraw {
  *       public static void main(String[] args) {
@@ -92,14 +57,6 @@
  *       }
  *   }
  *  </pre>
- *  If you compile and execute the program, you should see a window
- *  appear with a thick magenta line and a blue point.
- *  This program illustrates the two main types of methods in standard
- *  drawing&mdash;methods that draw geometric shapes and methods that
- *  control drawing parameters.
- *  The methods {@code StdDraw.line()} and {@code StdDraw.point()}
- *  draw lines and points; the methods {@code StdDraw.setPenRadius()}
- *  and {@code StdDraw.setPenColor()} control the line thickness and color.
  *  <p>
  *  <b>Points and lines.</b>
  *  You can draw points and line segments with the following methods:
@@ -442,57 +399,18 @@
  */
 public final class StdDraw implements ActionListener, MouseListener, MouseMotionListener, KeyListener
 {
-  /**
-   *  The color black.
-   */
   public static final Color            BLACK               = Color.BLACK;
-  /**
-   *  The color blue.
-   */
   public static final Color            BLUE                = Color.BLUE;
-  /**
-   *  The color cyan.
-   */
   public static final Color            CYAN                = Color.CYAN;
-  /**
-   *  The color dark gray.
-   */
   public static final Color            DARK_GRAY           = Color.DARK_GRAY;
-  /**
-   *  The color gray.
-   */
   public static final Color            GRAY                = Color.GRAY;
-  /**
-   *  The color green.
-   */
   public static final Color            GREEN               = Color.GREEN;
-  /**
-   *  The color light gray.
-   */
   public static final Color            LIGHT_GRAY          = Color.LIGHT_GRAY;
-  /**
-   *  The color magenta.
-   */
   public static final Color            MAGENTA             = Color.MAGENTA;
-  /**
-   *  The color orange.
-   */
   public static final Color            ORANGE              = Color.ORANGE;
-  /**
-   *  The color pink.
-   */
   public static final Color            PINK                = Color.PINK;
-  /**
-   *  The color red.
-   */
   public static final Color            RED                 = Color.RED;
-  /**
-   *  The color white.
-   */
   public static final Color            WHITE               = Color.WHITE;
-  /**
-   *  The color yellow.
-   */
   public static final Color            YELLOW              = Color.YELLOW;
   /**
    * Shade of blue used in <em>Introduction to Programming in Java</em>.
@@ -557,15 +475,31 @@ public final class StdDraw implements ActionListener, MouseListener, MouseMotion
   // time in milliseconds (from currentTimeMillis()) when we can draw again
   // used to control the frame rate
   private static long                  nextDraw            = -1;
-  // singleton pattern: client can't instantiate
   private StdDraw()
   {
   }
-  // static initializer
   static
   {
     init();
   }
+  public static void main(String[] args)
+  {
+    StdDraw.square(.2, .8, .1);
+    StdDraw.filledSquare(.8, .8, .2);
+    StdDraw.circle(.8, .2, .2);
+    StdDraw.setPenColor(StdDraw.BOOK_RED);
+    StdDraw.setPenRadius(.02);
+    StdDraw.arc(.8, .2, .1, 200, 45);
+    StdDraw.setPenRadius();
+    StdDraw.setPenColor(StdDraw.BOOK_BLUE);
+    double[] x = {.1, .2, .3, .2};
+    double[] y = {.2, .3, .2, .1};
+    StdDraw.filledPolygon(x, y);
+    StdDraw.setPenColor(StdDraw.BLACK);
+    StdDraw.text(0.2, 0.5, "black text");
+    StdDraw.setPenColor(StdDraw.WHITE);
+    StdDraw.text(0.8, 0.8, "white text");
+  }
   /**
    * Sets the canvas (drawing area) to be 512-by-512 pixels.
    * This also erases the current drawing and resets the coordinate system,
@@ -1539,7 +1473,6 @@ public static void save(String filename)
       throw new NullPointerException();
     File file = new File(filename);
     String suffix = filename.substring(filename.lastIndexOf('.') + 1);
-    // png files
     if (suffix.toLowerCase().equals("png"))
     {
       try
@@ -1787,27 +1720,4 @@ public void keyReleased(KeyEvent e)
       keysDown.remove(e.getKeyCode());
     }
   }
-  /**
-   * Test client.
-   */
-  public static void main(String[] args)
-  {
-    StdDraw.square(.2, .8, .1);
-    StdDraw.filledSquare(.8, .8, .2);
-    StdDraw.circle(.8, .2, .2);
-    StdDraw.setPenColor(StdDraw.BOOK_RED);
-    StdDraw.setPenRadius(.02);
-    StdDraw.arc(.8, .2, .1, 200, 45);
-    // draw a blue diamond
-    StdDraw.setPenRadius();
-    StdDraw.setPenColor(StdDraw.BOOK_BLUE);
-    double[] x = {.1, .2, .3, .2};
-    double[] y = {.2, .3, .2, .1};
-    StdDraw.filledPolygon(x, y);
-    // text
-    StdDraw.setPenColor(StdDraw.BLACK);
-    StdDraw.text(0.2, 0.5, "black text");
-    StdDraw.setPenColor(StdDraw.WHITE);
-    StdDraw.text(0.8, 0.8, "white text");
-  }
 }