TomTom SDK for iOS BackToRouteOptions

BackToRouteOptions

public struct BackToRouteOptions

Options for planning back to route.

BackToRouteOptions encapsulates all the necessary data and options required for replanning a route in navigation scenarios.

Important

This is a Public Preview API. It may be changed or removed at any time.


                    
                    
                    init(location:route:routeOptions:currentDistanceAlongRoute:numberOfVisitedWaypoints:)

Initializes a new instance of BackToRouteOptions.

Declaration

Swift

public init(
    location: GeoLocation,
    route: Route,
    routeOptions: RoutePlanningOptions,
    currentDistanceAlongRoute: Measurement<UnitLength>,
    numberOfVisitedWaypoints: Int
)

Parameters

`location`	The current location.
`route`	The current route.
`routeOptions`	The options for planning the route.
`currentDistanceAlongRoute`	The current distance traveled along the route.
`numberOfVisitedWaypoints`	The number of waypoints visited so far.


                    
                    
                    currentLocation

The current location.

Declaration

Swift

public private(set) var currentLocation: GeoLocation { get }


                    
                    
                    currentRoute

The current route.

Declaration

Swift

public private(set) var currentRoute: Route { get }


                    
                    
                    currentRouteOptions

The options for planning the route.

Declaration

Swift

public private(set) var currentRouteOptions: RoutePlanningOptions { get }


                    
                    
                    currentDistanceAlongRoute

The current distance traveled along the route.

Declaration

Swift

public private(set) var currentDistanceAlongRoute: Measurement<UnitLength> { get }

numberOfVisitedWaypoints
The number of waypoints visited so far.
Declaration
Swift

public private(set) var numberOfVisitedWaypoints: Int { get }