Changeset 10031 in josm

Timestamp:

2016-03-23T21:30:27+01:00 (9 years ago)

Author:

Don-vip

Message:

fix #12654 - Add layer invalidation listener (patch by michael2402)

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/mapmode/ImproveWayAccuracyAction.java (modified) (12 diffs)
• gui/MapView.java (modified) (9 diffs)
• gui/SelectionManager.java (modified) (4 diffs)
• gui/layer/AbstractMapViewPaintable.java (added)
• gui/layer/Layer.java (modified) (1 diff)
• gui/layer/MapViewPaintable.java (modified) (1 diff)
• gui/layer/OsmDataLayer.java (modified) (2 diffs)
• gui/layer/geoimage/GeoImageLayer.java (modified) (1 diff)
• gui/layer/markerlayer/MarkerLayer.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/actions/mapmode/ImproveWayAccuracyAction.java

@@ -39 +39 @@
 import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.gui.MapView;
+import org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable;
 import org.openstreetmap.josm.gui.layer.Layer;
-import org.openstreetmap.josm.gui.layer.MapViewPaintable;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
 import org.openstreetmap.josm.gui.util.GuiHelper;
@@ -51 +51 @@
  * @author Alexander Kachkaev <alexander@kachkaev.ru>, 2011
  */
-public class ImproveWayAccuracyAction extends MapMode implements MapViewPaintable,
+public class ImproveWayAccuracyAction extends MapMode implements
         SelectionChangedListener, ModifierListener {
 
@@ -90 +90 @@
 
     protected String oldModeHelpText;
+
+    private final AbstractMapViewPaintable temporaryLayer = new AbstractMapViewPaintable() {
+        @Override
+        public void paint(Graphics2D g, MapView mv, Bounds bbox) {
+            ImproveWayAccuracyAction.this.paint(g, mv, bbox);;
+        }
+    };
 
     /**
@@ -136 +143 @@
         Main.map.mapView.addMouseListener(this);
         Main.map.mapView.addMouseMotionListener(this);
-        Main.map.mapView.addTemporaryLayer(this);
+        Main.map.mapView.addTemporaryLayer(temporaryLayer);
         DataSet.addSelectionListener(this);
 
@@ -161 +168 @@
         Main.map.mapView.removeMouseListener(this);
         Main.map.mapView.removeMouseMotionListener(this);
-        Main.map.mapView.removeTemporaryLayer(this);
+        Main.map.mapView.removeTemporaryLayer(temporaryLayer);
         DataSet.removeSelectionListener(this);
 
         Main.map.keyDetector.removeModifierListener(this);
-        Main.map.mapView.repaint();
+        temporaryLayer.invalidate();
     }
 
@@ -213 +220 @@
      * Redraws temporary layer. Highlights targetWay in select mode. Draws
      * preview lines in improve mode and highlights the candidateNode
+     * @param g The graphics
+     * @param mv The map view
+     * @param bbox The bounding box
      */
-    @Override
     public void paint(Graphics2D g, MapView mv, Bounds bbox) {
         if (mousePos == null) {
@@ -357 +366 @@
         updateCursor();
         updateStatusLine();
-        Main.map.mapView.repaint();
+        temporaryLayer.invalidate();
     }
 
@@ -386 +395 @@
         updateCursor();
         updateStatusLine();
-        Main.map.mapView.repaint();
+        temporaryLayer.invalidate();
     }
 
@@ -512 +521 @@
         updateCursor();
         updateStatusLine();
-        Main.map.mapView.repaint();
+        temporaryLayer.invalidate();
     }
 
@@ -524 +533 @@
             mousePos = null;
         }
-        Main.map.mapView.repaint();
+        temporaryLayer.invalidate();
     }
 
@@ -598 +607 @@
         targetWay = null;
 
-        mv.repaint();
+        temporaryLayer.invalidate();
         updateStatusLine();
     }
@@ -623 +632 @@
         this.candidateSegment = null;
 
-        mv.repaint();
+        temporaryLayer.invalidate();
         updateStatusLine();
     }

trunk/src/org/openstreetmap/josm/gui/MapView.java

@@ -55 +55 @@
 import org.openstreetmap.josm.data.osm.visitor.paint.Rendering;
 import org.openstreetmap.josm.data.osm.visitor.paint.relations.MultipolygonCache;
+import org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable;
 import org.openstreetmap.josm.gui.layer.GpxLayer;
 import org.openstreetmap.josm.gui.layer.ImageryLayer;
@@ -60 +61 @@
 import org.openstreetmap.josm.gui.layer.LayerPositionStrategy;
 import org.openstreetmap.josm.gui.layer.MapViewPaintable;
+import org.openstreetmap.josm.gui.layer.MapViewPaintable.PaintableInvalidationEvent;
+import org.openstreetmap.josm.gui.layer.MapViewPaintable.PaintableInvalidationListener;
 import org.openstreetmap.josm.gui.layer.NativeScaleLayer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
@@ -125 +128 @@
     }
 
+    /**
+     * An invalidation listener that simply calls repaint() for now.
+     * @author Michael Zangl
+     */
+    private class LayerInvalidatedListener implements PaintableInvalidationListener {
+        private boolean ignoreRepaint;
+        @Override
+        public void paintablInvalidated(PaintableInvalidationEvent event) {
+            ignoreRepaint = true;
+            repaint();
+        }
+
+        /**
+         * Temporary until all {@link MapViewPaintable}s support this.
+         * @param p The paintable.
+         */
+        public void addTo(MapViewPaintable p) {
+            if (p instanceof AbstractMapViewPaintable) {
+                ((AbstractMapViewPaintable) p).addInvalidationListener(this);
+            }
+        }
+        /**
+         * Temporary until all {@link MapViewPaintable}s support this.
+         * @param p The paintable.
+         */
+        public void removeFrom(MapViewPaintable p) {
+            if (p instanceof AbstractMapViewPaintable) {
+                ((AbstractMapViewPaintable) p).removeInvalidationListener(this);
+            }
+        }
+
+        /**
+         * Attempts to trace repaints that did not originate from this listener. Good to find missed {@link MapView#repaint()}s in code.
+         */
+        protected synchronized void traceRandomRepaint() {
+            if (!ignoreRepaint) {
+                System.err.println("Repaint:");
+                Thread.dumpStack();
+            }
+            ignoreRepaint = false;
+        }
+    }
+
     public boolean viewportFollowing;
 
@@ -269 +315 @@
 
     /**
+     * The listener that listens to invalidations of all layers.
+     */
+    private final LayerInvalidatedListener invalidatedListener = new LayerInvalidatedListener();
+
+    /**
      * Constructs a new {@code MapView}.
      * @param contentPane The content pane used to register shortcuts in its
@@ -382 +433 @@
 
             layer.addPropertyChangeListener(this);
+            invalidatedListener.addTo(layer);
             Main.addProjectionChangeListener(layer);
             AudioPlayer.reset();
@@ -506 +558 @@
             Main.removeProjectionChangeListener(layer);
             layer.removePropertyChangeListener(this);
+            invalidatedListener.removeFrom(layer);
             layer.destroy();
             AudioPlayer.reset();
@@ -1035 +1088 @@
     public boolean addTemporaryLayer(MapViewPaintable mvp) {
         synchronized (temporaryLayers) {
-            return temporaryLayers.add(mvp);
+            boolean added = temporaryLayers.add(mvp);
+            if (added) {
+                invalidatedListener.addTo(mvp);
+            }
+            return added;
         }
     }
@@ -1046 +1103 @@
     public boolean removeTemporaryLayer(MapViewPaintable mvp) {
         synchronized (temporaryLayers) {
-            return temporaryLayers.remove(mvp);
+            boolean removed = temporaryLayers.remove(mvp);
+            if (removed) {
+                invalidatedListener.removeFrom(mvp);
+            }
+            return removed;
         }
     }
@@ -1206 +1267 @@
         super.repaint(tm, x, y, width, height);
     }
+
+    @Override
+    public void repaint() {
+        if (Main.isTraceEnabled()) {
+            invalidatedListener.traceRandomRepaint();
+        }
+        super.repaint();
+    }
 }

trunk/src/org/openstreetmap/josm/gui/SelectionManager.java

@@ -23 +23 @@
 import org.openstreetmap.josm.data.osm.Way;
 import org.openstreetmap.josm.data.osm.visitor.paint.PaintColors;
-import org.openstreetmap.josm.gui.layer.MapViewPaintable;
+import org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable;
 import org.openstreetmap.josm.tools.Utils;
 
@@ -89 +89 @@
      * @author Michael Zangl
      */
-    private class SelectionHintLayer implements MapViewPaintable {
+    private class SelectionHintLayer extends AbstractMapViewPaintable {
         @Override
         public void paint(Graphics2D g, MapView mv, Bounds bbox) {
@@ -368 +368 @@
     }
 
-    private static void selectionAreaChanged() {
-        // Trigger a redraw of the map view.
-        // A nicer way would be to provide change events for the temporary layer.
-        Main.map.mapView.repaint();
+    private void selectionAreaChanged() {
+        selectionHintLayer.invalidate();
     }
 
@@ -383 +381 @@
      */
     public Collection<OsmPrimitive> getSelectedObjects(boolean alt) {
-
         Collection<OsmPrimitive> selection = new LinkedList<>();
 

trunk/src/org/openstreetmap/josm/gui/layer/Layer.java

@@ -48 +48 @@
  * @author imi
  */
-public abstract class Layer implements Destroyable, MapViewPaintable, ProjectionChangeListener {
+public abstract class Layer extends AbstractMapViewPaintable implements Destroyable, ProjectionChangeListener {
 
     /**

trunk/src/org/openstreetmap/josm/gui/layer/MapViewPaintable.java

@@ -7 +7 @@
 import org.openstreetmap.josm.gui.MapView;
 
+/**
+ * This is a component that can be painted on the map view.
+ * <p>
+ * You might want to extend {@link AbstractMapViewPaintable} to ease implementation of this.
+ * <p>
+ * That class allows you to listen to paintable change events. Those methods may be moved here some time in the future.
+ */
 public interface MapViewPaintable {
+
+    /**
+     * This event is fired whenever the paintable got invalidated and needs repainting some time in the future.
+     * <p>
+     * Note: We might add an area in the future.
+     *
+     * @author Michael Zangl
+     */
+    class PaintableInvalidationEvent {
+        private final MapViewPaintable paintable;
+
+        /**
+         * Creates a new {@link PaintableInvalidationEvent}
+         * @param paintable The paintable that is invalidated.
+         */
+        public PaintableInvalidationEvent(MapViewPaintable paintable) {
+            super();
+            this.paintable = paintable;
+        }
+
+        /**
+         * Gets the layer that was invalidated.
+         * @return The layer.
+         */
+        public MapViewPaintable getLayer() {
+            return paintable;
+        }
+
+        @Override
+        public String toString() {
+            return "LayerInvalidationEvent [layer=" + paintable + "]";
+        }
+    }
+
+    /**
+     * This is a listener that listens to {@link PaintableInvalidationEvent}s
+     * @author Michael Zangl
+     */
+    interface PaintableInvalidationListener {
+        /**
+         * Called whenever a {@link PaintableInvalidationEvent} is fired. This might be called from any thread.
+         * @param event The event
+         */
+        void paintablInvalidated(PaintableInvalidationEvent event);
+    }
 
     /**

trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java

@@ -917 +917 @@
     @Override
     public void processDatasetEvent(AbstractDatasetChangedEvent event) {
-        isChanged = true;
+        invalidate();
         setRequiresSaveToFile(true);
         setRequiresUploadToServer(true);
@@ -924 +924 @@
     @Override
     public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
+        invalidate();
+    }
+
+    @Override
+    public void invalidate() {
         isChanged = true;
+        super.invalidate();
     }
 

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

@@ -970 +970 @@
     public void updateBufferAndRepaint() {
         updateOffscreenBuffer = true;
-        Main.map.mapView.repaint();
+        invalidate();
     }
 

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerLayer.java

@@ -158 +158 @@
                 mousePressed  = true;
                 if (isVisible()) {
-                    Main.map.mapView.repaint();
+                    invalidate();
                 }
             }
@@ -176 +176 @@
                     }
                 }
-                Main.map.mapView.repaint();
+                invalidate();
             }
         });