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.Collection;
010import java.util.Collections;
011import java.util.Comparator;
012import java.util.HashMap;
013import java.util.LinkedList;
014import java.util.List;
015import java.util.Map;
016import java.util.Set;
017import java.util.SortedSet;
018import java.util.TreeSet;
019
020import org.openstreetmap.josm.Main;
021import org.openstreetmap.josm.command.ChangeCommand;
022import org.openstreetmap.josm.command.Command;
023import org.openstreetmap.josm.command.MoveCommand;
024import org.openstreetmap.josm.command.SequenceCommand;
025import org.openstreetmap.josm.data.coor.EastNorth;
026import org.openstreetmap.josm.data.osm.Node;
027import org.openstreetmap.josm.data.osm.OsmPrimitive;
028import org.openstreetmap.josm.data.osm.Way;
029import org.openstreetmap.josm.data.osm.WaySegment;
030import org.openstreetmap.josm.data.projection.Projections;
031import org.openstreetmap.josm.tools.Geometry;
032import org.openstreetmap.josm.tools.MultiMap;
033import org.openstreetmap.josm.tools.Shortcut;
034
035/**
036 * Action allowing to join a node to a nearby way, operating on two modes:<ul>
037 * <li><b>Join Node to Way</b>: Include a node into the nearest way segments. The node does not move</li>
038 * <li><b>Move Node onto Way</b>: Move the node onto the nearest way segments and include it</li>
039 * </ul>
040 */
041public class JoinNodeWayAction extends JosmAction {
042
043    protected final boolean joinWayToNode;
044
045    protected JoinNodeWayAction(boolean joinWayToNode, String name, String iconName, String tooltip, Shortcut shortcut, boolean registerInToolbar) {
046        super(name, iconName, tooltip, shortcut, registerInToolbar);
047        this.joinWayToNode = joinWayToNode;
048    }
049
050    /**
051     * Constructs a Join Node to Way action.
052     * @return the Join Node to Way action
053     */
054    public static JoinNodeWayAction createJoinNodeToWayAction() {
055        JoinNodeWayAction action = new JoinNodeWayAction(false,
056                tr("Join Node to Way"), "joinnodeway", tr("Include a node into the nearest way segments"),
057                Shortcut.registerShortcut("tools:joinnodeway", tr("Tool: {0}", tr("Join Node to Way")), KeyEvent.VK_J, Shortcut.DIRECT), true);
058        action.putValue("help", ht("/Action/JoinNodeWay"));
059        return action;
060    }
061
062    /**
063     * Constructs a Move Node onto Way action.
064     * @return the Move Node onto Way action
065     */
066    public static JoinNodeWayAction createMoveNodeOntoWayAction() {
067        JoinNodeWayAction action = new JoinNodeWayAction(true,
068                tr("Move Node onto Way"), "movenodeontoway", tr("Move the node onto the nearest way segments and include it"),
069                Shortcut.registerShortcut("tools:movenodeontoway", tr("Tool: {0}", tr("Move Node onto Way")), KeyEvent.VK_N, Shortcut.DIRECT), true);
070        return action;
071    }
072
073    @Override
074    public void actionPerformed(ActionEvent e) {
075        if (!isEnabled())
076            return;
077        Collection<Node> selectedNodes = getCurrentDataSet().getSelectedNodes();
078        Collection<Command> cmds = new LinkedList<>();
079        Map<Way, MultiMap<Integer, Node>> data = new HashMap<>();
080
081        // If the user has selected some ways, only join the node to these.
082        boolean restrictToSelectedWays =
083                !getCurrentDataSet().getSelectedWays().isEmpty();
084
085        // Planning phase: decide where we'll insert the nodes and put it all in "data"
086        for (Node node : selectedNodes) {
087            List<WaySegment> wss = Main.map.mapView.getNearestWaySegments(
088                    Main.map.mapView.getPoint(node), OsmPrimitive.isSelectablePredicate);
089
090            MultiMap<Way, Integer> insertPoints = new MultiMap<>();
091            for (WaySegment ws : wss) {
092                // Maybe cleaner to pass a "isSelected" predicate to getNearestWaySegments, but this is less invasive.
093                if (restrictToSelectedWays && !ws.way.isSelected()) {
094                    continue;
095                }
096
097                if (ws.getFirstNode() != node && ws.getSecondNode() != node) {
098                    insertPoints.put(ws.way, ws.lowerIndex);
099                }
100            }
101            for (Map.Entry<Way, Set<Integer>> entry : insertPoints.entrySet()) {
102                final Way w = entry.getKey();
103                final Set<Integer> insertPointsForWay = entry.getValue();
104                for (int i : pruneSuccs(insertPointsForWay)) {
105                    MultiMap<Integer, Node> innerMap;
106                    if (!data.containsKey(w)) {
107                        innerMap = new MultiMap<>();
108                    } else {
109                        innerMap = data.get(w);
110                    }
111                    innerMap.put(i, node);
112                    data.put(w, innerMap);
113                }
114            }
115        }
116
117        // Execute phase: traverse the structure "data" and finally put the nodes into place
118        for (Map.Entry<Way, MultiMap<Integer, Node>> entry : data.entrySet()) {
119            final Way w = entry.getKey();
120            final MultiMap<Integer, Node> innerEntry = entry.getValue();
121
122            List<Integer> segmentIndexes = new LinkedList<>();
123            segmentIndexes.addAll(innerEntry.keySet());
124            Collections.sort(segmentIndexes, Collections.reverseOrder());
125
126            List<Node> wayNodes = w.getNodes();
127            for (Integer segmentIndex : segmentIndexes) {
128                final Set<Node> nodesInSegment = innerEntry.get(segmentIndex);
129                if (joinWayToNode) {
130                    for (Node node : nodesInSegment) {
131                        EastNorth newPosition = Geometry.closestPointToSegment(w.getNode(segmentIndex).getEastNorth(),
132                                                                            w.getNode(segmentIndex+1).getEastNorth(),
133                                                                            node.getEastNorth());
134                        cmds.add(new MoveCommand(node, Projections.inverseProject(newPosition)));
135                    }
136                }
137                List<Node> nodesToAdd = new LinkedList<>();
138                nodesToAdd.addAll(nodesInSegment);
139                Collections.sort(nodesToAdd, new NodeDistanceToRefNodeComparator(w.getNode(segmentIndex), w.getNode(segmentIndex+1), !joinWayToNode));
140                wayNodes.addAll(segmentIndex + 1, nodesToAdd);
141            }
142            Way wnew = new Way(w);
143            wnew.setNodes(wayNodes);
144            cmds.add(new ChangeCommand(w, wnew));
145        }
146
147        if (cmds.isEmpty()) return;
148        Main.main.undoRedo.add(new SequenceCommand(getValue(NAME).toString(), cmds));
149        Main.map.repaint();
150    }
151
152    private static SortedSet<Integer> pruneSuccs(Collection<Integer> is) {
153        SortedSet<Integer> is2 = new TreeSet<>();
154        for (int i : is) {
155            if (!is2.contains(i - 1) && !is2.contains(i + 1)) {
156                is2.add(i);
157            }
158        }
159        return is2;
160    }
161
162    /**
163     * Sorts collinear nodes by their distance to a common reference node.
164     */
165    private static class NodeDistanceToRefNodeComparator implements Comparator<Node> {
166        private final EastNorth refPoint;
167        private EastNorth refPoint2;
168        private final boolean projectToSegment;
169        NodeDistanceToRefNodeComparator(Node referenceNode, Node referenceNode2, boolean projectFirst) {
170            refPoint = referenceNode.getEastNorth();
171            refPoint2 = referenceNode2.getEastNorth();
172            projectToSegment = projectFirst;
173        }
174        @Override
175        public int compare(Node first, Node second) {
176            EastNorth firstPosition = first.getEastNorth();
177            EastNorth secondPosition = second.getEastNorth();
178
179            if (projectToSegment) {
180                firstPosition = Geometry.closestPointToSegment(refPoint, refPoint2, firstPosition);
181                secondPosition = Geometry.closestPointToSegment(refPoint, refPoint2, secondPosition);
182            }
183
184            double distanceFirst = firstPosition.distance(refPoint);
185            double distanceSecond = secondPosition.distance(refPoint);
186            double difference =  distanceFirst - distanceSecond;
187
188            if (difference > 0.0) return 1;
189            if (difference < 0.0) return -1;
190            return 0;
191        }
192    }
193
194    @Override
195    protected void updateEnabledState() {
196        if (getCurrentDataSet() == null) {
197            setEnabled(false);
198        } else {
199            updateEnabledState(getCurrentDataSet().getSelected());
200        }
201    }
202
203    @Override
204    protected void updateEnabledState(Collection<? extends OsmPrimitive> selection) {
205        setEnabled(selection != null && !selection.isEmpty());
206    }
207}