Install in Dash
RouteController Class Reference
RouteController
open class RouteController : NSObjectextension RouteController: HistoryRecordingextension RouteController: RouterA RouteController tracks the user’s progress along a route, posting notifications as the user reaches significant points along the route. On every location update, the route controller evaluates the user’s location, determining whether the user remains on the route. If not, the route controller calculates a new route.
RouteController is responsible for the core navigation logic whereas
NavigationViewController is responsible for displaying a default drop-in navigation UI.
Important
Creating an instance of this type will start an Active Guidance session. The trip session is stopped when the instance is deallocated. From more info read the Pricing Guide.Precondition
There should be only oneRouteController alive to any given time.
-
Declaration
Swift
public enum DefaultBehavior
View Source on GitHub
-
A
TileStoreinstance used by navigatorDeclaration
Swift
open var navigatorTileStore: TileStore { get } -
The route controller’s associated location manager.
Declaration
Swift
public unowned var dataSource: RouterDataSource -
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 } -
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 } -
Custom
RoutingProvider, used to create a route during refreshing or rerouting.If set to
nil- default Mapbox implementation will be used.Declaration
Swift
public var customRoutingProvider: RoutingProvider? -
Declaration
Swift
public var route: Route { get } -
Declaration
Swift
public internal(set) var indexedRouteResponse: IndexedRouteResponse { get set }
-
Details about the user’s progress along the current route, leg, and step.
To advance the route progress to next leg, use
RouteController.advanceLegIndex(completionHandler:)method.Declaration
Swift
public private(set) var routeProgress: RouteProgress { get } -
The idealized user location. Snapped to the route line, if applicable, otherwise raw.
See also
snappedLocation, rawLocationDeclaration
Swift
public var location: CLLocation? { get } -
The most recently received user location.
Note
This is a raw location received fromlocationManager. To obtain an idealized location, use thelocationproperty.Declaration
Swift
public var rawLocation: CLLocation? { get set } -
The route controller’s delegate.
Declaration
Swift
public weak var delegate: RouterDelegate? -
The route controller’s heading.
Declaration
Swift
public var heading: CLHeading? -
Advances current
RouteProgress.legIndexby 1.Declaration
Swift
public func advanceLegIndex(completionHandler: AdvanceLegCompletionHandler? = nil)Parameters
completionHandlerCompletion handler, which is called to report a status whether
RouteLegwas changed or not. -
Starts electronic horizon updates.
Pass
nilto use the default configuration. Updates will be delivered inNotification.Name.electronicHorizonDidUpdatePositionnotification. For more info, read the Electronic Horizon Guide.Postcondition
To change electronic horizon options call this method again with new options.
Note
The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.
Declaration
Swift
public func startUpdatingElectronicHorizon(with options: ElectronicHorizonOptions? = nil)Parameters
optionsOptions which will be used to configure electronic horizon updates.
-
Stops electronic horizon updates.
Declaration
Swift
public func stopUpdatingElectronicHorizon()
-
Declaration
Swift
public var reroutesProactively: Bool -
Declaration
Swift
public var initialManeuverAvoidanceRadius: TimeInterval { get set } -
Declaration
Swift
public var refreshesRoute: Bool -
Declaration
Swift
public private(set) var continuousAlternatives: [AlternativeRoute] { get } -
Enables automatic switching to online version of the current route when possible.
Indicates if
RouteControllerwill attempt to detect if current route was build offline and if there is an online route with the same path is available to automatically switch to it. Using online route is beneficial due to available live data like traffic congestion, incidents, etc. Check is not performed instantly and it is not guaranteed to receive an online version at any given period of time.Enabled by default.
Declaration
Swift
public var prefersOnlineRoute: Bool
-
Declaration
Swift
public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) -
Declaration
Swift
public func locationManager(_ manager: CLLocationManager, didUpdateHeading newHeading: CLHeading) -
Updates current
RouteProgress.legIndexto specified leg index.Declaration
Swift
public func updateRouteLeg(to index: Int, completionHandler: AdvanceLegCompletionHandler? = nil)Parameters
indexLeg index value to set.
completionHandlerCompletion handler, which is called to report a status whether
RouteLegwas changed or not. -
Declaration
Swift
public func finishRouting()
-
Declaration
Swift
public convenience init(alongRouteAtIndex routeIndex: Int, in routeResponse: RouteResponse, options: RouteOptions, directions: Directions = NavigationSettings.shared.directions, dataSource source: RouterDataSource) -
Declaration
Swift
@available(*, deprecated, renamed: "init(indexedRouteResponse:customRoutingProvider:dataSource:﹚") required public convenience init(alongRouteAtIndex routeIndex: Int, in routeResponse: RouteResponse, options: RouteOptions, routingProvider: RoutingProvider, dataSource source: RouterDataSource) -
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) -
Declaration
Swift
required public init(indexedRouteResponse: IndexedRouteResponse, customRoutingProvider: RoutingProvider?, dataSource source: RouterDataSource)
-
The road graph that is updated as the route controller tracks the user’s location.
Declaration
Swift
public var roadGraph: RoadGraph { get } -
The road object store that is updated as the route controller tracks the user’s location.
Declaration
Swift
public var roadObjectStore: RoadObjectStore { get } -
The road object matcher that allows to match user-defined road objects.
Declaration
Swift
public var roadObjectMatcher: RoadObjectMatcher { get }
-
Keys in the user info dictionaries of various notifications posted by instances of
See moreRouteController.Declaration
Swift
public struct NotificationUserInfoKey : Hashable, Equatable, RawRepresentable
-
Declaration
Swift
public func userIsOnRoute(_ location: CLLocation) -> Bool -
Declaration
Swift
public func userIsOnRoute(_ location: CLLocation, status: NavigationStatus?) -> Bool -
Declaration
Swift
public func reroute(from location: CLLocation, along progress: RouteProgress) -
Declaration
Swift
public func updateRoute(with indexedRouteResponse: IndexedRouteResponse, routeOptions: RouteOptions?, completion: ((Bool) -> Void)?)