Navigation
public class Navigation : EngineActions
The Navigation object defines the functionality of the navigation.
Important
This is a Public Preview API. It may be changed or removed at any time.-
A delegate that reports specific events that occur during the navigation.
Declaration
Swift
public weak var delegate: TomTomNavigationDelegate?
-
A delegate that reports specific error events that occur during the navigation.
Declaration
Swift
public weak var delegateError: TomTomNavigationErrorDelegate?
-
Adds a
NavigationObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addNavigationObserver(_ observer: NavigationObserver)
Parameters
observer
A class that can handle all navigation events except for error events.
-
Removes the
NavigationObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeNavigationObserver(_ observer: NavigationObserver)
Parameters
observer
A class that can handle all navigation events except for error events.
-
Adds a
NavigationStartObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addStartObserver(_ observer: NavigationStartObserver)
Parameters
observer
A class that can handle navigation start events.
-
Removes the
NavigationStartObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeStartObserver(_ observer: NavigationStartObserver)
Parameters
observer
A class that can handle navigation start events.
-
Adds a
NavigationMapMatchingObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addMapMatchingObserver(_ observer: NavigationMapMatchingObserver)
Parameters
observer
A class that can handle navigation map matching events.
-
Removes the
NavigationMapMatchingObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeMapMatchingObserver(_ observer: NavigationMapMatchingObserver)
Parameters
observer
A class that can handle navigation map matching events.
-
Adds a
NavigationProgressObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addProgressObserver(_ observer: NavigationProgressObserver)
Parameters
observer
A class that can handle navigation start events.
-
Removes the
NavigationProgressObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeProgressObserver(_ observer: NavigationProgressObserver)
Parameters
observer
A class that can handle navigation progress events.
-
Adds a
NavigationRouteObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addRouteObserver(_ observer: NavigationRouteObserver)
Parameters
observer
A class that can handle navigation route events.
-
Removes the
NavigationRouteObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeRouteObserver(_ observer: NavigationRouteObserver)
Parameters
observer
A class that can handle navigation route events.
-
Adds a
NavigationGuidanceObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addGuidanceObserver(_ observer: NavigationGuidanceObserver)
Parameters
observer
A class that can handle navigation guidance events.
-
Removes the
NavigationGuidanceObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeGuidanceObserver(_ observer: NavigationGuidanceObserver)
Parameters
observer
A class that can handle navigation guidance events.
-
Adds a
NavigationLocationContextObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addLocationContextObserver(_ observer: NavigationLocationContextObserver)
Parameters
observer
A class that can handle navigation location context events.
-
Removes the
NavigationLocationContextObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeLocationContextObserver(_ observer: NavigationLocationContextObserver)
Parameters
observer
A class that can handle navigation location context events.
-
Adds a
NavigationArrivalObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addArrivalObserver(_ observer: NavigationArrivalObserver)
Parameters
observer
A class that can handle navigation arrival events.
-
Removes the
NavigationArrivalObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeArrivalObserver(_ observer: NavigationArrivalObserver)
Parameters
observer
A class that can handle navigation arrival events.
-
Adds a
NavigationTripObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addTripObserver(_ observer: NavigationTripObserver)
Parameters
observer
A class that can handle navigation trip events.
-
Removes the
NavigationTripObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeTripObserver(_ observer: NavigationTripObserver)
Parameters
observer
A class that can handle navigation trip events.
-
Adds a
NavigationHorizonObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public func addHorizonObserver(_ observer: NavigationHorizonObserver)
Parameters
observer
A class that can handle navigation horizon events.
-
Removes the
NavigationHorizonObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Warning
This is an experimental API. It may be changed or removed at any time without notice. Use of this API is strongly discouraged.Declaration
Swift
public func removeHorizonObserver(_ observer: NavigationHorizonObserver)
Parameters
observer
A class that can handle navigation trip events.
-
Adds a
NavigationErrorObserver
toNavigation
. Keeps a weak pointer to the observer. It is expected to be called on the main queue.Declaration
Swift
public func addErrorObserver(_ observer: NavigationErrorObserver)
Parameters
observer
A class that can handle navigation error events.
-
Removes the
NavigationErrorObserver
toNavigation
. There is no need to call this function from the deinit of the observer. It is expected to be called on the main queue.Declaration
Swift
public func removeErrorObserver(_ observer: NavigationErrorObserver)
Parameters
observer
A class that can handle navigation error events.
-
Declaration
Swift
public func start()
-
Declaration
Swift
public func start(navigationPlan: NavigationPlan)
-
Declaration
Swift
public func update(routePlan: RoutePlan)
-
Declaration
Swift
public func stop()
-
Declaration
Swift
public func navigationSnapshot() -> NavigationSnapshot?
-
Important
This is a Public Preview API. It may be changed or removed at any time. The mode of navigation after start.Declaration
Swift
public enum NavigationMode