maplibre-navigation-core/org.maplibre.navigation.core.navigation.camera/RouteInformation

RouteInformation

data class RouteInformation(val route: DirectionsRoute?, val location: Location?, val routeProgress: RouteProgress?)

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.

Since

0.10.0

Constructors

Link copied to clipboard
constructor(route: DirectionsRoute?, location: Location?, routeProgress: RouteProgress?)

Properties

Link copied to clipboard
val location: Location?

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.

Link copied to clipboard
val route: DirectionsRoute?

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.

Link copied to clipboard
val routeProgress: RouteProgress?

The user's current progress along the route.