TomTom SDK for iOS RouteUpdateOptions

RouteUpdateOptions

public struct RouteUpdateOptions

Options for updating a route.

RouteUpdateOptions encapsulates all the necessary data and options required for updating a route in navigation scenarios.

Important

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

  • Initializes a new instance of RouteUpdateOptions.

    Declaration

    Swift

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

    Parameters

    location

    The current location of the user.
    route

    The current route being followed.
    routeOptions

    The options used for planning the current route.
    distanceAlongRoute

    The distance traveled along the route.
    remainingTime

    The remaining time to reach the destination.
    numberOfVisitedWaypoints

    The number of waypoints visited so far.

  • The current location of the user.

    Declaration

    Swift

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

  • The current route being followed.

    Declaration

    Swift

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

  • The options used for planning the current route.

    Declaration

    Swift

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

  • The distance traveled along the route.

    Declaration

    Swift

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

  • The remaining time to reach the destination.

    Declaration

    Swift

    public private(set) var remainingTime: Measurement<UnitDuration> { get }

  • The number of waypoints visited so far.

    Declaration

    Swift

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