source: josm/trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java@ 8790

Last change on this file since 8790 was 8510, checked in by Don-vip, 9 years ago

checkstyle: enable relevant whitespace checks and fix them
  • Property svn:eol-style set to native
File size: 25.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.event.ActionEvent;
8import java.awt.event.KeyEvent;
9import java.util.ArrayList;
10import java.util.Arrays;
11import java.util.Collection;
12import java.util.Collections;
13import java.util.HashMap;
14import java.util.HashSet;
15import java.util.Iterator;
16import java.util.LinkedList;
17import java.util.List;
18import java.util.Map;
19import java.util.Set;
20
21import javax.swing.JOptionPane;
22
23import org.openstreetmap.josm.Main;
24import org.openstreetmap.josm.command.Command;
25import org.openstreetmap.josm.command.MoveCommand;
26import org.openstreetmap.josm.command.SequenceCommand;
27import org.openstreetmap.josm.data.coor.EastNorth;
28import org.openstreetmap.josm.data.osm.Node;
29import org.openstreetmap.josm.data.osm.OsmPrimitive;
30import org.openstreetmap.josm.data.osm.Way;
31import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
32import org.openstreetmap.josm.gui.Notification;
33import org.openstreetmap.josm.tools.Shortcut;
34
35/**
36 * Tools / Orthogonalize
37 *
38 * Align edges of a way so all angles are angles of 90 or 180 degrees.
39 * See USAGE String below.
40 */
41public final class OrthogonalizeAction extends JosmAction {
42 private static final String USAGE = tr(
43 "<h3>When one or more ways are selected, the shape is adjusted such, that all angles are 90 or 180 degrees.</h3>"+
44 "You can add two nodes to the selection. Then, the direction is fixed by these two reference nodes. "+
45 "(Afterwards, you can undo the movement for certain nodes:<br>"+
46 "Select them and press the shortcut for Orthogonalize / Undo. The default is Shift-Q.)");
47
48 /**
49 * Constructs a new {@code OrthogonalizeAction}.
50 */
51 public OrthogonalizeAction() {
52 super(tr("Orthogonalize Shape"),
53 "ortho",
54 tr("Move nodes so all angles are 90 or 180 degrees"),
55 Shortcut.registerShortcut("tools:orthogonalize", tr("Tool: {0}", tr("Orthogonalize Shape")),
56 KeyEvent.VK_Q,
57 Shortcut.DIRECT), true);
58 putValue("help", ht("/Action/OrthogonalizeShape"));
59 }
60
61 /**
62 * excepted deviation from an angle of 0, 90, 180, 360 degrees
63 * maximum value: 45 degrees
64 *
65 * Current policy is to except just everything, no matter how strange the result would be.
66 */
67 private static final double TOLERANCE1 = Math.toRadians(45.); // within a way
68 private static final double TOLERANCE2 = Math.toRadians(45.); // ways relative to each other
69
70 /**
71 * Remember movements, so the user can later undo it for certain nodes
72 */
73 private static final Map<Node, EastNorth> rememberMovements = new HashMap<>();
74
75 /**
76 * Undo the previous orthogonalization for certain nodes.
77 *
78 * This is useful, if the way shares nodes that you don't like to change, e.g. imports or
79 * work of another user.
80 *
81 * This action can be triggered by shortcut only.
82 */
83 public static class Undo extends JosmAction {
84 /**
85 * Constructor
86 */
87 public Undo() {
88 super(tr("Orthogonalize Shape / Undo"), "ortho",
89 tr("Undo orthogonalization for certain nodes"),
90 Shortcut.registerShortcut("tools:orthogonalizeUndo", tr("Tool: {0}", tr("Orthogonalize Shape / Undo")),
91 KeyEvent.VK_Q,
92 Shortcut.SHIFT),
93 true, "action/orthogonalize/undo", true);
94 }
95
96 @Override
97 public void actionPerformed(ActionEvent e) {
98 if (!isEnabled())
99 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_VERY_LONG)
195 .show();
196 }
197 }
198
199 /**
200 * Collect groups of ways with common nodes in order to orthogonalize each group separately.
201 */
202 private static List<List<WayData>> buildGroups(List<WayData> wayDataList) {
203 List<List<WayData>> groups = new ArrayList<>();
204 Set<WayData> remaining = new HashSet<>(wayDataList);
205 while (!remaining.isEmpty()) {
206 List<WayData> group = new ArrayList<>();
207 groups.add(group);
208 Iterator<WayData> it = remaining.iterator();
209 WayData next = it.next();
210 it.remove();
211 extendGroupRec(group, next, new ArrayList<>(remaining));
212 remaining.removeAll(group);
213 }
214 return groups;
215 }
216
217 private static void extendGroupRec(List<WayData> group, WayData newGroupMember, List<WayData> remaining) {
218 group.add(newGroupMember);
219 for (int i = 0; i < remaining.size(); ++i) {
220 WayData candidate = remaining.get(i);
221 if (candidate == null) continue;
222 if (!Collections.disjoint(candidate.way.getNodes(), newGroupMember.way.getNodes())) {
223 remaining.set(i, null);
224 extendGroupRec(group, candidate, remaining);
225 }
226 }
227 }
228
229 /**
230 *
231 * Outline:
232 * 1. Find direction of all segments
233 * - direction = 0..3 (right,up,left,down)
234 * - right is not really right, you may have to turn your screen
235 * 2. Find average heading of all segments
236 * - heading = angle of a vector in polar coordinates
237 * - sum up horizontal segments (those with direction 0 or 2)
238 * - sum up vertical segments
239 * - turn the vertical sum by 90 degrees and add it to the horizontal sum
240 * - get the average heading from this total sum
241 * 3. Rotate all nodes by the average heading so that right is really right
242 * and all segments are approximately NS or EW.
243 * 4. If nodes are connected by a horizontal segment: Replace their y-Coordinate by
244 * the mean value of their y-Coordinates.
245 * - The same for vertical segments.
246 * 5. Rotate back.
247 *
248 **/
249 private static Collection<Command> orthogonalize(List<WayData> wayDataList, List<Node> headingNodes) throws InvalidUserInputException {
250 // find average heading
251 double headingAll;
252 try {
253 if (headingNodes.isEmpty()) {
254 // find directions of the segments and make them consistent between different ways
255 wayDataList.get(0).calcDirections(Direction.RIGHT);
256 double refHeading = wayDataList.get(0).heading;
257 for (WayData w : wayDataList) {
258 w.calcDirections(Direction.RIGHT);
259 int directionOffset = angleToDirectionChange(w.heading - refHeading, TOLERANCE2);
260 w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
261 if (angleToDirectionChange(refHeading - w.heading, TOLERANCE2) != 0) throw new RuntimeException();
262 }
263 EastNorth totSum = new EastNorth(0., 0.);
264 for (WayData w : wayDataList) {
265 totSum = EN.sum(totSum, w.segSum);
266 }
267 headingAll = EN.polar(new EastNorth(0., 0.), totSum);
268 } else {
269 headingAll = EN.polar(headingNodes.get(0).getEastNorth(), headingNodes.get(1).getEastNorth());
270 for (WayData w : wayDataList) {
271 w.calcDirections(Direction.RIGHT);
272 int directionOffset = angleToDirectionChange(w.heading - headingAll, TOLERANCE2);
273 w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
274 }
275 }
276 } catch (RejectedAngleException ex) {
277 throw new InvalidUserInputException(
278 tr("<html>Please make sure all selected ways head in a similar direction<br>"+
279 "or orthogonalize them one by one.</html>"), ex);
280 }
281
282 // put the nodes of all ways in a set
283 final Set<Node> allNodes = new HashSet<>();
284 for (WayData w : wayDataList) {
285 for (Node n : w.way.getNodes()) {
286 allNodes.add(n);
287 }
288 }
289
290 // the new x and y value for each node
291 final Map<Node, Double> nX = new HashMap<>();
292 final Map<Node, Double> nY = new HashMap<>();
293
294 // calculate the centroid of all nodes
295 // it is used as rotation center
296 EastNorth pivot = new EastNorth(0., 0.);
297 for (Node n : allNodes) {
298 pivot = EN.sum(pivot, n.getEastNorth());
299 }
300 pivot = new EastNorth(pivot.east() / allNodes.size(), pivot.north() / allNodes.size());
301
302 // rotate
303 for (Node n: allNodes) {
304 EastNorth tmp = EN.rotateCC(pivot, n.getEastNorth(), -headingAll);
305 nX.put(n, tmp.east());
306 nY.put(n, tmp.north());
307 }
308
309 // orthogonalize
310 final Direction[] HORIZONTAL = {Direction.RIGHT, Direction.LEFT};
311 final Direction[] VERTICAL = {Direction.UP, Direction.DOWN};
312 final Direction[][] ORIENTATIONS = {HORIZONTAL, VERTICAL};
313 for (Direction[] orientation : ORIENTATIONS) {
314 final Set<Node> s = new HashSet<>(allNodes);
315 int s_size = s.size();
316 for (int dummy = 0; dummy < s_size; ++dummy) {
317 if (s.isEmpty()) {
318 break;
319 }
320 final Node dummy_n = s.iterator().next(); // pick arbitrary element of s
321
322 final Set<Node> cs = new HashSet<>(); // will contain each node that can be reached from dummy_n
323 cs.add(dummy_n); // walking only on horizontal / vertical segments
324
325 boolean somethingHappened = true;
326 while (somethingHappened) {
327 somethingHappened = false;
328 for (WayData w : wayDataList) {
329 for (int i = 0; i < w.nSeg; ++i) {
330 Node n1 = w.way.getNodes().get(i);
331 Node n2 = w.way.getNodes().get(i+1);
332 if (Arrays.asList(orientation).contains(w.segDirections[i])) {
333 if (cs.contains(n1) && !cs.contains(n2)) {
334 cs.add(n2);
335 somethingHappened = true;
336 }
337 if (cs.contains(n2) && !cs.contains(n1)) {
338 cs.add(n1);
339 somethingHappened = true;
340 }
341 }
342 }
343 }
344 }
345 for (Node n : cs) {
346 s.remove(n);
347 }
348
349 final Map<Node, Double> nC = (orientation == HORIZONTAL) ? nY : nX;
350
351 double average = 0;
352 for (Node n : cs) {
353 average += nC.get(n).doubleValue();
354 }
355 average = average / cs.size();
356
357 // if one of the nodes is a heading node, forget about the average and use its value
358 for (Node fn : headingNodes) {
359 if (cs.contains(fn)) {
360 average = nC.get(fn);
361 }
362 }
363
364 // At this point, the two heading nodes (if any) are horizontally aligned, i.e. they
365 // have the same y coordinate. So in general we shouldn't find them in a vertical string
366 // of segments. This can still happen in some pathological cases (see #7889). To avoid
367 // both heading nodes collapsing to one point, we simply skip this segment string and
368 // don't touch the node coordinates.
369 if (orientation == VERTICAL && headingNodes.size() == 2 && cs.containsAll(headingNodes)) {
370 continue;
371 }
372
373 for (Node n : cs) {
374 nC.put(n, average);
375 }
376 }
377 if (!s.isEmpty()) throw new RuntimeException();
378 }
379
380 // rotate back and log the change
381 final Collection<Command> commands = new LinkedList<>();
382 for (Node n: allNodes) {
383 EastNorth tmp = new EastNorth(nX.get(n), nY.get(n));
384 tmp = EN.rotateCC(pivot, tmp, headingAll);
385 final double dx = tmp.east() - n.getEastNorth().east();
386 final double dy = tmp.north() - n.getEastNorth().north();
387 if (headingNodes.contains(n)) { // The heading nodes should not have changed
388 final double EPSILON = 1E-6;
389 if (Math.abs(dx) > Math.abs(EPSILON * tmp.east()) ||
390 Math.abs(dy) > Math.abs(EPSILON * tmp.east()))
391 throw new AssertionError();
392 } else {
393 OrthogonalizeAction.rememberMovements.put(n, new EastNorth(dx, dy));
394 commands.add(new MoveCommand(n, dx, dy));
395 }
396 }
397 return commands;
398 }
399
400 /**
401 * Class contains everything we need to know about a singe way.
402 */
403 private static class WayData {
404 public final Way way; // The assigned way
405 public final int nSeg; // Number of Segments of the Way
406 public final int nNode; // Number of Nodes of the Way
407 public Direction[] segDirections; // Direction of the segments
408 // segment i goes from node i to node (i+1)
409 public EastNorth segSum; // (Vector-)sum of all horizontal segments plus the sum of all vertical
410 // segments turned by 90 degrees
411 public double heading; // heading of segSum == approximate heading of the way
412
413 public WayData(Way pWay) {
414 way = pWay;
415 nNode = way.getNodes().size();
416 nSeg = nNode - 1;
417 }
418
419 /**
420 * Estimate the direction of the segments, given the first segment points in the
421 * direction <code>pInitialDirection</code>.
422 * Then sum up all horizontal / vertical segments to have a good guess for the
423 * heading of the entire way.
424 * @param pInitialDirection initial direction
425 * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
426 */
427 public void calcDirections(Direction pInitialDirection) throws InvalidUserInputException {
428 final EastNorth[] en = new EastNorth[nNode]; // alias: way.getNodes().get(i).getEastNorth() ---> en[i]
429 for (int i = 0; i < nNode; i++) {
430 en[i] = new EastNorth(way.getNodes().get(i).getEastNorth().east(), way.getNodes().get(i).getEastNorth().north());
431 }
432 segDirections = new Direction[nSeg];
433 Direction direction = pInitialDirection;
434 segDirections[0] = direction;
435 for (int i = 0; i < nSeg - 1; i++) {
436 double h1 = EN.polar(en[i], en[i+1]);
437 double h2 = EN.polar(en[i+1], en[i+2]);
438 try {
439 direction = direction.changeBy(angleToDirectionChange(h2 - h1, TOLERANCE1));
440 } catch (RejectedAngleException ex) {
441 throw new InvalidUserInputException(tr("Please select ways with angles of approximately 90 or 180 degrees."), ex);
442 }
443 segDirections[i+1] = direction;
444 }
445
446 // sum up segments
447 EastNorth h = new EastNorth(0., 0.);
448 EastNorth v = new EastNorth(0., 0.);
449 for (int i = 0; i < nSeg; ++i) {
450 EastNorth segment = EN.diff(en[i+1], en[i]);
451 if (segDirections[i] == Direction.RIGHT) {
452 h = EN.sum(h, segment);
453 } else if (segDirections[i] == Direction.UP) {
454 v = EN.sum(v, segment);
455 } else if (segDirections[i] == Direction.LEFT) {
456 h = EN.diff(h, segment);
457 } else if (segDirections[i] == Direction.DOWN) {
458 v = EN.diff(v, segment);
459 } else throw new IllegalStateException();
460 /**
461 * When summing up the length of the sum vector should increase.
462 * However, it is possible to construct ways, such that this assertion fails.
463 * So only uncomment this for testing
464 **/
465 // if (segDirections[i].ordinal() % 2 == 0) {
466 // if (EN.abs(h) < lh) throw new AssertionError();
467 // lh = EN.abs(h);
468 // } else {
469 // if (EN.abs(v) < lv) throw new AssertionError();
470 // lv = EN.abs(v);
471 // }
472 }
473 // rotate the vertical vector by 90 degrees (clockwise) and add it to the horizontal vector
474 segSum = EN.sum(h, new EastNorth(v.north(), -v.east()));
475 // if (EN.abs(segSum) < lh) throw new AssertionError();
476 this.heading = EN.polar(new EastNorth(0., 0.), segSum);
477 }
478 }
479
480 private enum Direction {
481 RIGHT, UP, LEFT, DOWN;
482 public Direction changeBy(int directionChange) {
483 int tmp = (this.ordinal() + directionChange) % 4;
484 if (tmp < 0) {
485 tmp += 4; // the % operator can return negative value
486 }
487 return Direction.values()[tmp];
488 }
489 }
490
491 /**
492 * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
493 */
494 private static double standard_angle_0_to_2PI(double a) {
495 while (a >= 2 * Math.PI) {
496 a -= 2 * Math.PI;
497 }
498 while (a < 0) {
499 a += 2 * Math.PI;
500 }
501 return a;
502 }
503
504 /**
505 * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
506 */
507 private static double standard_angle_mPI_to_PI(double a) {
508 while (a > Math.PI) {
509 a -= 2 * Math.PI;
510 }
511 while (a <= -Math.PI) {
512 a += 2 * Math.PI;
513 }
514 return a;
515 }
516
517 /**
518 * Class contains some auxiliary functions
519 */
520 private static final class EN {
521 private EN() {
522 // Hide implicit public constructor for utility class
523 }
524
525 /**
526 * Rotate counter-clock-wise.
527 */
528 public static EastNorth rotateCC(EastNorth pivot, EastNorth en, double angle) {
529 double cosPhi = Math.cos(angle);
530 double sinPhi = Math.sin(angle);
531 double x = en.east() - pivot.east();
532 double y = en.north() - pivot.north();
533 double nx = cosPhi * x - sinPhi * y + pivot.east();
534 double ny = sinPhi * x + cosPhi * y + pivot.north();
535 return new EastNorth(nx, ny);
536 }
537
538 public static EastNorth sum(EastNorth en1, EastNorth en2) {
539 return new EastNorth(en1.east() + en2.east(), en1.north() + en2.north());
540 }
541
542 public static EastNorth diff(EastNorth en1, EastNorth en2) {
543 return new EastNorth(en1.east() - en2.east(), en1.north() - en2.north());
544 }
545
546 public static double polar(EastNorth en1, EastNorth en2) {
547 return Math.atan2(en2.north() - en1.north(), en2.east() - en1.east());
548 }
549 }
550
551 /**
552 * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
553 * returns an integral value, corresponding to a counter clockwise turn:
554 */
555 private static int angleToDirectionChange(double a, double deltaMax) throws RejectedAngleException {
556 a = standard_angle_mPI_to_PI(a);
557 double d0 = Math.abs(a);
558 double d90 = Math.abs(a - Math.PI / 2);
559 double d_m90 = Math.abs(a + Math.PI / 2);
560 int dirChange;
561 if (d0 < deltaMax) {
562 dirChange = 0;
563 } else if (d90 < deltaMax) {
564 dirChange = 1;
565 } else if (d_m90 < deltaMax) {
566 dirChange = -1;
567 } else {
568 a = standard_angle_0_to_2PI(a);
569 double d180 = Math.abs(a - Math.PI);
570 if (d180 < deltaMax) {
571 dirChange = 2;
572 } else
573 throw new RejectedAngleException();
574 }
575 return dirChange;
576 }
577
578 /**
579 * Exception: unsuited user input
580 */
581 private static class InvalidUserInputException extends Exception {
582 InvalidUserInputException(String message) {
583 super(message);
584 }
585
586 InvalidUserInputException(String message, Throwable cause) {
587 super(message, cause);
588 }
589 }
590
591 /**
592 * Exception: angle cannot be recognized as 0, 90, 180 or 270 degrees
593 */
594 private static class RejectedAngleException extends Exception {
595 RejectedAngleException() {
596 super();
597 }
598 }
599
600 /**
601 * Don't check, if the current selection is suited for orthogonalization.
602 * Instead, show a usage dialog, that explains, why it cannot be done.
603 */
604 @Override
605 protected void updateEnabledState() {
606 setEnabled(getCurrentDataSet() != null);
607 }
608}
Note: See TracBrowser for help on using the repository browser.