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

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

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