Changeset 29384 in osm for applications/editors/josm/plugins/imagery_offset_db/src/iodb/OffsetDialogButton.java

Timestamp:

2013-03-22T22:18:26+01:00 (13 years ago)

Author:

zverik

Message:

ImageryID refactoring and javadocs

File:

• applications/editors/josm/plugins/imagery_offset_db/src/iodb/OffsetDialogButton.java (modified) (8 diffs)

applications/editors/josm/plugins/imagery_offset_db/src/iodb/OffsetDialogButton.java

@@ -5 +5 @@
 import javax.swing.ImageIcon;
 import javax.swing.JButton;
+import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.coor.EastNorth;
+import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.projection.Projection;
 import org.openstreetmap.josm.gui.layer.ImageryLayer;
 import org.openstreetmap.josm.tools.ImageProvider;
 
 /**
- * A button which shows offset information.
+ * A button which shows offset information. Must be spectacular, since it's the only
+ * non-JOptionPane GUI in the plugin.
  * 
- * @author zverik
+ * @author Zverik
+ * @license WTFPL
  */
 public class OffsetDialogButton extends JButton {
@@ -20 +26 @@
     private double direction;
 
+    /**
+     * Initialize the button with an offset. Calculated all relevant values.
+     * @param offset An offset to display on the button.
+     */
     public OffsetDialogButton( ImageryOffsetBase offset ) {
         super();
@@ -49 +59 @@
     }
 
+    /**
+     * Returns the offset associated with this button.
+     */
     public ImageryOffsetBase getOffset() {
         return offset;
@@ -69 +82 @@
     }
 
+    /**
+     * Calculates length and direction for two points in the imagery offset object.
+     * @see #getLengthAndDirection(iodb.ImageryOffset, double, double) 
+     */
     private double[] getLengthAndDirection( ImageryOffset offset ) {
         ImageryLayer layer = ImageryOffsetTools.getTopImageryLayer();
         double[] dxy = layer == null ? new double[] {0.0, 0.0} : new double[] {layer.getDx(), layer.getDy()};
-        return ImageryOffsetTools.getLengthAndDirection((ImageryOffset)offset, dxy[0], dxy[1]);
+        return getLengthAndDirection(offset, dxy[0], dxy[1]);
     }
 
+    /**
+     * Calculates length and direction for two points in the imagery offset object
+     * taking into account an existing imagery layer offset.
+     *
+     * @see #getLengthAndDirection(iodb.ImageryOffset)
+     */
+    public static double[] getLengthAndDirection( ImageryOffset offset, double dx, double dy ) {
+        Projection proj = Main.getProjection();
+        EastNorth pos = proj.latlon2eastNorth(offset.getPosition());
+        LatLon correctedCenterLL = proj.eastNorth2latlon(pos.add(-dx, -dy));
+        double length = correctedCenterLL.greatCircleDistance(offset.getImageryPos());
+        double direction = length < 1e-2 ? 0.0 : correctedCenterLL.heading(offset.getImageryPos());
+        // todo: north vs south. Meanwhile, let's fix this dirty:
+//        direction = Math.PI - direction;
+        if( direction < 0 )
+            direction += Math.PI * 2;
+        return new double[] {length, direction};
+    }
+
+    /**
+     * An offset icon. Displays a plain calibration icon for a geometry
+     * and an arrow for an imagery offset.
+     */
     class OffsetIcon implements Icon {
         private boolean isDeprecated;
@@ -82 +122 @@
         private ImageIcon background;
 
+        /**
+         * Initialize the icon with an offset object. Calculates length and direction
+         * of an arrow if they're needed.
+         */
         public OffsetIcon( ImageryOffsetBase offset ) {
             isDeprecated = offset.isDeprecated();
@@ -89 +133 @@
                 ImageryLayer layer = ImageryOffsetTools.getTopImageryLayer();
                 double[] dxy = layer == null ? new double[] {0.0, 0.0} : new double[] { layer.getDx(), layer.getDy() };
-                double[] ld = ImageryOffsetTools.getLengthAndDirection((ImageryOffset)offset, dxy[0], dxy[1]);
+                double[] ld = getLengthAndDirection((ImageryOffset)offset, dxy[0], dxy[1]);
                 length = ld[0];
                 direction = ld[1];
@@ -97 +141 @@
         }
 
+        /**
+         * Paints the base image and adds to it according to the offset.
+         */
         public void paintIcon( Component comp, Graphics g, int x, int y ) {
             background.paintIcon(comp, g, x, y);
@@ -110 +157 @@
                 } else {
                     // draw an arrow
-                    double arrowLength = length < 5 ? getIconWidth() / 2 - 1 : getIconWidth() - 4;
+                    double arrowLength = length < 10 ? getIconWidth() / 2 - 1 : getIconWidth() - 4;
                     g2.setStroke(new BasicStroke(2));
                     int dx = (int)Math.round(Math.sin(direction) * arrowLength / 2);