TomTomNavigation

Provides access to current registered engines and allows updating them.

The VehicleProvider used by the TomTomNavigation for providing vehicle updates to the navigation.

Information from VehicleProvider.vehicle is leveraged by the HorizonEngine to provide the relevant virtual horizon. Additionally, it is used as a request parameter for route replannings during the navigation session. Notably, it supersedes any vehicle information specified in the RoutePlanningOptions whether at the navigation start, or during any subsequent automatic or manual route replanning events.

Provides a CLLocation for map matching.

The LocationProvider used by the TomTomNavigation for providing location updates to the navigation.

Controls how the route deviations are handled.

When set to automatic the navigation replans the route automatically. When set to none the navigation does not replan the route.

The default value is automatic.

The unit system to be used within TomTomNavigation.

Once set, it is propagated to other components (e.g. GuidanceEngine) and used for the generation of guidance announcements.

If the UnitSystemType instance is dynamic then unitSystem is resolved based on the country attribute of the current location:

• for “USA” and “PRI” it resolves to SpecificUnitSystem/imperialFeet.
• for “GBR” it resolves to SpecificUnitSystem/imperialYards.
• for other countries it resolves to SpecificUnitSystem/metric.

The default value is UnitSystemType.default.

The preferred language to be used within TomTomNavigation in guidance instructions and announcement language.

The initial value is Locale.current. If the initial language is not supported, en-US will be used instead. Supported languages can be acquired from GuidanceEngine.availableLanguages.

Setting the preferred language updates the route. You can check the updated route language using language. If the specified language is not supported, en-US will be used instead.

To observe language changes, add:

• NavigationLanguageChangeObserver using addLanguageChangeObserver(_:).

The current language used within TomTomNavigation in guidance instructions and announcement language.

The initial value is Locale.current. To change language, see preferredLanguage.

A publishable variable that can be used to receive the same events that the delegate presents

The current NavigationState within TomTomNavigation.

The initial value is set to idle.

To change navigationState, see

• start(),
• start(navigationOptions:),
• stop() and
• setActiveRoutePlan(_:).

To observe changes to navigationState see NavigationStateChangeObserver.

The current BetterProposalAcceptanceMode.

The current NavigationSnapshot.

navigationSnapshot is nil at the start of navigation in the following situations:

• If the location provider is disabled.
• If the location provider is enabled but unable to find the location.

Starts navigation without specifying a Route.

Use this method to start the navigation in free driving mode.

Navigation goes through the following steps:

• Providing the MapMatchingResult via LocationMapMatchingObserver.
• Providing the updated LocationContext via NavigationLocationContextObserver.
• Providing the updated HorizonSnapshot via NavigationHorizonObserver.

As a result of successful action, the following observer is notified:

• NavigationStateChangeObserver, with the state set to freeDriving.

For examples on how to start navigation, see the developer documentation.

Starts navigation with the provided NavigationOptions.

Use this method to start the navigation in active guidance mode with the provided Route within the NavigationOptions.

Navigation goes through the following steps:

• Providing the MapMatchingResult via LocationMapMatchingObserver.
• Providing the updated LocationContext via NavigationLocationContextObserver.
• Providing the updated HorizonSnapshot via NavigationHorizonObserver.

Additionally, the system performs the following operations for the active, i.e., currently navigated Route within the NavigationOptions:

• Calculating RouteProgress and updating via NavigationProgressObserver.
• Checking all followed routes and deviations via NavigationRouteTrackingStateUpdateObserver.
• Generating Guidance via GuidanceUpdateObserver.
• Detecting arrival, possibly calling NavigationDestinationArrivalObserver or NavigationWaypointArrivalObserver.

As a result of successful action, the following observer is notified:

• NavigationStateChangeObserver, with the state set to activeGuidance.
• NavigationRouteAddObserver, with the Route and RoutePlanningOptions set in activeRoutePlan, and navigationStarted.
• NavigationActiveRouteChangeObserver, with the Route set in activeRoutePlan.

For examples on how to start navigation, see the developer documentation.

Updates the route plan during ongoing navigation.

The following listeners are notified:

• NavigationRouteUpdateObserver/didUpdateRoute(route:options:reason:) with the updated Route
• RoutePlanniningOptions and
• RouteUpdatedReason/manuallyUpdated

if current route does not contain the provided routeId, the method does not update the route.

• didChangeActiveRoute(route:) with the Route if active route has changed.

• didRemoveRoute(route:reason:) with all other routes except the active Route and manual.

Selects the Route with provided routeID as active.

The navigation switches to navigate along the desired route and the following listeners are notified:

• didChangeActiveRoute(route:) with Route selected by routeID.
• didRemoveRoute(route:reason:) with the previously active Route and manual If theRoute corresponding to the given routeId is not available, changing does not occur.

Marks a departure from the given waypoint independently from ArrivalDetectionEngine/hasArrivedAtWaypoint.

Use this method to manually mark a departure from a waypoint when the arrival detection mechanism is not sufficient; for example, in scenarios such as when the waypoint is a charging station, and the user wishes to trigger immediate replanning after insufficient charging by marking the waypoint as departed, or during delivery operations when the driver must manually confirm departure in cases of route deviations from the planned route.

The specified waypoint is marked as having been departed from and NavigationWaypointArrivalObserver are notified about this via NavigationDestinationArrivalObserver/didArriveAtWaypoint(waypoint:on:).

Notification via NavigationDestinationArrivalObserver/didArriveAtWaypoint(waypoint:on:) completes arrival detection for that particular waypoint. Navigation switches to arrival detection for the next waypoint, if there is one present.

Prerequisites for this action:

• A didArriveAtWaypoint(waypoint:on:) notification was previously issued for this waypoint.

• No didDepartFromWaypoint(waypoint:on:) notification was previously issued for this waypoint.

Stops current navigation session and clears data related to it.

If start has not been called previously, this method has no effect.

As a result of successful action, the following observer is notified:

• NavigationStateChangeObserver, with the state set to idle.

Adds a NavigationStateChangeObserver to TomTomNavigation. The observer is notified of changes to the navigationState.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationStateChangeObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a LocationMapMatchingObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added LocationMapMatchingObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationProgressObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationProgressObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationRouteAddObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationRouteAddObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationRouteRemoveObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationRouteRemoveObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationRouteUpdateObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationRouteUpdateObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a GuidanceUpdateObserver to TomTomNavigation..

This is notified whenever there is a change in location and the GuidanceEngine successfully generates a new Guidance.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added GuidanceUpdateObserver from TomTomNavigation.

This method allows you to stop receiving updates about guidance changes.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a LaneGuidanceUpdateObserver to TomTomNavigation.

This is notified whenever there is a change in location and the GuidanceEngine successfully generates a new lane guidance.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added LaneGuidanceUpdateObserver from TomTomNavigation.

This method allows you to stop receiving updates about lane guidance changes.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationActiveRouteChangeObserver to TomTomNavigation.

This is notified of changes to the active route whenever a new active route has been set.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationActiveRouteChangeObserver from TomTomNavigation.

This method allows you to stop receiving updates about active route changes.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationGuidanceObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationGuidanceObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationLocationContextObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationLocationContextObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationDestinationArrivalObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationDestinationArrivalObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationWaypointArrivalObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationWaypointArrivalObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationHorizonObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationHorizonObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationRouteTrackingStateUpdateObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationRouteTrackingStateUpdateObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.

Adds a NavigationLanguageChangeObserver to TomTomNavigation.

This method must be called on the main queue. The system maintains a weak reference to the observer.

Removes a previously added NavigationLanguageChangeObserver from TomTomNavigation.

No need to remove the observer manually; the system will handle it when the next event occurs. Ensure this method is called on the main queue. Avoid calling this method from the observer’s deinitializer unless you are sure it will be destroyed on the main queue.