com.tomtom.sdk.navigation:navigation-snapshot/com.tomtom.sdk.navigation

Package-level declarations

LocationSnapshot: Contains information specific to location e.g., the MapMatchingResult.
ConfigurationSnapshot: - Contains navigation configuration, e.g., the UnitSystem used for guidance.
TripSnapshot: - Contains information about the current trip session, e.g., if the driver has deviated from the route or reached the destination.
RouteSnapshot - Contains route-specific data such as the com.tomotm.sdk.navigation.RoutePlan, RouteProgress, or visited waypoints.

Types

ConfigurationSnapshot

class ConfigurationSnapshot

Snapshot of the current navigation configuration.

LocationSnapshot

class LocationSnapshot

Snapshot of the current location information during navigation.

NavigationSnapshot

class NavigationSnapshot

Snapshot of the current navigation session.

class RoutePlan(val route: Route, val routePlanningOptions: RoutePlanningOptions)

Defines parameters required for a single route in navigation session.

class RouteSnapshot

Snapshot of the route.

class TripSnapshot

Snapshot that contains information about the trip.

abstract class UnitSystemType : Parcelable

Defines types of UnitSystem handling.

Properties

currentActiveRoutePlanningOptions

val NavigationSnapshot.currentActiveRoutePlanningOptions: RoutePlanningOptions

Current RoutePlanningOptions that can be used for replanning the active route from the current position.

Functions

addItineraryPoint

fun RoutePlanningOptions.addItineraryPoint(itineraryPoint: ItineraryPoint): RoutePlanningOptions

Adds the given itineraryPoint to the Itinerary. It is added as the last waypoint in the Itinerary.waypoints list.

fun RoutePlanningOptions.addItineraryPoint(itineraryPoint: ItineraryPoint, itineraryPointBefore: ItineraryPoint): RoutePlanningOptions

Adds the given itineraryPoint to the Itinerary.

removeItineraryPoint

fun RoutePlanningOptions.removeItineraryPoint(itineraryPoint: ItineraryPoint): RoutePlanningOptions

Removes the given itineraryPoint from the Itinerary.

fun RoutePlanningOptions.skipRouteStop(routeStop: RouteStop): RoutePlanningOptions

Skips the given RouteStop. This operation is a combination of: