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

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

fix various Sonar issues, improve Javadoc
  • Property svn:eol-style set to native
File size: 25.1 KB
Line 
1// License: GPL. See LICENSE file for details.
2//
3package org.openstreetmap.josm.actions;
4
5import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
6import static org.openstreetmap.josm.tools.I18n.tr;
7
8import java.awt.event.ActionEvent;
9import java.awt.event.KeyEvent;
10import java.util.ArrayList;
11import java.util.Arrays;
12import java.util.Collection;
13import java.util.Collections;
14import java.util.HashMap;
15import java.util.HashSet;
16import java.util.Iterator;
17import java.util.LinkedList;
18import java.util.List;
19import java.util.Map;
20import java.util.Set;
21
22import javax.swing.JOptionPane;
23
24import org.openstreetmap.josm.Main;
25import org.openstreetmap.josm.command.Command;
26import org.openstreetmap.josm.command.MoveCommand;
27import org.openstreetmap.josm.command.SequenceCommand;
28import org.openstreetmap.josm.data.coor.EastNorth;
29import org.openstreetmap.josm.data.osm.Node;
30import org.openstreetmap.josm.data.osm.OsmPrimitive;
31import org.openstreetmap.josm.data.osm.Way;
32import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
33import org.openstreetmap.josm.gui.Notification;
34import org.openstreetmap.josm.tools.Shortcut;
35
36/**
37 * Tools / Orthogonalize
38 *
39 * Align edges of a way so all angles are angles of 90 or 180 degrees.
40 * See USAGE String below.
41 */
42public final class OrthogonalizeAction extends JosmAction {
43 private static final String USAGE = tr(
44 "<h3>When one or more ways are selected, the shape is adjusted such, that all angles are 90 or 180 degrees.</h3>"+
45 "You can add two nodes to the selection. Then, the direction is fixed by these two reference nodes. "+
46 "(Afterwards, you can undo the movement for certain nodes:<br>"+
47 "Select them and press the shortcut for Orthogonalize / Undo. The default is Shift-Q.)");
48
49 /**
50 * Constructs a new {@code OrthogonalizeAction}.
51 */
52 public OrthogonalizeAction() {
53 super(tr("Orthogonalize Shape"),
54 "ortho",
55 tr("Move nodes so all angles are 90 or 180 degrees"),
56 Shortcut.registerShortcut("tools:orthogonalize", tr("Tool: {0}", tr("Orthogonalize Shape")),
57 KeyEvent.VK_Q,
58 Shortcut.DIRECT), true);
59 putValue("help", ht("/Action/OrthogonalizeShape"));
60 }
61
62 /**
63 * excepted deviation from an angle of 0, 90, 180, 360 degrees
64 * maximum value: 45 degrees
65 *
66 * Current policy is to except just everything, no matter how strange the result would be.
67 */
68 private static final double TOLERANCE1 = Math.toRadians(45.); // within a way
69 private static final double TOLERANCE2 = Math.toRadians(45.); // ways relative to each other
70
71 /**
72 * Remember movements, so the user can later undo it for certain nodes
73 */
74 private static final Map<Node, EastNorth> rememberMovements = new HashMap<>();
75
76 /**
77 * Undo the previous orthogonalization for certain nodes.
78 *
79 * This is useful, if the way shares nodes that you don't like to change, e.g. imports or
80 * work of another user.
81 *
82 * This action can be triggered by shortcut only.
83 */
84 public static class Undo extends JosmAction {
85 /**
86 * Constructor
87 */
88 public Undo() {
89 super(tr("Orthogonalize Shape / Undo"), "ortho",
90 tr("Undo orthogonalization for certain nodes"),
91 Shortcut.registerShortcut("tools:orthogonalizeUndo", tr("Tool: {0}", tr("Orthogonalize Shape / Undo")),
92 KeyEvent.VK_Q,
93 Shortcut.SHIFT),
94 true, "action/orthogonalize/undo", true);
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();
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 throw new InvalidUserInputException();
116 }
117 catch (InvalidUserInputException ex) {
118 new Notification(
119 tr("Orthogonalize Shape / Undo<br>"+
120 "Please select nodes that were moved by the previous Orthogonalize Shape action!"))
121 .setIcon(JOptionPane.INFORMATION_MESSAGE)
122 .show();
123 }
124 }
125 }
126
127 @Override
128 public void actionPerformed(ActionEvent e) {
129 if (!isEnabled())
130 return;
131 if ("EPSG:4326".equals(Main.getProjection().toString())) {
132 String msg = tr("<html>You are using the EPSG:4326 projection which might lead<br>" +
133 "to undesirable results when doing rectangular alignments.<br>" +
134 "Change your projection to get rid of this warning.<br>" +
135 "Do you want to continue?</html>");
136 if (!ConditionalOptionPaneUtil.showConfirmationDialog(
137 "align_rectangular_4326",
138 Main.parent,
139 msg,
140 tr("Warning"),
141 JOptionPane.YES_NO_OPTION,
142 JOptionPane.QUESTION_MESSAGE,
143 JOptionPane.YES_OPTION))
144 return;
145 }
146
147 final List<Node> nodeList = new ArrayList<>();
148 final List<WayData> wayDataList = new ArrayList<>();
149 final Collection<OsmPrimitive> sel = getCurrentDataSet().getSelected();
150
151 try {
152 // collect nodes and ways from the selection
153 for (OsmPrimitive p : sel) {
154 if (p instanceof Node) {
155 nodeList.add((Node) p);
156 }
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 }
172 else if (nodeList.isEmpty()) {
173 List<List<WayData>> groups = buildGroups(wayDataList);
174 for (List<WayData> g: groups) {
175 commands.addAll(orthogonalize(g, nodeList));
176 }
177 } else
178 throw new IllegalStateException();
179
180 Main.main.undoRedo.add(new SequenceCommand(tr("Orthogonalize"), commands));
181 Main.map.repaint();
182
183 } else
184 throw new InvalidUserInputException("usage");
185 }
186 } catch (InvalidUserInputException ex) {
187 String msg;
188 if ("usage".equals(ex.getMessage())) {
189 msg = "<h2>" + tr("Usage") + "</h2>" + USAGE;
190 } else {
191 msg = ex.getMessage() + "<br><hr><h2>" + tr("Usage") + "</h2>" + USAGE;
192 }
193 new Notification(msg)
194 .setIcon(JOptionPane.INFORMATION_MESSAGE)
195 .setDuration(Notification.TIME_VERY_LONG)
196 .show();
197 }
198 }
199
200 /**
201 * Collect groups of ways with common nodes in order to orthogonalize each group separately.
202 */
203 private static List<List<WayData>> buildGroups(List<WayData> wayDataList) {
204 List<List<WayData>> groups = new ArrayList<>();
205 Set<WayData> remaining = new HashSet<>(wayDataList);
206 while (!remaining.isEmpty()) {
207 List<WayData> group = new ArrayList<>();
208 groups.add(group);
209 Iterator<WayData> it = remaining.iterator();
210 WayData next = it.next();
211 it.remove();
212 extendGroupRec(group, next, new ArrayList<>(remaining));
213 remaining.removeAll(group);
214 }
215 return groups;
216 }
217
218 private static void extendGroupRec(List<WayData> group, WayData newGroupMember, List<WayData> remaining) {
219 group.add(newGroupMember);
220 for (int i = 0; i < remaining.size(); ++i) {
221 WayData candidate = remaining.get(i);
222 if (candidate == null) continue;
223 if (!Collections.disjoint(candidate.way.getNodes(), newGroupMember.way.getNodes())) {
224 remaining.set(i, null);
225 extendGroupRec(group, candidate, remaining);
226 }
227 }
228 }
229
230 /**
231 *
232 * Outline:
233 * 1. Find direction of all segments
234 * - direction = 0..3 (right,up,left,down)
235 * - right is not really right, you may have to turn your screen
236 * 2. Find average heading of all segments
237 * - heading = angle of a vector in polar coordinates
238 * - sum up horizontal segments (those with direction 0 or 2)
239 * - sum up vertical segments
240 * - turn the vertical sum by 90 degrees and add it to the horizontal sum
241 * - get the average heading from this total sum
242 * 3. Rotate all nodes by the average heading so that right is really right
243 * and all segments are approximately NS or EW.
244 * 4. If nodes are connected by a horizontal segment: Replace their y-Coordinate by
245 * the mean value of their y-Coordinates.
246 * - The same for vertical segments.
247 * 5. Rotate back.
248 *
249 **/
250 private static Collection<Command> orthogonalize(List<WayData> wayDataList, List<Node> headingNodes) throws InvalidUserInputException {
251 // find average heading
252 double headingAll;
253 try {
254 if (headingNodes.isEmpty()) {
255 // find directions of the segments and make them consistent between different ways
256 wayDataList.get(0).calcDirections(Direction.RIGHT);
257 double refHeading = wayDataList.get(0).heading;
258 for (WayData w : wayDataList) {
259 w.calcDirections(Direction.RIGHT);
260 int directionOffset = angleToDirectionChange(w.heading - refHeading, TOLERANCE2);
261 w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
262 if (angleToDirectionChange(refHeading - w.heading, TOLERANCE2) != 0) throw new RuntimeException();
263 }
264 EastNorth totSum = new EastNorth(0., 0.);
265 for (WayData w : wayDataList) {
266 totSum = EN.sum(totSum, w.segSum);
267 }
268 headingAll = EN.polar(new EastNorth(0., 0.), totSum);
269 }
270 else {
271 headingAll = EN.polar(headingNodes.get(0).getEastNorth(), headingNodes.get(1).getEastNorth());
272 for (WayData w : wayDataList) {
273 w.calcDirections(Direction.RIGHT);
274 int directionOffset = angleToDirectionChange(w.heading - headingAll, TOLERANCE2);
275 w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
276 }
277 }
278 } catch (RejectedAngleException ex) {
279 throw new InvalidUserInputException(
280 tr("<html>Please make sure all selected ways head in a similar direction<br>"+
281 "or orthogonalize them one by one.</html>"), ex);
282 }
283
284 // put the nodes of all ways in a set
285 final HashSet<Node> allNodes = new HashSet<>();
286 for (WayData w : wayDataList) {
287 for (Node n : w.way.getNodes()) {
288 allNodes.add(n);
289 }
290 }
291
292 // the new x and y value for each node
293 final HashMap<Node, Double> nX = new HashMap<>();
294 final HashMap<Node, Double> nY = new HashMap<>();
295
296 // calculate the centroid of all nodes
297 // it is used as rotation center
298 EastNorth pivot = new EastNorth(0., 0.);
299 for (Node n : allNodes) {
300 pivot = EN.sum(pivot, n.getEastNorth());
301 }
302 pivot = new EastNorth(pivot.east() / allNodes.size(), pivot.north() / allNodes.size());
303
304 // rotate
305 for (Node n: allNodes) {
306 EastNorth tmp = EN.rotateCC(pivot, n.getEastNorth(), - headingAll);
307 nX.put(n, tmp.east());
308 nY.put(n, tmp.north());
309 }
310
311 // orthogonalize
312 final Direction[] HORIZONTAL = {Direction.RIGHT, Direction.LEFT};
313 final Direction[] VERTICAL = {Direction.UP, Direction.DOWN};
314 final Direction[][] ORIENTATIONS = {HORIZONTAL, VERTICAL};
315 for (Direction[] orientation : ORIENTATIONS){
316 final HashSet<Node> s = new HashSet<>(allNodes);
317 int s_size = s.size();
318 for (int dummy = 0; dummy < s_size; ++dummy) {
319 if (s.isEmpty()) {
320 break;
321 }
322 final Node dummy_n = s.iterator().next(); // pick arbitrary element of s
323
324 final HashSet<Node> cs = new HashSet<>(); // will contain each node that can be reached from dummy_n
325 cs.add(dummy_n); // walking only on horizontal / vertical segments
326
327 boolean somethingHappened = true;
328 while (somethingHappened) {
329 somethingHappened = false;
330 for (WayData w : wayDataList) {
331 for (int i=0; i < w.nSeg; ++i) {
332 Node n1 = w.way.getNodes().get(i);
333 Node n2 = w.way.getNodes().get(i+1);
334 if (Arrays.asList(orientation).contains(w.segDirections[i])) {
335 if (cs.contains(n1) && ! cs.contains(n2)) {
336 cs.add(n2);
337 somethingHappened = true;
338 }
339 if (cs.contains(n2) && ! cs.contains(n1)) {
340 cs.add(n1);
341 somethingHappened = true;
342 }
343 }
344 }
345 }
346 }
347 for (Node n : cs) {
348 s.remove(n);
349 }
350
351 final HashMap<Node, Double> nC = (orientation == HORIZONTAL) ? nY : nX;
352
353 double average = 0;
354 for (Node n : cs) {
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 }
395 else {
396 OrthogonalizeAction.rememberMovements.put(n, new EastNorth(dx, dy));
397 commands.add(new MoveCommand(n, dx, dy));
398 }
399 }
400 return commands;
401 }
402
403 /**
404 * Class contains everything we need to know about a singe way.
405 */
406 private static class WayData {
407 public final Way way; // The assigned way
408 public final int nSeg; // Number of Segments of the Way
409 public final int nNode; // Number of Nodes of the Way
410 public Direction[] segDirections; // Direction of the segments
411 // segment i goes from node i to node (i+1)
412 public EastNorth segSum; // (Vector-)sum of all horizontal segments plus the sum of all vertical
413 // segments turned by 90 degrees
414 public double heading; // heading of segSum == approximate heading of the way
415 public 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
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 * When summing up the length of the sum vector should increase.
464 * However, it is possible to construct ways, such that this assertion fails.
465 * So only uncomment this for testing
466 **/
467 // if (segDirections[i].ordinal() % 2 == 0) {
468 // if (EN.abs(h) < lh) throw new AssertionError();
469 // lh = EN.abs(h);
470 // } else {
471 // if (EN.abs(v) < lv) throw new AssertionError();
472 // lv = EN.abs(v);
473 // }
474 }
475 // rotate the vertical vector by 90 degrees (clockwise) and add it to the horizontal vector
476 segSum = EN.sum(h, new EastNorth(v.north(), - v.east()));
477 // if (EN.abs(segSum) < lh) throw new AssertionError();
478 this.heading = EN.polar(new EastNorth(0.,0.), segSum);
479 }
480 }
481
482 private enum Direction {
483 RIGHT, UP, LEFT, DOWN;
484 public Direction changeBy(int directionChange) {
485 int tmp = (this.ordinal() + directionChange) % 4;
486 if (tmp < 0) {
487 tmp += 4; // the % operator can return negative value
488 }
489 return Direction.values()[tmp];
490 }
491 }
492
493 /**
494 * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
495 */
496 private static double standard_angle_0_to_2PI(double a) {
497 while (a >= 2 * Math.PI) {
498 a -= 2 * Math.PI;
499 }
500 while (a < 0) {
501 a += 2 * Math.PI;
502 }
503 return a;
504 }
505
506 /**
507 * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
508 */
509 private static double standard_angle_mPI_to_PI(double a) {
510 while (a > Math.PI) {
511 a -= 2 * Math.PI;
512 }
513 while (a <= - Math.PI) {
514 a += 2 * Math.PI;
515 }
516 return a;
517 }
518
519 /**
520 * Class contains some auxiliary functions
521 */
522 private static final class EN {
523 private EN() {
524 // Hide implicit public constructor for utility class
525 }
526 /**
527 * Rotate counter-clock-wise.
528 */
529 public static EastNorth rotateCC(EastNorth pivot, EastNorth en, double angle) {
530 double cosPhi = Math.cos(angle);
531 double sinPhi = Math.sin(angle);
532 double x = en.east() - pivot.east();
533 double y = en.north() - pivot.north();
534 double nx = cosPhi * x - sinPhi * y + pivot.east();
535 double ny = sinPhi * x + cosPhi * y + pivot.north();
536 return new EastNorth(nx, ny);
537 }
538 public static EastNorth sum(EastNorth en1, EastNorth en2) {
539 return new EastNorth(en1.east() + en2.east(), en1.north() + en2.north());
540 }
541 public static EastNorth diff(EastNorth en1, EastNorth en2) {
542 return new EastNorth(en1.east() - en2.east(), en1.north() - en2.north());
543 }
544 public static double polar(EastNorth en1, EastNorth en2) {
545 return Math.atan2(en2.north() - en1.north(), en2.east() - en1.east());
546 }
547 }
548
549 /**
550 * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
551 * returns an integral value, corresponding to a counter clockwise turn:
552 */
553 private static int angleToDirectionChange(double a, double deltaMax) throws RejectedAngleException {
554 a = standard_angle_mPI_to_PI(a);
555 double d0 = Math.abs(a);
556 double d90 = Math.abs(a - Math.PI / 2);
557 double d_m90 = Math.abs(a + Math.PI / 2);
558 int dirChange;
559 if (d0 < deltaMax) {
560 dirChange = 0;
561 } else if (d90 < deltaMax) {
562 dirChange = 1;
563 } else if (d_m90 < deltaMax) {
564 dirChange = -1;
565 } else {
566 a = standard_angle_0_to_2PI(a);
567 double d180 = Math.abs(a - Math.PI);
568 if (d180 < deltaMax) {
569 dirChange = 2;
570 } else
571 throw new RejectedAngleException();
572 }
573 return dirChange;
574 }
575
576 /**
577 * Exception: unsuited user input
578 */
579 private static class InvalidUserInputException extends Exception {
580 InvalidUserInputException(String message) {
581 super(message);
582 }
583 InvalidUserInputException(String message, Throwable cause) {
584 super(message, cause);
585 }
586 InvalidUserInputException() {
587 super();
588 }
589 }
590 /**
591 * Exception: angle cannot be recognized as 0, 90, 180 or 270 degrees
592 */
593 private static class RejectedAngleException extends Exception {
594 RejectedAngleException() {
595 super();
596 }
597 }
598
599 /**
600 * Don't check, if the current selection is suited for orthogonalization.
601 * Instead, show a usage dialog, that explains, why it cannot be done.
602 */
603 @Override
604 protected void updateEnabledState() {
605 setEnabled(getCurrentDataSet() != null);
606 }
607}
Note: See TracBrowser for help on using the repository browser.