Cleaned up; javadoc

1 files changed, 109 insertions, 38 deletions

diff --git a/Week11 Mandelbrot/src/com/camilstaps/mandelbrot/ZoomFrame.java b/Week11 Mandelbrot/src/com/camilstaps/mandelbrot/ZoomFrame.java
index 1dfa2a7..3c15d5b 100644
--- a/Week11 Mandelbrot/src/com/camilstaps/mandelbrot/ZoomFrame.java
+++ b/Week11 Mandelbrot/src/com/camilstaps/mandelbrot/ZoomFrame.java
@@ -12,8 +12,8 @@ import java.awt.event.MouseMotionListener;
 import javax.swing.JFrame;
 
 /**
- *
- * @author camilstaps
+ * A frame in which zooming is possible
+ * @author Camil Staps, s4498062
  */
 public class ZoomFrame extends JFrame implements MouseListener, MouseMotionListener {
     
@@ -40,65 +40,103 @@ public class ZoomFrame extends JFrame implements MouseListener, MouseMotionListe
     }
 
     @Override
-    public void mouseClicked(MouseEvent me) {
-    }
+    public void mouseClicked(MouseEvent me) {}
 
+    /**
+     * Save the coordinates
+     * @param me 
+     */
     @Override
     public void mousePressed(MouseEvent me) {
         old_x = start_x = me.getX();
         old_y = start_y = me.getY();
     }
 
+    /**
+     * On shift-click, zoom out.
+     * On click, zoom in.
+     * On drag, zoom the box.
+     * @param me 
+     */
     @Override
     public void mouseReleased(MouseEvent me) {
         if (me.getX() == start_x && me.getY() == start_y) {
-            if (mandelbrotView == null || mandelbrotTextFields == null)
-                return;
-
-            mandelbrotTextFields.setCenterX(mandelbrotView.getX(me.getX()));
-            mandelbrotTextFields.setCenterY(mandelbrotView.getY(me.getY()));
-            
             if ((me.getModifiers() & InputEvent.SHIFT_MASK) != 0) {
-                mandelbrotTextFields.setScale(mandelbrotTextFields.getScale() / 2);
+                zoomOut(me);
             } else {
-                mandelbrotTextFields.setScale(mandelbrotTextFields.getScale() * 2);
+                zoomIn(me);
             }
         } else {
-            double center_x = (mandelbrotView.getX(me.getX())
-                    - mandelbrotView.getX(start_x)) / 2
-                    + mandelbrotView.getX(start_x);
-            double center_y = (mandelbrotView.getY(me.getY())
-                    - mandelbrotView.getY(start_y)) / 2
-                    + mandelbrotView.getY(start_y);
-            
-            mandelbrotTextFields.setCenterX(center_x);
-            mandelbrotTextFields.setCenterY(center_y);
-            
-            double scale = mandelbrotTextFields.getScale()
-                    / (me.getX() - start_x)
-                    * getWidth();
-            
-            System.err.println(mandelbrotTextFields.getScale());
-            System.err.println(me.getX() - start_x);
-            System.err.println(getWidth());
-            
-            mandelbrotTextFields.setScale(scale);
+            zoomBox(me);
         }
             
         mandelbrotView.redraw();
         
         dragging = false;
     }
+    
+    /**
+     * Zoom in with factor 2
+     * @param me 
+     */
+    private void zoomIn(MouseEvent me) {
+        if (mandelbrotView == null || mandelbrotTextFields == null)
+            return;
 
-    @Override
-    public void mouseEntered(MouseEvent me) {
+        mandelbrotTextFields.setCenterX(mandelbrotView.getX(me.getX()));
+        mandelbrotTextFields.setCenterY(mandelbrotView.getY(me.getY()));
+
+        mandelbrotTextFields.setScale(mandelbrotTextFields.getScale() * 2);
     }
+    
+    /**
+     * Zoom out with factor 2
+     * @param me 
+     */
+    private void zoomOut(MouseEvent me) {
+        if (mandelbrotView == null || mandelbrotTextFields == null)
+            return;
 
-    @Override
-    public void mouseExited(MouseEvent me) {
+        mandelbrotTextFields.setCenterX(mandelbrotView.getX(me.getX()));
+        mandelbrotTextFields.setCenterY(mandelbrotView.getY(me.getY()));
+
+        mandelbrotTextFields.setScale(mandelbrotTextFields.getScale() / 2);
     }
+    
+    /**
+     * Zoom to the selected box.
+     * Intentionally chose to let the user only select squares, otherwise it's too easy to mess up the scale
+     * @param me 
+     */
+    private void zoomBox(MouseEvent me) {
+        double center_x = (mandelbrotView.getX(me.getX())
+                - mandelbrotView.getX(start_x)) / 2
+                + mandelbrotView.getX(start_x);
+        double center_y = (mandelbrotView.getY(me.getY())
+                - mandelbrotView.getY(start_y)) / 2
+                + mandelbrotView.getY(start_y);
+
+        mandelbrotTextFields.setCenterX(center_x);
+        mandelbrotTextFields.setCenterY(center_y);
+
+        double scale = mandelbrotTextFields.getScale()
+                / (me.getX() - start_x)
+                * getWidth();
+
+        mandelbrotTextFields.setScale(scale);
+    }
+
+    @Override
+    public void mouseEntered(MouseEvent me) {}
 
     @Override
+    public void mouseExited(MouseEvent me) {}
+
+    /**
+     * Erase the old box, draw the new box
+     * @param me 
+     */
+    @Override
     public void mouseDragged(MouseEvent me) {
         Graphics g = getSafeGraphics();
         if (g != null) {
@@ -111,6 +149,10 @@ public class ZoomFrame extends JFrame implements MouseListener, MouseMotionListe
         }
     }
     
+    /**
+     * Semi-singleton construction for graphics
+     * @return 
+     */
     private Graphics getSafeGraphics() {
         if (graphics == null) {
             graphics = getGraphics();
@@ -119,6 +161,9 @@ public class ZoomFrame extends JFrame implements MouseListener, MouseMotionListe
         return graphics;
     }
     
+    /**
+     * Erase the old zoombox if it exists
+     */
     private void eraseZoombox() {
         if (start_x < 0 || start_y < 0 || old_x < 0 || old_y < 0)
             return;
@@ -128,15 +173,41 @@ public class ZoomFrame extends JFrame implements MouseListener, MouseMotionListe
     }
 
     @Override
-    public void mouseMoved(MouseEvent me) {
-        //System.err.println(me.toString());
-    }
+    public void mouseMoved(MouseEvent me) {}
     
+    /**
+     * Interface to get and set user input
+     */
     public interface MandelbrotTextFields {
+        
+        /**
+         * Set the center X
+         * @param x 
+         */
         public void setCenterX(double x);
+        
+        /**
+         * Set the center Y
+         * @param y 
+         */
         public void setCenterY(double y);
+        
+        /**
+         * Get the scale factor
+         * @return 
+         */
         public double getScale();
+        
+        /**
+         * Set the scale factor
+         * @param scale 
+         */
         public void setScale(double scale);
+        
+        /**
+         * Set the max amount of iterations for the mandel function
+         * @param repetitions 
+         */
         public void setRepetitions(int repetitions);
     }