001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.actions.mapmode;
003
004import static org.openstreetmap.josm.tools.I18n.marktr;
005import static org.openstreetmap.josm.tools.I18n.tr;
006import static org.openstreetmap.josm.tools.I18n.trn;
007
008import java.awt.Color;
009import java.awt.Cursor;
010import java.awt.Graphics2D;
011import java.awt.Point;
012import java.awt.Stroke;
013import java.awt.event.KeyEvent;
014import java.awt.event.MouseEvent;
015import java.awt.geom.GeneralPath;
016import java.util.ArrayList;
017import java.util.Collection;
018import java.util.LinkedList;
019import java.util.List;
020
021import javax.swing.JOptionPane;
022
023import org.openstreetmap.josm.Main;
024import org.openstreetmap.josm.command.AddCommand;
025import org.openstreetmap.josm.command.ChangeCommand;
026import org.openstreetmap.josm.command.Command;
027import org.openstreetmap.josm.command.DeleteCommand;
028import org.openstreetmap.josm.command.MoveCommand;
029import org.openstreetmap.josm.command.SequenceCommand;
030import org.openstreetmap.josm.data.Bounds;
031import org.openstreetmap.josm.data.SelectionChangedListener;
032import org.openstreetmap.josm.data.coor.EastNorth;
033import org.openstreetmap.josm.data.osm.DataSet;
034import org.openstreetmap.josm.data.osm.Node;
035import org.openstreetmap.josm.data.osm.OsmPrimitive;
036import org.openstreetmap.josm.data.osm.Way;
037import org.openstreetmap.josm.data.osm.WaySegment;
038import org.openstreetmap.josm.data.osm.visitor.paint.PaintColors;
039import org.openstreetmap.josm.gui.MapFrame;
040import org.openstreetmap.josm.gui.MapView;
041import org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable;
042import org.openstreetmap.josm.gui.layer.Layer;
043import org.openstreetmap.josm.gui.layer.OsmDataLayer;
044import org.openstreetmap.josm.gui.util.GuiHelper;
045import org.openstreetmap.josm.gui.util.ModifierListener;
046import org.openstreetmap.josm.tools.ImageProvider;
047import org.openstreetmap.josm.tools.Pair;
048import org.openstreetmap.josm.tools.Shortcut;
049
050/**
051 * @author Alexander Kachkaev <alexander@kachkaev.ru>, 2011
052 */
053public class ImproveWayAccuracyAction extends MapMode implements
054        SelectionChangedListener, ModifierListener {
055
056    enum State {
057        selecting, improving
058    }
059
060    private State state;
061
062    private MapView mv;
063
064    private static final long serialVersionUID = 42L;
065
066    private transient Way targetWay;
067    private transient Node candidateNode;
068    private transient WaySegment candidateSegment;
069
070    private Point mousePos;
071    private boolean dragging;
072
073    private final Cursor cursorSelect;
074    private final Cursor cursorSelectHover;
075    private final Cursor cursorImprove;
076    private final Cursor cursorImproveAdd;
077    private final Cursor cursorImproveDelete;
078    private final Cursor cursorImproveAddLock;
079    private final Cursor cursorImproveLock;
080
081    private Color guideColor;
082    private transient Stroke selectTargetWayStroke;
083    private transient Stroke moveNodeStroke;
084    private transient Stroke moveNodeIntersectingStroke;
085    private transient Stroke addNodeStroke;
086    private transient Stroke deleteNodeStroke;
087    private int dotSize;
088
089    private boolean selectionChangedBlocked;
090
091    protected String oldModeHelpText;
092
093    private final transient AbstractMapViewPaintable temporaryLayer = new AbstractMapViewPaintable() {
094        @Override
095        public void paint(Graphics2D g, MapView mv, Bounds bbox) {
096            ImproveWayAccuracyAction.this.paint(g, mv, bbox);
097        }
098    };
099
100    /**
101     * Constructs a new {@code ImproveWayAccuracyAction}.
102     * @param mapFrame Map frame
103     */
104    public ImproveWayAccuracyAction(MapFrame mapFrame) {
105        super(tr("Improve Way Accuracy"), "improvewayaccuracy",
106                tr("Improve Way Accuracy mode"),
107                Shortcut.registerShortcut("mapmode:ImproveWayAccuracy",
108                tr("Mode: {0}", tr("Improve Way Accuracy")),
109                KeyEvent.VK_W, Shortcut.DIRECT), mapFrame, Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
110
111        cursorSelect = ImageProvider.getCursor("normal", "mode");
112        cursorSelectHover = ImageProvider.getCursor("hand", "mode");
113        cursorImprove = ImageProvider.getCursor("crosshair", null);
114        cursorImproveAdd = ImageProvider.getCursor("crosshair", "addnode");
115        cursorImproveDelete = ImageProvider.getCursor("crosshair", "delete_node");
116        cursorImproveAddLock = ImageProvider.getCursor("crosshair",
117                "add_node_lock");
118        cursorImproveLock = ImageProvider.getCursor("crosshair", "lock");
119        readPreferences();
120    }
121
122    // -------------------------------------------------------------------------
123    // Mode methods
124    // -------------------------------------------------------------------------
125    @Override
126    public void enterMode() {
127        if (!isEnabled()) {
128            return;
129        }
130        super.enterMode();
131        readPreferences();
132
133        mv = Main.map.mapView;
134        mousePos = null;
135        oldModeHelpText = "";
136
137        if (getLayerManager().getEditDataSet() == null) {
138            return;
139        }
140
141        updateStateByCurrentSelection();
142
143        Main.map.mapView.addMouseListener(this);
144        Main.map.mapView.addMouseMotionListener(this);
145        Main.map.mapView.addTemporaryLayer(temporaryLayer);
146        DataSet.addSelectionListener(this);
147
148        Main.map.keyDetector.addModifierListener(this);
149    }
150
151    @Override
152    protected void readPreferences() {
153        guideColor = Main.pref.getColor(marktr("improve way accuracy helper line"), null);
154        if (guideColor == null) guideColor = PaintColors.HIGHLIGHT.get();
155
156        selectTargetWayStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.select-target", "2"));
157        moveNodeStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.move-node", "1 6"));
158        moveNodeIntersectingStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.move-node-intersecting", "1 2 6"));
159        addNodeStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.add-node", "1"));
160        deleteNodeStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.delete-node", "1"));
161        dotSize = Main.pref.getInteger("improvewayaccuracy.dot-size", 6);
162    }
163
164    @Override
165    public void exitMode() {
166        super.exitMode();
167
168        Main.map.mapView.removeMouseListener(this);
169        Main.map.mapView.removeMouseMotionListener(this);
170        Main.map.mapView.removeTemporaryLayer(temporaryLayer);
171        DataSet.removeSelectionListener(this);
172
173        Main.map.keyDetector.removeModifierListener(this);
174        temporaryLayer.invalidate();
175    }
176
177    @Override
178    protected void updateStatusLine() {
179        String newModeHelpText = getModeHelpText();
180        if (!newModeHelpText.equals(oldModeHelpText)) {
181            oldModeHelpText = newModeHelpText;
182            Main.map.statusLine.setHelpText(newModeHelpText);
183            Main.map.statusLine.repaint();
184        }
185    }
186
187    @Override
188    public String getModeHelpText() {
189        if (state == State.selecting) {
190            if (targetWay != null) {
191                return tr("Click on the way to start improving its shape.");
192            } else {
193                return tr("Select a way that you want to make more accurate.");
194            }
195        } else {
196            if (ctrl) {
197                return tr("Click to add a new node. Release Ctrl to move existing nodes or hold Alt to delete.");
198            } else if (alt) {
199                return tr("Click to delete the highlighted node. Release Alt to move existing nodes or hold Ctrl to add new nodes.");
200            } else {
201                return tr("Click to move the highlighted node. Hold Ctrl to add new nodes, or Alt to delete.");
202            }
203        }
204    }
205
206    @Override
207    public boolean layerIsSupported(Layer l) {
208        return l instanceof OsmDataLayer;
209    }
210
211    @Override
212    protected void updateEnabledState() {
213        setEnabled(getLayerManager().getEditLayer() != null);
214    }
215
216    // -------------------------------------------------------------------------
217    // MapViewPaintable methods
218    // -------------------------------------------------------------------------
219    /**
220     * Redraws temporary layer. Highlights targetWay in select mode. Draws
221     * preview lines in improve mode and highlights the candidateNode
222     * @param g The graphics
223     * @param mv The map view
224     * @param bbox The bounding box
225     */
226    public void paint(Graphics2D g, MapView mv, Bounds bbox) {
227        if (mousePos == null) {
228            return;
229        }
230
231        g.setColor(guideColor);
232
233        if (state == State.selecting && targetWay != null) {
234            // Highlighting the targetWay in Selecting state
235            // Non-native highlighting is used, because sometimes highlighted
236            // segments are covered with others, which is bad.
237            g.setStroke(selectTargetWayStroke);
238
239            List<Node> nodes = targetWay.getNodes();
240
241            GeneralPath b = new GeneralPath();
242            Point p0 = mv.getPoint(nodes.get(0));
243            Point pn;
244            b.moveTo(p0.x, p0.y);
245
246            for (Node n : nodes) {
247                pn = mv.getPoint(n);
248                b.lineTo(pn.x, pn.y);
249            }
250            if (targetWay.isClosed()) {
251                b.lineTo(p0.x, p0.y);
252            }
253
254            g.draw(b);
255
256        } else if (state == State.improving) {
257            // Drawing preview lines and highlighting the node
258            // that is going to be moved.
259            // Non-native highlighting is used here as well.
260
261            // Finding endpoints
262            Point p1 = null, p2 = null;
263            if (ctrl && candidateSegment != null) {
264                g.setStroke(addNodeStroke);
265                p1 = mv.getPoint(candidateSegment.getFirstNode());
266                p2 = mv.getPoint(candidateSegment.getSecondNode());
267            } else if (!alt && !ctrl && candidateNode != null) {
268                g.setStroke(moveNodeStroke);
269                List<Pair<Node, Node>> wpps = targetWay.getNodePairs(false);
270                for (Pair<Node, Node> wpp : wpps) {
271                    if (wpp.a == candidateNode) {
272                        p1 = mv.getPoint(wpp.b);
273                    }
274                    if (wpp.b == candidateNode) {
275                        p2 = mv.getPoint(wpp.a);
276                    }
277                    if (p1 != null && p2 != null) {
278                        break;
279                    }
280                }
281            } else if (alt && !ctrl && candidateNode != null) {
282                g.setStroke(deleteNodeStroke);
283                List<Node> nodes = targetWay.getNodes();
284                int index = nodes.indexOf(candidateNode);
285
286                // Only draw line if node is not first and/or last
287                if (index != 0 && index != (nodes.size() - 1)) {
288                    p1 = mv.getPoint(nodes.get(index - 1));
289                    p2 = mv.getPoint(nodes.get(index + 1));
290                }
291                // TODO: indicate what part that will be deleted? (for end nodes)
292            }
293
294
295            // Drawing preview lines
296            GeneralPath b = new GeneralPath();
297            if (alt && !ctrl) {
298                // In delete mode
299                if (p1 != null && p2 != null) {
300                    b.moveTo(p1.x, p1.y);
301                    b.lineTo(p2.x, p2.y);
302                }
303            } else {
304                // In add or move mode
305                if (p1 != null) {
306                    b.moveTo(mousePos.x, mousePos.y);
307                    b.lineTo(p1.x, p1.y);
308                }
309                if (p2 != null) {
310                    b.moveTo(mousePos.x, mousePos.y);
311                    b.lineTo(p2.x, p2.y);
312                }
313            }
314            g.draw(b);
315
316            // Highlighting candidateNode
317            if (candidateNode != null) {
318                p1 = mv.getPoint(candidateNode);
319                g.fillRect(p1.x - dotSize/2, p1.y - dotSize/2, dotSize, dotSize);
320            }
321
322            if (!alt && !ctrl && candidateNode != null) {
323                b.reset();
324                drawIntersectingWayHelperLines(mv, b);
325                g.setStroke(moveNodeIntersectingStroke);
326                g.draw(b);
327            }
328
329        }
330    }
331
332    protected void drawIntersectingWayHelperLines(MapView mv, GeneralPath b) {
333        for (final OsmPrimitive referrer : candidateNode.getReferrers()) {
334            if (!(referrer instanceof Way) || targetWay.equals(referrer)) {
335                continue;
336            }
337            final List<Node> nodes = ((Way) referrer).getNodes();
338            for (int i = 0; i < nodes.size(); i++) {
339                if (!candidateNode.equals(nodes.get(i))) {
340                    continue;
341                }
342                if (i > 0) {
343                    final Point p = mv.getPoint(nodes.get(i - 1));
344                    b.moveTo(mousePos.x, mousePos.y);
345                    b.lineTo(p.x, p.y);
346                }
347                if (i < nodes.size() - 1) {
348                    final Point p = mv.getPoint(nodes.get(i + 1));
349                    b.moveTo(mousePos.x, mousePos.y);
350                    b.lineTo(p.x, p.y);
351                }
352            }
353        }
354    }
355
356    // -------------------------------------------------------------------------
357    // Event handlers
358    // -------------------------------------------------------------------------
359    @Override
360    public void modifiersChanged(int modifiers) {
361        if (!Main.isDisplayingMapView() || !Main.map.mapView.isActiveLayerDrawable()) {
362            return;
363        }
364        updateKeyModifiers(modifiers);
365        updateCursorDependentObjectsIfNeeded();
366        updateCursor();
367        updateStatusLine();
368        temporaryLayer.invalidate();
369    }
370
371    @Override
372    public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
373        if (selectionChangedBlocked) {
374            return;
375        }
376        updateStateByCurrentSelection();
377    }
378
379    @Override
380    public void mouseDragged(MouseEvent e) {
381        dragging = true;
382        mouseMoved(e);
383    }
384
385    @Override
386    public void mouseMoved(MouseEvent e) {
387        if (!isEnabled()) {
388            return;
389        }
390
391        mousePos = e.getPoint();
392
393        updateKeyModifiers(e);
394        updateCursorDependentObjectsIfNeeded();
395        updateCursor();
396        updateStatusLine();
397        temporaryLayer.invalidate();
398    }
399
400    @Override
401    public void mouseReleased(MouseEvent e) {
402        dragging = false;
403        if (!isEnabled() || e.getButton() != MouseEvent.BUTTON1) {
404            return;
405        }
406
407        updateKeyModifiers(e);
408        mousePos = e.getPoint();
409
410        if (state == State.selecting) {
411            if (targetWay != null) {
412                getLayerManager().getEditDataSet().setSelected(targetWay.getPrimitiveId());
413                updateStateByCurrentSelection();
414            }
415        } else if (state == State.improving && mousePos != null) {
416            // Checking if the new coordinate is outside of the world
417            if (mv.getLatLon(mousePos.x, mousePos.y).isOutSideWorld()) {
418                JOptionPane.showMessageDialog(Main.parent,
419                        tr("Cannot add a node outside of the world."),
420                        tr("Warning"), JOptionPane.WARNING_MESSAGE);
421                return;
422            }
423
424            if (ctrl && !alt && candidateSegment != null) {
425                // Adding a new node to the highlighted segment
426                // Important: If there are other ways containing the same
427                // segment, a node must added to all of that ways.
428                Collection<Command> virtualCmds = new LinkedList<>();
429
430                // Creating a new node
431                Node virtualNode = new Node(mv.getEastNorth(mousePos.x,
432                        mousePos.y));
433                virtualCmds.add(new AddCommand(virtualNode));
434
435                // Looking for candidateSegment copies in ways that are
436                // referenced
437                // by candidateSegment nodes
438                List<Way> firstNodeWays = OsmPrimitive.getFilteredList(
439                        candidateSegment.getFirstNode().getReferrers(),
440                        Way.class);
441                List<Way> secondNodeWays = OsmPrimitive.getFilteredList(
442                        candidateSegment.getFirstNode().getReferrers(),
443                        Way.class);
444
445                Collection<WaySegment> virtualSegments = new LinkedList<>();
446                for (Way w : firstNodeWays) {
447                    List<Pair<Node, Node>> wpps = w.getNodePairs(true);
448                    for (Way w2 : secondNodeWays) {
449                        if (!w.equals(w2)) {
450                            continue;
451                        }
452                        // A way is referenced in both nodes.
453                        // Checking if there is such segment
454                        int i = -1;
455                        for (Pair<Node, Node> wpp : wpps) {
456                            ++i;
457                            boolean ab = wpp.a.equals(candidateSegment.getFirstNode())
458                                    && wpp.b.equals(candidateSegment.getSecondNode());
459                            boolean ba = wpp.b.equals(candidateSegment.getFirstNode())
460                                    && wpp.a.equals(candidateSegment.getSecondNode());
461                            if (ab || ba) {
462                                virtualSegments.add(new WaySegment(w, i));
463                            }
464                        }
465                    }
466                }
467
468                // Adding the node to all segments found
469                for (WaySegment virtualSegment : virtualSegments) {
470                    Way w = virtualSegment.way;
471                    Way wnew = new Way(w);
472                    wnew.addNode(virtualSegment.lowerIndex + 1, virtualNode);
473                    virtualCmds.add(new ChangeCommand(w, wnew));
474                }
475
476                // Finishing the sequence command
477                String text = trn("Add a new node to way",
478                        "Add a new node to {0} ways",
479                        virtualSegments.size(), virtualSegments.size());
480
481                Main.main.undoRedo.add(new SequenceCommand(text, virtualCmds));
482
483            } else if (alt && !ctrl && candidateNode != null) {
484                // Deleting the highlighted node
485
486                //check to see if node is in use by more than one object
487                List<OsmPrimitive> referrers = candidateNode.getReferrers();
488                List<Way> ways = OsmPrimitive.getFilteredList(referrers, Way.class);
489                if (referrers.size() != 1 || ways.size() != 1) {
490                    // detach node from way
491                    final Way newWay = new Way(targetWay);
492                    final List<Node> nodes = newWay.getNodes();
493                    nodes.remove(candidateNode);
494                    newWay.setNodes(nodes);
495                    Main.main.undoRedo.add(new ChangeCommand(targetWay, newWay));
496                } else if (candidateNode.isTagged()) {
497                    JOptionPane.showMessageDialog(Main.parent,
498                            tr("Cannot delete node that has tags"),
499                            tr("Error"), JOptionPane.ERROR_MESSAGE);
500                } else {
501                    List<Node> nodeList = new ArrayList<>();
502                    nodeList.add(candidateNode);
503                    Command deleteCmd = DeleteCommand.delete(getLayerManager().getEditLayer(), nodeList, true);
504                    if (deleteCmd != null) {
505                        Main.main.undoRedo.add(deleteCmd);
506                    }
507                }
508
509
510            } else if (candidateNode != null) {
511                // Moving the highlighted node
512                EastNorth nodeEN = candidateNode.getEastNorth();
513                EastNorth cursorEN = mv.getEastNorth(mousePos.x, mousePos.y);
514
515                Main.main.undoRedo.add(new MoveCommand(candidateNode, cursorEN.east() - nodeEN.east(), cursorEN.north() - nodeEN.north()));
516            }
517        }
518
519        mousePos = null;
520        updateCursor();
521        updateStatusLine();
522        temporaryLayer.invalidate();
523    }
524
525    @Override
526    public void mouseExited(MouseEvent e) {
527        if (!isEnabled()) {
528            return;
529        }
530
531        if (!dragging) {
532            mousePos = null;
533        }
534        temporaryLayer.invalidate();
535    }
536
537    // -------------------------------------------------------------------------
538    // Custom methods
539    // -------------------------------------------------------------------------
540    /**
541     * Sets new cursor depending on state, mouse position
542     */
543    private void updateCursor() {
544        if (!isEnabled()) {
545            mv.setNewCursor(null, this);
546            return;
547        }
548
549        if (state == State.selecting) {
550            mv.setNewCursor(targetWay == null ? cursorSelect
551                    : cursorSelectHover, this);
552        } else if (state == State.improving) {
553            if (alt && !ctrl) {
554                mv.setNewCursor(cursorImproveDelete, this);
555            } else if (shift || dragging) {
556                if (ctrl) {
557                    mv.setNewCursor(cursorImproveAddLock, this);
558                } else {
559                    mv.setNewCursor(cursorImproveLock, this);
560                }
561            } else if (ctrl && !alt) {
562                mv.setNewCursor(cursorImproveAdd, this);
563            } else {
564                mv.setNewCursor(cursorImprove, this);
565            }
566        }
567    }
568
569    /**
570     * Updates these objects under cursor: targetWay, candidateNode,
571     * candidateSegment
572     */
573    public void updateCursorDependentObjectsIfNeeded() {
574        if (state == State.improving && (shift || dragging)
575                && !(candidateNode == null && candidateSegment == null)) {
576            return;
577        }
578
579        if (mousePos == null) {
580            candidateNode = null;
581            candidateSegment = null;
582            return;
583        }
584
585        if (state == State.selecting) {
586            targetWay = ImproveWayAccuracyHelper.findWay(mv, mousePos);
587        } else if (state == State.improving) {
588            if (ctrl && !alt) {
589                candidateSegment = ImproveWayAccuracyHelper.findCandidateSegment(mv,
590                        targetWay, mousePos);
591                candidateNode = null;
592            } else {
593                candidateNode = ImproveWayAccuracyHelper.findCandidateNode(mv,
594                        targetWay, mousePos);
595                candidateSegment = null;
596            }
597        }
598    }
599
600    /**
601     * Switches to Selecting state
602     */
603    public void startSelecting() {
604        state = State.selecting;
605
606        targetWay = null;
607
608        temporaryLayer.invalidate();
609        updateStatusLine();
610    }
611
612    /**
613     * Switches to Improving state
614     *
615     * @param targetWay Way that is going to be improved
616     */
617    public void startImproving(Way targetWay) {
618        state = State.improving;
619
620        DataSet ds = getLayerManager().getEditDataSet();
621        Collection<OsmPrimitive> currentSelection = ds.getSelected();
622        if (currentSelection.size() != 1
623                || !currentSelection.iterator().next().equals(targetWay)) {
624            selectionChangedBlocked = true;
625            ds.clearSelection();
626            ds.setSelected(targetWay.getPrimitiveId());
627            selectionChangedBlocked = false;
628        }
629
630        this.targetWay = targetWay;
631        this.candidateNode = null;
632        this.candidateSegment = null;
633
634        temporaryLayer.invalidate();
635        updateStatusLine();
636    }
637
638    /**
639     * Updates the state according to the current selection. Goes to Improve
640     * state if a single way or node is selected. Extracts a way by a node in
641     * the second case.
642     *
643     */
644    private void updateStateByCurrentSelection() {
645        final List<Node> nodeList = new ArrayList<>();
646        final List<Way> wayList = new ArrayList<>();
647        final Collection<OsmPrimitive> sel = getLayerManager().getEditDataSet().getSelected();
648
649        // Collecting nodes and ways from the selection
650        for (OsmPrimitive p : sel) {
651            if (p instanceof Way) {
652                wayList.add((Way) p);
653            }
654            if (p instanceof Node) {
655                nodeList.add((Node) p);
656            }
657        }
658
659        if (wayList.size() == 1) {
660            // Starting improving the single selected way
661            startImproving(wayList.get(0));
662            return;
663        } else if (nodeList.size() == 1) {
664            // Starting improving the only way of the single selected node
665            List<OsmPrimitive> r = nodeList.get(0).getReferrers();
666            if (r.size() == 1 && (r.get(0) instanceof Way)) {
667                startImproving((Way) r.get(0));
668                return;
669            }
670        }
671
672        // Starting selecting by default
673        startSelecting();
674    }
675}