Changeset 6172 in josm for trunk/src/org/openstreetmap/josm/tools

Timestamp:

2013-08-21T18:15:12+02:00 (11 years ago)

Author:

Don-vip

Message:

fix #8849:

• Used scaled down (16x16 pixels) of large (.svg) images if no size is explicitely defined
• rendering of emergency=aed with recently added svg
• optimizations/refactoring in icons rotating/rescaling code
• fix of various warnings, javadoc

File:

• trunk/src/org/openstreetmap/josm/tools/ImageProvider.java (modified) (23 diffs)

trunk/src/org/openstreetmap/josm/tools/ImageProvider.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
-import java.awt.Component;
 import java.awt.Cursor;
 import java.awt.Dimension;
@@ -83 +82 @@
     }
 
+    /**
+     * Supported image types
+     */
     public static enum ImageType {
-        SVG,    // scalable vector graphics
-        OTHER   // everything else, e.g. png, gif (must be supported by Java)
+        /** Scalable vector graphics */
+        SVG,
+        /** Everything else, e.g. png, gif (must be supported by Java) */
+        OTHER
     }
 
@@ -107 +111 @@
      * The icon cache
      */
-    private static Map<String, ImageResource> cache = new HashMap<String, ImageResource>();
-
-    private final static ExecutorService imageFetcher = Executors.newSingleThreadExecutor();
+    private static final Map<String, ImageResource> cache = new HashMap<String, ImageResource>();
+
+    /**
+     * Caches the image data for rotated versions of the same image.
+     */
+    private static final Map<Image, Map<Long, ImageResource>> rotateCache = new HashMap<Image, Map<Long, ImageResource>>();
+
+    private static final ExecutorService imageFetcher = Executors.newSingleThreadExecutor();
 
     public interface ImageCallback {
@@ -116 +125 @@
 
     /**
+     * Constructs a new {@code ImageProvider} from a filename in a given directory.
      * @param subdir    subdirectory the image lies in
      * @param name      the name of the image. If it does not end with '.png' or '.svg',
@@ -125 +135 @@
     }
 
+    /**
+     * Constructs a new {@code ImageProvider} from a filename.
+     * @param name      the name of the image. If it does not end with '.png' or '.svg',
+     *                  both extensions are tried.
+     */
     public ImageProvider(String name) {
         this.name = name;
@@ -131 +146 @@
     /**
      * Directories to look for the image.
+     * @param dirs The directories to look for.
+     * @return the current object, for convenience
      */
     public ImageProvider setDirs(Collection<String> dirs) {
@@ -141 +158 @@
      * If name starts with <tt>http://</tt> Id is not used for the cache.
      * (A URL is unique anyway.)
+     * @return the current object, for convenience
      */
     public ImageProvider setId(String id) {
@@ -151 +169 @@
      *
      * (optional)
+     * @return the current object, for convenience
      */
     public ImageProvider setArchive(File archive) {
@@ -163 +182 @@
      *
      * (optional)
+     * @return the current object, for convenience
      */
     public ImageProvider setInArchiveDir(String inArchiveDir) {
@@ -175 +195 @@
      * The width part of the dimension can be -1. Then it will only set the height but
      * keep the aspect ratio. (And the other way around.)
+     * @return the current object, for convenience
      */
     public ImageProvider setSize(Dimension size) {
@@ -184 +205 @@
     /**
      * @see #setSize
+     * @return the current object, for convenience
      */
     public ImageProvider setWidth(int width) {
@@ -192 +214 @@
     /**
      * @see #setSize
+     * @return the current object, for convenience
      */
     public ImageProvider setHeight(int height) {
@@ -205 +228 @@
      *
      * 'size' and 'maxSize' are not compatible, you should set only one of them.
+     * @return the current object, for convenience
      */
     public ImageProvider setMaxSize(Dimension maxSize) {
@@ -214 +238 @@
     /**
      * Convenience method, see {@link #setMaxSize(Dimension)}.
+     * @return the current object, for convenience
      */
     public ImageProvider setMaxSize(int maxSize) {
@@ -221 +246 @@
     /**
      * @see #setMaxSize
+     * @return the current object, for convenience
      */
     public ImageProvider setMaxWidth(int maxWidth) {
@@ -229 +255 @@
     /**
      * @see #setMaxSize
+     * @return the current object, for convenience
      */
     public ImageProvider setMaxHeight(int maxHeight) {
@@ -253 +280 @@
      *
      * In combination with setOptional(true);
+     * @return the current object, for convenience
      */
     public ImageProvider setSuppressWarnings(boolean suppressWarnings) {
@@ -261 +289 @@
     /**
      * Add a collection of additional class loaders to search image for.
+     * @return the current object, for convenience
      */
     public ImageProvider setAdditionalClassLoaders(Collection<ClassLoader> additionalClassLoaders) {
@@ -388 +417 @@
                 }
             } catch (UnsupportedEncodingException ex) {
-                throw new RuntimeException(ex.getMessage(), ex);
-            } catch (IOException ex) {
                 throw new RuntimeException(ex.getMessage(), ex);
             }
@@ -482 +509 @@
 
     private static ImageResource getIfAvailableHttp(String url, ImageType type) {
+        MirroredInputStream is = null;
         try {
-            MirroredInputStream is = new MirroredInputStream(url,
+            is = new MirroredInputStream(url,
                     new File(Main.pref.getCacheDirectory(), "images").getPath());
             switch (type) {
@@ -501 +529 @@
         } catch (IOException e) {
             return null;
+        } finally {
+            Utils.close(is);
         }
     }
@@ -791 +821 @@
      * Creates a rotated version of the input image.
      *
-     * @param c The component to get properties useful for painting, e.g. the foreground or
-     * background color.
      * @param img the image to be rotated.
      * @param rotatedAngle the rotated angle, in degree, clockwise. It could be any double but we
-     * will mod it with 360 before using it.
+     * will mod it with 360 before using it. More over for caching performance, it will be rounded to 
+     * an entire value between 0 and 360.
      *
      * @return the image after rotating.
-     */
-    public static Image createRotatedImage(Component c, Image img, double rotatedAngle) {
-        // convert rotatedAngle to a value from 0 to 360
-        double originalAngle = rotatedAngle % 360;
+     * @since 6172
+     */
+    public static Image createRotatedImage(Image img, double rotatedAngle) {
+        return createRotatedImage(img, rotatedAngle, ImageResource.DEFAULT_DIMENSION);
+    }
+    
+    /**
+     * Creates a rotated version of the input image, scaled to the given dimension.
+     *
+     * @param img the image to be rotated.
+     * @param rotatedAngle the rotated angle, in degree, clockwise. It could be any double but we
+     * will mod it with 360 before using it. More over for caching performance, it will be rounded to 
+     * an entire value between 0 and 360.
+     * @param dimension The requested dimensions. Use (-1,-1) for the original size
+     * and (width, -1) to set the width, but otherwise scale the image proportionally.
+     * @return the image after rotating and scaling.
+     * @since 6172
+     */
+    public static Image createRotatedImage(Image img, double rotatedAngle, Dimension dimension) {
+        CheckParameterUtil.ensureParameterNotNull(img, "img");
+        
+        // convert rotatedAngle to an integer value from 0 to 360
+        Long originalAngle = Math.round(rotatedAngle % 360);
         if (rotatedAngle != 0 && originalAngle == 0) {
-            originalAngle = 360.0;
-        }
-
-        // convert originalAngle to a value from 0 to 90
-        double angle = originalAngle % 90;
-        if (originalAngle != 0.0 && angle == 0.0) {
-            angle = 90.0;
-        }
-
-        double radian = Math.toRadians(angle);
-
-        new ImageIcon(img); // load completely
-        int iw = img.getWidth(null);
-        int ih = img.getHeight(null);
-        int w;
-        int h;
-
-        if ((originalAngle >= 0 && originalAngle <= 90) || (originalAngle > 180 && originalAngle <= 270)) {
-            w = (int) (iw * Math.sin(DEGREE_90 - radian) + ih * Math.sin(radian));
-            h = (int) (iw * Math.sin(radian) + ih * Math.sin(DEGREE_90 - radian));
-        } else {
-            w = (int) (ih * Math.sin(DEGREE_90 - radian) + iw * Math.sin(radian));
-            h = (int) (ih * Math.sin(radian) + iw * Math.sin(DEGREE_90 - radian));
-        }
-        BufferedImage image = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
-        Graphics g = image.getGraphics();
-        Graphics2D g2d = (Graphics2D) g.create();
-
-        // calculate the center of the icon.
-        int cx = iw / 2;
-        int cy = ih / 2;
-
-        // move the graphics center point to the center of the icon.
-        g2d.translate(w / 2, h / 2);
-
-        // rotate the graphics about the center point of the icon
-        g2d.rotate(Math.toRadians(originalAngle));
-
-        g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC);
-        g2d.drawImage(img, -cx, -cy, c);
-
-        g2d.dispose();
-        new ImageIcon(image); // load completely
-        return image;
+            originalAngle = 360L;
+        }
+        
+        ImageResource imageResource = null;
+
+        synchronized (rotateCache) {
+            Map<Long, ImageResource> cacheByAngle = rotateCache.get(img);
+            if (cacheByAngle == null) {
+                rotateCache.put(img, cacheByAngle = new HashMap<Long, ImageResource>());
+            }
+            
+            imageResource = cacheByAngle.get(originalAngle);
+            
+            if (imageResource == null) {
+                // convert originalAngle to a value from 0 to 90
+                double angle = originalAngle % 90;
+                if (originalAngle != 0.0 && angle == 0.0) {
+                    angle = 90.0;
+                }
+        
+                double radian = Math.toRadians(angle);
+        
+                new ImageIcon(img); // load completely
+                int iw = img.getWidth(null);
+                int ih = img.getHeight(null);
+                int w;
+                int h;
+        
+                if ((originalAngle >= 0 && originalAngle <= 90) || (originalAngle > 180 && originalAngle <= 270)) {
+                    w = (int) (iw * Math.sin(DEGREE_90 - radian) + ih * Math.sin(radian));
+                    h = (int) (iw * Math.sin(radian) + ih * Math.sin(DEGREE_90 - radian));
+                } else {
+                    w = (int) (ih * Math.sin(DEGREE_90 - radian) + iw * Math.sin(radian));
+                    h = (int) (ih * Math.sin(radian) + iw * Math.sin(DEGREE_90 - radian));
+                }
+                Image image = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
+                cacheByAngle.put(originalAngle, imageResource = new ImageResource(image));
+                Graphics g = image.getGraphics();
+                Graphics2D g2d = (Graphics2D) g.create();
+        
+                // calculate the center of the icon.
+                int cx = iw / 2;
+                int cy = ih / 2;
+        
+                // move the graphics center point to the center of the icon.
+                g2d.translate(w / 2, h / 2);
+        
+                // rotate the graphics about the center point of the icon
+                g2d.rotate(Math.toRadians(originalAngle));
+        
+                g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC);
+                g2d.drawImage(img, -cx, -cy, null);
+        
+                g2d.dispose();
+                new ImageIcon(image); // load completely
+            }
+            return imageResource.getImageIcon(dimension).getImage();
+        }
+    }
+    
+    /**
+     * Creates a scaled down version of the input image to fit maximum dimensions. (Keeps aspect ratio)
+     *
+     * @param img the image to be scaled down.
+     * @param maxSize the maximum size in pixels (both for width and height) 
+     *
+     * @return the image after scaling.
+     * @since 6172
+     */
+    public static Image createBoundedImage(Image img, int maxSize) {
+        return new ImageResource(img).getImageIconBounded(new Dimension(maxSize, maxSize)).getImage();
     }
 
@@ -886 +961 @@
         Graphics2D g = img.createGraphics();
         g.setClip(0, 0, width, height);
-        if (scaleX != null) {
+        if (scaleX != null && scaleY != null) {
             g.scale(scaleX, scaleY);
         }