Changeset 16946 in josm

Timestamp:

2020-08-28T20:16:25+02:00 (4 years ago)

Author:

simon04

Message:

fix #19706, fix #19725 - ImageProvider/ImageResource: extract ImageResizeMode, add HiDPI support to bounded/padded icons

Location:

trunk

Files:

• src/org/openstreetmap/josm/tools/HiDPISupport.java (modified) (1 diff)
• src/org/openstreetmap/josm/tools/ImageProvider.java (modified) (3 diffs)
• src/org/openstreetmap/josm/tools/ImageResizeMode.java (added)
• src/org/openstreetmap/josm/tools/ImageResource.java (modified) (9 diffs)
• test/unit/org/openstreetmap/josm/tools/ImageResizeModeTest.java (added)
• test/unit/org/openstreetmap/josm/tools/OsmPrimitiveImageProviderTest.java (modified) (2 diffs)

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

@@ -54 +54 @@
      * @param base the base image
      * @param ir a corresponding image resource
+     * @param resizeMode how to size/resize the image
      * @return multi-resolution image if necessary and possible, the base image otherwise
      */
-    public static Image getMultiResolutionImage(Image base, ImageResource ir) {
+    public static Image getMultiResolutionImage(Image base, ImageResource ir, ImageResizeMode resizeMode) {
         double uiScale = getHiDPIScale();
         if (uiScale != 1.0 && baseMultiResolutionImageConstructor != null) {
             ImageIcon zoomed = ir.getImageIconAlreadyScaled(new Dimension(
                     (int) Math.round(base.getWidth(null) * uiScale),
-                    (int) Math.round(base.getHeight(null) * uiScale)), false, true);
+                    (int) Math.round(base.getHeight(null) * uiScale)), false, true, resizeMode);
             Image mrImg = getMultiResolutionImage(Arrays.asList(base, zoomed.getImage()));
             if (mrImg != null) return mrImg;

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

@@ -660 +660 @@
         }
         if (virtualMaxWidth != -1 || virtualMaxHeight != -1)
-            return ir.getImageIconBounded(new Dimension(virtualMaxWidth, virtualMaxHeight), multiResolution);
+            return ir.getImageIcon(new Dimension(virtualMaxWidth, virtualMaxHeight), multiResolution, ImageResizeMode.BOUNDED);
         else
-            return ir.getImageIcon(new Dimension(virtualWidth, virtualHeight), multiResolution);
+            return ir.getImageIcon(new Dimension(virtualWidth, virtualHeight), multiResolution, ImageResizeMode.AUTO);
     }
 
@@ -1472 +1472 @@
     }
 
-    static BufferedImage createPaddedIcon(Image icon, Dimension iconSize) {
-        int backgroundRealWidth = GuiSizesHelper.getSizeDpiAdjusted(iconSize.width);
-        int backgroundRealHeight = GuiSizesHelper.getSizeDpiAdjusted(iconSize.height);
-        int iconRealWidth = icon.getWidth(null);
-        int iconRealHeight = icon.getHeight(null);
-        BufferedImage image = new BufferedImage(backgroundRealWidth, backgroundRealHeight, BufferedImage.TYPE_INT_ARGB);
-        double scaleFactor = Math.min(
-                backgroundRealWidth / (double) iconRealWidth,
-                backgroundRealHeight / (double) iconRealHeight);
-        Image scaledIcon;
-        final int scaledWidth;
-        final int scaledHeight;
-        if (scaleFactor < 1) {
-            // Scale icon such that it fits on background.
-            scaledWidth = (int) (iconRealWidth * scaleFactor);
-            scaledHeight = (int) (iconRealHeight * scaleFactor);
-            scaledIcon = icon.getScaledInstance(scaledWidth, scaledHeight, Image.SCALE_SMOOTH);
-        } else {
-            // Use original size, don't upscale.
-            scaledWidth = iconRealWidth;
-            scaledHeight = iconRealHeight;
-            scaledIcon = icon;
-        }
-        image.getGraphics().drawImage(scaledIcon,
-                (backgroundRealWidth - scaledWidth) / 2,
-                (backgroundRealHeight - scaledHeight) / 2, null);
-
-        return image;
-    }
-
     /**
      * Constructs an image from the given SVG data.
      * @param svg the SVG data
      * @param dim the desired image dimension
+     * @param resizeMode how to size/resize the image
      * @return an image from the given SVG data at the desired dimension.
      */
-    public static BufferedImage createImageFromSvg(SVGDiagram svg, Dimension dim) {
+    static BufferedImage createImageFromSvg(SVGDiagram svg, Dimension dim, ImageResizeMode resizeMode) {
         if (Logging.isTraceEnabled()) {
             Logging.trace("createImageFromSvg: {0} {1}", svg.getXMLBase(), dim);
@@ -1514 +1485 @@
         final float sourceWidth = svg.getWidth();
         final float sourceHeight = svg.getHeight();
-        final float realWidth;
-        final float realHeight;
-        if (dim.width >= 0) {
-            realWidth = dim.width;
-            if (dim.height >= 0) {
-                realHeight = dim.height;
-            } else {
-                realHeight = sourceHeight * realWidth / sourceWidth;
-            }
-        } else if (dim.height >= 0) {
-            realHeight = dim.height;
-            realWidth = sourceWidth * realHeight / sourceHeight;
-        } else {
-            realWidth = GuiSizesHelper.getSizeDpiAdjusted(sourceWidth);
-            realHeight = GuiSizesHelper.getSizeDpiAdjusted(sourceHeight);
-        }
-
-        int roundedWidth = Math.round(realWidth);
-        int roundedHeight = Math.round(realHeight);
-        if (roundedWidth <= 0 || roundedHeight <= 0 || roundedWidth >= Integer.MAX_VALUE || roundedHeight >= Integer.MAX_VALUE) {
-            Logging.error("createImageFromSvg: {0} {1} realWidth={2} realHeight={3}",
-                    svg.getXMLBase(), dim, Float.toString(realWidth), Float.toString(realHeight));
+        if (sourceWidth <= 0 || sourceHeight <= 0) {
+            Logging.error("createImageFromSvg: {0} {1} sourceWidth={2} sourceHeight={3}", svg.getXMLBase(), dim, sourceWidth, sourceHeight);
             return null;
         }
-        BufferedImage img = new BufferedImage(roundedWidth, roundedHeight, BufferedImage.TYPE_INT_ARGB);
-        Graphics2D g = img.createGraphics();
-        g.setClip(0, 0, img.getWidth(), img.getHeight());
-        g.scale(realWidth / sourceWidth, realHeight / sourceHeight);
-        g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
-        try {
-            synchronized (getSvgUniverse()) {
-                svg.render(g);
-            }
-        } catch (SVGException ex) {
-            Logging.log(Logging.LEVEL_ERROR, "Unable to load svg:", ex);
-            return null;
-        }
-        return img;
+        return resizeMode.createBufferedImage(dim, new Dimension((int) sourceWidth, (int) sourceHeight), g -> {
+            try {
+                synchronized (getSvgUniverse()) {
+                    svg.render(g);
+                }
+            } catch (SVGException ex) {
+                Logging.log(Logging.LEVEL_ERROR, "Unable to load svg:", ex);
+            }
+        });
     }
 

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

@@ -29 +29 @@
 
     /**
-     * Caches the image data for resized versions of the same image.
-     */
-    private final Map<Dimension, BufferedImage> imgCache = new ConcurrentHashMap<>(4);
+     * Caches the image data for resized versions of the same image. The key is obtained using {@link ImageResizeMode#cacheKey(Dimension)}.
+     */
+    private final Map<Integer, BufferedImage> imgCache = new ConcurrentHashMap<>(4);
     /**
      * SVG diagram information in case of SVG vector image.
@@ -138 +138 @@
      *         to set the width, but otherwise scale the image proportionally.
      * @return ImageIcon object for the image of this resource, scaled according to dim
-     * @see #getImageIconBounded(java.awt.Dimension, boolean)
+     * @see #getImageIconBounded(java.awt.Dimension)
      */
     public ImageIcon getImageIcon(Dimension dim) {
-        return getImageIcon(dim, true);
+        return getImageIcon(dim, true, ImageResizeMode.AUTO);
     }
 
@@ -151 +151 @@
      * (java.awt.image.MultiResolutionImage in Java 9), otherwise a plain {@link BufferedImage}.
      * When running Java 8, this flag has no effect and a plain image will be returned in any case.
+     * @param resizeMode how to size/resize the image
      * @return ImageIcon object for the image of this resource, scaled according to dim
      * @since 12722
      */
-    ImageIcon getImageIcon(Dimension dim, boolean multiResolution) {
-        return getImageIconAlreadyScaled(GuiSizesHelper.getDimensionDpiAdjusted(dim), multiResolution, false);
+    ImageIcon getImageIcon(Dimension dim, boolean multiResolution, ImageResizeMode resizeMode) {
+        return getImageIconAlreadyScaled(GuiSizesHelper.getDimensionDpiAdjusted(dim), multiResolution, false, resizeMode);
     }
 
@@ -167 +168 @@
      * When running Java 8, this flag has no effect and a plain image will be returned in any case.
      * @param highResolution whether the high resolution variant should be used for overlays
+     * @param resizeMode how to size/resize the image
      * @return ImageIcon object for the image of this resource, scaled according to dim
      */
-    ImageIcon getImageIconAlreadyScaled(Dimension dim, boolean multiResolution, boolean highResolution) {
+    ImageIcon getImageIconAlreadyScaled(Dimension dim, boolean multiResolution, boolean highResolution, ImageResizeMode resizeMode) {
         CheckParameterUtil.ensureThat((dim.width > 0 || dim.width == -1) && (dim.height > 0 || dim.height == -1),
                 () -> dim + " is invalid");
 
-        BufferedImage img = imgCache.get(dim);
+        final int cacheKey = resizeMode.cacheKey(dim);
+        BufferedImage img = imgCache.get(cacheKey);
         if (img == null) {
             if (svg != null) {
-                img = ImageProvider.createImageFromSvg(svg, dim);
+                img = ImageProvider.createImageFromSvg(svg, dim, resizeMode);
                 if (img == null) {
                     return null;
@@ -182 +185 @@
             } else {
                 if (baseImage == null) throw new AssertionError();
-
                 ImageIcon icon = new ImageIcon(baseImage);
-                if (dim.width == -1 && dim.height == -1) {
-                    dim.width = GuiSizesHelper.getSizeDpiAdjusted(icon.getIconWidth());
-                    dim.height = GuiSizesHelper.getSizeDpiAdjusted(icon.getIconHeight());
-                } else if (dim.width == -1) {
-                    dim.width = Math.max(1, icon.getIconWidth() * dim.height / icon.getIconHeight());
-                } else if (dim.height == -1) {
-                    dim.height = Math.max(1, icon.getIconHeight() * dim.width / icon.getIconWidth());
-                }
-                Image i = icon.getImage().getScaledInstance(dim.width, dim.height, Image.SCALE_SMOOTH);
-                img = new BufferedImage(dim.width, dim.height, BufferedImage.TYPE_INT_ARGB);
-                img.getGraphics().drawImage(i, 0, 0, null);
+                img = resizeMode.createBufferedImage(dim, new Dimension(icon.getIconWidth(), icon.getIconHeight()),
+                        g -> g.drawImage(icon.getImage(), 0, 0, null));
             }
             if (overlayInfo != null) {
@@ -212 +205 @@
                 disabledIcon.paintIcon(new JPanel(), img.getGraphics(), 0, 0);
             }
-            imgCache.put(dim, img);
+            imgCache.put(cacheKey, img);
         }
 
@@ -219 +212 @@
         else {
             try {
-                Image mrImg = HiDPISupport.getMultiResolutionImage(img, this);
+                Image mrImg = HiDPISupport.getMultiResolutionImage(img, this, resizeMode);
                 return new ImageIcon(mrImg);
             } catch (NoClassDefFoundError e) {
@@ -237 +230 @@
      * which means it is not bounded.
      * @return ImageIcon object for the image of this resource, scaled down if needed, according to maxSize
-     * @see #getImageIconBounded(java.awt.Dimension, boolean)
      */
     public ImageIcon getImageIconBounded(Dimension maxSize) {
-        return getImageIconBounded(maxSize, true);
-    }
-
-    /**
-     * Get image icon with a certain maximum size. The image is scaled down
-     * to fit maximum dimensions. (Keeps aspect ratio)
-     *
-     * @param maxSize The maximum size. One of the dimensions (width or height) can be -1,
-     * which means it is not bounded.
-     * @param  multiResolution If true, return a multi-resolution image
-     * (java.awt.image.MultiResolutionImage in Java 9), otherwise a plain {@link BufferedImage}.
-     * When running Java 8, this flag has no effect and a plain image will be returned in any case.
-     * @return ImageIcon object for the image of this resource, scaled down if needed, according to maxSize
-     * @since 12722
-     */
-    public ImageIcon getImageIconBounded(Dimension maxSize, boolean multiResolution) {
-        CheckParameterUtil.ensureThat((maxSize.width > 0 || maxSize.width == -1) && (maxSize.height > 0 || maxSize.height == -1),
-                () -> maxSize + " is invalid");
-        float sourceWidth;
-        float sourceHeight;
-        int maxWidth = maxSize.width;
-        int maxHeight = maxSize.height;
-        if (svg != null) {
-            sourceWidth = svg.getWidth();
-            sourceHeight = svg.getHeight();
-        } else {
-            if (baseImage == null) throw new AssertionError();
-            ImageIcon icon = new ImageIcon(baseImage);
-            sourceWidth = icon.getIconWidth();
-            sourceHeight = icon.getIconHeight();
-            if (sourceWidth <= maxWidth) {
-                maxWidth = -1;
-            }
-            if (sourceHeight <= maxHeight) {
-                maxHeight = -1;
-            }
-        }
-
-        if (maxWidth == -1 && maxHeight == -1)
-            return getImageIcon(DEFAULT_DIMENSION, multiResolution);
-        else if (maxWidth == -1)
-            return getImageIcon(new Dimension(-1, maxHeight), multiResolution);
-        else if (maxHeight == -1)
-            return getImageIcon(new Dimension(maxWidth, -1), multiResolution);
-        else if (sourceWidth / maxWidth > sourceHeight / maxHeight)
-            return getImageIcon(new Dimension(maxWidth, -1), multiResolution);
-        else
-            return getImageIcon(new Dimension(-1, maxHeight), multiResolution);
+        return getImageIcon(maxSize, true, ImageResizeMode.BOUNDED);
     }
 
@@ -297 +242 @@
      */
     public ImageIcon getPaddedIcon(Dimension iconSize) {
-        final ImageIcon imageIcon = getImageIcon(iconSize);
-        if (imageIcon.getIconWidth() == iconSize.width && imageIcon.getIconHeight() == iconSize.height) {
-            // fast path for square and svg icons
-            return imageIcon;
-        }
-
-        final Dimension cacheKey = new Dimension(-iconSize.width, -iconSize.height); // use negative width/height for differentiation
-        BufferedImage image = imgCache.get(cacheKey);
-        if (image == null) {
-            image = ImageProvider.createPaddedIcon(getImageIcon().getImage(), iconSize);
-            imgCache.put(cacheKey, image);
-        }
-        return new ImageIcon(image);
+        return getImageIcon(iconSize, true, ImageResizeMode.PADDED);
     }
 

trunk/test/unit/org/openstreetmap/josm/tools/OsmPrimitiveImageProviderTest.java

@@ -61 +61 @@
         assertNotNull(OsmPrimitiveImageProvider.getResource(OsmUtils.createPrimitive("way waterway=stream"), noDefault));
         assertNotNull(OsmPrimitiveImageProvider.getResource(OsmUtils.createPrimitive("relation type=route route=railway"), noDefault));
-        // a non-square svg icon
+    }
+
+    /**
+     * Unit test of {@link OsmPrimitiveImageProvider#getResource} for non-square images.
+     */
+    @Test
+    public void testGetResourceNonSquare() {
         final ImageIcon bankIcon = OsmPrimitiveImageProvider
                 .getResource(OsmUtils.createPrimitive("node amenity=bank"), Options.DEFAULT)
@@ -67 +73 @@
         assertEquals(ImageProvider.ImageSizes.LARGEICON.getVirtualWidth(), bankIcon.getIconWidth());
         assertEquals(ImageProvider.ImageSizes.LARGEICON.getVirtualHeight(), bankIcon.getIconHeight());
+        final ImageIcon addressIcon = OsmPrimitiveImageProvider
+                .getResource(OsmUtils.createPrimitive("node \"addr:housenumber\"=123"), Options.DEFAULT)
+                .getPaddedIcon(ImageProvider.ImageSizes.LARGEICON.getImageDimension());
+        assertEquals(ImageProvider.ImageSizes.LARGEICON.getVirtualWidth(), addressIcon.getIconWidth());
+        assertEquals(ImageProvider.ImageSizes.LARGEICON.getVirtualHeight(), addressIcon.getIconHeight());
     }
 }