Changeset 31333 in osm for applications/editors/josm/plugins

Timestamp:

2015-07-02T16:33:39+02:00 (9 years ago)

Author:

nokutu

Message:

Code cleaned

Location:

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary

Files:

• MapillaryAbstractImage.java (modified) (9 diffs)
• MapillaryData.java (modified) (7 diffs)
• MapillaryDataListener.java (modified) (1 diff)
• MapillaryImage.java (modified) (3 diffs)
• MapillaryImportedImage.java (modified) (1 diff)
• MapillaryLayer.java (modified) (6 diffs)
• MapillaryMouseAdapter.java (modified) (2 diffs)
• MapillaryPlugin.java (modified) (3 diffs)
• downloads/MapillarySequenceDownloadThread.java (modified) (1 diff)
• downloads/MapillarySquareDownloadManagerThread.java (modified) (3 diffs)
• gui/MapillaryImageDisplay.java (modified) (1 diff)
• gui/MapillaryMainDialog.java (added)
• gui/MapillaryToggleDialog.java (deleted)

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryAbstractImage.java

@@ -23 +23 @@
     public static Lock lock = new ReentrantLock();
 
+    /** The time the image was captured, in Epoch format */
     private long capturedAt;
-
     /** Position of the picture */
     public final LatLon latLon;
@@ -78 +78 @@
      * Returns whether the image is visible on the map or not.
      * 
-     * @return
+     * @return True if the image is visible; false otherwise.
      */
     public boolean isVisible() {
@@ -91 +91 @@
      * Returns the last fixed coordinates of the object.
      * 
-     * @return
+     * @return A LatLon object containing.
      */
     public LatLon getTempLatLon() {
@@ -101 +101 @@
      * 
      * @param x
+     *            The movement of the image in longitude units.
      * @param y
+     *            The movement of the image in latitude units.
      */
     public void move(double x, double y) {
@@ -113 +115 @@
      * 
      * @param ca
+     *            The angle the image is moving.
      */
     public void turn(double ca) {
@@ -140 +143 @@
      * Returns the last fixed direction of the object.
      * 
-     * @return
+     * @return The last fixed direction of the object. 0 means north.
      */
     public double getTempCa() {
@@ -149 +152 @@
      * Returns the date the picture was taken in DMY format.
      * 
-     * @return
+     * @return A String object containing the date when the picture was taken.
      */
     public String getDate() {
@@ -192 +195 @@
      * 
      * @param date
+     *            The string containing the date.
      * @param format
-     * @return
+     *            The format of the date.
+     * @return The date in Epoch format.
      */
     public long getEpoch(String date, String format) {
@@ -210 +215 @@
      * Returns current time in Epoch format
      * 
-     * @return
+     * @return The current date in Epoch format.
      */
     private long currentTime() {

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryData.java

@@ -93 +93 @@
 
     /**
-     * Sets the image under the mouse cursor.
-     * 
-     * @param image
-     */
-    public void setHoveredImage(MapillaryAbstractImage image) {
+     * Highlights the image under the cursor.
+     * 
+     * @param image
+     *            The image under the cursor.
+     */
+    public void setHighlightedImage(MapillaryAbstractImage image) {
         highlightedImage = image;
     }
@@ -104 +105 @@
      * Returns the image under the mouse cursor.
      * 
-     * @return
+     * @return The image under the mouse cursor.
      */
     public MapillaryAbstractImage getHoveredImage() {
@@ -210 +211 @@
 
     /**
-     * Selects a new image and then starts a new MapillaryImageDownloadThread
-     * thread in order to download its surrounding thumbnails. If the user does
-     * ctrl+click, this isn't triggered.
+     * Selects a new image and then starts a new
+     * {@link MapillaryImageDownloadThread} thread in order to download its
+     * surrounding thumbnails. If the user does ctrl+click, this isn't
+     * triggered.
      * 
      * @param image
@@ -222 +224 @@
 
     /**
-     * Selects a new image and then starts a new MapillaryImageDownloadThread
-     * thread in order to download its surrounding thumbnails. If the user does
-     * ctrl+click, this isn't triggered. You can choose whether to center the
-     * view on the new image or not.
-     * 
-     * @param image
+     * Selects a new image and then starts a new
+     * {@link MapillaryImageDownloadThread} thread in order to download its
+     * surrounding thumbnails. If the user does ctrl+click, this isn't
+     * triggered. You can choose whether to center the view on the new image or
+     * not.
+     * 
+     * @param image
+     *            The {@link MapillaryImage} which is going to be selected.
      * @param zoom
+     *            True if the view must be centered on the image; false
+     *            otherwise.
      */
     public void setSelectedImage(MapillaryAbstractImage image, boolean zoom) {
@@ -291 +297 @@
 
     /**
-     * Adds a set of MapillaryImage objects to the list of selected images.
+     * Adds a set of {@code MapillaryAbstractImage} objects to the list of
+     * selected images.
      * 
      * @param images
+     *            A List object containing the set of images to be added.
      */
     public void addMultiSelectedImage(List<MapillaryAbstractImage> images) {
@@ -307 +315 @@
 
     /**
-     * Returns a list containing all MapillaryImage objects selected with ctrl +
-     * click
-     * 
-     * @return
+     * Returns a List containing all {@code MapillaryAbstractImage} objects
+     * selected with ctrl + click
+     * 
+     * @return A List object containing all the images selected.
      */
     public List<MapillaryAbstractImage> getMultiSelectedImages() {
@@ -329 +337 @@
      * Returns the amount of images contained by this object.
      * 
-     * @return
+     * @return The amount of images in stored.
      */
     public int size() {

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryDataListener.java

@@ -3 +3 @@
 public interface MapillaryDataListener {
 
+    /**
+     * Fired when any image is added to the database.
+     */
     public void imagesAdded();
 

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryImage.java

@@ -17 +17 @@
     private MapillarySequence sequence;
 
-    /** Epoch time when the image was taken. */
     /** The user that made the image */
     private String user;
@@ -63 +62 @@
      * 
      * @param sign
+     *            A String that identifies the type of sign.
      */
     public void addSign(String sign) {
@@ -68 +68 @@
     }
 
+    /**
+     * Returns a List containing the signs assigned to this image.
+     * 
+     * @return A List object containing the signs assigned to this image.
+     */
     public List<String> getSigns() {
         return signs;
     }
 
+    /**
+     * Sets the username of the person who took the image.
+     * @param user A String containing the username of the person who took the image.
+     */
     public void setUser(String user) {
         this.user = user;

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryImportedImage.java

@@ -39 +39 @@
     }
 
+    /**
+     * Returns the File object where the picture is located.
+     * @return The File object where the picture is located.
+     */
     public File getFile() {
         return file;

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryLayer.java

@@ -9 +9 @@
 import org.openstreetmap.josm.plugins.mapillary.downloads.MapillaryDownloader;
 import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryFilterDialog;
-import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryToggleDialog;
+import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryMainDialog;
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.gui.layer.Layer;
@@ -110 +110 @@
         }
         MapillaryPlugin.setMenuEnabled(MapillaryPlugin.EXPORT_MENU, true);
-        if (!MapillaryToggleDialog.getInstance().isShowing())
-            MapillaryToggleDialog.getInstance().getButton().doClick();
+        if (!MapillaryMainDialog.getInstance().isShowing())
+            MapillaryMainDialog.getInstance().getButton().doClick();
         createHatchTexture();
         data.dataUpdated();
@@ -178 +178 @@
     @Override
     public void destroy() {
-        MapillaryToggleDialog.getInstance().setImage(null);
-        MapillaryToggleDialog.getInstance().updateImage();
+        MapillaryMainDialog.getInstance().setImage(null);
+        MapillaryMainDialog.getInstance().updateImage();
         data.getImages().clear();
         MapillaryLayer.INSTANCE = null;
@@ -278 +278 @@
         MapillaryLayer.BLUE = null;
         MapillaryLayer.RED = null;
-        MapillaryToggleDialog.getInstance().blueButton.setEnabled(false);
-        MapillaryToggleDialog.getInstance().redButton.setEnabled(false);
+        MapillaryMainDialog.getInstance().blueButton.setEnabled(false);
+        MapillaryMainDialog.getInstance().redButton.setEnabled(false);
 
         // Sets blue and red lines and enables/disables the buttons
@@ -291 +291 @@
                         mv.getPoint(closestImages[0].getLatLon()).y,
                         selected.x, selected.y);
-                MapillaryToggleDialog.getInstance().blueButton.setEnabled(true);
+                MapillaryMainDialog.getInstance().blueButton.setEnabled(true);
             }
             if (closestImages[1] != null) {
@@ -299 +299 @@
                         mv.getPoint(closestImages[1].getLatLon()).y,
                         selected.x, selected.y);
-                MapillaryToggleDialog.getInstance().redButton.setEnabled(true);
+                MapillaryMainDialog.getInstance().redButton.setEnabled(true);
             }
         }

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryMouseAdapter.java

@@ -13 +13 @@
 import org.openstreetmap.josm.plugins.mapillary.commands.CommandTurnImage;
 import org.openstreetmap.josm.plugins.mapillary.commands.MapillaryRecord;
-import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryToggleDialog;
+import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryMainDialog;
 
 /**
@@ -231 +231 @@
         if (MapillaryData.getInstance().getHoveredImage() != closestTemp
                 && closestTemp != null) {
-            MapillaryData.getInstance().setHoveredImage(closestTemp);
-            MapillaryToggleDialog.getInstance().setImage(closestTemp);
-            MapillaryToggleDialog.getInstance().updateImage();
+            MapillaryData.getInstance().setHighlightedImage(closestTemp);
+            MapillaryMainDialog.getInstance().setImage(closestTemp);
+            MapillaryMainDialog.getInstance().updateImage();
         } else if (MapillaryData.getInstance().getHoveredImage() != closestTemp
                 && closestTemp == null) {
-            MapillaryData.getInstance().setHoveredImage(null);
-            MapillaryToggleDialog.getInstance().setImage(
+            MapillaryData.getInstance().setHighlightedImage(null);
+            MapillaryMainDialog.getInstance().setImage(
                     MapillaryData.getInstance().getSelectedImage());
-            MapillaryToggleDialog.getInstance().updateImage();
+            MapillaryMainDialog.getInstance().updateImage();
         }
         MapillaryData.getInstance().dataUpdated();

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryPlugin.java

@@ -21 +21 @@
 import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryHistoryDialog;
 import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryPreferenceSetting;
-import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryToggleDialog;
+import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryMainDialog;
 import org.openstreetmap.josm.plugins.mapillary.actions.*;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -101 +101 @@
     public void mapFrameInitialized(MapFrame oldFrame, MapFrame newFrame) {
         if (oldFrame == null && newFrame != null) { // map frame added
-            Main.map.addToggleDialog(MapillaryToggleDialog.getInstance(), false);
+            Main.map.addToggleDialog(MapillaryMainDialog.getInstance(), false);
             Main.map.addToggleDialog(MapillaryHistoryDialog.getInstance(),
                     false);
@@ -111 +111 @@
         }
         if (oldFrame != null && newFrame == null) { // map frame destroyed
-            MapillaryToggleDialog.destroyInstance();
+            MapillaryMainDialog.destroyInstance();
             MapillaryHistoryDialog.destroyInstance();
             MapillaryFilterDialog.destroyInstance();

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/downloads/MapillarySequenceDownloadThread.java

@@ -120 +120 @@
 
     private boolean isInside(MapillaryAbstractImage image) {
-        for (int i = 0; i < bounds.size(); i++) {
+        for (int i = 0; i < bounds.size(); i++)
             if (bounds.get(i).contains(image.getLatLon()))
                 return true;
-        }
         return false;
     }

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/downloads/MapillarySquareDownloadManagerThread.java

@@ -10 +10 @@
 import org.openstreetmap.josm.plugins.mapillary.MapillaryLayer;
 import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryFilterDialog;
-import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryToggleDialog;
+import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryMainDialog;
 
 /**
@@ -45 +45 @@
                         .setHelpText("Downloading image's information");
                 completeImages();
-                MapillaryToggleDialog.getInstance().updateTitle();
+                MapillaryMainDialog.getInstance().updateTitle();
                 Main.map.statusLine.setHelpText("Downloading signs");
                 downloadSigns();
@@ -59 +59 @@
         layer.data.dataUpdated();
         MapillaryFilterDialog.getInstance().refresh();
-        MapillaryToggleDialog.getInstance().updateImage();
+        MapillaryMainDialog.getInstance().updateImage();
     }
 

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/gui/MapillaryImageDisplay.java

@@ -25 +25 @@
 /**
  * This object is a responsible JComponent which lets you zoom and drag. It is
- * included in a {@link MapillaryToggleDialog} object.
+ * included in a {@link MapillaryMainDialog} object.
  * 
  * @author Jorge
  * @see MapillaryImageDisplay
- * @see MapillaryToggleDialog
+ * @see MapillaryMainDialog
  */
 public class MapillaryImageDisplay extends JComponent {