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