001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.actions;
003
004import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
005import static org.openstreetmap.josm.tools.I18n.tr;
006
007import java.awt.event.ActionEvent;
008import java.awt.event.KeyEvent;
009import java.util.ArrayList;
010import java.util.Arrays;
011import java.util.Collection;
012import java.util.Collections;
013import java.util.HashMap;
014import java.util.HashSet;
015import java.util.Iterator;
016import java.util.LinkedList;
017import java.util.List;
018import java.util.Map;
019import java.util.Set;
020
021import javax.swing.JOptionPane;
022
023import org.openstreetmap.josm.Main;
024import org.openstreetmap.josm.command.Command;
025import org.openstreetmap.josm.command.MoveCommand;
026import org.openstreetmap.josm.command.SequenceCommand;
027import org.openstreetmap.josm.data.coor.EastNorth;
028import org.openstreetmap.josm.data.osm.Node;
029import org.openstreetmap.josm.data.osm.OsmPrimitive;
030import org.openstreetmap.josm.data.osm.Way;
031import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
032import org.openstreetmap.josm.gui.Notification;
033import org.openstreetmap.josm.tools.Shortcut;
034
035/**
036 * Tools / Orthogonalize
037 *
038 * Align edges of a way so all angles are angles of 90 or 180 degrees.
039 * See USAGE String below.
040 */
041public final class OrthogonalizeAction extends JosmAction {
042    private static final String USAGE = tr(
043            "<h3>When one or more ways are selected, the shape is adjusted such, that all angles are 90 or 180 degrees.</h3>"+
044            "You can add two nodes to the selection. Then, the direction is fixed by these two reference nodes. "+
045            "(Afterwards, you can undo the movement for certain nodes:<br>"+
046            "Select them and press the shortcut for Orthogonalize / Undo. The default is Shift-Q.)");
047
048    /**
049     * Constructs a new {@code OrthogonalizeAction}.
050     */
051    public OrthogonalizeAction() {
052        super(tr("Orthogonalize Shape"),
053                "ortho",
054                tr("Move nodes so all angles are 90 or 180 degrees"),
055                Shortcut.registerShortcut("tools:orthogonalize", tr("Tool: {0}", tr("Orthogonalize Shape")),
056                        KeyEvent.VK_Q,
057                        Shortcut.DIRECT), true);
058        putValue("help", ht("/Action/OrthogonalizeShape"));
059    }
060
061    /**
062     * excepted deviation from an angle of 0, 90, 180, 360 degrees
063     * maximum value: 45 degrees
064     *
065     * Current policy is to except just everything, no matter how strange the result would be.
066     */
067    private static final double TOLERANCE1 = Math.toRadians(45.);   // within a way
068    private static final double TOLERANCE2 = Math.toRadians(45.);   // ways relative to each other
069
070    /**
071     * Remember movements, so the user can later undo it for certain nodes
072     */
073    private static final Map<Node, EastNorth> rememberMovements = new HashMap<>();
074
075    /**
076     * Undo the previous orthogonalization for certain nodes.
077     *
078     * This is useful, if the way shares nodes that you don't like to change, e.g. imports or
079     * work of another user.
080     *
081     * This action can be triggered by shortcut only.
082     */
083    public static class Undo extends JosmAction {
084        /**
085         * Constructor
086         */
087        public Undo() {
088            super(tr("Orthogonalize Shape / Undo"), "ortho",
089                    tr("Undo orthogonalization for certain nodes"),
090                    Shortcut.registerShortcut("tools:orthogonalizeUndo", tr("Tool: {0}", tr("Orthogonalize Shape / Undo")),
091                            KeyEvent.VK_Q,
092                            Shortcut.SHIFT),
093                    true, "action/orthogonalize/undo", true);
094        }
095
096        @Override
097        public void actionPerformed(ActionEvent e) {
098            if (!isEnabled())
099                return;
100            final Collection<Command> commands = new LinkedList<>();
101            final Collection<OsmPrimitive> sel = getCurrentDataSet().getSelected();
102            try {
103                for (OsmPrimitive p : sel) {
104                    if (!(p instanceof Node)) throw new InvalidUserInputException("selected object is not a node");
105                    Node n = (Node) p;
106                    if (rememberMovements.containsKey(n)) {
107                        EastNorth tmp = rememberMovements.get(n);
108                        commands.add(new MoveCommand(n, -tmp.east(), -tmp.north()));
109                        rememberMovements.remove(n);
110                    }
111                }
112                if (!commands.isEmpty()) {
113                    Main.main.undoRedo.add(new SequenceCommand(tr("Orthogonalize / Undo"), commands));
114                    Main.map.repaint();
115                } else {
116                    throw new InvalidUserInputException("Commands are empty");
117                }
118            } catch (InvalidUserInputException ex) {
119                new Notification(
120                        tr("Orthogonalize Shape / Undo<br>"+
121                        "Please select nodes that were moved by the previous Orthogonalize Shape action!"))
122                        .setIcon(JOptionPane.INFORMATION_MESSAGE)
123                        .show();
124            }
125        }
126    }
127
128    @Override
129    public void actionPerformed(ActionEvent e) {
130        if (!isEnabled())
131            return;
132        if ("EPSG:4326".equals(Main.getProjection().toString())) {
133            String msg = tr("<html>You are using the EPSG:4326 projection which might lead<br>" +
134                    "to undesirable results when doing rectangular alignments.<br>" +
135                    "Change your projection to get rid of this warning.<br>" +
136            "Do you want to continue?</html>");
137            if (!ConditionalOptionPaneUtil.showConfirmationDialog(
138                    "align_rectangular_4326",
139                    Main.parent,
140                    msg,
141                    tr("Warning"),
142                    JOptionPane.YES_NO_OPTION,
143                    JOptionPane.QUESTION_MESSAGE,
144                    JOptionPane.YES_OPTION))
145                return;
146        }
147
148        final List<Node> nodeList = new ArrayList<>();
149        final List<WayData> wayDataList = new ArrayList<>();
150        final Collection<OsmPrimitive> sel = getCurrentDataSet().getSelected();
151
152        try {
153            // collect nodes and ways from the selection
154            for (OsmPrimitive p : sel) {
155                if (p instanceof Node) {
156                    nodeList.add((Node) p);
157                } else if (p instanceof Way) {
158                    wayDataList.add(new WayData((Way) p));
159                } else
160                    throw new InvalidUserInputException(tr("Selection must consist only of ways and nodes."));
161            }
162            if (wayDataList.isEmpty())
163                throw new InvalidUserInputException("usage");
164            else  {
165                if (nodeList.size() == 2 || nodeList.isEmpty()) {
166                    OrthogonalizeAction.rememberMovements.clear();
167                    final Collection<Command> commands = new LinkedList<>();
168
169                    if (nodeList.size() == 2) {  // fixed direction
170                        commands.addAll(orthogonalize(wayDataList, nodeList));
171                    } else if (nodeList.isEmpty()) {
172                        List<List<WayData>> groups = buildGroups(wayDataList);
173                        for (List<WayData> g: groups) {
174                            commands.addAll(orthogonalize(g, nodeList));
175                        }
176                    } else
177                        throw new IllegalStateException();
178
179                    Main.main.undoRedo.add(new SequenceCommand(tr("Orthogonalize"), commands));
180                    Main.map.repaint();
181
182                } else
183                    throw new InvalidUserInputException("usage");
184            }
185        } catch (InvalidUserInputException ex) {
186            String msg;
187            if ("usage".equals(ex.getMessage())) {
188                msg = "<h2>" + tr("Usage") + "</h2>" + USAGE;
189            } else {
190                msg = ex.getMessage() + "<br><hr><h2>" + tr("Usage") + "</h2>" + USAGE;
191            }
192            new Notification(msg)
193                    .setIcon(JOptionPane.INFORMATION_MESSAGE)
194                    .setDuration(Notification.TIME_DEFAULT)
195                    .show();
196        }
197    }
198
199    /**
200     * Collect groups of ways with common nodes in order to orthogonalize each group separately.
201     * @param wayDataList list of ways
202     * @return groups of ways with common nodes
203     */
204    private static List<List<WayData>> buildGroups(List<WayData> wayDataList) {
205        List<List<WayData>> groups = new ArrayList<>();
206        Set<WayData> remaining = new HashSet<>(wayDataList);
207        while (!remaining.isEmpty()) {
208            List<WayData> group = new ArrayList<>();
209            groups.add(group);
210            Iterator<WayData> it = remaining.iterator();
211            WayData next = it.next();
212            it.remove();
213            extendGroupRec(group, next, new ArrayList<>(remaining));
214            remaining.removeAll(group);
215        }
216        return groups;
217    }
218
219    private static void extendGroupRec(List<WayData> group, WayData newGroupMember, List<WayData> remaining) {
220        group.add(newGroupMember);
221        for (int i = 0; i < remaining.size(); ++i) {
222            WayData candidate = remaining.get(i);
223            if (candidate == null) continue;
224            if (!Collections.disjoint(candidate.way.getNodes(), newGroupMember.way.getNodes())) {
225                remaining.set(i, null);
226                extendGroupRec(group, candidate, remaining);
227            }
228        }
229    }
230
231    /**
232     *
233     *  Outline:
234     *  1. Find direction of all segments
235     *      - direction = 0..3 (right,up,left,down)
236     *      - right is not really right, you may have to turn your screen
237     *  2. Find average heading of all segments
238     *      - heading = angle of a vector in polar coordinates
239     *      - sum up horizontal segments (those with direction 0 or 2)
240     *      - sum up vertical segments
241     *      - turn the vertical sum by 90 degrees and add it to the horizontal sum
242     *      - get the average heading from this total sum
243     *  3. Rotate all nodes by the average heading so that right is really right
244     *      and all segments are approximately NS or EW.
245     *  4. If nodes are connected by a horizontal segment: Replace their y-Coordinate by
246     *      the mean value of their y-Coordinates.
247     *      - The same for vertical segments.
248     *  5. Rotate back.
249     * @param wayDataList list of ways
250     * @param headingNodes list of heading nodes
251     * @return list of commands to perform
252     * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
253     **/
254    private static Collection<Command> orthogonalize(List<WayData> wayDataList, List<Node> headingNodes) throws InvalidUserInputException {
255        // find average heading
256        double headingAll;
257        try {
258            if (headingNodes.isEmpty()) {
259                // find directions of the segments and make them consistent between different ways
260                wayDataList.get(0).calcDirections(Direction.RIGHT);
261                double refHeading = wayDataList.get(0).heading;
262                EastNorth totSum = new EastNorth(0., 0.);
263                for (WayData w : wayDataList) {
264                    w.calcDirections(Direction.RIGHT);
265                    int directionOffset = angleToDirectionChange(w.heading - refHeading, TOLERANCE2);
266                    w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
267                    if (angleToDirectionChange(refHeading - w.heading, TOLERANCE2) != 0)
268                        throw new RuntimeException();
269                    totSum = EN.sum(totSum, w.segSum);
270                }
271                headingAll = EN.polar(new EastNorth(0., 0.), totSum);
272            } else {
273                headingAll = EN.polar(headingNodes.get(0).getEastNorth(), headingNodes.get(1).getEastNorth());
274                for (WayData w : wayDataList) {
275                    w.calcDirections(Direction.RIGHT);
276                    int directionOffset = angleToDirectionChange(w.heading - headingAll, TOLERANCE2);
277                    w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
278                }
279            }
280        } catch (RejectedAngleException ex) {
281            throw new InvalidUserInputException(
282                    tr("<html>Please make sure all selected ways head in a similar direction<br>"+
283                    "or orthogonalize them one by one.</html>"), ex);
284        }
285
286        // put the nodes of all ways in a set
287        final Set<Node> allNodes = new HashSet<>();
288        for (WayData w : wayDataList) {
289            for (Node n : w.way.getNodes()) {
290                allNodes.add(n);
291            }
292        }
293
294        // the new x and y value for each node
295        final Map<Node, Double> nX = new HashMap<>();
296        final Map<Node, Double> nY = new HashMap<>();
297
298        // calculate the centroid of all nodes
299        // it is used as rotation center
300        EastNorth pivot = new EastNorth(0., 0.);
301        for (Node n : allNodes) {
302            pivot = EN.sum(pivot, n.getEastNorth());
303        }
304        pivot = new EastNorth(pivot.east() / allNodes.size(), pivot.north() / allNodes.size());
305
306        // rotate
307        for (Node n: allNodes) {
308            EastNorth tmp = EN.rotateCC(pivot, n.getEastNorth(), -headingAll);
309            nX.put(n, tmp.east());
310            nY.put(n, tmp.north());
311        }
312
313        // orthogonalize
314        final Direction[] HORIZONTAL = {Direction.RIGHT, Direction.LEFT};
315        final Direction[] VERTICAL = {Direction.UP, Direction.DOWN};
316        final Direction[][] ORIENTATIONS = {HORIZONTAL, VERTICAL};
317        for (Direction[] orientation : ORIENTATIONS) {
318            final Set<Node> s = new HashSet<>(allNodes);
319            int s_size = s.size();
320            for (int dummy = 0; dummy < s_size; ++dummy) {
321                if (s.isEmpty()) {
322                    break;
323                }
324                final Node dummy_n = s.iterator().next();     // pick arbitrary element of s
325
326                final Set<Node> cs = new HashSet<>(); // will contain each node that can be reached from dummy_n
327                cs.add(dummy_n);                      // walking only on horizontal / vertical segments
328
329                boolean somethingHappened = true;
330                while (somethingHappened) {
331                    somethingHappened = false;
332                    for (WayData w : wayDataList) {
333                        for (int i = 0; i < w.nSeg; ++i) {
334                            Node n1 = w.way.getNodes().get(i);
335                            Node n2 = w.way.getNodes().get(i+1);
336                            if (Arrays.asList(orientation).contains(w.segDirections[i])) {
337                                if (cs.contains(n1) && !cs.contains(n2)) {
338                                    cs.add(n2);
339                                    somethingHappened = true;
340                                }
341                                if (cs.contains(n2) && !cs.contains(n1)) {
342                                    cs.add(n1);
343                                    somethingHappened = true;
344                                }
345                            }
346                        }
347                    }
348                }
349
350                final Map<Node, Double> nC = (orientation == HORIZONTAL) ? nY : nX;
351
352                double average = 0;
353                for (Node n : cs) {
354                    s.remove(n);
355                    average += nC.get(n).doubleValue();
356                }
357                average = average / cs.size();
358
359                // if one of the nodes is a heading node, forget about the average and use its value
360                for (Node fn : headingNodes) {
361                    if (cs.contains(fn)) {
362                        average = nC.get(fn);
363                    }
364                }
365
366                // At this point, the two heading nodes (if any) are horizontally aligned, i.e. they
367                // have the same y coordinate. So in general we shouldn't find them in a vertical string
368                // of segments. This can still happen in some pathological cases (see #7889). To avoid
369                // both heading nodes collapsing to one point, we simply skip this segment string and
370                // don't touch the node coordinates.
371                if (orientation == VERTICAL && headingNodes.size() == 2 && cs.containsAll(headingNodes)) {
372                    continue;
373                }
374
375                for (Node n : cs) {
376                    nC.put(n, average);
377                }
378            }
379            if (!s.isEmpty()) throw new RuntimeException();
380        }
381
382        // rotate back and log the change
383        final Collection<Command> commands = new LinkedList<>();
384        for (Node n: allNodes) {
385            EastNorth tmp = new EastNorth(nX.get(n), nY.get(n));
386            tmp = EN.rotateCC(pivot, tmp, headingAll);
387            final double dx = tmp.east()  - n.getEastNorth().east();
388            final double dy = tmp.north() - n.getEastNorth().north();
389            if (headingNodes.contains(n)) { // The heading nodes should not have changed
390                final double EPSILON = 1E-6;
391                if (Math.abs(dx) > Math.abs(EPSILON * tmp.east()) ||
392                        Math.abs(dy) > Math.abs(EPSILON * tmp.east()))
393                    throw new AssertionError();
394            } else {
395                OrthogonalizeAction.rememberMovements.put(n, new EastNorth(dx, dy));
396                commands.add(new MoveCommand(n, dx, dy));
397            }
398        }
399        return commands;
400    }
401
402    /**
403     * Class contains everything we need to know about a single way.
404     */
405    private static class WayData {
406        public final Way way;             // The assigned way
407        public final int nSeg;            // Number of Segments of the Way
408        public final int nNode;           // Number of Nodes of the Way
409        public Direction[] segDirections; // Direction of the segments
410        // segment i goes from node i to node (i+1)
411        public EastNorth segSum;          // (Vector-)sum of all horizontal segments plus the sum of all vertical
412        // segments turned by 90 degrees
413        public double heading;            // heading of segSum == approximate heading of the way
414
415        WayData(Way pWay) {
416            way = pWay;
417            nNode = way.getNodes().size();
418            nSeg = nNode - 1;
419        }
420
421        /**
422         * Estimate the direction of the segments, given the first segment points in the
423         * direction <code>pInitialDirection</code>.
424         * Then sum up all horizontal / vertical segments to have a good guess for the
425         * heading of the entire way.
426         * @param pInitialDirection initial direction
427         * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
428         */
429        public void calcDirections(Direction pInitialDirection) throws InvalidUserInputException {
430            final EastNorth[] en = new EastNorth[nNode]; // alias: way.getNodes().get(i).getEastNorth() ---> en[i]
431            for (int i = 0; i < nNode; i++) {
432                en[i] = new EastNorth(way.getNodes().get(i).getEastNorth().east(), way.getNodes().get(i).getEastNorth().north());
433            }
434            segDirections = new Direction[nSeg];
435            Direction direction = pInitialDirection;
436            segDirections[0] = direction;
437            for (int i = 0; i < nSeg - 1; i++) {
438                double h1 = EN.polar(en[i], en[i+1]);
439                double h2 = EN.polar(en[i+1], en[i+2]);
440                try {
441                    direction = direction.changeBy(angleToDirectionChange(h2 - h1, TOLERANCE1));
442                } catch (RejectedAngleException ex) {
443                    throw new InvalidUserInputException(tr("Please select ways with angles of approximately 90 or 180 degrees."), ex);
444                }
445                segDirections[i+1] = direction;
446            }
447
448            // sum up segments
449            EastNorth h = new EastNorth(0., 0.);
450            EastNorth v = new EastNorth(0., 0.);
451            for (int i = 0; i < nSeg; ++i) {
452                EastNorth segment = EN.diff(en[i+1], en[i]);
453                if      (segDirections[i] == Direction.RIGHT) {
454                    h = EN.sum(h, segment);
455                } else if (segDirections[i] == Direction.UP) {
456                    v = EN.sum(v, segment);
457                } else if (segDirections[i] == Direction.LEFT) {
458                    h = EN.diff(h, segment);
459                } else if (segDirections[i] == Direction.DOWN) {
460                    v = EN.diff(v, segment);
461                } else throw new IllegalStateException();
462            }
463            // rotate the vertical vector by 90 degrees (clockwise) and add it to the horizontal vector
464            segSum = EN.sum(h, new EastNorth(v.north(), -v.east()));
465            this.heading = EN.polar(new EastNorth(0., 0.), segSum);
466        }
467    }
468
469    private enum Direction {
470        RIGHT, UP, LEFT, DOWN;
471        public Direction changeBy(int directionChange) {
472            int tmp = (this.ordinal() + directionChange) % 4;
473            if (tmp < 0) {
474                tmp += 4;          // the % operator can return negative value
475            }
476            return Direction.values()[tmp];
477        }
478    }
479
480    /**
481     * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
482     * @param a angle
483     * @return correct angle
484     */
485    private static double standard_angle_0_to_2PI(double a) {
486        while (a >= 2 * Math.PI) {
487            a -= 2 * Math.PI;
488        }
489        while (a < 0) {
490            a += 2 * Math.PI;
491        }
492        return a;
493    }
494
495    /**
496     * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
497     * @param a angle
498     * @return correct angle
499     */
500    private static double standard_angle_mPI_to_PI(double a) {
501        while (a > Math.PI) {
502            a -= 2 * Math.PI;
503        }
504        while (a <= -Math.PI) {
505            a += 2 * Math.PI;
506        }
507        return a;
508    }
509
510    /**
511     * Class contains some auxiliary functions
512     */
513    private static final class EN {
514        private EN() {
515            // Hide implicit public constructor for utility class
516        }
517
518        /**
519         * Rotate counter-clock-wise.
520         * @param pivot pivot
521         * @param en original east/north
522         * @param angle angle, in radians
523         * @return new east/north
524         */
525        public static EastNorth rotateCC(EastNorth pivot, EastNorth en, double angle) {
526            double cosPhi = Math.cos(angle);
527            double sinPhi = Math.sin(angle);
528            double x = en.east() - pivot.east();
529            double y = en.north() - pivot.north();
530            double nx =  cosPhi * x - sinPhi * y + pivot.east();
531            double ny =  sinPhi * x + cosPhi * y + pivot.north();
532            return new EastNorth(nx, ny);
533        }
534
535        public static EastNorth sum(EastNorth en1, EastNorth en2) {
536            return new EastNorth(en1.east() + en2.east(), en1.north() + en2.north());
537        }
538
539        public static EastNorth diff(EastNorth en1, EastNorth en2) {
540            return new EastNorth(en1.east() - en2.east(), en1.north() - en2.north());
541        }
542
543        public static double polar(EastNorth en1, EastNorth en2) {
544            return Math.atan2(en2.north() - en1.north(), en2.east() -  en1.east());
545        }
546    }
547
548    /**
549     * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
550     * returns an integral value, corresponding to a counter clockwise turn.
551     * @param a angle, in radians
552     * @param deltaMax maximum tolerance, in radians
553     * @return an integral value, corresponding to a counter clockwise turn
554     * @throws RejectedAngleException in case of invalid angle
555     */
556    private static int angleToDirectionChange(double a, double deltaMax) throws RejectedAngleException {
557        a = standard_angle_mPI_to_PI(a);
558        double d0    = Math.abs(a);
559        double d90   = Math.abs(a - Math.PI / 2);
560        double d_m90 = Math.abs(a + Math.PI / 2);
561        int dirChange;
562        if (d0 < deltaMax) {
563            dirChange =  0;
564        } else if (d90 < deltaMax) {
565            dirChange =  1;
566        } else if (d_m90 < deltaMax) {
567            dirChange = -1;
568        } else {
569            a = standard_angle_0_to_2PI(a);
570            double d180 = Math.abs(a - Math.PI);
571            if (d180 < deltaMax) {
572                dirChange = 2;
573            } else
574                throw new RejectedAngleException();
575        }
576        return dirChange;
577    }
578
579    /**
580     * Exception: unsuited user input
581     */
582    private static class InvalidUserInputException extends Exception {
583        InvalidUserInputException(String message) {
584            super(message);
585        }
586
587        InvalidUserInputException(String message, Throwable cause) {
588            super(message, cause);
589        }
590    }
591
592    /**
593     * Exception: angle cannot be recognized as 0, 90, 180 or 270 degrees
594     */
595    private static class RejectedAngleException extends Exception {
596        RejectedAngleException() {
597            super();
598        }
599    }
600
601    /**
602     * Don't check, if the current selection is suited for orthogonalization.
603     * Instead, show a usage dialog, that explains, why it cannot be done.
604     */
605    @Override
606    protected void updateEnabledState() {
607        setEnabled(getCurrentDataSet() != null);
608    }
609}