// License: GPL. See LICENSE file for details.
package org.openstreetmap.josm.actions.mapmode;
import static org.openstreetmap.josm.tools.I18n.marktr;
import static org.openstreetmap.josm.tools.I18n.tr;
import static org.openstreetmap.josm.tools.I18n.trn;
import java.awt.Color;
import java.awt.Cursor;
import java.awt.Graphics2D;
import java.awt.Point;
import java.awt.Stroke;
import java.awt.event.KeyEvent;
import java.awt.event.MouseEvent;
import java.awt.geom.GeneralPath;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import javax.swing.JOptionPane;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.command.AddCommand;
import org.openstreetmap.josm.command.ChangeCommand;
import org.openstreetmap.josm.command.Command;
import org.openstreetmap.josm.command.DeleteCommand;
import org.openstreetmap.josm.command.MoveCommand;
import org.openstreetmap.josm.command.SequenceCommand;
import org.openstreetmap.josm.data.Bounds;
import org.openstreetmap.josm.data.SelectionChangedListener;
import org.openstreetmap.josm.data.coor.EastNorth;
import org.openstreetmap.josm.data.osm.DataSet;
import org.openstreetmap.josm.data.osm.Node;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.data.osm.Way;
import org.openstreetmap.josm.data.osm.WaySegment;
import org.openstreetmap.josm.data.osm.visitor.paint.PaintColors;
import org.openstreetmap.josm.gui.MapFrame;
import org.openstreetmap.josm.gui.MapView;
import org.openstreetmap.josm.gui.layer.Layer;
import org.openstreetmap.josm.gui.layer.MapViewPaintable;
import org.openstreetmap.josm.gui.layer.OsmDataLayer;
import org.openstreetmap.josm.gui.util.GuiHelper;
import org.openstreetmap.josm.gui.util.ModifierListener;
import org.openstreetmap.josm.tools.ImageProvider;
import org.openstreetmap.josm.tools.Pair;
import org.openstreetmap.josm.tools.Shortcut;
/**
* @author Alexander Kachkaev <alexander@kachkaev.ru>, 2011
*/
public class ImproveWayAccuracyAction extends MapMode implements MapViewPaintable,
SelectionChangedListener, ModifierListener {
enum State {
selecting, improving
}
private State state;
private MapView mv;
private static final long serialVersionUID = 42L;
private Way targetWay;
private Node candidateNode = null;
private WaySegment candidateSegment = null;
private Point mousePos = null;
private boolean dragging = false;
private final Cursor cursorSelect;
private final Cursor cursorSelectHover;
private final Cursor cursorImprove;
private final Cursor cursorImproveAdd;
private final Cursor cursorImproveDelete;
private final Cursor cursorImproveAddLock;
private final Cursor cursorImproveLock;
private Color guideColor;
private Stroke selectTargetWayStroke;
private Stroke moveNodeStroke;
private Stroke addNodeStroke;
private Stroke deleteNodeStroke;
private int dotSize;
private boolean selectionChangedBlocked = false;
protected String oldModeHelpText;
/**
* Constructs a new {@code ImproveWayAccuracyAction}.
* @param mapFrame Map frame
*/
public ImproveWayAccuracyAction(MapFrame mapFrame) {
super(tr("Improve Way Accuracy"), "improvewayaccuracy.png",
tr("Improve Way Accuracy mode"),
Shortcut.registerShortcut("mapmode:ImproveWayAccuracy",
tr("Mode: {0}", tr("Improve Way Accuracy")),
KeyEvent.VK_W, Shortcut.DIRECT), mapFrame, Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
cursorSelect = ImageProvider.getCursor("normal", "mode");
cursorSelectHover = ImageProvider.getCursor("hand", "mode");
cursorImprove = ImageProvider.getCursor("crosshair", null);
cursorImproveAdd = ImageProvider.getCursor("crosshair", "addnode");
cursorImproveDelete = ImageProvider.getCursor("crosshair", "delete_node");
cursorImproveAddLock = ImageProvider.getCursor("crosshair",
"add_node_lock");
cursorImproveLock = ImageProvider.getCursor("crosshair", "lock");
readPreferences();
}
// -------------------------------------------------------------------------
// Mode methods
// -------------------------------------------------------------------------
@Override
public void enterMode() {
if (!isEnabled()) {
return;
}
super.enterMode();
readPreferences();
mv = Main.map.mapView;
mousePos = null;
oldModeHelpText = "";
if (getCurrentDataSet() == null) {
return;
}
updateStateByCurrentSelection();
Main.map.mapView.addMouseListener(this);
Main.map.mapView.addMouseMotionListener(this);
Main.map.mapView.addTemporaryLayer(this);
DataSet.addSelectionListener(this);
Main.map.keyDetector.addModifierListener(this);
}
private void readPreferences() {
guideColor = Main.pref.getColor(marktr("improve way accuracy helper line"), null);
if (guideColor == null) guideColor = PaintColors.HIGHLIGHT.get();
selectTargetWayStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.select-target", "2"));
moveNodeStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.move-node", "1 6"));
addNodeStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.add-node", "1"));
deleteNodeStroke = GuiHelper.getCustomizedStroke(Main.pref.get("improvewayaccuracy.stroke.delete-node", "1"));
dotSize = Main.pref.getInteger("improvewayaccuracy.dot-size",6);
}
@Override
public void exitMode() {
super.exitMode();
Main.map.mapView.removeMouseListener(this);
Main.map.mapView.removeMouseMotionListener(this);
Main.map.mapView.removeTemporaryLayer(this);
DataSet.removeSelectionListener(this);
Main.map.keyDetector.removeModifierListener(this);
Main.map.mapView.repaint();
}
@Override
protected void updateStatusLine() {
String newModeHelpText = getModeHelpText();
if (!newModeHelpText.equals(oldModeHelpText)) {
oldModeHelpText = newModeHelpText;
Main.map.statusLine.setHelpText(newModeHelpText);
Main.map.statusLine.repaint();
}
}
@Override
public String getModeHelpText() {
if (state == State.selecting) {
if (targetWay != null) {
return tr("Click on the way to start improving its shape.");
} else {
return tr("Select a way that you want to make more accurate.");
}
} else {
if (ctrl) {
return tr("Click to add a new node. Release Ctrl to move existing nodes or hold Alt to delete.");
} else if (alt) {
return tr("Click to delete the highlighted node. Release Alt to move existing nodes or hold Ctrl to add new nodes.");
} else {
return tr("Click to move the highlighted node. Hold Ctrl to add new nodes, or Alt to delete.");
}
}
}
@Override
public boolean layerIsSupported(Layer l) {
return l instanceof OsmDataLayer;
}
@Override
protected void updateEnabledState() {
setEnabled(getEditLayer() != null);
}
// -------------------------------------------------------------------------
// MapViewPaintable methods
// -------------------------------------------------------------------------
/**
* Redraws temporary layer. Highlights targetWay in select mode. Draws
* preview lines in improve mode and highlights the candidateNode
*/
@Override
public void paint(Graphics2D g, MapView mv, Bounds bbox) {
if (mousePos == null) {
return;
}
g.setColor(guideColor);
if (state == State.selecting && targetWay != null) {
// Highlighting the targetWay in Selecting state
// Non-native highlighting is used, because sometimes highlighted
// segments are covered with others, which is bad.
g.setStroke(selectTargetWayStroke);
List<Node> nodes = targetWay.getNodes();
GeneralPath b = new GeneralPath();
Point p0 = mv.getPoint(nodes.get(0));
Point pn;
b.moveTo(p0.x, p0.y);
for (Node n : nodes) {
pn = mv.getPoint(n);
b.lineTo(pn.x, pn.y);
}
if (targetWay.isClosed()) {
b.lineTo(p0.x, p0.y);
}
g.draw(b);
} else if (state == State.improving) {
// Drawing preview lines and highlighting the node
// that is going to be moved.
// Non-native highlighting is used here as well.
// Finding endpoints
Point p1 = null, p2 = null;
if (ctrl && candidateSegment != null) {
g.setStroke(addNodeStroke);
p1 = mv.getPoint(candidateSegment.getFirstNode());
p2 = mv.getPoint(candidateSegment.getSecondNode());
} else if (!alt && !ctrl && candidateNode != null) {
g.setStroke(moveNodeStroke);
List<Pair<Node, Node>> wpps = targetWay.getNodePairs(false);
for (Pair<Node, Node> wpp : wpps) {
if (wpp.a == candidateNode) {
p1 = mv.getPoint(wpp.b);
}
if (wpp.b == candidateNode) {
p2 = mv.getPoint(wpp.a);
}
if (p1 != null && p2 != null) {
break;
}
}
} else if (alt && !ctrl && candidateNode != null) {
g.setStroke(deleteNodeStroke);
List<Node> nodes = targetWay.getNodes();
int index = nodes.indexOf(candidateNode);
// Only draw line if node is not first and/or last
if (index != 0 && index != (nodes.size() - 1)) {
p1 = mv.getPoint(nodes.get(index - 1));
p2 = mv.getPoint(nodes.get(index + 1));
}
// TODO: indicate what part that will be deleted? (for end nodes)
}
// Drawing preview lines
GeneralPath b = new GeneralPath();
if (alt && !ctrl) {
// In delete mode
if (p1 != null && p2 != null) {
b.moveTo(p1.x, p1.y);
b.lineTo(p2.x, p2.y);
}
} else {
// In add or move mode
if (p1 != null) {
b.moveTo(mousePos.x, mousePos.y);
b.lineTo(p1.x, p1.y);
}
if (p2 != null) {
b.moveTo(mousePos.x, mousePos.y);
b.lineTo(p2.x, p2.y);
}
}
g.draw(b);
// Highlighting candidateNode
if (candidateNode != null) {
p1 = mv.getPoint(candidateNode);
g.fillRect(p1.x - dotSize/2, p1.y - dotSize/2, dotSize, dotSize);
}
}
}
// -------------------------------------------------------------------------
// Event handlers
// -------------------------------------------------------------------------
@Override
public void modifiersChanged(int modifiers) {
if (!Main.isDisplayingMapView() || !Main.map.mapView.isActiveLayerDrawable()) {
return;
}
updateKeyModifiers(modifiers);
updateCursorDependentObjectsIfNeeded();
updateCursor();
updateStatusLine();
Main.map.mapView.repaint();
}
@Override
public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
if (selectionChangedBlocked) {
return;
}
updateStateByCurrentSelection();
}
@Override
public void mouseDragged(MouseEvent e) {
dragging = true;
mouseMoved(e);
}
@Override
public void mouseMoved(MouseEvent e) {
if (!isEnabled()) {
return;
}
mousePos = e.getPoint();
updateKeyModifiers(e);
updateCursorDependentObjectsIfNeeded();
updateCursor();
updateStatusLine();
Main.map.mapView.repaint();
}
@Override
public void mouseReleased(MouseEvent e) {
dragging = false;
if (!isEnabled() || e.getButton() != MouseEvent.BUTTON1) {
return;
}
updateKeyModifiers(e);
mousePos = e.getPoint();
if (state == State.selecting) {
if (targetWay != null) {
getCurrentDataSet().setSelected(targetWay.getPrimitiveId());
updateStateByCurrentSelection();
}
} else if (state == State.improving && mousePos != null) {
// Checking if the new coordinate is outside of the world
if (mv.getLatLon(mousePos.x, mousePos.y).isOutSideWorld()) {
JOptionPane.showMessageDialog(Main.parent,
tr("Cannot place a node outside of the world."),
tr("Warning"), JOptionPane.WARNING_MESSAGE);
return;
}
if (ctrl && !alt && candidateSegment != null) {
// Adding a new node to the highlighted segment
// Important: If there are other ways containing the same
// segment, a node must added to all of that ways.
Collection<Command> virtualCmds = new LinkedList<>();
// Creating a new node
Node virtualNode = new Node(mv.getEastNorth(mousePos.x,
mousePos.y));
virtualCmds.add(new AddCommand(virtualNode));
// Looking for candidateSegment copies in ways that are
// referenced
// by candidateSegment nodes
List<Way> firstNodeWays = OsmPrimitive.getFilteredList(
candidateSegment.getFirstNode().getReferrers(),
Way.class);
List<Way> secondNodeWays = OsmPrimitive.getFilteredList(
candidateSegment.getFirstNode().getReferrers(),
Way.class);
Collection<WaySegment> virtualSegments = new LinkedList<>();
for (Way w : firstNodeWays) {
List<Pair<Node, Node>> wpps = w.getNodePairs(true);
for (Way w2 : secondNodeWays) {
if (!w.equals(w2)) {
continue;
}
// A way is referenced in both nodes.
// Checking if there is such segment
int i = -1;
for (Pair<Node, Node> wpp : wpps) {
++i;
if ((wpp.a.equals(candidateSegment.getFirstNode())
&& wpp.b.equals(candidateSegment.getSecondNode()) || (wpp.b.equals(candidateSegment.getFirstNode()) && wpp.a.equals(candidateSegment.getSecondNode())))) {
virtualSegments.add(new WaySegment(w, i));
}
}
}
}
// Adding the node to all segments found
for (WaySegment virtualSegment : virtualSegments) {
Way w = virtualSegment.way;
Way wnew = new Way(w);
wnew.addNode(virtualSegment.lowerIndex + 1, virtualNode);
virtualCmds.add(new ChangeCommand(w, wnew));
}
// Finishing the sequence command
String text = trn("Add a new node to way",
"Add a new node to {0} ways",
virtualSegments.size(), virtualSegments.size());
Main.main.undoRedo.add(new SequenceCommand(text, virtualCmds));
} else if (alt && !ctrl && candidateNode != null) {
// Deleting the highlighted node
//check to see if node is in use by more than one object
List<OsmPrimitive> referrers = candidateNode.getReferrers();
List<Way> ways = OsmPrimitive.getFilteredList(referrers, Way.class);
if (referrers.size() != 1 || ways.size() != 1) {
JOptionPane.showMessageDialog(Main.parent,
tr("Cannot delete node that is referenced by multiple objects"),
tr("Error"), JOptionPane.ERROR_MESSAGE);
} else if (candidateNode.isTagged()) {
JOptionPane.showMessageDialog(Main.parent,
tr("Cannot delete node that has tags"),
tr("Error"), JOptionPane.ERROR_MESSAGE);
} else {
List<Node> nodeList = new ArrayList<>();
nodeList.add(candidateNode);
Command deleteCmd = DeleteCommand.delete(getEditLayer(), nodeList, true);
if (deleteCmd != null) {
Main.main.undoRedo.add(deleteCmd);
}
}
} else if (candidateNode != null) {
// Moving the highlighted node
EastNorth nodeEN = candidateNode.getEastNorth();
EastNorth cursorEN = mv.getEastNorth(mousePos.x, mousePos.y);
Main.main.undoRedo.add(new MoveCommand(candidateNode, cursorEN.east() - nodeEN.east(), cursorEN.north()
- nodeEN.north()));
}
}
mousePos = null;
updateCursor();
updateStatusLine();
Main.map.mapView.repaint();
}
@Override
public void mouseExited(MouseEvent e) {
if (!isEnabled()) {
return;
}
if (!dragging) {
mousePos = null;
}
Main.map.mapView.repaint();
}
// -------------------------------------------------------------------------
// Custom methods
// -------------------------------------------------------------------------
/**
* Sets new cursor depending on state, mouse position
*/
private void updateCursor() {
if (!isEnabled()) {
mv.setNewCursor(null, this);
return;
}
if (state == State.selecting) {
mv.setNewCursor(targetWay == null ? cursorSelect
: cursorSelectHover, this);
} else if (state == State.improving) {
if (alt && !ctrl) {
mv.setNewCursor(cursorImproveDelete, this);
} else if (shift || dragging) {
if (ctrl) {
mv.setNewCursor(cursorImproveAddLock, this);
} else {
mv.setNewCursor(cursorImproveLock, this);
}
} else if (ctrl && !alt) {
mv.setNewCursor(cursorImproveAdd, this);
} else {
mv.setNewCursor(cursorImprove, this);
}
}
}
/**
* Updates these objects under cursor: targetWay, candidateNode,
* candidateSegment
*/
public void updateCursorDependentObjectsIfNeeded() {
if (state == State.improving && (shift || dragging)
&& !(candidateNode == null && candidateSegment == null)) {
return;
}
if (mousePos == null) {
candidateNode = null;
candidateSegment = null;
return;
}
if (state == State.selecting) {
targetWay = ImproveWayAccuracyHelper.findWay(mv, mousePos);
} else if (state == State.improving) {
if (ctrl && !alt) {
candidateSegment = ImproveWayAccuracyHelper.findCandidateSegment(mv,
targetWay, mousePos);
candidateNode = null;
} else {
candidateNode = ImproveWayAccuracyHelper.findCandidateNode(mv,
targetWay, mousePos);
candidateSegment = null;
}
}
}
/**
* Switches to Selecting state
*/
public void startSelecting() {
state = State.selecting;
targetWay = null;
mv.repaint();
updateStatusLine();
}
/**
* Switches to Improving state
*
* @param targetWay Way that is going to be improved
*/
public void startImproving(Way targetWay) {
state = State.improving;
Collection<OsmPrimitive> currentSelection = getCurrentDataSet().getSelected();
if (currentSelection.size() != 1
|| !currentSelection.iterator().next().equals(targetWay)) {
selectionChangedBlocked = true;
getCurrentDataSet().clearSelection();
getCurrentDataSet().setSelected(targetWay.getPrimitiveId());
selectionChangedBlocked = false;
}
this.targetWay = targetWay;
this.candidateNode = null;
this.candidateSegment = null;
mv.repaint();
updateStatusLine();
}
/**
* Updates the state according to the current selection. Goes to Improve
* state if a single way or node is selected. Extracts a way by a node in
* the second case.
*
*/
private void updateStateByCurrentSelection() {
final List<Node> nodeList = new ArrayList<>();
final List<Way> wayList = new ArrayList<>();
final Collection<OsmPrimitive> sel = getCurrentDataSet().getSelected();
// Collecting nodes and ways from the selection
for (OsmPrimitive p : sel) {
if (p instanceof Way) {
wayList.add((Way) p);
}
if (p instanceof Node) {
nodeList.add((Node) p);
}
}
if (wayList.size() == 1) {
// Starting improving the single selected way
startImproving(wayList.get(0));
return;
} else if (nodeList.size() > 0) {
// Starting improving the only way of the single selected node
if (nodeList.size() == 1) {
List<OsmPrimitive> r = nodeList.get(0).getReferrers();
if (r.size() == 1 && (r.get(0) instanceof Way)) {
startImproving((Way) r.get(0));
return;
}
}
}
// Starting selecting by default
startSelecting();
}
}