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 * @return groups of ways with common nodes 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 * @return list of commands to perform 249 * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees 250 **/ 251 private static Collection<Command> orthogonalize(List<WayData> wayDataList, List<Node> headingNodes) throws InvalidUserInputException { 252 // find average heading 253 double headingAll; 254 try { 255 if (headingNodes.isEmpty()) { 256 // find directions of the segments and make them consistent between different ways 257 wayDataList.get(0).calcDirections(Direction.RIGHT); 258 double refHeading = wayDataList.get(0).heading; 259 EastNorth totSum = new EastNorth(0., 0.); 260 for (WayData w : wayDataList) { 261 w.calcDirections(Direction.RIGHT); 262 int directionOffset = angleToDirectionChange(w.heading - refHeading, TOLERANCE2); 263 w.calcDirections(Direction.RIGHT.changeBy(directionOffset)); 264 if (angleToDirectionChange(refHeading - w.heading, TOLERANCE2) != 0) 265 throw new RuntimeException(); 266 totSum = EN.sum(totSum, w.segSum); 267 } 268 headingAll = EN.polar(new EastNorth(0., 0.), totSum); 269 } else { 270 headingAll = EN.polar(headingNodes.get(0).getEastNorth(), headingNodes.get(1).getEastNorth()); 271 for (WayData w : wayDataList) { 272 w.calcDirections(Direction.RIGHT); 273 int directionOffset = angleToDirectionChange(w.heading - headingAll, TOLERANCE2); 274 w.calcDirections(Direction.RIGHT.changeBy(directionOffset)); 275 } 276 } 277 } catch (RejectedAngleException ex) { 278 throw new InvalidUserInputException( 279 tr("<html>Please make sure all selected ways head in a similar direction<br>"+ 280 "or orthogonalize them one by one.</html>"), ex); 281 } 282 283 // put the nodes of all ways in a set 284 final Set<Node> allNodes = new HashSet<>(); 285 for (WayData w : wayDataList) { 286 for (Node n : w.way.getNodes()) { 287 allNodes.add(n); 288 } 289 } 290 291 // the new x and y value for each node 292 final Map<Node, Double> nX = new HashMap<>(); 293 final Map<Node, Double> nY = new HashMap<>(); 294 295 // calculate the centroid of all nodes 296 // it is used as rotation center 297 EastNorth pivot = new EastNorth(0., 0.); 298 for (Node n : allNodes) { 299 pivot = EN.sum(pivot, n.getEastNorth()); 300 } 301 pivot = new EastNorth(pivot.east() / allNodes.size(), pivot.north() / allNodes.size()); 302 303 // rotate 304 for (Node n: allNodes) { 305 EastNorth tmp = EN.rotateCC(pivot, n.getEastNorth(), -headingAll); 306 nX.put(n, tmp.east()); 307 nY.put(n, tmp.north()); 308 } 309 310 // orthogonalize 311 final Direction[] HORIZONTAL = {Direction.RIGHT, Direction.LEFT}; 312 final Direction[] VERTICAL = {Direction.UP, Direction.DOWN}; 313 final Direction[][] ORIENTATIONS = {HORIZONTAL, VERTICAL}; 314 for (Direction[] orientation : ORIENTATIONS) { 315 final Set<Node> s = new HashSet<>(allNodes); 316 int s_size = s.size(); 317 for (int dummy = 0; dummy < s_size; ++dummy) { 318 if (s.isEmpty()) { 319 break; 320 } 321 final Node dummy_n = s.iterator().next(); // pick arbitrary element of s 322 323 final Set<Node> cs = new HashSet<>(); // will contain each node that can be reached from dummy_n 324 cs.add(dummy_n); // walking only on horizontal / vertical segments 325 326 boolean somethingHappened = true; 327 while (somethingHappened) { 328 somethingHappened = false; 329 for (WayData w : wayDataList) { 330 for (int i = 0; i < w.nSeg; ++i) { 331 Node n1 = w.way.getNodes().get(i); 332 Node n2 = w.way.getNodes().get(i+1); 333 if (Arrays.asList(orientation).contains(w.segDirections[i])) { 334 if (cs.contains(n1) && !cs.contains(n2)) { 335 cs.add(n2); 336 somethingHappened = true; 337 } 338 if (cs.contains(n2) && !cs.contains(n1)) { 339 cs.add(n1); 340 somethingHappened = true; 341 } 342 } 343 } 344 } 345 } 346 347 final Map<Node, Double> nC = (orientation == HORIZONTAL) ? nY : nX; 348 349 double average = 0; 350 for (Node n : cs) { 351 s.remove(n); 352 average += nC.get(n).doubleValue(); 353 } 354 average = average / cs.size(); 355 356 // if one of the nodes is a heading node, forget about the average and use its value 357 for (Node fn : headingNodes) { 358 if (cs.contains(fn)) { 359 average = nC.get(fn); 360 } 361 } 362 363 // At this point, the two heading nodes (if any) are horizontally aligned, i.e. they 364 // have the same y coordinate. So in general we shouldn't find them in a vertical string 365 // of segments. This can still happen in some pathological cases (see #7889). To avoid 366 // both heading nodes collapsing to one point, we simply skip this segment string and 367 // don't touch the node coordinates. 368 if (orientation == VERTICAL && headingNodes.size() == 2 && cs.containsAll(headingNodes)) { 369 continue; 370 } 371 372 for (Node n : cs) { 373 nC.put(n, average); 374 } 375 } 376 if (!s.isEmpty()) throw new RuntimeException(); 377 } 378 379 // rotate back and log the change 380 final Collection<Command> commands = new LinkedList<>(); 381 for (Node n: allNodes) { 382 EastNorth tmp = new EastNorth(nX.get(n), nY.get(n)); 383 tmp = EN.rotateCC(pivot, tmp, headingAll); 384 final double dx = tmp.east() - n.getEastNorth().east(); 385 final double dy = tmp.north() - n.getEastNorth().north(); 386 if (headingNodes.contains(n)) { // The heading nodes should not have changed 387 final double EPSILON = 1E-6; 388 if (Math.abs(dx) > Math.abs(EPSILON * tmp.east()) || 389 Math.abs(dy) > Math.abs(EPSILON * tmp.east())) 390 throw new AssertionError(); 391 } else { 392 OrthogonalizeAction.rememberMovements.put(n, new EastNorth(dx, dy)); 393 commands.add(new MoveCommand(n, dx, dy)); 394 } 395 } 396 return commands; 397 } 398 399 /** 400 * Class contains everything we need to know about a singe way. 401 */ 402 private static class WayData { 403 public final Way way; // The assigned way 404 public final int nSeg; // Number of Segments of the Way 405 public final int nNode; // Number of Nodes of the Way 406 public Direction[] segDirections; // Direction of the segments 407 // segment i goes from node i to node (i+1) 408 public EastNorth segSum; // (Vector-)sum of all horizontal segments plus the sum of all vertical 409 // segments turned by 90 degrees 410 public double heading; // heading of segSum == approximate heading of the way 411 412 WayData(Way pWay) { 413 way = pWay; 414 nNode = way.getNodes().size(); 415 nSeg = nNode - 1; 416 } 417 418 /** 419 * Estimate the direction of the segments, given the first segment points in the 420 * direction <code>pInitialDirection</code>. 421 * Then sum up all horizontal / vertical segments to have a good guess for the 422 * heading of the entire way. 423 * @param pInitialDirection initial direction 424 * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees 425 */ 426 public void calcDirections(Direction pInitialDirection) throws InvalidUserInputException { 427 final EastNorth[] en = new EastNorth[nNode]; // alias: way.getNodes().get(i).getEastNorth() ---> en[i] 428 for (int i = 0; i < nNode; i++) { 429 en[i] = new EastNorth(way.getNodes().get(i).getEastNorth().east(), way.getNodes().get(i).getEastNorth().north()); 430 } 431 segDirections = new Direction[nSeg]; 432 Direction direction = pInitialDirection; 433 segDirections[0] = direction; 434 for (int i = 0; i < nSeg - 1; i++) { 435 double h1 = EN.polar(en[i], en[i+1]); 436 double h2 = EN.polar(en[i+1], en[i+2]); 437 try { 438 direction = direction.changeBy(angleToDirectionChange(h2 - h1, TOLERANCE1)); 439 } catch (RejectedAngleException ex) { 440 throw new InvalidUserInputException(tr("Please select ways with angles of approximately 90 or 180 degrees."), ex); 441 } 442 segDirections[i+1] = direction; 443 } 444 445 // sum up segments 446 EastNorth h = new EastNorth(0., 0.); 447 EastNorth v = new EastNorth(0., 0.); 448 for (int i = 0; i < nSeg; ++i) { 449 EastNorth segment = EN.diff(en[i+1], en[i]); 450 if (segDirections[i] == Direction.RIGHT) { 451 h = EN.sum(h, segment); 452 } else if (segDirections[i] == Direction.UP) { 453 v = EN.sum(v, segment); 454 } else if (segDirections[i] == Direction.LEFT) { 455 h = EN.diff(h, segment); 456 } else if (segDirections[i] == Direction.DOWN) { 457 v = EN.diff(v, segment); 458 } else throw new IllegalStateException(); 459 } 460 // rotate the vertical vector by 90 degrees (clockwise) and add it to the horizontal vector 461 segSum = EN.sum(h, new EastNorth(v.north(), -v.east())); 462 this.heading = EN.polar(new EastNorth(0., 0.), segSum); 463 } 464 } 465 466 private enum Direction { 467 RIGHT, UP, LEFT, DOWN; 468 public Direction changeBy(int directionChange) { 469 int tmp = (this.ordinal() + directionChange) % 4; 470 if (tmp < 0) { 471 tmp += 4; // the % operator can return negative value 472 } 473 return Direction.values()[tmp]; 474 } 475 } 476 477 /** 478 * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ). 479 * @return correct angle 480 */ 481 private static double standard_angle_0_to_2PI(double a) { 482 while (a >= 2 * Math.PI) { 483 a -= 2 * Math.PI; 484 } 485 while (a < 0) { 486 a += 2 * Math.PI; 487 } 488 return a; 489 } 490 491 /** 492 * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ]. 493 * @return correct angle 494 */ 495 private static double standard_angle_mPI_to_PI(double a) { 496 while (a > Math.PI) { 497 a -= 2 * Math.PI; 498 } 499 while (a <= -Math.PI) { 500 a += 2 * Math.PI; 501 } 502 return a; 503 } 504 505 /** 506 * Class contains some auxiliary functions 507 */ 508 private static final class EN { 509 private EN() { 510 // Hide implicit public constructor for utility class 511 } 512 513 /** 514 * Rotate counter-clock-wise. 515 * @return new east/north 516 */ 517 public static EastNorth rotateCC(EastNorth pivot, EastNorth en, double angle) { 518 double cosPhi = Math.cos(angle); 519 double sinPhi = Math.sin(angle); 520 double x = en.east() - pivot.east(); 521 double y = en.north() - pivot.north(); 522 double nx = cosPhi * x - sinPhi * y + pivot.east(); 523 double ny = sinPhi * x + cosPhi * y + pivot.north(); 524 return new EastNorth(nx, ny); 525 } 526 527 public static EastNorth sum(EastNorth en1, EastNorth en2) { 528 return new EastNorth(en1.east() + en2.east(), en1.north() + en2.north()); 529 } 530 531 public static EastNorth diff(EastNorth en1, EastNorth en2) { 532 return new EastNorth(en1.east() - en2.east(), en1.north() - en2.north()); 533 } 534 535 public static double polar(EastNorth en1, EastNorth en2) { 536 return Math.atan2(en2.north() - en1.north(), en2.east() - en1.east()); 537 } 538 } 539 540 /** 541 * Recognize angle to be approximately 0, 90, 180 or 270 degrees. 542 * returns an integral value, corresponding to a counter clockwise turn. 543 * @return an integral value, corresponding to a counter clockwise turn 544 * @throws RejectedAngleException in case of invalid angle 545 */ 546 private static int angleToDirectionChange(double a, double deltaMax) throws RejectedAngleException { 547 a = standard_angle_mPI_to_PI(a); 548 double d0 = Math.abs(a); 549 double d90 = Math.abs(a - Math.PI / 2); 550 double d_m90 = Math.abs(a + Math.PI / 2); 551 int dirChange; 552 if (d0 < deltaMax) { 553 dirChange = 0; 554 } else if (d90 < deltaMax) { 555 dirChange = 1; 556 } else if (d_m90 < deltaMax) { 557 dirChange = -1; 558 } else { 559 a = standard_angle_0_to_2PI(a); 560 double d180 = Math.abs(a - Math.PI); 561 if (d180 < deltaMax) { 562 dirChange = 2; 563 } else 564 throw new RejectedAngleException(); 565 } 566 return dirChange; 567 } 568 569 /** 570 * Exception: unsuited user input 571 */ 572 private static class InvalidUserInputException extends Exception { 573 InvalidUserInputException(String message) { 574 super(message); 575 } 576 577 InvalidUserInputException(String message, Throwable cause) { 578 super(message, cause); 579 } 580 } 581 582 /** 583 * Exception: angle cannot be recognized as 0, 90, 180 or 270 degrees 584 */ 585 private static class RejectedAngleException extends Exception { 586 RejectedAngleException() { 587 super(); 588 } 589 } 590 591 /** 592 * Don't check, if the current selection is suited for orthogonalization. 593 * Instead, show a usage dialog, that explains, why it cannot be done. 594 */ 595 @Override 596 protected void updateEnabledState() { 597 setEnabled(getCurrentDataSet() != null); 598 } 599}