Changeset 12375 in josm for trunk/src/org

Timestamp:

2017-06-09T21:37:52+02:00 (7 years ago)

Author:

michael2402

Message:

Document the data.coor package

Location:

trunk/src/org/openstreetmap/josm/data/coor

Files:

• EastNorth.java (modified) (3 diffs)
• LatLon.java (modified) (2 diffs)
• QuadTiling.java (modified) (2 diffs)

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

@@ -2 +2 @@
 package org.openstreetmap.josm.data.coor;
 
+import org.openstreetmap.gui.jmapviewer.JMapViewer;
 import org.openstreetmap.gui.jmapviewer.Projected;
 import org.openstreetmap.gui.jmapviewer.interfaces.IProjected;
@@ -16 +17 @@
     private static final long serialVersionUID = 1L;
 
+    /**
+     * A zero constant
+     */
     public static final EastNorth ZERO = new EastNorth(0, 0);
 
@@ -184 +188 @@
     }
 
+    /**
+     * Converts this to a {@link IProjected} instance to be used in the {@link JMapViewer}
+     * @return The projected
+     */
     public IProjected toProjected() {
         return new Projected(east(), north());

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

@@ -52 +52 @@
      */
     public static final double MAX_SERVER_PRECISION = 1e-7;
+    /**
+     * The inverse of the server precision
+     * @see #MAX_SERVER_PRECISION
+     */
     public static final double MAX_SERVER_INV_PRECISION = 1e7;
 
@@ -70 +74 @@
     private static DecimalFormat cDmMinuteFormatter = new DecimalFormat(
             Main.pref == null ? "00.000" : Main.pref.get("latlon.dm.decimal-format", "00.000"));
+    /**
+     * The normal number format for server precision coordinates
+     */
     public static final DecimalFormat cDdFormatter;
+    /**
+     * The number format used for high precision coordinates
+     */
     public static final DecimalFormat cDdHighPecisionFormatter;
     static {

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

@@ -4 +4 @@
 import org.openstreetmap.josm.tools.Utils;
 
+/**
+ * This class helps in tiling the world into multiple quad tiles.
+ */
 public final class QuadTiling {
 
@@ -10 +13 @@
     }
 
+    /**
+     * The maximum number of levels to split the quads
+     */
     public static final int NR_LEVELS = 24;
+    /**
+     * The number of parts the world is split into in each direction
+     */
     public static final double WORLD_PARTS = 1 << NR_LEVELS;
 
+    /**
+     * The log(2) of how many tiles there are per level
+     */
     public static final int TILES_PER_LEVEL_SHIFT = 2; // Has to be 2. Other parts of QuadBuckets code rely on it
+    /**
+     * How many tiles there are per level
+     */
     public static final int TILES_PER_LEVEL = 1 << TILES_PER_LEVEL_SHIFT;
+    /**
+     * The size of the world in X direction
+     */
     public static final int X_PARTS = 360;
+    /**
+     * The offset of the world in x direction
+     */
     public static final int X_BIAS = -180;
 
+    /**
+     * The size of the world in y direction
+     */
     public static final int Y_PARTS = 180;
+    /**
+     * The offset of the world in y direction
+     */
     public static final int Y_BIAS = -90;
 
+    /**
+     * Converts a tile index to a lat/lon position
+     * @param quad The tile to convert
+     * @return The lat/lon position of that tile
+     */
     public static LatLon tile2LatLon(long quad) {
         // The world is divided up into X_PARTS,Y_PARTS.