Changeset 4271 in josm

Timestamp:

Jul 27, 2011 9:23:35 PM (22 months ago)

Author:

bastiK

Message:

extend image caching and add support for scaled svg images (see #6560)

Location:

trunk/src/org/openstreetmap/josm/tools

Files:

• ImageProvider.java (modified) (15 diffs)
• ImageRequest.java (added)
• ImageResource.java (added)

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

@@ -10 +10 @@
 import java.awt.Component;
 import java.awt.Cursor;
+import java.awt.Dimension;
 import java.awt.Graphics;
 import java.awt.Graphics2D;
@@ -42 +43 @@
 
 /**
- * Helperclass to support the application with images.
+ * Helper class to support the application with images.
  * @author imi
  */
@@ -59 +60 @@
     public static enum ImageType {
         SVG,    // scalable vector graphics
-        OTHER   // everything else, e.g. png, gif
-                // must be supported by Java
-    }
-
-    /**
-     * remember whether the image has been sanitized
-     */
-    private static class ImageWrapper {
-        Image img;
-        boolean sanitized;
-
-        public ImageWrapper(Image img, boolean sanitized) {
-            this.img = img;
-            this.sanitized = sanitized;
-        }
+        OTHER   // everything else, e.g. png, gif (must be supported by Java)
     }
 
@@ -79 +66 @@
      * The icon cache
      */
-    private static Map<String, ImageWrapper> cache = new HashMap<String, ImageWrapper>();
+    private static Map<String, ImageResource> cache = new HashMap<String, ImageResource>();
 
     /**
@@ -127 +114 @@
     }
 
+    public static ImageIcon getIfAvailable(Collection<String> dirs, String id, String subdir, String name, File archive, boolean sanitize) {
+        return getIfAvailable(dirs, id, subdir, name, archive, null, sanitize);
+    }
+    
     /**
      * The full path of the image is either a url (starting with http://)
@@ -137 +128 @@
      *                  it will try both extensions.
      * @param archive   A zip file where the image is located (may be null).
+     * @param dim       The dimensions of the image if it should be scaled. null if the
+     *                  original size of the image should be returned. The width 
+     *                  part of the dimension can be -1. Then it will scale the width
+     *                  in the same way as the height. (And the other way around.)
      * @param sanitize  If the image should be repainted to a new BufferedImage to work
      *                  around certain issues.
      */
-    public static ImageIcon getIfAvailable(Collection<String> dirs, String id, String subdir, String name, File archive, boolean sanitize) {
-        ImageWrapper iw = getIfAvailableImpl(dirs, id, subdir, name, archive);
-        if (iw == null)
+    public static ImageIcon getIfAvailable(Collection<String> dirs, String id, String subdir, String name, File archive, Dimension dim, boolean sanitize) {
+        ImageResource ir = getIfAvailableImpl(dirs, id, subdir, name, archive);
+        if (ir == null)
             return null;
-        if (sanitize && !iw.sanitized) {
-            iw.img = sanitize(iw.img);
-            iw.sanitized = true;
-        }
-        return new ImageIcon(iw.img);
-    }
-
-    private static ImageWrapper getIfAvailableImpl(Collection<String> dirs, String id, String subdir, String name, File archive) {
+        return ir.getImageIcon(dim == null ? ImageResource.DEFAULT_DIMENSION : dim, sanitize);
+    }
+
+    private static ImageResource getIfAvailableImpl(Collection<String> dirs, String id, String subdir, String name, File archive) {
         if (name == null)
             return null;
@@ -158 +149 @@
         if (name.startsWith("http://")) {
             String url = name;
-            ImageWrapper iw = cache.get(url);
-            if (iw != null) return iw;
-            iw = getIfAvailableHttp(url, type);
-            if (iw != null) {
-                cache.put(url, iw);
-            }
-            return iw;
+            ImageResource ir = cache.get(url);
+            if (ir != null) return ir;
+            ir = getIfAvailableHttp(url, type);
+            if (ir != null) {
+                cache.put(url, ir);
+            }
+            return ir;
         }
 
@@ -198 +189 @@
                 }
 
-                ImageWrapper iw = cache.get(cache_name);
-                if (iw != null) return iw;
+                ImageResource ir = cache.get(cache_name);
+                if (ir != null) return ir;
 
                 switch (place) {
                     case ARCHIVE:
                         if (archive != null) {
-                            iw = getIfAvailableZip(full_name, archive, type);
-                            if (iw != null) {
-                                cache.put(cache_name, iw);
-                                return iw;
+                            ir = getIfAvailableZip(full_name, archive, type);
+                            if (ir != null) {
+                                cache.put(cache_name, ir);
+                                return ir;
                             }
                         }
@@ -220 +211 @@
                         if (path == null)
                             continue;
-                        iw = getIfAvailableLocalURL(path, type);
-                        if (iw != null) {
-                            cache.put(cache_name, iw);
-                            return iw;
+                        ir = getIfAvailableLocalURL(path, type);
+                        if (ir != null) {
+                            cache.put(cache_name, ir);
+                            return ir;
                         }
                         break;
@@ -232 +223 @@
     }
 
-    private static ImageWrapper getIfAvailableHttp(String url, ImageType type) {
-        Image img = null;
+    private static ImageResource getIfAvailableHttp(String url, ImageType type) {
         try {
             MirroredInputStream is = new MirroredInputStream(url,
@@ -240 +230 @@
                 case SVG:
                     URI uri = getSvgUniverse().loadSVG(is, is.getFile().toURI().toURL().toString());
-                    img = createImageFromSvgUri(uri);
-                    break;
+                    SVGDiagram svg = getSvgUniverse().getDiagram(uri);
+                    return svg == null ? null : new ImageResource(svg);
                 case OTHER:
-                    img = Toolkit.getDefaultToolkit().createImage(is.getFile().toURI().toURL());
-                    break;
+                    Image img = Toolkit.getDefaultToolkit().createImage(is.getFile().toURI().toURL());
+                    return img == null ? null : new ImageResource(img, false);
+                default:
+                    throw new AssertionError();
             }
         } catch (IOException e) {
-        }
-        return img == null ? null : new ImageWrapper(img, false);
-    }
-
-    private static ImageWrapper getIfAvailableZip(String full_name, File archive, ImageType type) {
+            return null;
+        }
+    }
+
+    private static ImageResource getIfAvailableZip(String full_name, File archive, ImageType type) {
         ZipFile zipFile = null;
-        Image img = null;
         try
         {
@@ -269 +260 @@
                         case SVG:
                             URI uri = getSvgUniverse().loadSVG(is, full_name);
-                            img = createImageFromSvgUri(uri);
-                            break;
+                            SVGDiagram svg = getSvgUniverse().getDiagram(uri);
+                            return svg == null ? null : new ImageResource(svg);
                         case OTHER:
                             while(size > 0)
@@ -278 +269 @@
                                 size -= l;
                             }
-                            img = Toolkit.getDefaultToolkit().createImage(buf);
-                            break;
+                            Image img = Toolkit.getDefaultToolkit().createImage(buf);
+                            return img == null ? null : new ImageResource(img, false);
+                        default:
+                            throw new AssertionError();
                     }
                 } finally {
@@ -297 +290 @@
             }
         }
-        return img == null ? null : new ImageWrapper(img, false);
-    }
-
-    private static ImageWrapper getIfAvailableLocalURL(URL path, ImageType type) {
-        Image img = null;
+        return null;
+    }
+
+    private static ImageResource getIfAvailableLocalURL(URL path, ImageType type) {
         switch (type) {
             case SVG:
                 URI uri = getSvgUniverse().loadSVG(path);
-                img = createImageFromSvgUri(uri);
-                break;
+                SVGDiagram svg = getSvgUniverse().getDiagram(uri);
+                return svg == null ? null : new ImageResource(svg);
             case OTHER:
-                img = Toolkit.getDefaultToolkit().createImage(path);
-                break;
-        }
-        return img == null ? null : new ImageWrapper(img, false);
+                Image img = Toolkit.getDefaultToolkit().createImage(path);
+                return img == null ? null : new ImageResource(img, false);
+            default:
+                throw new AssertionError();
+        }
     }
 
@@ -521 +514 @@
     }
 
-    private static Image createImageFromSvgUri(URI uri) {
-        SVGDiagram dia = getSvgUniverse().getDiagram(uri);
-        int w = (int)dia.getWidth();
-        int h = (int)dia.getHeight();
-        Image img = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
+    public static Image createImageFromSvg(SVGDiagram svg, Dimension dim) {
+        float realWidth = svg.getWidth();
+        float realHeight = svg.getHeight();
+        int width = Math.round(realWidth);
+        int height = Math.round(realHeight);
+        Double scaleX = null, scaleY = null;
+        if (dim.width != -1) {
+            width = dim.width;
+            scaleX = (double) width / realWidth;
+            if (dim.height == -1) {
+                scaleY = scaleX;
+                height = (int) Math.round(realHeight * scaleY);
+            } else {
+                height = dim.height;
+                scaleY = (double) height / realHeight;
+            }
+        } else if (dim.height != -1) {
+            height = dim.height;
+            scaleX = scaleY = (double) height / realHeight;
+            width = (int) Math.round(realWidth * scaleX);
+        }
+        Image img = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB);
         Graphics2D g = ((BufferedImage) img).createGraphics();
-        g.setClip(0, 0, w, h);
+        g.setClip(0, 0, width, height);
+        if (scaleX != null) {
+            g.scale(scaleX, scaleY);
+        }
         g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
         try {
-            dia.render(g);
+            svg.render(g);
         } catch (SVGException ex) {
             return null;