source: josm/trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWayAction.java@ 6310

Last change on this file since 6310 was 6310, checked in by Don-vip, 11 years ago

Sonar/FindBugs - Nested blocks of code should not be left empty
  • Property svn:eol-style set to native
File size: 21.5 KB
Line 
1// License: GPL. See LICENSE file for details.
2package org.openstreetmap.josm.actions.mapmode;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.AWTEvent;
8import java.awt.Color;
9import java.awt.Cursor;
10import java.awt.Graphics2D;
11import java.awt.Point;
12import java.awt.Stroke;
13import java.awt.Toolkit;
14import java.awt.event.AWTEventListener;
15import java.awt.event.InputEvent;
16import java.awt.event.KeyEvent;
17import java.awt.event.MouseEvent;
18import java.util.Collection;
19import java.util.LinkedHashSet;
20
21import javax.swing.JOptionPane;
22
23import org.openstreetmap.josm.Main;
24import org.openstreetmap.josm.data.Bounds;
25import org.openstreetmap.josm.data.Preferences.PreferenceChangeEvent;
26import org.openstreetmap.josm.data.Preferences.PreferenceChangedListener;
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.data.osm.WaySegment;
32import org.openstreetmap.josm.data.osm.visitor.paint.PaintColors;
33import org.openstreetmap.josm.gui.MapFrame;
34import org.openstreetmap.josm.gui.MapView;
35import org.openstreetmap.josm.gui.NavigatableComponent;
36import org.openstreetmap.josm.gui.NavigatableComponent.SystemOfMeasurement;
37import org.openstreetmap.josm.gui.layer.Layer;
38import org.openstreetmap.josm.gui.layer.MapViewPaintable;
39import org.openstreetmap.josm.gui.layer.OsmDataLayer;
40import org.openstreetmap.josm.gui.util.GuiHelper;
41import org.openstreetmap.josm.tools.Geometry;
42import static org.openstreetmap.josm.tools.I18n.marktr;
43import org.openstreetmap.josm.tools.ImageProvider;
44import org.openstreetmap.josm.tools.Shortcut;
45
46//// TODO: (list below)
47/* == Functionality ==
48 *
49 * 1. Use selected nodes as split points for the selected ways.
50 *
51 * The ways containing the selected nodes will be split and only the "inner"
52 * parts will be copied
53 *
54 * 2. Enter exact offset
55 *
56 * 3. Improve snapping
57 *
58 * 4. Visual cues could be better
59 *
60 * 5. Cursors (Half-done)
61 *
62 * 6. (long term) Parallelize and adjust offsets of existing ways
63 *
64 * == Code quality ==
65 *
66 * a) The mode, flags, and modifiers might be updated more than necessary.
67 *
68 * Not a performance problem, but better if they where more centralized
69 *
70 * b) Extract generic MapMode services into a super class and/or utility class
71 *
72 * c) Maybe better to simply draw our own source way highlighting?
73 *
74 * Current code doesn't not take into account that ways might been highlighted
75 * by other than us. Don't think that situation should ever happen though.
76 */
77
78/**
79 * MapMode for making parallel ways.
80 *
81 * All calculations are done in projected coordinates.
82 *
83 * @author Ole Jørgen Brønner (olejorgenb)
84 */
85public class ParallelWayAction extends MapMode implements AWTEventListener, MapViewPaintable, PreferenceChangedListener {
86
87 private enum Mode {
88 dragging, normal
89 }
90
91 //// Preferences and flags
92 // See updateModeLocalPreferences for defaults
93 private Mode mode;
94 private boolean copyTags;
95 private boolean copyTagsDefault;
96
97 private boolean snap;
98 private boolean snapDefault;
99
100 private double snapThreshold;
101 private double snapDistanceMetric;
102 private double snapDistanceImperial;
103 private double snapDistanceChinese;
104 private double snapDistanceNautical;
105
106 private ModifiersSpec snapModifierCombo;
107 private ModifiersSpec copyTagsModifierCombo;
108 private ModifiersSpec addToSelectionModifierCombo;
109 private ModifiersSpec toggleSelectedModifierCombo;
110 private ModifiersSpec setSelectedModifierCombo;
111
112 private int initialMoveDelay;
113
114 private final MapView mv;
115
116 // Mouse tracking state
117 private Point mousePressedPos;
118 private boolean mouseIsDown;
119 private long mousePressedTime;
120 private boolean mouseHasBeenDragged;
121
122 private WaySegment referenceSegment;
123 private ParallelWays pWays;
124 private LinkedHashSet<Way> sourceWays;
125 private EastNorth helperLineStart;
126 private EastNorth helperLineEnd;
127
128 Stroke helpLineStroke;
129 Stroke refLineStroke;
130 Color mainColor;
131
132 public ParallelWayAction(MapFrame mapFrame) {
133 super(tr("Parallel"), "parallel", tr("Make parallel copies of ways"),
134 Shortcut.registerShortcut("mapmode:parallel", tr("Mode: {0}",
135 tr("Parallel")), KeyEvent.VK_P, Shortcut.SHIFT),
136 mapFrame, ImageProvider.getCursor("normal", "parallel"));
137 putValue("help", ht("/Action/Parallel"));
138 mv = mapFrame.mapView;
139 updateModeLocalPreferences();
140 Main.pref.addPreferenceChangeListener(this);
141 }
142
143 @Override
144 public void enterMode() {
145 // super.enterMode() updates the status line and cursor so we need our state to be set correctly
146 setMode(Mode.normal);
147 pWays = null;
148 updateAllPreferences(); // All default values should've been set now
149
150 super.enterMode();
151
152 mv.addMouseListener(this);
153 mv.addMouseMotionListener(this);
154 mv.addTemporaryLayer(this);
155
156 helpLineStroke = GuiHelper.getCustomizedStroke(getStringPref("stroke.hepler-line", "1" ));
157 refLineStroke = GuiHelper.getCustomizedStroke(getStringPref("stroke.ref-line", "1 2 2"));
158 mainColor = Main.pref.getColor(marktr("make parallel helper line"), null);
159 if (mainColor == null) mainColor = PaintColors.SELECTED.get();
160
161 //// Needed to update the mouse cursor if modifiers are changed when the mouse is motionless
162 try {
163 Toolkit.getDefaultToolkit().addAWTEventListener(this, AWTEvent.KEY_EVENT_MASK);
164 } catch (SecurityException ex) {
165 Main.warn(ex);
166 }
167 sourceWays = new LinkedHashSet<Way>(getCurrentDataSet().getSelectedWays());
168 for (Way w : sourceWays) {
169 w.setHighlighted(true);
170 }
171 mv.repaint();
172 }
173
174 @Override
175 public void exitMode() {
176 super.exitMode();
177 mv.removeMouseListener(this);
178 mv.removeMouseMotionListener(this);
179 mv.removeTemporaryLayer(this);
180 Main.map.statusLine.setDist(-1);
181 Main.map.statusLine.repaint();
182 try {
183 Toolkit.getDefaultToolkit().removeAWTEventListener(this);
184 } catch (SecurityException ex) {
185 Main.warn(ex);
186 }
187 removeWayHighlighting(sourceWays);
188 pWays = null;
189 sourceWays = null;
190 referenceSegment = null;
191 mv.repaint();
192 }
193
194 @Override
195 public String getModeHelpText() {
196 // TODO: add more detailed feedback based on modifier state.
197 // TODO: dynamic messages based on preferences. (Could be problematic translation wise)
198 switch (mode) {
199 case normal:
200 return tr("Select ways as in Select mode. Drag selected ways or a single way to create a parallel copy (Alt toggles tag preservation)");
201 case dragging:
202 return tr("Hold Ctrl to toggle snapping");
203 }
204 return ""; // impossible ..
205 }
206
207 // Separated due to "race condition" between default values
208 private void updateAllPreferences() {
209 updateModeLocalPreferences();
210 // @formatter:off
211 // @formatter:on
212 }
213
214 private void updateModeLocalPreferences() {
215 // @formatter:off
216 snapThreshold = Main.pref.getDouble (prefKey("snap-threshold-percent"), 0.70);
217 snapDefault = Main.pref.getBoolean(prefKey("snap-default"), true);
218 copyTagsDefault = Main.pref.getBoolean(prefKey("copy-tags-default"), true);
219 initialMoveDelay = Main.pref.getInteger(prefKey("initial-move-delay"), 200);
220 snapDistanceMetric = Main.pref.getDouble(prefKey("snap-distance-metric"), 0.5);
221 snapDistanceImperial = Main.pref.getDouble(prefKey("snap-distance-imperial"), 1);
222 snapDistanceChinese = Main.pref.getDouble(prefKey("snap-distance-chinese"), 1);
223 snapDistanceNautical = Main.pref.getDouble(prefKey("snap-distance-nautical"), 0.1);
224
225 snapModifierCombo = new ModifiersSpec(getStringPref("snap-modifier-combo", "?sC"));
226 copyTagsModifierCombo = new ModifiersSpec(getStringPref("copy-tags-modifier-combo", "As?"));
227 addToSelectionModifierCombo = new ModifiersSpec(getStringPref("add-to-selection-modifier-combo", "aSc"));
228 toggleSelectedModifierCombo = new ModifiersSpec(getStringPref("toggle-selection-modifier-combo", "asC"));
229 setSelectedModifierCombo = new ModifiersSpec(getStringPref("set-selection-modifier-combo", "asc"));
230 // @formatter:on
231 }
232
233 @Override
234 public boolean layerIsSupported(Layer layer) {
235 return layer instanceof OsmDataLayer;
236 }
237
238 @Override
239 public void eventDispatched(AWTEvent e) {
240 if (Main.map == null || mv == null || !mv.isActiveLayerDrawable())
241 return;
242
243 // Should only get InputEvents due to the mask in enterMode
244 if (updateModifiersState((InputEvent) e)) {
245 updateStatusLine();
246 updateCursor();
247 }
248 }
249
250 private boolean updateModifiersState(InputEvent e) {
251 boolean oldAlt = alt, oldShift = shift, oldCtrl = ctrl;
252 updateKeyModifiers(e);
253 boolean changed = (oldAlt != alt || oldShift != shift || oldCtrl != ctrl);
254 return changed;
255 }
256
257 private void updateCursor() {
258 Cursor newCursor = null;
259 switch (mode) {
260 case normal:
261 if (matchesCurrentModifiers(setSelectedModifierCombo)) {
262 newCursor = ImageProvider.getCursor("normal", "parallel");
263 } else if (matchesCurrentModifiers(addToSelectionModifierCombo)) {
264 newCursor = ImageProvider.getCursor("normal", "parallel"); // FIXME
265 } else if (matchesCurrentModifiers(toggleSelectedModifierCombo)) {
266 newCursor = ImageProvider.getCursor("normal", "parallel"); // FIXME
267 } else {
268 // TODO: set to a cursor indicating an error
269 }
270 break;
271 case dragging:
272 if (snap) {
273 // TODO: snapping cursor?
274 newCursor = Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR);
275 } else {
276 newCursor = Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR);
277 }
278 }
279 if (newCursor != null) {
280 mv.setNewCursor(newCursor, this);
281 }
282 }
283
284 private void setMode(Mode mode) {
285 this.mode = mode;
286 updateCursor();
287 updateStatusLine();
288 }
289
290 private boolean isValidModifierCombination() {
291 // TODO: implement to give feedback on invalid modifier combination
292 return true;
293 }
294
295 private boolean sanityCheck() {
296 // @formatter:off
297 boolean areWeSane =
298 mv.isActiveLayerVisible() &&
299 mv.isActiveLayerDrawable() &&
300 ((Boolean) this.getValue("active"));
301 // @formatter:on
302 assert (areWeSane); // mad == bad
303 return areWeSane;
304 }
305
306 @Override
307 public void mousePressed(MouseEvent e) {
308 requestFocusInMapView();
309 updateModifiersState(e);
310 // Other buttons are off limit, but we still get events.
311 if (e.getButton() != MouseEvent.BUTTON1)
312 return;
313
314 if (!sanityCheck())
315 return;
316
317 updateFlagsOnlyChangeableOnPress();
318 updateFlagsChangeableAlways();
319
320 // Since the created way is left selected, we need to unselect again here
321 if (pWays != null && pWays.ways != null) {
322 getCurrentDataSet().clearSelection(pWays.ways);
323 pWays = null;
324 }
325
326 mouseIsDown = true;
327 mousePressedPos = e.getPoint();
328 mousePressedTime = System.currentTimeMillis();
329
330 }
331
332 @Override
333 public void mouseReleased(MouseEvent e) {
334 updateModifiersState(e);
335 // Other buttons are off limit, but we still get events.
336 if (e.getButton() != MouseEvent.BUTTON1)
337 return;
338
339 if (!mouseHasBeenDragged) {
340 // use point from press or click event? (or are these always the same)
341 Way nearestWay = mv.getNearestWay(e.getPoint(), OsmPrimitive.isSelectablePredicate);
342 if (nearestWay == null) {
343 if (matchesCurrentModifiers(setSelectedModifierCombo)) {
344 clearSourceWays();
345 }
346 resetMouseTrackingState();
347 return;
348 }
349 boolean isSelected = nearestWay.isSelected();
350 if (matchesCurrentModifiers(addToSelectionModifierCombo)) {
351 if (!isSelected) {
352 addSourceWay(nearestWay);
353 }
354 } else if (matchesCurrentModifiers(toggleSelectedModifierCombo)) {
355 if (isSelected) {
356 removeSourceWay(nearestWay);
357 } else {
358 addSourceWay(nearestWay);
359 }
360 } else if (matchesCurrentModifiers(setSelectedModifierCombo)) {
361 clearSourceWays();
362 addSourceWay(nearestWay);
363 } // else -> invalid modifier combination
364 } else if (mode == Mode.dragging) {
365 clearSourceWays();
366 }
367
368 setMode(Mode.normal);
369 resetMouseTrackingState();
370 mv.repaint();
371 }
372
373 private void removeWayHighlighting(Collection<Way> ways) {
374 if (ways == null)
375 return;
376 for (Way w : ways) {
377 w.setHighlighted(false);
378 }
379 }
380
381 @Override
382 public void mouseDragged(MouseEvent e) {
383 // WTF.. the event passed here doesn't have button info?
384 // Since we get this event from other buttons too, we must check that
385 // _BUTTON1_ is down.
386 if (!mouseIsDown)
387 return;
388
389 boolean modifiersChanged = updateModifiersState(e);
390 updateFlagsChangeableAlways();
391
392 if (modifiersChanged) {
393 // Since this could be remotely slow, do it conditionally
394 updateStatusLine();
395 updateCursor();
396 }
397
398 if ((System.currentTimeMillis() - mousePressedTime) < initialMoveDelay)
399 return;
400 // Assuming this event only is emitted when the mouse has moved
401 // Setting this after the check above means we tolerate clicks with some movement
402 mouseHasBeenDragged = true;
403
404 Point p = e.getPoint();
405 if (mode == Mode.normal) {
406 // Should we ensure that the copyTags modifiers are still valid?
407
408 // Important to use mouse position from the press, since the drag
409 // event can come quite late
410 if (!isModifiersValidForDragMode())
411 return;
412 if (!initParallelWays(mousePressedPos, copyTags))
413 return;
414 setMode(Mode.dragging);
415 }
416
417 // Calculate distance to the reference line
418 EastNorth enp = mv.getEastNorth((int) p.getX(), (int) p.getY());
419 EastNorth nearestPointOnRefLine = Geometry.closestPointToLine(referenceSegment.getFirstNode().getEastNorth(),
420 referenceSegment.getSecondNode().getEastNorth(), enp);
421
422 // Note: d is the distance in _projected units_
423 double d = enp.distance(nearestPointOnRefLine);
424 double realD = mv.getProjection().eastNorth2latlon(enp).greatCircleDistance(mv.getProjection().eastNorth2latlon(nearestPointOnRefLine));
425 double snappedRealD = realD;
426
427 // TODO: abuse of isToTheRightSideOfLine function.
428 boolean toTheRight = Geometry.isToTheRightSideOfLine(referenceSegment.getFirstNode(),
429 referenceSegment.getFirstNode(), referenceSegment.getSecondNode(), new Node(enp));
430
431 if (snap) {
432 // TODO: Very simple snapping
433 // - Snap steps relative to the distance?
434 double snapDistance;
435 SystemOfMeasurement som = NavigatableComponent.getSystemOfMeasurement();
436 if (som.equals(NavigatableComponent.CHINESE_SOM)) {
437 snapDistance = snapDistanceChinese * NavigatableComponent.CHINESE_SOM.aValue;
438 } else if (som.equals(NavigatableComponent.IMPERIAL_SOM)) {
439 snapDistance = snapDistanceImperial * NavigatableComponent.IMPERIAL_SOM.aValue;
440 } else if (som.equals(NavigatableComponent.NAUTICAL_MILE_SOM)) {
441 snapDistance = snapDistanceNautical * NavigatableComponent.NAUTICAL_MILE_SOM.aValue;
442 } else {
443 snapDistance = snapDistanceMetric; // Metric system by default
444 }
445 double closestWholeUnit;
446 double modulo = realD % snapDistance;
447 if (modulo < snapDistance/2.0) {
448 closestWholeUnit = realD - modulo;
449 } else {
450 closestWholeUnit = realD + (snapDistance-modulo);
451 }
452 if (Math.abs(closestWholeUnit - realD) < (snapThreshold * snapDistance)) {
453 snappedRealD = closestWholeUnit;
454 } else {
455 snappedRealD = closestWholeUnit + Math.signum(realD - closestWholeUnit) * snapDistance;
456 }
457 }
458 d = snappedRealD * (d/realD); // convert back to projected distance. (probably ok on small scales)
459 helperLineStart = nearestPointOnRefLine;
460 helperLineEnd = enp;
461 if (toTheRight) {
462 d = -d;
463 }
464 pWays.changeOffset(d);
465
466 Main.map.statusLine.setDist(Math.abs(snappedRealD));
467 Main.map.statusLine.repaint();
468 mv.repaint();
469 }
470
471 private boolean matchesCurrentModifiers(ModifiersSpec spec) {
472 return spec.matchWithKnown(alt, shift, ctrl);
473 }
474
475 @Override
476 public void paint(Graphics2D g, MapView mv, Bounds bbox) {
477 if (mode == Mode.dragging) {
478 // sanity checks
479 if (mv == null)
480 return;
481
482 // FIXME: should clip the line (gets insanely slow when zoomed in on a very long line
483 g.setStroke(refLineStroke);
484 g.setColor(mainColor);
485 Point p1 = mv.getPoint(referenceSegment.getFirstNode().getEastNorth());
486 Point p2 = mv.getPoint(referenceSegment.getSecondNode().getEastNorth());
487 g.drawLine(p1.x, p1.y, p2.x, p2.y);
488
489 g.setStroke(helpLineStroke);
490 g.setColor(mainColor);
491 p1 = mv.getPoint(helperLineStart);
492 p2 = mv.getPoint(helperLineEnd);
493 g.drawLine(p1.x, p1.y, p2.x, p2.y);
494 }
495 }
496
497 private boolean isModifiersValidForDragMode() {
498 return (!alt && !shift && !ctrl) || matchesCurrentModifiers(snapModifierCombo)
499 || matchesCurrentModifiers(copyTagsModifierCombo);
500 }
501
502 private void updateFlagsOnlyChangeableOnPress() {
503 copyTags = copyTagsDefault != matchesCurrentModifiers(copyTagsModifierCombo);
504 }
505
506 private void updateFlagsChangeableAlways() {
507 snap = snapDefault != matchesCurrentModifiers(snapModifierCombo);
508 }
509
510 //// We keep the source ways and the selection in sync so the user can see the source way's tags
511 private void addSourceWay(Way w) {
512 assert (sourceWays != null);
513 getCurrentDataSet().addSelected(w);
514 w.setHighlighted(true);
515 sourceWays.add(w);
516 }
517
518 private void removeSourceWay(Way w) {
519 assert (sourceWays != null);
520 getCurrentDataSet().clearSelection(w);
521 w.setHighlighted(false);
522 sourceWays.remove(w);
523 }
524
525 private void clearSourceWays() {
526 assert (sourceWays != null);
527 getCurrentDataSet().clearSelection(sourceWays);
528 for (Way w : sourceWays) {
529 w.setHighlighted(false);
530 }
531 sourceWays.clear();
532 }
533
534 private void resetMouseTrackingState() {
535 mouseIsDown = false;
536 mousePressedPos = null;
537 mouseHasBeenDragged = false;
538 }
539
540 // TODO: rename
541 private boolean initParallelWays(Point p, boolean copyTags) {
542 referenceSegment = mv.getNearestWaySegment(p, Way.isUsablePredicate, true);
543 if (referenceSegment == null)
544 return false;
545
546 if (!sourceWays.contains(referenceSegment.way)) {
547 clearSourceWays();
548 addSourceWay(referenceSegment.way);
549 }
550
551 try {
552 int referenceWayIndex = -1;
553 int i = 0;
554 for (Way w : sourceWays) {
555 if (w == referenceSegment.way) {
556 referenceWayIndex = i;
557 break;
558 }
559 i++;
560 }
561 pWays = new ParallelWays(sourceWays, copyTags, referenceWayIndex);
562 pWays.commit();
563 getCurrentDataSet().setSelected(pWays.ways);
564 return true;
565 } catch (IllegalArgumentException e) {
566 // TODO: Not ideal feedback. Maybe changing the cursor could be a good mechanism?
567 JOptionPane.showMessageDialog(
568 Main.parent,
569 tr("ParallelWayAction\n" +
570 "The ways selected must form a simple branchless path"),
571 tr("Make parallel way error"),
572 JOptionPane.INFORMATION_MESSAGE);
573 // The error dialog prevents us from getting the mouseReleased event
574 resetMouseTrackingState();
575 pWays = null;
576 return false;
577 }
578 }
579
580 private String prefKey(String subKey) {
581 return "edit.make-parallel-way-action." + subKey;
582 }
583
584 private String getStringPref(String subKey, String def) {
585 return Main.pref.get(prefKey(subKey), def);
586 }
587
588 @Override
589 public void preferenceChanged(PreferenceChangeEvent e) {
590 if (e.getKey().startsWith(prefKey(""))) {
591 updateAllPreferences();
592 }
593 }
594
595 @Override
596 public void destroy() {
597 super.destroy();
598 Main.pref.removePreferenceChangeListener(this);
599 }
600}
Note: See TracBrowser for help on using the repository browser.