Changeset 34170 in osm for applications/editors/josm/plugins/piclayer/src/org/openstreetmap

Timestamp:

2018-04-27T00:21:35+02:00 (7 years ago)

Author:

donvip

Message:

javadoc

Location:

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

Files:

• PicLayerPlugin.java (modified) (2 diffs)
• actions/GenericPicTransformAction.java (modified) (2 diffs)
• actions/LoadPictureCalibrationAction.java (modified) (2 diffs)
• actions/LoadPictureCalibrationFromWorldAction.java (modified) (1 diff)
• actions/ResetCalibrationAction.java (modified) (1 diff)
• actions/SavePictureCalibrationAction.java (modified) (2 diffs)
• actions/SavePictureCalibrationToWorldAction.java (modified) (3 diffs)
• actions/newlayer/NewLayerFromClipboardAction.java (modified) (1 diff)
• actions/newlayer/NewLayerFromFileAction.java (modified) (1 diff)
• actions/transform/MovePictureAction.java (modified) (3 diffs)
• actions/transform/RotatePictureAction.java (modified) (3 diffs)
• actions/transform/ScaleXPictureAction.java (modified) (3 diffs)
• actions/transform/ScaleXYPictureAction.java (modified) (3 diffs)
• actions/transform/ScaleYPictureAction.java (modified) (3 diffs)
• actions/transform/ShearPictureAction.java (modified) (3 diffs)
• actions/transform/affine/MovePointAction.java (modified) (1 diff)
• actions/transform/affine/RemovePointAction.java (modified) (1 diff)
• actions/transform/affine/TransformPointAction.java (modified) (2 diffs)
• layer/PicLayerAbstract.java (modified) (7 diffs)
• transform/PictureTransform.java (modified) (1 diff)

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/PicLayerPlugin.java

@@ -49 +49 @@
     JosmAction newLayerFromFileAction = new NewLayerFromFileAction();
     JosmAction newLayerFromClipboardAction = new NewLayerFromClipboardAction();
+
     /**
-     * Constructor...
+     * Constructor.
+     * @param info plugin info
      */
     public PicLayerPlugin(PluginInformation info) {
@@ -73 +75 @@
         if (newFrame != null) {
             // Create plugin map modes
-            MovePictureAction movePictureAction = new MovePictureAction(newFrame);
-            MovePointAction movePointAction = new MovePointAction(newFrame);
-            TransformPointAction transformPointAction = new TransformPointAction(newFrame);
-            RemovePointAction removePointAction = new RemovePointAction(newFrame);
+            MovePictureAction movePictureAction = new MovePictureAction();
+            MovePointAction movePointAction = new MovePointAction();
+            TransformPointAction transformPointAction = new TransformPointAction();
+            RemovePointAction removePointAction = new RemovePointAction();
 
-            RotatePictureAction rotatePictureAction = new RotatePictureAction(newFrame);
-            ScaleXYPictureAction scaleXYPictureAction = new ScaleXYPictureAction(newFrame);
-            ScaleXPictureAction scaleXPictureAction = new ScaleXPictureAction(newFrame);
-            ScaleYPictureAction scaleYPictureAction = new ScaleYPictureAction(newFrame);
-            ShearPictureAction shearPictureAction = new ShearPictureAction(newFrame);
+            RotatePictureAction rotatePictureAction = new RotatePictureAction();
+            ScaleXYPictureAction scaleXYPictureAction = new ScaleXYPictureAction();
+            ScaleXPictureAction scaleXPictureAction = new ScaleXPictureAction();
+            ScaleYPictureAction scaleYPictureAction = new ScaleYPictureAction();
+            ShearPictureAction shearPictureAction = new ShearPictureAction();
             // Create plugin buttons and add them to the toolbar
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/GenericPicTransformAction.java

@@ -18 +18 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
-@SuppressWarnings("serial")
+/**
+ * Superclass of transformation actions.
+ */
 public abstract class GenericPicTransformAction extends MapMode implements MouseListener, MouseMotionListener {
 
@@ -35 +37 @@
     }
 
-    public GenericPicTransformAction(String name, String actionName, String iconName,
-            String tooltip, MapFrame mapFrame, Cursor cursor) {
+    public GenericPicTransformAction(String name, String actionName, String iconName, String tooltip, Cursor cursor) {
         super(name, iconName, tooltip, cursor);
         this.actionName = actionName;

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/LoadPictureCalibrationAction.java

@@ -20 +20 @@
  *
  */
-@SuppressWarnings("serial")
 public class LoadPictureCalibrationAction extends JosmAction {
 
@@ -31 +30 @@
     /**
      * Constructor
+     * @param owner Owner layer of the action
      */
     public LoadPictureCalibrationAction(PicLayerAbstract owner) {

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/LoadPictureCalibrationFromWorldAction.java

@@ -14 +14 @@
 import org.openstreetmap.josm.plugins.piclayer.layer.PicLayerAbstract;
 
-@SuppressWarnings("serial")
+/**
+ * Action to import World File Calibration.
+ */
 public class LoadPictureCalibrationFromWorldAction extends JosmAction {
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/ResetCalibrationAction.java

@@ -11 +11 @@
 import org.openstreetmap.josm.plugins.piclayer.transform.PictureTransform;
 
-@SuppressWarnings("serial")
+/**
+ * Action to reset Calibration.
+ */
 public class ResetCalibrationAction extends JosmAction {
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/SavePictureCalibrationAction.java

@@ -22 +22 @@
  * TODO Four almost identical classes. Refactoring needed.
  */
-@SuppressWarnings("serial")
 public class SavePictureCalibrationAction extends JosmAction {
 
@@ -30 +29 @@
     /**
      * Constructor
+     * @param owner Owner layer of the action
      */
     public SavePictureCalibrationAction(PicLayerAbstract owner) {

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/SavePictureCalibrationToWorldAction.java

@@ -17 +17 @@
 import org.openstreetmap.josm.plugins.piclayer.layer.PicLayerAbstract;
 
+/**
+ * Action to export World file Calibration.
+ */
 public class SavePictureCalibrationToWorldAction extends JosmAction {
 
@@ -55 +58 @@
             }
         }
-        
+
         // Save dialog
         final JFileChooser fc = new JFileChooser();
@@ -73 +76 @@
                 for (int i = 0; i < 6; i++) {
                     bw.write(Double.toString(values[i]));
-                    if (i<5) {
+                    if (i < 5) {
                         bw.newLine();
                     }

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/newlayer/NewLayerFromClipboardAction.java

@@ -17 +17 @@
  * the content of the clipboard.
  */
-@SuppressWarnings("serial")
 public class NewLayerFromClipboardAction extends JosmAction {
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/newlayer/NewLayerFromFileAction.java

@@ -29 +29 @@
  * Action responsible for creation of new layers based on image files.
  */
-@SuppressWarnings("serial")
 public class NewLayerFromFileAction extends JosmAction {
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/MovePictureAction.java

@@ -8 +8 @@
 import org.openstreetmap.josm.data.coor.EastNorth;
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -15 +14 @@
  * This class handles the input during moving the picture.
  */
-@SuppressWarnings("serial")
 public class MovePictureAction extends GenericPicTransformAction {
 
@@ -21 +19 @@
      * Constructor
      */
-    public MovePictureAction(MapFrame frame) {
+    public MovePictureAction() {
         super(tr("PicLayer move"), tr("Moved"), "move", tr("Drag to move the picture"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/RotatePictureAction.java

@@ -9 +9 @@
 
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -16 +15 @@
  * This class handles the input during rotating the picture.
  */
-@SuppressWarnings("serial")
 public class RotatePictureAction extends GenericPicTransformAction {
 
@@ -22 +20 @@
      * Constructor
      */
-    public RotatePictureAction(MapFrame frame) {
+    public RotatePictureAction() {
         super(tr("PicLayer rotate"), tr("Rotated"), "rotate", tr("Drag to rotate the picture"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/ScaleXPictureAction.java

@@ -7 +7 @@
 
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -14 +13 @@
  * This class handles the input during scaling the picture.
  */
-@SuppressWarnings("serial")
 public class ScaleXPictureAction extends GenericPicTransformAction {
 
@@ -20 +18 @@
      * Constructor
      */
-    public ScaleXPictureAction(MapFrame frame) {
+    public ScaleXPictureAction() {
         super(tr("PicLayer scale X"), tr("Scaled by X"), "scale_x", tr("Drag to scale the picture in the X Axis"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/ScaleXYPictureAction.java

@@ -9 +9 @@
 
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -16 +15 @@
  * This class handles the input during scaling the picture.
  */
-@SuppressWarnings("serial")
 public class ScaleXYPictureAction extends GenericPicTransformAction {
 
@@ -22 +20 @@
      * Constructor
      */
-    public ScaleXYPictureAction(MapFrame frame) {
+    public ScaleXYPictureAction() {
         super(tr("PicLayer scale"), tr("Scaled"), "scale", tr("Drag to scale the picture in the X and Y Axis"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/ScaleYPictureAction.java

@@ -7 +7 @@
 
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -14 +13 @@
  * This class handles the input during scaling the picture.
  */
-@SuppressWarnings("serial")
 public class ScaleYPictureAction extends GenericPicTransformAction {
 
@@ -20 +18 @@
      * Constructor
      */
-    public ScaleYPictureAction(MapFrame frame) {
+    public ScaleYPictureAction() {
         super(tr("PicLayer scale Y"), tr("Scaled by Y"), "scale_y", tr("Drag to scale the picture in the Y Axis"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/ShearPictureAction.java

@@ -8 +8 @@
 import org.openstreetmap.josm.data.coor.EastNorth;
 import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -15 +14 @@
  * This class handles the input during shearing of the picture.
  */
-@SuppressWarnings("serial")
 public class ShearPictureAction extends GenericPicTransformAction {
 
@@ -21 +19 @@
      * Constructor
      */
-    public ShearPictureAction(MapFrame frame) {
-        super(tr("PicLayer shear"), tr("Sheared"), "shear", tr("Drag to shear the picture"), frame, ImageProvider.getCursor("crosshair", null));
+    public ShearPictureAction() {
+        super(tr("PicLayer shear"), tr("Sheared"), "shear", tr("Drag to shear the picture"), ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/affine/MovePointAction.java

@@ -8 +8 @@
 import java.awt.geom.Point2D;
 
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
 
-// old version - ctrl move point (not transforming picture)
-@SuppressWarnings("serial")
+/**
+ * old version - ctrl move point (not transforming picture)
+ */
 public class MovePointAction extends GenericPicTransformAction {
 
-    public MovePointAction(MapFrame frame) {
+    public MovePointAction() {
         super(tr("PicLayer Move point"), tr("Point added/moved"), "movepoint", tr("Drag or create point on the picture"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/affine/RemovePointAction.java

@@ -6 +6 @@
 import java.awt.event.MouseEvent;
 
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
 
-@SuppressWarnings("serial")
+/**
+ * Remove point on the picture
+ */
 public class RemovePointAction extends GenericPicTransformAction {
 
-    public RemovePointAction(MapFrame frame) {
+    public RemovePointAction() {
         super(tr("PicLayer Remove point"), tr("Point removed"), "removepoint", tr("Remove point on the picture"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/actions/transform/affine/TransformPointAction.java

@@ -8 +8 @@
 import java.awt.geom.Point2D;
 
-import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.plugins.piclayer.actions.GenericPicTransformAction;
 import org.openstreetmap.josm.tools.ImageProvider;
 
-@SuppressWarnings("serial")
+/**
+ * Transform point on the picture
+ */
 public class TransformPointAction extends GenericPicTransformAction {
 
-    public TransformPointAction(MapFrame frame) {
+    public TransformPointAction() {
         super(tr("PicLayer Transform point"), tr("Point transformed"), "transformpoint", tr("Transform point on the picture"),
-                frame, ImageProvider.getCursor("crosshair", null));
+                ImageProvider.getCursor("crosshair", null));
     }
 
@@ -26 +27 @@
             if (selectedPoint != null) {
                 /*if (currentLayer.getTransformer().getOriginPoints().size() < 3)
-                    JOptionPane.showMessageDialog(null, tr("You should have 3 checkpoints to transform the image!"), tr("PicLayer"), JOptionPane.ERROR_MESSAGE, null);
+                    JOptionPane.showMessageDialog(null,
+                    tr("You should have 3 checkpoints to transform the image!"), tr("PicLayer"), JOptionPane.ERROR_MESSAGE, null);
                 else*/
                 //{
-                    currentLayer.getTransformer().updatePair(selectedPoint, pressed);
+                currentLayer.getTransformer().updatePair(selectedPoint, pressed);
                 //}
             }

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/layer/PicLayerAbstract.java

@@ -59 +59 @@
 
     // Initial position of the image in the real world
-//    protected EastNorth initialImagePosition;
+    // protected EastNorth initialImagePosition;
 
     // Position of the image in the real world
@@ -133 +133 @@
      * Initializes the image. Gets the image from a subclass and stores some
      * initial parameters. Throws exception if something fails.
+     * @throws IOException in case of error
      */
     public void initialize() throws IOException {
@@ -169 +170 @@
      *
      * TODO: Replace the IOException by our own exception.
+     * @return created image
+     * @throws IOException in case of error
      */
     protected abstract Image createImage() throws IOException;
@@ -176 +179 @@
     /**
      * To be overridden by subclasses. Returns the user readable name of the layer.
+     * @return the user readable name of the layer
      */
     public abstract String getPicLayerName();
@@ -294 +298 @@
 
     /**
-     * Returns the distance in meter, that corresponds to one unit in east north
-     * space. For normal projections, it is about 1 (but usually changing with
-     * latitude).
-     * For EPSG:4326, it is the distance from one meridian of full degree to the
-     * next (a couple of kilometers).
+     * Returns the distance in meter, that corresponds to one unit in east north space.
+     * For normal projections, it is about 1 (but usually changing with latitude).
+     * For EPSG:4326, it is the distance from one meridian of full degree to the next (a couple of kilometers).
+     * @param en east/north
+     * @return the distance in meter, that corresponds to one unit in east north space
      */
     protected double getMetersPerEasting(EastNorth en) {
@@ -398 +402 @@
     /**
      * Loads calibration data from file
-     * @param file The file to read from
+     * @param is The input stream to read from
+     * @throws IOException in case of error
      */
     public void loadCalibration(InputStream is) throws IOException {
@@ -550 +555 @@
     /**
      * Moves the picture. Scaled in EastNorth...
+     * @param x The offset to add in east direction
+     * @param y The offset to add in north direction
      */
     public void movePictureBy(double x, double y) {

applications/editors/josm/plugins/piclayer/src/org/openstreetmap/josm/plugins/piclayer/transform/PictureTransform.java

@@ -55 +55 @@
 
     /**
-     * updates pair of points (suppose that other pairs are (origin=>origin) points are the same),
+     * updates pair of points (suppose that other pairs are (origin=>origin) points are the same),
      * solves equation,
      * applies transform matrix to the existing cachedTransform