LegacyRouteController

open class LegacyRouteController : NSObject, Router, InternalRouter, CLLocationManagerDelegate


                    
                    
                    dataSource

Declaration

Swift

public unowned var dataSource: RouterDataSource

View Source on GitHub


                    
                    
                    directions

A reference to a MapboxDirections service. Used for rerouting.

Declaration

Swift

@available(*, deprecated, message: "Use `customRoutingProvider` instead. If route controller was not initialized using `Directions` object - this property is unused and ignored.")
public lazy var directions: Directions { get set }

View Source on GitHub


                    
                    
                    routingProvider

RoutingProvider, used to create a route during refreshing or rerouting.

Declaration

Swift

@available(*, deprecated, message: "Use `customRoutingProvider` instead. This property will be equal to `customRoutingProvider` if that is provided or a `MapboxRoutingProvider` instance otherwise.")
public lazy var routingProvider: RoutingProvider { get set }

View Source on GitHub

customRoutingProvider
Custom RoutingProvider, used to create a route during refreshing or rerouting.
Declaration
Swift

public var customRoutingProvider: RoutingProvider?
View Source on GitHub
route
Declaration
Swift

public var route: Route { get }
View Source on GitHub


                    
                    
                    indexedRouteResponse

Declaration

Swift

public internal(set) var indexedRouteResponse: IndexedRouteResponse { get set }

View Source on GitHub

Tracking the Progress


                    
                    
                    delegate

Declaration

Swift

public weak var delegate: RouterDelegate?

View Source on GitHub


                    
                    
                    routeProgress

Declaration

Swift

public internal(set) var routeProgress: RouteProgress { get set }

View Source on GitHub


                    
                    
                    location

Declaration

Swift

public var location: CLLocation? { get }

View Source on GitHub

heading
Declaration
Swift

public var heading: CLHeading?
View Source on GitHub
rawLocation
The most recently received user location.

Note
This is a raw location received from locationManager. To obtain an idealized location, use the location property.
Declaration
Swift

public var rawLocation: CLLocation? { get set }
View Source on GitHub

Controlling and Altering the Route

reroutesProactively
Declaration
Swift

public var reroutesProactively: Bool
View Source on GitHub
initialManeuverAvoidanceRadius
Declaration
Swift

public var initialManeuverAvoidanceRadius: TimeInterval
View Source on GitHub
refreshesRoute
Declaration
Swift

public var refreshesRoute: Bool
View Source on GitHub
continuousAlternatives
LegacyRouteController does not support continuous alternatives.

This array will always be empty.
Declaration
Swift

public private(set) var continuousAlternatives: [AlternativeRoute] { get }
View Source on GitHub

Navigating

waypointArrivalThreshold
The threshold used when we determine when the user has arrived at the waypoint. By default, we claim arrival 5 seconds before the user is physically estimated to arrive.
Declaration
Swift

public var waypointArrivalThreshold: TimeInterval
View Source on GitHub


                    
                    
                    updateRoute(with:routeOptions:completion:)

Declaration

Swift

public func updateRoute(with indexedRouteResponse: IndexedRouteResponse,
                        routeOptions: RouteOptions?,
                        completion: ((Bool) -> Void)?)

View Source on GitHub


                    
                    
                    advanceLegIndex(completionHandler:)

Declaration

Swift

public func advanceLegIndex(completionHandler: AdvanceLegCompletionHandler? = nil)

View Source on GitHub


                    
                    
                    reroutingTolerance

Declaration

Swift

public var reroutingTolerance: CLLocationDistance { get }

View Source on GitHub


                    
                    
                    userIsOnRoute(_:)

Declaration

Swift

public func userIsOnRoute(_ location: CLLocation) -> Bool

View Source on GitHub


                    
                    
                    init(alongRouteAtIndex:in:options:directions:dataSource:)

Declaration

Swift

public convenience init(alongRouteAtIndex routeIndex: Int,
                        in routeResponse: RouteResponse,
                        options: RouteOptions,
                        directions: Directions = NavigationSettings.shared.directions,
                        dataSource source: RouterDataSource)

View Source on GitHub


                    
                    
                    init(alongRouteAtIndex:in:options:routingProvider:dataSource:)

Declaration

Swift

@available(*, deprecated, renamed: "init(indexedRouteResponse:customRoutingProvider:dataSource:﹚")
required public convenience init(alongRouteAtIndex routeIndex: Int,
                                 in routeResponse: RouteResponse,
                                 options: RouteOptions,
                                 routingProvider: RoutingProvider = Directions.shared,
                                 dataSource source: RouterDataSource)

View Source on GitHub


                    
                    
                    init(alongRouteAtIndex:in:options:customRoutingProvider:dataSource:)

Declaration

Swift

@available(*, deprecated, renamed: "init(indexedRouteResponse:customRoutingProvider:dataSource:﹚")
required public convenience init(alongRouteAtIndex routeIndex: Int,
                                 in routeResponse: RouteResponse,
                                 options: RouteOptions,
                                 customRoutingProvider: RoutingProvider? = nil,
                                 dataSource source: RouterDataSource)

View Source on GitHub


                    
                    
                    init(indexedRouteResponse:customRoutingProvider:dataSource:)

Declaration

Swift

required public init(indexedRouteResponse: IndexedRouteResponse,
                     customRoutingProvider: RoutingProvider?,
                     dataSource source: RouterDataSource)

View Source on GitHub

finishRouting()
Declaration
Swift

public func finishRouting()
View Source on GitHub

Handling LocationManager Output


                    
                    
                    locationManager(_:didUpdateHeading:)

Declaration

Swift

public func locationManager(_ manager: CLLocationManager, didUpdateHeading newHeading: CLHeading)

View Source on GitHub


                    
                    
                    locationManager(_:didUpdateLocations:)

Declaration

Swift

public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation])

View Source on GitHub


                    
                    
                    reroute(from:along:)

Declaration

Swift

public func reroute(from location: CLLocation, along progress: RouteProgress)

View Source on GitHub

LegacyRouteController

Configuring Route-Related Data

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Tracking the Progress

Declaration

Declaration

Declaration

Declaration

Declaration

Controlling and Altering the Route

Declaration

Declaration

Declaration

Declaration

Navigating

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Handling LocationManager Output

Declaration

Declaration

Declaration