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

Last change on this file since 10226 was 10001, checked in by Don-vip, 8 years ago

sonar - Local variable and method parameter names should comply with a naming convention
  • Property svn:eol-style set to native
File size: 25.6 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 Collection<OsmPrimitive> sel = getCurrentDataSet().getSelected();
149
150 try {
151 final SequenceCommand command = orthogonalize(sel);
152 Main.main.undoRedo.add(new SequenceCommand(tr("Orthogonalize"), command));
153 Main.map.repaint();
154 } catch (InvalidUserInputException ex) {
155 String msg;
156 if ("usage".equals(ex.getMessage())) {
157 msg = "<h2>" + tr("Usage") + "</h2>" + USAGE;
158 } else {
159 msg = ex.getMessage() + "<br><hr><h2>" + tr("Usage") + "</h2>" + USAGE;
160 }
161 new Notification(msg)
162 .setIcon(JOptionPane.INFORMATION_MESSAGE)
163 .setDuration(Notification.TIME_DEFAULT)
164 .show();
165 }
166 }
167
168 /**
169 * Rectifies the selection
170 * @param selection the selection which should be rectified
171 * @return a rectifying command
172 * @throws InvalidUserInputException if the selection is invalid
173 */
174 static SequenceCommand orthogonalize(Iterable<OsmPrimitive> selection) throws InvalidUserInputException {
175 final List<Node> nodeList = new ArrayList<>();
176 final List<WayData> wayDataList = new ArrayList<>();
177 // collect nodes and ways from the selection
178 for (OsmPrimitive p : selection) {
179 if (p instanceof Node) {
180 nodeList.add((Node) p);
181 } else if (p instanceof Way) {
182 wayDataList.add(new WayData(((Way) p).getNodes()));
183 } else {
184 throw new InvalidUserInputException(tr("Selection must consist only of ways and nodes."));
185 }
186 }
187 if (wayDataList.isEmpty() && nodeList.size() > 2) {
188 final WayData data = new WayData(nodeList);
189 final Collection<Command> commands = orthogonalize(Collections.singletonList(data), Collections.<Node>emptyList());
190 return new SequenceCommand(tr("Orthogonalize"), commands);
191 } else if (wayDataList.isEmpty()) {
192 throw new InvalidUserInputException("usage");
193 } else {
194 if (nodeList.size() == 2 || nodeList.isEmpty()) {
195 OrthogonalizeAction.rememberMovements.clear();
196 final Collection<Command> commands = new LinkedList<>();
197
198 if (nodeList.size() == 2) { // fixed direction
199 commands.addAll(orthogonalize(wayDataList, nodeList));
200 } else if (nodeList.isEmpty()) {
201 List<List<WayData>> groups = buildGroups(wayDataList);
202 for (List<WayData> g: groups) {
203 commands.addAll(orthogonalize(g, nodeList));
204 }
205 } else {
206 throw new IllegalStateException();
207 }
208
209 return new SequenceCommand(tr("Orthogonalize"), commands);
210
211 } else {
212 throw new InvalidUserInputException("usage");
213 }
214 }
215 }
216
217 /**
218 * Collect groups of ways with common nodes in order to orthogonalize each group separately.
219 * @param wayDataList list of ways
220 * @return groups of ways with common nodes
221 */
222 private static List<List<WayData>> buildGroups(List<WayData> wayDataList) {
223 List<List<WayData>> groups = new ArrayList<>();
224 Set<WayData> remaining = new HashSet<>(wayDataList);
225 while (!remaining.isEmpty()) {
226 List<WayData> group = new ArrayList<>();
227 groups.add(group);
228 Iterator<WayData> it = remaining.iterator();
229 WayData next = it.next();
230 it.remove();
231 extendGroupRec(group, next, new ArrayList<>(remaining));
232 remaining.removeAll(group);
233 }
234 return groups;
235 }
236
237 private static void extendGroupRec(List<WayData> group, WayData newGroupMember, List<WayData> remaining) {
238 group.add(newGroupMember);
239 for (int i = 0; i < remaining.size(); ++i) {
240 WayData candidate = remaining.get(i);
241 if (candidate == null) continue;
242 if (!Collections.disjoint(candidate.wayNodes, newGroupMember.wayNodes)) {
243 remaining.set(i, null);
244 extendGroupRec(group, candidate, remaining);
245 }
246 }
247 }
248
249 /**
250 *
251 * Outline:
252 * 1. Find direction of all segments
253 * - direction = 0..3 (right,up,left,down)
254 * - right is not really right, you may have to turn your screen
255 * 2. Find average heading of all segments
256 * - heading = angle of a vector in polar coordinates
257 * - sum up horizontal segments (those with direction 0 or 2)
258 * - sum up vertical segments
259 * - turn the vertical sum by 90 degrees and add it to the horizontal sum
260 * - get the average heading from this total sum
261 * 3. Rotate all nodes by the average heading so that right is really right
262 * and all segments are approximately NS or EW.
263 * 4. If nodes are connected by a horizontal segment: Replace their y-Coordinate by
264 * the mean value of their y-Coordinates.
265 * - The same for vertical segments.
266 * 5. Rotate back.
267 * @param wayDataList list of ways
268 * @param headingNodes list of heading nodes
269 * @return list of commands to perform
270 * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
271 **/
272 private static Collection<Command> orthogonalize(List<WayData> wayDataList, List<Node> headingNodes) throws InvalidUserInputException {
273 // find average heading
274 double headingAll;
275 try {
276 if (headingNodes.isEmpty()) {
277 // find directions of the segments and make them consistent between different ways
278 wayDataList.get(0).calcDirections(Direction.RIGHT);
279 double refHeading = wayDataList.get(0).heading;
280 EastNorth totSum = new EastNorth(0., 0.);
281 for (WayData w : wayDataList) {
282 w.calcDirections(Direction.RIGHT);
283 int directionOffset = angleToDirectionChange(w.heading - refHeading, TOLERANCE2);
284 w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
285 if (angleToDirectionChange(refHeading - w.heading, TOLERANCE2) != 0)
286 throw new RuntimeException();
287 totSum = EN.sum(totSum, w.segSum);
288 }
289 headingAll = EN.polar(new EastNorth(0., 0.), totSum);
290 } else {
291 headingAll = EN.polar(headingNodes.get(0).getEastNorth(), headingNodes.get(1).getEastNorth());
292 for (WayData w : wayDataList) {
293 w.calcDirections(Direction.RIGHT);
294 int directionOffset = angleToDirectionChange(w.heading - headingAll, TOLERANCE2);
295 w.calcDirections(Direction.RIGHT.changeBy(directionOffset));
296 }
297 }
298 } catch (RejectedAngleException ex) {
299 throw new InvalidUserInputException(
300 tr("<html>Please make sure all selected ways head in a similar direction<br>"+
301 "or orthogonalize them one by one.</html>"), ex);
302 }
303
304 // put the nodes of all ways in a set
305 final Set<Node> allNodes = new HashSet<>();
306 for (WayData w : wayDataList) {
307 allNodes.addAll(w.wayNodes);
308 }
309
310 // the new x and y value for each node
311 final Map<Node, Double> nX = new HashMap<>();
312 final Map<Node, Double> nY = new HashMap<>();
313
314 // calculate the centroid of all nodes
315 // it is used as rotation center
316 EastNorth pivot = new EastNorth(0., 0.);
317 for (Node n : allNodes) {
318 pivot = EN.sum(pivot, n.getEastNorth());
319 }
320 pivot = new EastNorth(pivot.east() / allNodes.size(), pivot.north() / allNodes.size());
321
322 // rotate
323 for (Node n: allNodes) {
324 EastNorth tmp = EN.rotateCC(pivot, n.getEastNorth(), -headingAll);
325 nX.put(n, tmp.east());
326 nY.put(n, tmp.north());
327 }
328
329 // orthogonalize
330 final Direction[] horizontal = {Direction.RIGHT, Direction.LEFT};
331 final Direction[] vertical = {Direction.UP, Direction.DOWN};
332 final Direction[][] orientations = {horizontal, vertical};
333 for (Direction[] orientation : orientations) {
334 final Set<Node> s = new HashSet<>(allNodes);
335 int size = s.size();
336 for (int dummy = 0; dummy < size; ++dummy) {
337 if (s.isEmpty()) {
338 break;
339 }
340 final Node dummyN = s.iterator().next(); // pick arbitrary element of s
341
342 final Set<Node> cs = new HashSet<>(); // will contain each node that can be reached from dummyN
343 cs.add(dummyN); // walking only on horizontal / vertical segments
344
345 boolean somethingHappened = true;
346 while (somethingHappened) {
347 somethingHappened = false;
348 for (WayData w : wayDataList) {
349 for (int i = 0; i < w.nSeg; ++i) {
350 Node n1 = w.wayNodes.get(i);
351 Node n2 = w.wayNodes.get(i+1);
352 if (Arrays.asList(orientation).contains(w.segDirections[i])) {
353 if (cs.contains(n1) && !cs.contains(n2)) {
354 cs.add(n2);
355 somethingHappened = true;
356 }
357 if (cs.contains(n2) && !cs.contains(n1)) {
358 cs.add(n1);
359 somethingHappened = true;
360 }
361 }
362 }
363 }
364 }
365
366 final Map<Node, Double> nC = (orientation == horizontal) ? nY : nX;
367
368 double average = 0;
369 for (Node n : cs) {
370 s.remove(n);
371 average += nC.get(n).doubleValue();
372 }
373 average = average / cs.size();
374
375 // if one of the nodes is a heading node, forget about the average and use its value
376 for (Node fn : headingNodes) {
377 if (cs.contains(fn)) {
378 average = nC.get(fn);
379 }
380 }
381
382 // At this point, the two heading nodes (if any) are horizontally aligned, i.e. they
383 // have the same y coordinate. So in general we shouldn't find them in a vertical string
384 // of segments. This can still happen in some pathological cases (see #7889). To avoid
385 // both heading nodes collapsing to one point, we simply skip this segment string and
386 // don't touch the node coordinates.
387 if (orientation == vertical && headingNodes.size() == 2 && cs.containsAll(headingNodes)) {
388 continue;
389 }
390
391 for (Node n : cs) {
392 nC.put(n, average);
393 }
394 }
395 if (!s.isEmpty()) throw new RuntimeException();
396 }
397
398 // rotate back and log the change
399 final Collection<Command> commands = new LinkedList<>();
400 for (Node n: allNodes) {
401 EastNorth tmp = new EastNorth(nX.get(n), nY.get(n));
402 tmp = EN.rotateCC(pivot, tmp, headingAll);
403 final double dx = tmp.east() - n.getEastNorth().east();
404 final double dy = tmp.north() - n.getEastNorth().north();
405 if (headingNodes.contains(n)) { // The heading nodes should not have changed
406 final double epsilon = 1E-6;
407 if (Math.abs(dx) > Math.abs(epsilon * tmp.east()) ||
408 Math.abs(dy) > Math.abs(epsilon * tmp.east()))
409 throw new AssertionError();
410 } else {
411 OrthogonalizeAction.rememberMovements.put(n, new EastNorth(dx, dy));
412 commands.add(new MoveCommand(n, dx, dy));
413 }
414 }
415 return commands;
416 }
417
418 /**
419 * Class contains everything we need to know about a single way.
420 */
421 private static class WayData {
422 public final List<Node> wayNodes; // The assigned way
423 public final int nSeg; // Number of Segments of the Way
424 public final int nNode; // Number of Nodes of the Way
425 public Direction[] segDirections; // Direction of the segments
426 // segment i goes from node i to node (i+1)
427 public EastNorth segSum; // (Vector-)sum of all horizontal segments plus the sum of all vertical
428 // segments turned by 90 degrees
429 public double heading; // heading of segSum == approximate heading of the way
430
431 WayData(List<Node> wayNodes) {
432 this.wayNodes = wayNodes;
433 this.nNode = wayNodes.size();
434 this.nSeg = nNode - 1;
435 }
436
437 /**
438 * Estimate the direction of the segments, given the first segment points in the
439 * direction <code>pInitialDirection</code>.
440 * Then sum up all horizontal / vertical segments to have a good guess for the
441 * heading of the entire way.
442 * @param pInitialDirection initial direction
443 * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
444 */
445 public void calcDirections(Direction pInitialDirection) throws InvalidUserInputException {
446 final EastNorth[] en = new EastNorth[nNode]; // alias: wayNodes.get(i).getEastNorth() ---> en[i]
447 for (int i = 0; i < nNode; i++) {
448 en[i] = wayNodes.get(i).getEastNorth();
449 }
450 segDirections = new Direction[nSeg];
451 Direction direction = pInitialDirection;
452 segDirections[0] = direction;
453 for (int i = 0; i < nSeg - 1; i++) {
454 double h1 = EN.polar(en[i], en[i+1]);
455 double h2 = EN.polar(en[i+1], en[i+2]);
456 try {
457 direction = direction.changeBy(angleToDirectionChange(h2 - h1, TOLERANCE1));
458 } catch (RejectedAngleException ex) {
459 throw new InvalidUserInputException(tr("Please select ways with angles of approximately 90 or 180 degrees."), ex);
460 }
461 segDirections[i+1] = direction;
462 }
463
464 // sum up segments
465 EastNorth h = new EastNorth(0., 0.);
466 EastNorth v = new EastNorth(0., 0.);
467 for (int i = 0; i < nSeg; ++i) {
468 EastNorth segment = EN.diff(en[i+1], en[i]);
469 if (segDirections[i] == Direction.RIGHT) {
470 h = EN.sum(h, segment);
471 } else if (segDirections[i] == Direction.UP) {
472 v = EN.sum(v, segment);
473 } else if (segDirections[i] == Direction.LEFT) {
474 h = EN.diff(h, segment);
475 } else if (segDirections[i] == Direction.DOWN) {
476 v = EN.diff(v, segment);
477 } else throw new IllegalStateException();
478 }
479 // rotate the vertical vector by 90 degrees (clockwise) and add it to the horizontal vector
480 segSum = EN.sum(h, new EastNorth(v.north(), -v.east()));
481 this.heading = EN.polar(new EastNorth(0., 0.), segSum);
482 }
483 }
484
485 private enum Direction {
486 RIGHT, UP, LEFT, DOWN;
487 public Direction changeBy(int directionChange) {
488 int tmp = (this.ordinal() + directionChange) % 4;
489 if (tmp < 0) {
490 tmp += 4; // the % operator can return negative value
491 }
492 return Direction.values()[tmp];
493 }
494 }
495
496 /**
497 * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
498 * @param a angle
499 * @return correct angle
500 */
501 private static double standard_angle_0_to_2PI(double a) {
502 while (a >= 2 * Math.PI) {
503 a -= 2 * Math.PI;
504 }
505 while (a < 0) {
506 a += 2 * Math.PI;
507 }
508 return a;
509 }
510
511 /**
512 * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
513 * @param a angle
514 * @return correct angle
515 */
516 private static double standard_angle_mPI_to_PI(double a) {
517 while (a > Math.PI) {
518 a -= 2 * Math.PI;
519 }
520 while (a <= -Math.PI) {
521 a += 2 * Math.PI;
522 }
523 return a;
524 }
525
526 /**
527 * Class contains some auxiliary functions
528 */
529 private static final class EN {
530 private EN() {
531 // Hide implicit public constructor for utility class
532 }
533
534 /**
535 * Rotate counter-clock-wise.
536 * @param pivot pivot
537 * @param en original east/north
538 * @param angle angle, in radians
539 * @return new east/north
540 */
541 public static EastNorth rotateCC(EastNorth pivot, EastNorth en, double angle) {
542 double cosPhi = Math.cos(angle);
543 double sinPhi = Math.sin(angle);
544 double x = en.east() - pivot.east();
545 double y = en.north() - pivot.north();
546 double nx = cosPhi * x - sinPhi * y + pivot.east();
547 double ny = sinPhi * x + cosPhi * y + pivot.north();
548 return new EastNorth(nx, ny);
549 }
550
551 public static EastNorth sum(EastNorth en1, EastNorth en2) {
552 return new EastNorth(en1.east() + en2.east(), en1.north() + en2.north());
553 }
554
555 public static EastNorth diff(EastNorth en1, EastNorth en2) {
556 return new EastNorth(en1.east() - en2.east(), en1.north() - en2.north());
557 }
558
559 public static double polar(EastNorth en1, EastNorth en2) {
560 return Math.atan2(en2.north() - en1.north(), en2.east() - en1.east());
561 }
562 }
563
564 /**
565 * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
566 * returns an integral value, corresponding to a counter clockwise turn.
567 * @param a angle, in radians
568 * @param deltaMax maximum tolerance, in radians
569 * @return an integral value, corresponding to a counter clockwise turn
570 * @throws RejectedAngleException in case of invalid angle
571 */
572 private static int angleToDirectionChange(double a, double deltaMax) throws RejectedAngleException {
573 a = standard_angle_mPI_to_PI(a);
574 double d0 = Math.abs(a);
575 double d90 = Math.abs(a - Math.PI / 2);
576 double dm90 = Math.abs(a + Math.PI / 2);
577 int dirChange;
578 if (d0 < deltaMax) {
579 dirChange = 0;
580 } else if (d90 < deltaMax) {
581 dirChange = 1;
582 } else if (dm90 < deltaMax) {
583 dirChange = -1;
584 } else {
585 a = standard_angle_0_to_2PI(a);
586 double d180 = Math.abs(a - Math.PI);
587 if (d180 < deltaMax) {
588 dirChange = 2;
589 } else
590 throw new RejectedAngleException();
591 }
592 return dirChange;
593 }
594
595 /**
596 * Exception: unsuited user input
597 */
598 protected static class InvalidUserInputException extends Exception {
599 InvalidUserInputException(String message) {
600 super(message);
601 }
602
603 InvalidUserInputException(String message, Throwable cause) {
604 super(message, cause);
605 }
606 }
607
608 /**
609 * Exception: angle cannot be recognized as 0, 90, 180 or 270 degrees
610 */
611 protected static class RejectedAngleException extends Exception {
612 RejectedAngleException() {
613 super();
614 }
615 }
616
617 @Override
618 protected void updateEnabledState() {
619 setEnabled(getCurrentDataSet() != null && !getCurrentDataSet().getSelected().isEmpty());
620 }
621
622 @Override
623 protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
624 setEnabled(selection != null && !selection.isEmpty());
625 }
626}
Note: See TracBrowser for help on using the repository browser.