Improve ferry instructions (graphhopper#3179)

* announce ferry in instructions

* extra instruction sign needed

* Update maps to 34acd30e

* fix

* ensure never NPE

* use mode==ferry for mapbox response

Author: karussell

core/src/main/java/com/graphhopper/GraphHopper.java

@@ -866,10 +866,10 @@ protected void prepareImport() {
                     "graph.encoded_values: " + encodedValuesString);
         }
 
-        // these are used in the snap prevention filter (avoid motorway, tunnel, etc.) so they have to be there
+        // following encoded values are used by instructions and in the snap prevention filter (avoid motorway, tunnel, etc.)
         encodedValuesWithProps.putIfAbsent(RoadClass.KEY, new PMap());
         encodedValuesWithProps.putIfAbsent(RoadEnvironment.KEY, new PMap());
-        // used by instructions...
+        // now only used by instructions:
         encodedValuesWithProps.putIfAbsent(Roundabout.KEY, new PMap());
         encodedValuesWithProps.putIfAbsent(VehicleAccess.key("car"), new PMap());
         encodedValuesWithProps.putIfAbsent(RoadClassLink.KEY, new PMap());

core/src/main/java/com/graphhopper/routing/InstructionsFromEdges.java

@@ -44,6 +44,7 @@ public class InstructionsFromEdges implements Path.EdgeVisitor {
     private final BooleanEncodedValue roundaboutEnc;
     private final BooleanEncodedValue roadClassLinkEnc;
     private final EnumEncodedValue<RoadClass> roadClassEnc;
+    private final EnumEncodedValue<RoadEnvironment> roadEnvEnc;
     private final IntEncodedValue lanesEnc;
     private final DecimalEncodedValue maxSpeedEnc;
 
@@ -78,6 +79,7 @@ public class InstructionsFromEdges implements Path.EdgeVisitor {
     private boolean prevInRoundabout;
     private String prevDestinationAndRef;
     private String prevName;
+    private RoadEnvironment prevRoadEnv;
     private String prevInstructionName;
 
     private static final int MAX_U_TURN_DISTANCE = 35;
@@ -86,6 +88,7 @@ public InstructionsFromEdges(Graph graph, Weighting weighting, EncodedValueLooku
                                  InstructionList ways) {
         this.weighting = weighting;
         this.roundaboutEnc = evLookup.getBooleanEncodedValue(Roundabout.KEY);
+        this.roadEnvEnc = evLookup.getEnumEncodedValue(RoadEnvironment.KEY, RoadEnvironment.class);
         this.roadClassEnc = evLookup.getEnumEncodedValue(RoadClass.KEY, RoadClass.class);
         this.roadClassLinkEnc = evLookup.getBooleanEncodedValue(RoadClassLink.KEY);
         this.maxSpeedEnc = evLookup.getDecimalEncodedValue(MaxSpeed.KEY);
@@ -95,6 +98,7 @@ public InstructionsFromEdges(Graph graph, Weighting weighting, EncodedValueLooku
         prevNode = -1;
         prevInRoundabout = false;
         prevName = null;
+        prevRoadEnv = null;
 
         BooleanEncodedValue carAccessEnc = evLookup.getBooleanEncodedValue(VehicleAccess.key("car"));
         outEdgeExplorer = graph.createEdgeExplorer(edge -> edge.get(carAccessEnc));
@@ -149,6 +153,8 @@ public void next(EdgeIteratorState edge, int index, int prevEdgeId) {
         final String destination = (String) edge.getValue(STREET_DESTINATION); // getValue is fast if it does not exist in edge
         final String destinationRef = (String) edge.getValue(STREET_DESTINATION_REF);
         final String motorwayJunction = (String) edge.getValue(MOTORWAY_JUNCTION);
+        final RoadEnvironment roadEnv = edge.get(roadEnvEnc);
+
         if ((prevInstruction == null) && (!isRoundabout)) // very first instruction (if not in Roundabout)
         {
             int sign = Instruction.CONTINUE_ON_STREET;
@@ -157,12 +163,15 @@ public void next(EdgeIteratorState edge, int index, int prevEdgeId) {
             prevInstruction.setExtraInfo(STREET_DESTINATION, destination);
             prevInstruction.setExtraInfo(STREET_DESTINATION_REF, destinationRef);
             prevInstruction.setExtraInfo(MOTORWAY_JUNCTION, motorwayJunction);
+            prevInstruction.setExtraInfo("ferry", InstructionsHelper.createFerryInfo(roadEnv, prevRoadEnv));
+
             double startLat = nodeAccess.getLat(baseNode);
             double startLon = nodeAccess.getLon(baseNode);
             double heading = AngleCalc.ANGLE_CALC.calcAzimuth(startLat, startLon, latitude, longitude);
             prevInstruction.setExtraInfo("heading", Helper.round(heading, 2));
             ways.add(prevInstruction);
             prevName = name;
+            prevRoadEnv = roadEnv;
             prevDestinationAndRef = destination + destinationRef;
 
         } else if (isRoundabout) {
@@ -197,6 +206,7 @@ public void next(EdgeIteratorState edge, int index, int prevEdgeId) {
                 {
                     prevOrientation = AngleCalc.ANGLE_CALC.calcOrientation(prevLat, prevLon, latitude, longitude);
                     prevName = name;
+                    prevRoadEnv = roadEnv;
                     prevDestinationAndRef = destination + destinationRef;
                 }
                 prevInstruction = roundaboutInstruction;
@@ -220,6 +230,7 @@ public void next(EdgeIteratorState edge, int index, int prevEdgeId) {
             prevInstruction.setExtraInfo(STREET_DESTINATION, destination);
             prevInstruction.setExtraInfo(STREET_DESTINATION_REF, destinationRef);
             prevInstruction.setExtraInfo(MOTORWAY_JUNCTION, motorwayJunction);
+            prevInstruction.setExtraInfo("ferry", InstructionsHelper.createFerryInfo(roadEnv, prevRoadEnv));
 
             // calc angle between roundabout entrance and exit
             double orientation = AngleCalc.ANGLE_CALC.calcOrientation(prevLat, prevLon, latitude, longitude);
@@ -239,6 +250,7 @@ public void next(EdgeIteratorState edge, int index, int prevEdgeId) {
 
             prevInstructionName = prevName;
             prevName = name;
+            prevRoadEnv = roadEnv;
             prevDestinationAndRef = destination + destinationRef;
 
         } else {
@@ -296,10 +308,12 @@ public void next(EdgeIteratorState edge, int index, int prevEdgeId) {
                 prevInstruction.setExtraInfo(STREET_DESTINATION, destination);
                 prevInstruction.setExtraInfo(STREET_DESTINATION_REF, destinationRef);
                 prevInstruction.setExtraInfo(MOTORWAY_JUNCTION, motorwayJunction);
+                prevInstruction.setExtraInfo("ferry", InstructionsHelper.createFerryInfo(roadEnv, prevRoadEnv));
             }
             // Update the prevName, since we don't always create an instruction on name changes the previous
             // name can be an old name. This leads to incorrect turn instructions due to name changes
             prevName = name;
+            prevRoadEnv = roadEnv;
             prevDestinationAndRef = destination + destinationRef;
         }
 
@@ -351,10 +365,13 @@ private int getTurn(EdgeIteratorState edge, int baseNode, int prevNode, int adjN
         InstructionsOutgoingEdges outgoingEdges = new InstructionsOutgoingEdges(prevEdge, edge, weighting, maxSpeedEnc,
                 roadClassEnc, roadClassLinkEnc, lanesEnc, allExplorer, nodeAccess, prevNode, baseNode, adjNode);
         int nrOfPossibleTurns = outgoingEdges.getAllowedTurns();
+        RoadEnvironment roadEnv = edge.get(roadEnvEnc);
 
         // there is no other turn possible
         if (nrOfPossibleTurns <= 1) {
-            if (Math.abs(sign) > 1 && outgoingEdges.getVisibleTurns() > 1 && !outgoingEdges.mergedOrSplitWay()) {
+            if (InstructionsHelper.isToFerry(roadEnv, prevRoadEnv)) return Instruction.FERRY;
+            if (Math.abs(sign) > 1 && outgoingEdges.getVisibleTurns() > 1 && !outgoingEdges.mergedOrSplitWay()
+                    || InstructionsHelper.isFromFerry(roadEnv, prevRoadEnv)) {
                 // This is an actual turn because |sign| > 1
                 // There could be some confusion, if we would not create a turn instruction, even though it is the only
                 // possible turn, also see #1048
@@ -366,9 +383,11 @@ private int getTurn(EdgeIteratorState edge, int baseNode, int prevNode, int adjN
 
         // Very certain, this is a turn
         if (Math.abs(sign) > 1) {
+            if (InstructionsHelper.isToFerry(roadEnv, prevRoadEnv)) return Instruction.FERRY;
             // Don't show an instruction if the user is following a street, even though the street is
             // bending. We should only do this, if following the street is the obvious choice.
             if (InstructionsHelper.isSameName(name, prevName) && outgoingEdges.outgoingEdgesAreSlowerByFactor(2)
+                    || InstructionsHelper.isFromFerry(roadEnv, prevRoadEnv)
                     || outgoingEdges.mergedOrSplitWay()) {
                 return Instruction.IGNORE;
             }
@@ -397,6 +416,11 @@ private int getTurn(EdgeIteratorState edge, int baseNode, int prevNode, int adjN
         // Signs provide too less detail, so we use the delta for a precise comparison
         double delta = InstructionsHelper.calculateOrientationDelta(prevLat, prevLon, lat, lon, prevOrientation);
 
+        if (InstructionsHelper.isToFerry(roadEnv, prevRoadEnv))
+            return Instruction.FERRY;
+        else if (InstructionsHelper.isFromFerry(roadEnv, prevRoadEnv))
+            return Instruction.CONTINUE_ON_STREET;
+
         // This state is bad! Two streets are going more or less straight
         // Happens a lot for trunk_links
         // For _links, comparing flags works quite good, as links usually have different speeds => different flags

core/src/main/java/com/graphhopper/routing/InstructionsHelper.java

@@ -17,6 +17,7 @@
  */
 package com.graphhopper.routing;
 
+import com.graphhopper.routing.ev.RoadEnvironment;
 import com.graphhopper.storage.NodeAccess;
 import com.graphhopper.util.*;
 import com.graphhopper.util.shapes.GHPoint;
@@ -80,4 +81,19 @@ static GHPoint getPointForOrientationCalculation(EdgeIteratorState edgeIteratorS
         }
         return new GHPoint(tmpLat, tmpLon);
     }
+
+    static boolean isToFerry(RoadEnvironment re, RoadEnvironment prev) {
+        return (re == RoadEnvironment.FERRY) && re != prev;
+    }
+
+    static boolean isFromFerry(RoadEnvironment re, RoadEnvironment prev) {
+        return (prev == RoadEnvironment.FERRY) && re != prev;
+    }
+
+    static String createFerryInfo(RoadEnvironment re, RoadEnvironment prev) {
+        if (re == prev) return null;
+        if (re == RoadEnvironment.FERRY) return "board_ferry";
+        if (prev == RoadEnvironment.FERRY) return "leave_ferry";
+        return null;
+    }
 }

core/src/main/resources/com/graphhopper/util/ar.txt

@@ -36,6 +36,8 @@ stopover=توقف %1$s
 roundabout_enter=أدخل الدوران
 roundabout_exit=في الدوران ، أتخذ مخرج   %1$s
 roundabout_exit_onto=في الدوران ، أتخذ مخرج   %1$s من خلال %2$s
+leave_ferry=
+board_ferry=
 web.total_ascend=%1$s اجمالى صعود
 web.total_descend=%1$s اجمالى نزول
 web.way_contains_ford=انتبه ، هناك مخاضة على الطريق

core/src/main/resources/com/graphhopper/util/ast.txt

@@ -36,6 +36,8 @@ stopover=pasando per %1$s
 roundabout_enter=Entra na rotonda
 roundabout_exit=Na rotonda, toma la salida %1$s
 roundabout_exit_onto=Na rotonda, toma la salida %1$s haza %2$s
+leave_ferry=
+board_ferry=
 web.total_ascend=%1$s d'ascensu total
 web.total_descend=%1$s de descensu total
 web.way_contains_ford=hai un vau nel camín

core/src/main/resources/com/graphhopper/util/az.txt

@@ -36,6 +36,8 @@ stopover=dayanacaq %1$s
 roundabout_enter=dairəvi yola dönün
 roundabout_exit=%1$s çıxışdan çıxın
 roundabout_exit_onto=%1$s çıxışdan %2$s çıxın
+leave_ferry=
+board_ferry=
 web.total_ascend=%1$s yüksəliş
 web.total_descend=%1$s eniş
 web.way_contains_ford=Yolda keçid var

core/src/main/resources/com/graphhopper/util/bg.txt

@@ -36,6 +36,8 @@ stopover=отправна точка %1$s
 roundabout_enter=Влезте в кръговото кръстовище
 roundabout_exit=На кръговото кръстовище вземете изход %1$s
 roundabout_exit_onto=На кръговото кръстовище вземете изход %1$s по %2$s
+leave_ferry=
+board_ferry=
 web.total_ascend=%1$s общо изкачване
 web.total_descend=%1$s общо слизане
 web.way_contains_ford=Внимание, на пътя има брод

core/src/main/resources/com/graphhopper/util/bn_BN.txt

@@ -36,6 +36,8 @@ stopover=
 roundabout_enter=গোলচক্কর
 roundabout_exit=গোলচক্কর হতে %1$s এর দিকে যান
 roundabout_exit_onto=গোলচক্কর হতে %2$s এ যেতে %1$s এর দিকে যান
+leave_ferry=
+board_ferry=
 web.total_ascend=
 web.total_descend=
 web.way_contains_ford=

core/src/main/resources/com/graphhopper/util/ca.txt

@@ -36,6 +36,8 @@ stopover=passant per %1$s
 roundabout_enter=Entra a la rotonda
 roundabout_exit=A la rotonda, agafa la %1$sa sortida
 roundabout_exit_onto=A la rotonda, agafa la %1$sa sortida cap a %2$s
+leave_ferry=
+board_ferry=
 web.total_ascend=%1$s de pujada total
 web.total_descend=%1$s de baixada total
 web.way_contains_ford=hi ha un gual en el camí
@@ -100,7 +102,7 @@ web.via_hint=Passant per
 web.from_hint=Des de
 web.gpx_export_button=Exporta a GPX
 web.gpx_button=GPX
-web.settings_gpx_export=Exportació GPX 
+web.settings_gpx_export=Exportació GPX
 web.settings_gpx_export_trk=Amb pista
 web.settings_gpx_export_rte=Amb ruta
 web.settings_gpx_export_wpt=Amb waypoints

core/src/main/resources/com/graphhopper/util/cs_CZ.txt

@@ -36,6 +36,8 @@ stopover=průjezdní bod %1$s
 roundabout_enter=Vjeďte na kruhový objezd
 roundabout_exit=Na kruhovém objezdu použijte %1$s. výjezd
 roundabout_exit_onto=Na kruhovém objezdu použijte %1$s. výjezd, směrem na %2$s
+leave_ferry=
+board_ferry=
 web.total_ascend=celkové stoupání %1$s
 web.total_descend=celkové klesání %1$s
 web.way_contains_ford=Trasa obsahuje brody