Changeset 18684 in josm

Timestamp:

2023-03-07T17:15:04+01:00 (21 months ago)

Author:

taylor.smock

Message:

Fix #22770: High precision scroll inputs may cause zoom events in the ImageDisplay

This is caused by the mouse wheel rotation being 0 (MouseWheelEvent#getWheelRotation )
which then caused the image viewer to perform a zoom event.

Location:

trunk

Files:

• src/org/openstreetmap/josm/gui/layer/geoimage/ImageDisplay.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/gui/layer/geoimage/ImageDisplayTest.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/layer/geoimage/ImageDisplay.java

@@ -365 +365 @@
                 currentVisibleRect.width = (int) (currentVisibleRect.width * ZOOM_STEP.get());
                 currentVisibleRect.height = (int) (currentVisibleRect.height * ZOOM_STEP.get());
-            } else {
+            } else if (rotation < 0) {
                 currentVisibleRect.width = (int) (currentVisibleRect.width / ZOOM_STEP.get());
                 currentVisibleRect.height = (int) (currentVisibleRect.height / ZOOM_STEP.get());
-            }
+            } // else rotation == 0, which can happen with some modern trackpads (see #22770)
 
             // Check that the zoom doesn't exceed MAX_ZOOM:1

trunk/test/unit/org/openstreetmap/josm/gui/layer/geoimage/ImageDisplayTest.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui.layer.geoimage;
 
+import static org.junit.jupiter.api.Assertions.assertAll;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
 
 import java.awt.Dimension;
 import java.awt.Graphics2D;
 import java.awt.Rectangle;
+import java.awt.event.MouseWheelEvent;
+import java.awt.event.MouseWheelListener;
 import java.awt.image.BufferedImage;
+import java.io.IOException;
+import java.lang.reflect.Field;
 import java.nio.file.DirectoryStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.function.IntFunction;
+import java.util.function.Supplier;
+
+import javax.swing.JPanel;
 
 import org.junit.jupiter.api.Disabled;
@@ -18 +29 @@
 import org.openstreetmap.josm.gui.layer.imagery.ImageryFilterSettings;
 import org.openstreetmap.josm.testutils.annotations.BasicPreferences;
+import org.openstreetmap.josm.tools.ReflectionUtils;
 
 /**
@@ -61 +73 @@
         }
     }
+
+    /**
+     * Non-regression test for #22770 which occurs when a high resolution trackpad does not have a full mouse wheel event
+     */
+    @Test
+    void testNonRegression22770() {
+        final ImageDisplay imageDisplay = new ImageDisplay(new ImageryFilterSettings());
+        final Field visRectField = assertDoesNotThrow(() -> ImageDisplay.class.getDeclaredField("visibleRect"));
+        final Field wheelListenerField = assertDoesNotThrow(() -> ImageDisplay.class.getDeclaredField("imgMouseListener"));
+        ReflectionUtils.setObjectsAccessible(wheelListenerField, visRectField);
+        final Supplier<VisRect> visRectSupplier = () -> new VisRect((VisRect) assertDoesNotThrow(() -> visRectField.get(imageDisplay)));
+        final MouseWheelListener listener = (MouseWheelListener) assertDoesNotThrow(() -> wheelListenerField.get(imageDisplay));
+        final IntFunction<MouseWheelEvent> mouseEventProvider = wheelRotation -> new MouseWheelEvent(new JPanel(), 0, 0, 0,
+                320, 240, 320, 240, 0, false,
+                MouseWheelEvent.WHEEL_UNIT_SCROLL, wheelRotation, wheelRotation, wheelRotation);
+        imageDisplay.setSize(640, 480);
+        imageDisplay.setImage0(new TestImageEntry(640, 480)).run();
+        final VisRect initialVisibleRect = visRectSupplier.get();
+        assertEquals(640, initialVisibleRect.width);
+        assertEquals(480, initialVisibleRect.height);
+        // First, check that zoom in works
+        listener.mouseWheelMoved(mouseEventProvider.apply(-1));
+        assertNotEquals(initialVisibleRect, imageDisplay.getVisibleRect());
+        final VisRect zoomedInVisRect = visRectSupplier.get();
+        // If this fails, check to make certain that geoimage.zoom-step-factor defaults haven't changed
+        assertAll(() -> assertEquals(426, zoomedInVisRect.width),
+                () -> assertEquals(320, zoomedInVisRect.height));
+        // Now check that a zoom event with no wheel rotation does not cause movement
+        listener.mouseWheelMoved(mouseEventProvider.apply(0));
+        final VisRect noZoomVisRect = visRectSupplier.get();
+        assertAll(() -> assertEquals(426, noZoomVisRect.width),
+                () -> assertEquals(320, noZoomVisRect.height));
+
+        // Finally zoom out
+        listener.mouseWheelMoved(mouseEventProvider.apply(1));
+        final VisRect zoomOutVisRect = visRectSupplier.get();
+        assertAll(() -> assertEquals(640, zoomOutVisRect.width),
+                () -> assertEquals(480, zoomOutVisRect.height));
+    }
+
+    private static class TestImageEntry extends ImageEntry {
+        private final int width;
+        private final int height;
+        TestImageEntry(int width, int height) {
+            this.width = width;
+            this.height = height;
+        }
+
+        @Override
+        public int getWidth() {
+            return this.width;
+        }
+
+        @Override
+        public int getHeight() {
+            return this.height;
+        }
+
+        @Override
+        public BufferedImage read(Dimension target) throws IOException {
+            return new BufferedImage(this.width, this.height, BufferedImage.TYPE_INT_RGB);
+        }
+    }
 }