Add RouteProgressState to RouteProgress for current Navigator information

[danesfeder]

Closes #1501 @navdeepg to confirm

This is an example of a last step from the Directions API (containing the maneuver type "arrive"):

       {
        "intersections": [{
          "in": 0,
          "entry": [true],
          "bearings": [252],
          "location": [-71.068719, 42.352396]
        }],
        "driving_side": "right",
        "geometry": "wo~woA|aupfC",
        "mode": "driving",
        "maneuver": {
          "bearing_after": 0,
          "bearing_before": 72,
          "location": [-71.068719, 42.352396],
          "type": "arrive",
          "instruction": "You have arrived at your destination"
        },
        "ref": "MA 2",
        "weight": 0,
        "duration": 0,
        "name": "Boylston Street (MA 2)",
        "distance": 0,
        "voiceInstructions": [],
        "bannerInstructions": []
      }

As you can see, the step has a single point that represents the geometry. Navigator ignores the step, making it impossible for a user to be "on the step" and have maneuver type == "arrive".

This PR adds a RouteProgressState that not only gives information about when a user has arrived, but also a lot of other information given to us via the Navigator RouteState. Even if we did allow navigation on this step, it would be very hard to get a location update that was snapped to this geometry.

Example usage to detect when a user has arrived at the end of the given RouteLeg:

  @Override
  public void onProgressChange(Location location, RouteProgress routeProgress) {
    Integer currentState = routeProgress.currentState();
    if (currentState != null && currentState == RouteProgressState.ROUTE_ARRIVED) {
      // Arrived at the end of the leg!
    }
  }

This is marked SEMVER because it breaks RouteUtils.

cc @kevinkreiser

[navdeepg]

Hey Dan,
This is exactly what i needed. Let me know when you guys are going to merge this, so that i can start testing this.

Thanks,
Navdeep

[kevinkreiser]

should we have OFF ROUTE as well? technically if you dont do a re-route you will stay off route until you get back on

[Guardiola31337]

I guess that's not needed because of

mapbox-navigation-android/libandroid-navigation/src/main/java/com/mapbox/services/android/navigation/v5/routeprogress/RouteProgressStateMap.java

Line 15 in 6922783

put(RouteState.OFFROUTE, null); // Ignore off-route (info already provided via listener)

but I'll defer to @danesfeder to confirm

[navdeepg]

currentState() in RoutrProgress.java is not available in current version 0.22.0 of navigation sdk. Can you please let me know when you are going to publish it?

[danesfeder]

@Guardiola31337 I converted RouteProgressState to an enum and this is ready for another 👀

[Guardiola31337]

Thanks for addressing the feedback @danesfeder 🙇

🚢

[danesfeder]

@navdeepg now that this is merged to master, you can test with 0.23.0-SNAPSHOT see here. Stay tuned for the 0.23.0 release incoming soon and thanks for your patience.