Class RouteInformation

  • All Implemented Interfaces:

    
    public final class RouteInformation
    
                        

    This class holds all information related to a route and a user's progress along the route. It also provides useful information (screen configuration and target distance) which can be used to make additional configuration changes to the map's camera.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      RouteInformation(DirectionsRoute route, Location location, RouteProgress routeProgress)
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final DirectionsRoute getRoute() The current route the user is navigating along.
      final Location getLocation() The user's current location along the route.
      final RouteProgress getRouteProgress() The user's current progress along the route.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RouteInformation

        RouteInformation(DirectionsRoute route, Location location, RouteProgress routeProgress)
    • Method Detail

      • getRoute

         final DirectionsRoute getRoute()

        The current route the user is navigating along. This value will update when reroutes occur and it will be null if the RouteInformation is generated from an update to route progress or from an orientation change.

      • getLocation

         final Location getLocation()

        The user's current location along the route. This value will update when orientation changes occur as well as when progress along a route changes.

      • getRouteProgress

         final RouteProgress getRouteProgress()

        The user's current progress along the route.