Changeset 4651 in osm for applications/editors/josm/plugins/duplicateway

Timestamp:

2007-09-22T03:17:53+02:00 (17 years ago)

Author:

brent

Message:

Improved Version

Location:

applications/editors/josm/plugins/duplicateway

Files:

• Duplicate-Way.jar (modified) ( previous)
• src/org/openstreetmap/josm/plugins/duplicateway/DuplicateWayAction.java (added)
• src/org/openstreetmap/josm/plugins/duplicateway/DuplicateWayPlugin.java (modified) (1 diff)
• src/org/openstreetmap/josm/plugins/duplicateway/JVector.java (moved) (moved from applications/editors/josm/plugins/duplicateway/src/org/openstreetmap/josm/plugins/duplicateway/JosmVector.java ) (20 diffs)

applications/editors/josm/plugins/duplicateway/src/org/openstreetmap/josm/plugins/duplicateway/DuplicateWayPlugin.java

@@ -31 +31 @@
     if (toolsMenu == null) {
       toolsMenu = new JMenu(name);
-      toolsMenu.add(new JMenuItem(new DuplicateWayAction(name)));
+      toolsMenu.add(new JMenuItem(new DuplicateWayAction()));
       Main.main.menu.add(toolsMenu, 2);
     }
     else {
       toolsMenu.addSeparator();
-      toolsMenu.add(new JMenuItem(new DuplicateWayAction(name)));
+      toolsMenu.add(new JMenuItem(new DuplicateWayAction()));
     }
     

applications/editors/josm/plugins/duplicateway/src/org/openstreetmap/josm/plugins/duplicateway/JVector.java

@@ +1 @@
+
+// License: GPL. Copyright 2007 by Brent Easton
+
 package org.openstreetmap.josm.plugins.duplicateway;
 
@@ -8 +11 @@
 import org.openstreetmap.josm.data.osm.Segment;
 
-public class JosmVector extends Line2D.Double {
+/**
+ *
+ * A class encapsulating a line Segment treating it as a Vector (
+ * direction and length). Includes Utility routines to perform various
+ * transformations and Trigonometric operations 
+ *
+ * @author Brent Easton
+ *
+ */
+public class JVector extends Line2D.Double {
   
   public static final double EARTH_CIRCUMFERENCE = 40041455;
@@ -15 +27 @@
   protected Point2D.Double rtheta = null;
   
-  public JosmVector(double x1, double y1, double x2, double y2) {
+  /**
+   * Create new JVector joining two points
+   * 
+   * @param x1
+   * @param y1
+   * @param x2
+   * @param y2
+   */
+  public JVector(double x1, double y1, double x2, double y2) {
     super(x1, y1, x2, y2);
   }
   
-  public JosmVector(JosmVector ls) {
+  /**
+   * Create new JVector from another JVector
+   * 
+   * @param v JVector to copy
+   */
+  public JVector(JVector v) {
     super();
-    x1 = ls.x1;
-    x2 = ls.x2;
-    y1 = ls.y1;
-    y2 = ls.y2;
-  }
-  
-  public JosmVector (Segment s) {
+    x1 = v.x1;
+    x2 = v.x2;
+    y1 = v.y1;
+    y2 = v.y2;
+  }
+  
+  /**
+   * Create a new JVector based on a JOSM Segment object
+   * 
+   * @param s
+   */
+  public JVector (Segment s) {
     super(s.from.eastNorth.east(), s.from.eastNorth.north(), s.to.eastNorth.east(), s.to.eastNorth.north());
   }
   
-  /*
+  /**
    * Calculate slope/intersect from cartesian co-ords
+   *
    */
   protected void calculateSlopeIntercept() {
@@ -40 +71 @@
   }
   
+  /**
+   * Return the slope of the JVector
+   * @return slope
+   */
   public double getSlope() {
     if (slopeIntercept == null) {
@@ -47 +82 @@
   }
   
+  /**
+   * Return the Y intercept of the JVector
+   * @return intercept
+   */
   public double getIntercept() {
     if (slopeIntercept == null) {
@@ -54 +93 @@
   }
   
-  /*
+  /**
    * Calculate the polar coordinates for this line as a ray with
    * the from point as origin
@@ -66 +105 @@
   }
   
+  /**
+   * Return the length of the line segment
+   * @return length
+   */
   public double getLength() {
     if (rtheta == null) {
@@ -73 +116 @@
   }
   
+  /**
+   * Return the angle of the line segment
+   * @return theta
+   */
   public double getTheta() {
     if (rtheta == null) {
@@ -80 +127 @@
   }
   
-  /*
-   * Set the Cartesian co-ords of the to point from the Polar co-ords
+  /**
+   * Convert Polar co-ords to cartesian
    */
   protected void polarToCartesian() {
@@ -91 +138 @@
   }
   
+  /**
+   * Set the line segment using Polar co-ordinates
+   * 
+   * @param r line length
+   * @param theta angle
+   */
   protected void setPolar(double r, double theta) {
     rtheta = new Point2D.Double(r, theta);
@@ -96 +149 @@
   }
   
+  /**
+   * Set the length of the line segment
+   * @param l length
+   */
   protected void setLength(double l) {
     rtheta.x = l;
     polarToCartesian();
   }
-  /*
+  
+  /**
    * Reverse the direction of the segment
    */
@@ -114 +172 @@
   }
   
-  /*
-   * Rotate the line 
+  /**
+   * Rotate the line segment about the origin
+   * @param rot angle to rotate
    */
   protected void rotate(double rot) {
@@ -125 +184 @@
   }
   
+  /**
+   * Rotate 90 degrees clockwise
+   *
+   */
   protected void rotate90CW() {
     rotate(-PI_ON_2);
   }
   
+  /**
+   * Rotate 90 degrees counterclockwise
+   *
+   */
   protected void rotate90CCW() {
     rotate(PI_ON_2);
   }
   
-  /*
+  /**
    * Normalize theta to be in the range -PI < theta < PI
+   * @param theta
+   * @return normalized angle
    */
   protected double normalize(double theta) {
@@ -147 +216 @@
     return theta;
   }
-  
-//  /*
-//   * Rotate vector and set lenngth. If offset is positive,
-//   * rotate so the vector points more towards the right, 
-//   * otherwise towards the left
-//   */
-//  protected void rotate(double theta, double offset) {
-//    if (getTheta() > 0) {
-//      if (offset > 0) {
-//        rotate(-theta);
-//      }
-//      else {
-//        rotate(theta);
-//      }
-//    }
-//    else {
-//      if (offset > 0) {
-//        rotate(theta);
-//      }
-//      else {
-//        rotate(-theta);
-//      }
-//    }
-//    setLength(Math.abs(offset));
-//  }
  
+  /**
+   * Rotate the line segment 90 degrees and set the length.  
+   * @param offset length
+   */
   protected void rotate90(double offset) {
     rotate(PI_ON_2 * (offset < 0 ? 1 : -1));
@@ -182 +230 @@
    * -ve if the point is to the left of the line, or +ve if to the right
    */
+  
+  
+  /**
+   * Return the distance of the given point from this line. Offset is 
+   * -ve if the point is to the left of the line, or +ve if to the right
+   * @param target 
+   */
   protected double calculateOffset(EastNorth target) {
     
     // Calculate the perpendicular interceptor to this point
     EastNorth intersectPoint = perpIntersect(target);
-    JosmVector intersectRay = new JosmVector(intersectPoint.east(), intersectPoint.north(), target.east(), target.north());
+    JVector intersectRay = new JVector(intersectPoint.east(), intersectPoint.north(), target.east(), target.north());
     
     // Offset is equal to the length of the interceptor
@@ -201 +256 @@
   
 
-  /*
+  /**
    * Return the Perpendicular distance between a point
    * and this line. Units is degrees.
+   * @param n Node
    */
   public double perpDistance(Node n) {
@@ -209 +265 @@
   }
 
+  /**
+   * Calculate the perpendicular distance from the supplied
+   * point to this line
+   * @param en point
+   * @return distance
+   */
   public double perpDistance(EastNorth en) {
    return ptLineDist(en.east(), en.north());
   }
 
+  /**
+   * Calculate the perpendicular distance from the given point
+   * to a JOSM segment.
+   * @param s
+   * @param en
+   * @return
+   */
   public static double perpDistance(Segment s, EastNorth en) {  
    return Line2D.ptSegDist(s.from.eastNorth.east(), s.from.eastNorth.north(), s.to.eastNorth.east(), s.to.eastNorth.north(), en.east(), en.north());
   }
-  /*
+  
+  /**
    * Calculate the bisector between this and another Vector. A positive offset means
    * the bisector must point to the right of the Vectors.
-   */
-  public JosmVector bisector(JosmVector ls, double offset) {
-    JosmVector newSeg = new JosmVector(ls);
+   * @param ls Other vector to create angle to bisect
+   * @param offset length of bisecing vector
+   * @return the bisecting vector
+   */
+  public JVector bisector(JVector ls, double offset) {
+    JVector newSeg = new JVector(ls);
     double newTheta = Math.PI + ls.getTheta() - getTheta();
     newSeg.setPolar(Math.abs(offset), newSeg.getTheta() - newTheta/2.0);
@@ -229 +302 @@
       newSeg.rotate(Math.PI);
     }
-    
-//    if (newSeg.getTheta() < -PI_ON_2) {
-//      if (offset > 0) {
-//        newSeg.rotate(Math.PI);
-//      }
-//    }
-//    else if (newSeg.getTheta() > PI_ON_2) {
-//      if (offset > 0) {
-//        newSeg.rotate(-Math.PI);
-//      }
-//    }
-//    else {   
-//     if (offset < 0) {
-//       newSeg.rotate(Math.PI);
-//      }
-//    }
     return newSeg;
   }
   
-  /*
+  /**
    * Return the Perpendicular Intersector from a point to this line
+   * @param n a JOSM node
+   * @return the point on our line closest to n
    */
   public EastNorth perpIntersect(Node n) {
@@ -255 +314 @@
   }
   
+  /**
+   * Calculate the point on our line closest to the supplied point
+   * @param en point
+   * @return return closest point
+   */
   public EastNorth perpIntersect(EastNorth en) {
     
@@ -277 +341 @@
     return new EastNorth(intersectE, intersectN);
   }
-//  
-//  /*
-//   * Return a compass heading  
-//   */
-//  public String direction() {
-//    double theta = getTheta();
-//    String direction = "";
-//    if (theta >= 0) {
-//      if (theta < PI_ON_2) {
-//        direction = "ne";
-//      }
-//      else {
-//        direction = "nw";
-//      }
-//    }
-//    else {
-//      if (theta < -PI_ON_2) {
-//        direction = "sw";
-//      }
-//      else {
-//        direction = "se";
-//      }
-//    }
-//    return direction;
-//  }
 }