Changeset 12161 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2017-05-15T15:43:30+02:00 (7 years ago)

Author:

michael2402

Message:

See #13415: Add the ILatLon interface, unify handling of Nodes and CachedLatLon

Location:

trunk/src/org/openstreetmap/josm/data

Files:

• Bounds.java (modified) (3 diffs)
• coor/CachedLatLon.java (modified) (5 diffs)
• coor/LatLon.java (modified) (4 diffs)
• osm/BBox.java (modified) (4 diffs)
• osm/INode.java (modified) (3 diffs)
• osm/Node.java (modified) (3 diffs)
• osm/NodeData.java (modified) (1 diff)
• osm/NodePositionComparator.java (modified) (1 diff)
• projection/AbstractProjection.java (modified) (4 diffs)
• projection/Ellipsoid.java (modified) (1 diff)
• projection/Projecting.java (modified) (3 diffs)
• projection/Projection.java (modified) (1 diff)
• projection/ShiftedProjecting.java (modified) (2 diffs)
• validation/PaintVisitor.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/data/Bounds.java

@@ -10 +10 @@
 import java.util.function.Consumer;
 
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.osm.BBox;
@@ -18 +19 @@
  * This is a simple data class for "rectangular" areas of the world, given in
  * lat/lon min/max values.  The values are rounded to LatLon.OSM_SERVER_PRECISION
+ *
+ * @see BBox to represent invalid areas.
  *
  * @author imi
@@ -390 +393 @@
     /**
      * Determines if the given point {@code ll} is within these bounds.
+     * <p>
+     * Points with unknown coordinates are always outside the coordinates.
      * @param ll The lat/lon to check
      * @return {@code true} if {@code ll} is within these bounds, {@code false} otherwise
      */
     public boolean contains(LatLon ll) {
+        // binary compatibility
+        return contains((ILatLon) ll);
+    }
+
+    /**
+     * Determines if the given point {@code ll} is within these bounds.
+     * <p>
+     * Points with unknown coordinates are always outside the coordinates.
+     * @param ll The lat/lon to check
+     * @return {@code true} if {@code ll} is within these bounds, {@code false} otherwise
+     * @since xxx
+     */
+    public boolean contains(ILatLon ll) {
+        if (!ll.isLatLonKnown()) {
+            return false;
+        }
         if (ll.lat() < minLat || ll.lat() > maxLat)
             return false;

trunk/src/org/openstreetmap/josm/data/coor/CachedLatLon.java

@@ -5 +5 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.projection.Projecting;
 import org.openstreetmap.josm.data.projection.Projection;
 
@@ -20 +21 @@
 
     private EastNorth eastNorth;
-    private transient Projection proj;
+    private transient Object cacheKey;
 
     /**
@@ -37 +38 @@
     public CachedLatLon(LatLon coor) {
         super(coor.lat(), coor.lon());
-        proj = null;
+        cacheKey = null;
     }
 
@@ -45 +46 @@
      */
     public CachedLatLon(EastNorth eastNorth) {
-        super(Main.getProjection().eastNorth2latlon(eastNorth));
-        proj = Main.getProjection();
+        this(eastNorth, Main.getProjection());
+    }
+
+    private CachedLatLon(EastNorth eastNorth, Projection projection) {
+        super(projection.eastNorth2latlon(eastNorth));
+        cacheKey = projection.getCacheKey();
         this.eastNorth = eastNorth;
     }
@@ -55 +60 @@
      * @return the internally cached east/north coordinates. null, if the globally defined projection is null
      */
-    public final EastNorth getEastNorth() {
-        if (!Objects.equals(proj, Main.getProjection())) {
-            proj = Main.getProjection();
-            eastNorth = proj.latlon2eastNorth(this);
+    @Override
+    public final EastNorth getEastNorth(Projecting projecting) {
+        if (!Objects.equals(cacheKey, projecting.getCacheKey())) {
+            cacheKey = projecting.getCacheKey();
+            eastNorth = projecting.latlon2eastNorth(this);
         }
         return eastNorth;

trunk/src/org/openstreetmap/josm/data/coor/LatLon.java

@@ -43 +43 @@
  * @author Imi
  */
-public class LatLon extends Coordinate {
+public class LatLon extends Coordinate implements ILatLon {
 
     private static final long serialVersionUID = 1L;
@@ -251 +251 @@
     }
 
-    protected LatLon(LatLon coor) {
+    /**
+     * Creates a new LatLon object for the given coordinate
+     * @param coor The coordinates to copy from.
+     */
+    public LatLon(ILatLon coor) {
         super(coor.lon(), coor.lat());
     }
@@ -263 +267 @@
     }
 
-    /**
-     * Returns the latitude, i.e., the north-south position in degrees.
-     * @return the latitude
-     */
+    @Override
     public double lat() {
         return y;
@@ -286 +287 @@
     }
 
-    /**
-     * Returns the longitude, i.e., the east-west position in degrees.
-     * @return the longitude
-     */
+    @Override
     public double lon() {
         return x;

trunk/src/org/openstreetmap/josm/data/osm/BBox.java

@@ -7 +7 @@
 
 import org.openstreetmap.josm.data.Bounds;
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.coor.QuadTiling;
@@ -85 +86 @@
      */
     public BBox(Way w) {
-        w.getNodes().forEach(n -> add(n.getCoor()));
+        w.getNodes().forEach(this::add);
     }
 
@@ -93 +94 @@
      */
     public BBox(Node n) {
-        if (n.isLatLonKnown()) {
-            add(n.getCoor());
-        }
+        this((ILatLon) n);
+    }
+
+    /**
+     * Create BBox for a given latlon. An invalid BBox is returned if the coordinates are not known.
+     * @param ll The lat lon position
+     */
+    public BBox(ILatLon ll) {
+        add(ll);
+    }
+
+    /**
+     * Add a point to an existing BBox. Extends this bbox if necessary so that this.bounds(c) will return true
+     * if c is a valid LatLon instance.
+     * Kept for binary compatibility
+     * @param c a LatLon point
+     */
+    public final void add(LatLon c) {
+        add((ILatLon) c);
     }
 
@@ -103 +120 @@
      * @param c a LatLon point
      */
-    public final void add(LatLon c) {
-        if (c != null && c.isValid()) {
-            add(c.lon(), c.lat());
-        }
+    public final void add(ILatLon c) {
+        add(c.lon(), c.lat());
     }
 

trunk/src/org/openstreetmap/josm/data/osm/INode.java

@@ -3 +3 @@
 
 import org.openstreetmap.josm.data.coor.EastNorth;
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 
@@ -9 +10 @@
  * @since 4098
  */
-public interface INode extends IPrimitive {
+public interface INode extends IPrimitive, ILatLon {
 
     /**
@@ -24 +25 @@
 
     /**
-     * Returns east/north coordinates of this node.
-     * @return east/north coordinates of this node
-     */
-    EastNorth getEastNorth();
-
-    /**
      * Sets east/north coordinates of this node.
      * @param eastNorth east/north coordinates of this node

trunk/src/org/openstreetmap/josm/data/osm/Node.java

@@ -15 +15 @@
 import org.openstreetmap.josm.data.osm.visitor.PrimitiveVisitor;
 import org.openstreetmap.josm.data.osm.visitor.Visitor;
-import org.openstreetmap.josm.data.projection.Projection;
+import org.openstreetmap.josm.data.projection.Projecting;
 import org.openstreetmap.josm.data.projection.Projections;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
@@ -48 +48 @@
      * @since 7828
      */
+    @Override
     public boolean isLatLonKnown() {
+        // We cannot use default implementation - if we remove this implementation, we will break binary compatibility.
         return !Double.isNaN(lat) && !Double.isNaN(lon);
     }
@@ -81 +83 @@
     @Override
     public LatLon getCoor() {
-        if (!isLatLonKnown()) return null;
-        return new LatLon(lat, lon);
-    }
-
-    /**
-     * <p>Replies the projected east/north coordinates.</p>
-     *
-     * <p>Uses the {@link Main#getProjection() global projection} to project the lan/lon-coordinates.
-     * Internally caches the projected coordinates.</p>
-     *
-     * <p>Replies {@code null} if this node doesn't know lat/lon-coordinates, i.e. because it is an incomplete node.
-     *
-     * @return the east north coordinates or {@code null}
-     * @see #invalidateEastNorthCache()
-     *
-     */
-    @Override
-    public EastNorth getEastNorth() {
-        return getEastNorth(Main.getProjection());
-    }
-
-    /**
-     * Replies the projected east/north coordinates.
-     * <p>
-     * The result of the last conversion is cached. The cache object is used as cache key.
-     * @param projection The projection to use.
-     * @return The projected east/north coordinates
-     * @since 10827
-     */
-    public EastNorth getEastNorth(Projection projection) {
+        if (!isLatLonKnown()) {
+            return null;
+        } else {
+            return new LatLon(lat, lon);
+        }
+    }
+
+    @Override
+    public double lat() {
+        return lat;
+    }
+
+    @Override
+    public double lon() {
+        return lon;
+    }
+
+    @Override
+    public EastNorth getEastNorth(Projecting projection) {
         if (!isLatLonKnown()) return null;
 

trunk/src/org/openstreetmap/josm/data/osm/NodeData.java

@@ -41 +41 @@
     }
 
-    private boolean isLatLonKnown() {
+    @Override
+    public double lat() {
+        return lat;
+    }
+
+    @Override
+    public double lon() {
+        return lon;
+    }
+
+    @Override
+    public boolean isLatLonKnown() {
         return !Double.isNaN(lat) && !Double.isNaN(lon);
     }

trunk/src/org/openstreetmap/josm/data/osm/NodePositionComparator.java

@@ -20 +20 @@
             return 0;
 
-        int dLat = Double.compare(n1.getCoor().lat(), n2.getCoor().lat());
-        return dLat != 0 ? dLat : Double.compare(n1.getCoor().lon(), n2.getCoor().lon());
+        int dLat = Double.compare(n1.lat(), n2.lat());
+        return dLat != 0 ? dLat : Double.compare(n1.lon(), n2.lon());
     }
 }

trunk/src/org/openstreetmap/josm/data/projection/AbstractProjection.java

@@ -10 +10 @@
 import org.openstreetmap.josm.data.ProjectionBounds;
 import org.openstreetmap.josm.data.coor.EastNorth;
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.projection.datum.Datum;
@@ -114 +115 @@
 
     @Override
-    public EastNorth latlon2eastNorth(LatLon ll) {
-        ll = datum.fromWGS84(ll);
+    public EastNorth latlon2eastNorth(ILatLon toConvert) {
+        // TODO: Use ILatLon in datum, so we don't need to wrap it here.
+        LatLon ll = datum.fromWGS84(new LatLon(toConvert));
         double[] en = proj.project(Utils.toRadians(ll.lat()), Utils.toRadians(LatLon.normalizeLon(ll.lon() - lon0 - pm)));
         return new EastNorth((ellps.a * k0 * en[0] + x0) / toMeter, (ellps.a * k0 * en[1] + y0) / toMeter);
@@ -122 +124 @@
     @Override
     public LatLon eastNorth2latlon(EastNorth en) {
+        // We know it is a latlon. Nice would be to change this method return type to ILatLon
         return eastNorth2latlon(en, LatLon::normalizeLon);
     }
@@ -127 +130 @@
     @Override
     public LatLon eastNorth2latlonClamped(EastNorth en) {
-        LatLon ll = eastNorth2latlon(en, lon -> Utils.clamp(lon, -180, 180));
+        ILatLon ll = eastNorth2latlon(en, lon -> Utils.clamp(lon, -180, 180));
         Bounds bounds = getWorldBoundsLatLon();
         return new LatLon(Utils.clamp(ll.lat(), bounds.getMinLat(), bounds.getMaxLat()),

trunk/src/org/openstreetmap/josm/data/projection/Ellipsoid.java

@@ -7 +7 @@
 package org.openstreetmap.josm.data.projection;
 
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.tools.Utils;

trunk/src/org/openstreetmap/josm/data/projection/Projecting.java

@@ -6 +6 @@
 import org.openstreetmap.josm.data.ProjectionBounds;
 import org.openstreetmap.josm.data.coor.EastNorth;
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 
@@ -19 +20 @@
     /**
      * Convert from lat/lon to easting/northing.
+     * <p>
+     * This method exists to not break binary compatibility with old plugins
      *
      * @param ll the geographical point to convert (in WGS84 lat/lon)
      * @return the corresponding east/north coordinates
      */
-    EastNorth latlon2eastNorth(LatLon ll);
+    default EastNorth latlon2eastNorth(LatLon ll) {
+        return latlon2eastNorth((ILatLon) ll);
+    }
+
+    /**
+     * Convert from lat/lon to easting/northing. This method uses the newer {@link ILatLon} interface.
+     *
+     * @param ll the geographical point to convert (in WGS84 lat/lon)
+     * @return the corresponding east/north coordinates
+     * @since xxx
+     */
+    EastNorth latlon2eastNorth(ILatLon ll);
 
     /**
@@ -48 +62 @@
      */
     Map<ProjectionBounds, Projecting> getProjectingsForArea(ProjectionBounds area);
+
+    /**
+     * Gets the object used as cache identifier when caching results of this projection.
+     * @return The object to use as cache key
+     * @since 10827
+     */
+    default Object getCacheKey() {
+        return this;
+    }
 }

trunk/src/org/openstreetmap/josm/data/projection/Projection.java

@@ -119 +119 @@
      */
     boolean switchXY();
-
-    /**
-     * Gets the object used as cache identifier when caching results of this projection.
-     * @return The object to use as cache key
-     * @since 10827
-     */
-    default Object getCacheKey() {
-        return this;
-    }
 }

trunk/src/org/openstreetmap/josm/data/projection/ShiftedProjecting.java

@@ -7 +7 @@
 import org.openstreetmap.josm.data.ProjectionBounds;
 import org.openstreetmap.josm.data.coor.EastNorth;
+import org.openstreetmap.josm.data.coor.ILatLon;
 import org.openstreetmap.josm.data.coor.LatLon;
 
@@ -29 +30 @@
 
     @Override
-    public EastNorth latlon2eastNorth(LatLon ll) {
+    public EastNorth latlon2eastNorth(ILatLon ll) {
         return base.latlon2eastNorth(ll).add(offset);
     }

trunk/src/org/openstreetmap/josm/data/validation/PaintVisitor.java

@@ -3 +3 @@
 
 import java.awt.Color;
-import java.awt.Graphics;
+import java.awt.Graphics2D;
 import java.awt.Point;
 import java.util.HashSet;
@@ -18 +18 @@
 import org.openstreetmap.josm.data.osm.visitor.AbstractVisitor;
 import org.openstreetmap.josm.gui.MapView;
+import org.openstreetmap.josm.gui.draw.MapViewPath;
+import org.openstreetmap.josm.gui.draw.SymbolShape;
 import org.openstreetmap.josm.tools.Utils;
 
@@ -27 +29 @@
 public class PaintVisitor extends AbstractVisitor implements ValidatorVisitor {
     /** The graphics */
-    private final Graphics g;
+    private final Graphics2D g;
     /** The MapView */
     private final MapView mv;
@@ -44 +46 @@
      * @param mv The Mapview
      */
-    public PaintVisitor(Graphics g, MapView mv) {
+    public PaintVisitor(Graphics2D g, MapView mv) {
         this.g = g;
         this.mv = mv;
@@ -121 +123 @@
 
         if (!paintedPoints.contains(pp)) {
-            Point p = mv.getPoint(n);
+            MapViewPath circle = new MapViewPath(mv.getState()).shapeAround(n, SymbolShape.CIRCLE, 10);
 
             if (selected) {
                 g.setColor(getHighlightColor(color));
-                g.fillOval(p.x - 5, p.y - 5, 10, 10);
+                g.fill(circle);
             }
             g.setColor(color);
-            g.drawOval(p.x - 5, p.y - 5, 10, 10);
+            g.draw(circle);
             paintedPoints.add(pp);
         }