Protocols

Engine that instantiates the update of the data store used for navigation.

See more

public protocol DataStoreMaintenanceEngine : ManageableEngine

See more

public protocol MainNavigationEngines

Provides access to Dynamic Routing

public protocol DynamicRoutingProvider

public protocol RouteNavigationEnginesProvider

The TomTomNavigation protocol defines the functionality of the navigation.

See more

public protocol TomTomNavigation : AnyObject

Provides access to current registered engines and allows updating them.

See more

public protocol NavigationEngineRegistry : AnyObject

The NavigationEngines protocol defines all engines that can be used by the TomTomSDKNavigation module.

See more

public protocol NavigationEngines : MainNavigationEngines, RouteNavigationEnginesProvider

An observer that receives navigation start events.

See more

public protocol NavigationStartObserver : Observer

An observer that receives navigation map matching events.

See more

public protocol NavigationMapMatchingObserver : Observer

An observer that receives navigation progress events.

See more

public protocol NavigationProgressObserver : Observer

An observer that receives navigation route events.

See more

public protocol NavigationRouteObserver : Observer

An observer that receives navigation guidance events.

See more

public protocol NavigationGuidanceObserver : Observer

An observer that receives navigation guidance events.

See more

public protocol NavigationLocationContextObserver : Observer

An observer that receives navigation events of arrival at destination.

Destination arrival is detected by the TomTomSDKNavigationEngines/ArrivalDetectionEngine. On arrival detection, navigation continues in turn-by-turn mode until it’s stopped or switched into free-driving mode.

To be notified about the destination arrival event while navigating, first implement the NavigationDestinationArrivalObserver protocol:

class NavigationDestinationArrivalObserverImpl: NavigationDestinationArrivalObserver {
    func didArriveAtDestination(route: TomTomSDKRoute.Route) {
        // Add code here that handles arrival at a destination.
    }
}

Then register this observer using addDestinationArrivalObserver(_:).

To stop receiving the destination arrival event, unregister the observer using removeDestinationArrivalObserver(_:).

See more

public protocol NavigationDestinationArrivalObserver : Observer

An observer that receives navigation events related with visiting waypoints.

The waypoint arrival state changes are detected by the TomTomSDKNavigationEngines/ArrivalDetectionEngine. Different observer methods are called depending on what state has been detected by the TomTomSDKNavigationEngines/ArrivalDetectionEngine:

• didArriveAtWaypoint(waypoint:on:) is received when the TomTomSDKNavigationEngines/ArrivalDetectionEngine detects an arrival at a waypoint.
• didDepartFromWaypoint(waypoint:on:) is received when the TomTomSDKNavigationEngines/ArrivalDetectionEngine detects a departure from a waypoint.

To be notified about the waypoint arrival events while navigating, first implement the NavigationWaypointArrivalObserver protocol:

class NavigationWaypointArrivalObserverImpl: NavigationWaypointArrivalObserver {
    func didArriveAtWaypoint(waypoint: RouteStop, on route: Route) {
        // Add code here that handles an arrival at a waypoint.
    }

    func didDepartFromWaypoint(waypoint: RouteStop, on route: Route) {
        // Add code here that handles a departure from a waypoint.
    }
}

Then register this observer using addWaypointArrivalObserver(_:).

To stop receiving these events, unregister the observer using removeWaypointArrivalObserver(_:).

See more

public protocol NavigationWaypointArrivalObserver : Observer

An observer that receives navigation horizon events.

See more

public protocol NavigationHorizonObserver : Observer

An observer that receives route tracking state updates.

The information about the route state is represented by RouteTrackingState. When the driver deviates or returns to the active route, the navigation engine sends route-tracking state updates to the observer.

To start receiving route tracking state updates, become an observer using Navigation.addRouteTrackingStateUpdateObserver(_ observer:): To stop receiving route tracking state updates, remove the previously added observer using Navigation.removeRouteTrackingStateUpdateObserver(_ observer:):

See more

public protocol NavigationRouteTrackingStateUpdateObserver : Observer

An observer that receives navigation error events.

public protocol NavigationErrorObserver : Observer

Specifies how to handle requests which failed during replanning of a Route.

See more

public protocol ReplanningRetryPolicy

public protocol SimpleEngineCommonCalculator