Changeset 12303 in josm for trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/RepeatImageElement.java

Timestamp:

2017-06-02T21:39:27+02:00 (7 years ago)

Author:

michael2402

Message:

Javadoc for package org.openstreetmap.josm.gui.mappaint.styleelement

File:

• trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/RepeatImageElement.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/RepeatImageElement.java

@@ -22 +22 @@
      */
     public enum LineImageAlignment {
+        /**
+         * Align it to the top side of the line
+         */
         TOP(.5),
+        /**
+         * Align it to the center of the line
+         */
         CENTER(0),
+        /**
+         * Align it to the bottom of the line
+         */
         BOTTOM(-.5);
 
@@ -41 +50 @@
     }
 
+    /**
+     * The image to draw on the line repeatedly
+     */
     public MapImage pattern;
+    /**
+     * The offset to the side of the way
+     */
     public float offset;
+    /**
+     * The space between the images
+     */
     public float spacing;
+    /**
+     * The offset of the first image along the way
+     */
     public float phase;
+    /**
+     * The alignment of the image
+     */
     public LineImageAlignment align;
 
@@ -50 +74 @@
             null, null};
 
+    /**
+     * Create a new image element
+     * @param c The cascade
+     * @param pattern The image to draw on the line repeatedly
+     * @param offset The offset to the side of the way
+     * @param spacing The space between the images
+     * @param phase The offset of the first image along the way
+     * @param align The alignment of the image
+     */
     public RepeatImageElement(Cascade c, MapImage pattern, float offset, float spacing, float phase, LineImageAlignment align) {
         super(c, 2.9f);
@@ -61 +94 @@
     }
 
+    /**
+     * Create a RepeatImageElement from the given environment
+     * @param env The environment
+     * @return The image style element or <code>null</code> if none should be painted
+     */
     public static RepeatImageElement create(Environment env) {
         MapImage pattern = NodeElement.createIcon(env, REPEAT_IMAGE_KEYS);