navigation:engine/com.tomtom.sdk.navigation/TomTomNavigation

TomTomNavigation

class TomTomNavigation : NavigationController

Responsible for interacting with and customizing a navigation.

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

Companion

object Companion

Functions

addOnDestinationReachedListener

open override fun addOnDestinationReachedListener(listener: OnDestinationReachedListener)

Adds an OnDestinationReachedListener which will inform about reaching destination the ArrivalDetectionEngine successfully detects arrival at the destination.

addOnGuidanceUpdateListener

open override fun addOnGuidanceUpdateListener(listener: OnGuidanceUpdateListener)

Adds an OnGuidanceUpdateListener which will inform about new Guidance each time a location change occurs and the GuidanceEngine successfully generates it.

addOnHorizonUpdateListener

open override fun addOnHorizonUpdateListener(options: HorizonOptions, listener: OnHorizonUpdatedListener)

Adds an OnHorizonUpdatedListener which will inform about new horizon snaphot each time a location change occurs and the HorizonEngine successfully updated it.

addOnLaneGuidanceUpdatedListener

open override fun addOnLaneGuidanceUpdatedListener(listener: OnLaneGuidanceUpdateListener)

Adds an OnLaneGuidanceUpdateListener which will report new LaneGuidance every time a location change occurs and the GuidanceEngine successfully generates it.

addOnLocationContextUpdateListener

open override fun addOnLocationContextUpdateListener(listener: OnLocationContextUpdateListener)

Adds an OnLocationContextUpdateListener which will inform about new LocationContext each time a location change occurs and the LocationContextProviderEngine successfully provides it.

addOnLocationMatchedListener

open override fun addOnLocationMatchedListener(listener: OnLocationMatchedListener)

Adds an OnLocationMatchedListener which will inform about new MatchedLocation each time a location change occurs and the MapMatchingEngine successfully matched it.

addOnLocationPredictionsGeneratedListener

open override fun addOnLocationPredictionsGeneratedListener(listener: OnLocationPredictionsGeneratedListener)

Adds an OnLocationPredictionsGeneratedListener which will inform about new predictions.

addOnNavigationErrorListener

open override fun addOnNavigationErrorListener(listener: OnNavigationErrorListener)

Adds an OnNavigationErrorListener which will inform about errors that occurred during navigating.

addOnNavigationStartedListener

open override fun addOnNavigationStartedListener(listener: OnNavigationStartedListener)

Adds an OnNavigationStartedListener which will inform about successful navigation start.

addOnProgressUpdateListener

open override fun addOnProgressUpdateListener(listener: OnProgressUpdateListener)

Adds an OnProgressUpdateListener which will inform about new progress along the route each time a location change occurs and the RouteProgressEngine successfully calculates it.

addOnReplannedRouteProposedListener

open override fun addOnReplannedRouteProposedListener(listener: OnReplannedRouteProposedListener)

Adds an OnReplannedRouteProposedListener which will inform about new ReplannedRoute. Its Route can either be used in update or discarded. Listener will only be triggered if ContinuousReplanningMode is set to ContinuousReplanningMode.Manual or ContinuousReplanningMode.UnreachableOnly in NavigationConfiguration.

addOnRouteDeviationListener

open override fun addOnRouteDeviationListener(listener: OnRouteDeviationListener)

Adds an OnRouteDeviationListener which will inform about getting off the route when the RouteTrackingEngine successfully detects it.

addOnRoutesChangedListener

open override fun addOnRoutesChangedListener(listener: OnRoutesChangedListener)

Adds an OnRoutesChangedListener which will inform about successful update of the Route.

addOnRouteUpdatedListener

open override fun addOnRouteUpdatedListener(listener: OnRouteUpdatedListener)

Adds an OnRouteUpdatedListener which will inform about successful update of the Route.

addOnWaypointVisitedListener

open override fun addOnWaypointVisitedListener(listener: OnWaypointVisitedListener)

Adds an OnWaypointVisitedListener which will inform about reaching waypoints when the ArrivalDetectionEngine successfully detects arrival at a waypoint.

arrivalDetectionEngine

open override fun arrivalDetectionEngine(): ArrivalDetectionEngine

Returns the current ArrivalDetectionEngine.

changeContinuousReplanningMode

open override fun changeContinuousReplanningMode(continuousReplanningMode: ContinuousReplanningMode)

Replaces the current ContinuousReplanningMode with the new one.

open override fun close()

continuousReplanningMode

open override fun continuousReplanningMode(): ContinuousReplanningMode

Returns the current ContinuousReplanningMode.

guidanceEngine

open override fun guidanceEngine(): GuidanceEngine

Returns the current GuidanceEngine.

horizonEngine

open override fun horizonEngine(): HorizonEngine?

Returns the current HorizonEngine.

locationContextProviderEngine

open override fun locationContextProviderEngine(): LocationContextProviderEngine

Returns the current LocationContextProviderEngine.

locationProvider

open override fun locationProvider(): LocationProvider

Returns the current LocationProvider.

mapMatchingEngine

open override fun mapMatchingEngine(): MapMatchingEngine

Returns the current MapMatchingEngine.

navigationSnapshot

open override fun navigationSnapshot(): NavigationSnapshot?

Returns the current NavigationSnapshot. The return value is null when navigation is not yet started or already stopped.

removeOnDestinationReachedListener

open override fun removeOnDestinationReachedListener(listener: OnDestinationReachedListener)

Removes previously registered OnDestinationReachedListener.

removeOnGuidanceUpdateListener

open override fun removeOnGuidanceUpdateListener(listener: OnGuidanceUpdateListener)

Removes previously registered OnGuidanceUpdateListener.

removeOnHorizonUpdateListener

open override fun removeOnHorizonUpdateListener(listener: OnHorizonUpdatedListener)

Removes previously registered OnHorizonUpdatedListener.

removeOnLaneGuidanceUpdatedListener

open override fun removeOnLaneGuidanceUpdatedListener(listener: OnLaneGuidanceUpdateListener)

Removes previously registered OnLaneGuidanceUpdateListener.

removeOnLocationContextUpdateListener

open override fun removeOnLocationContextUpdateListener(listener: OnLocationContextUpdateListener)

Removes previously registered OnLocationContextUpdateListener.

removeOnLocationMatchedListener

open override fun removeOnLocationMatchedListener(listener: OnLocationMatchedListener)

Removes previously registered OnLocationMatchedListener.

removeOnLocationPredictionsGeneratedListener

open override fun removeOnLocationPredictionsGeneratedListener(listener: OnLocationPredictionsGeneratedListener)

Removes previously registered OnLocationPredictionsGeneratedListener.

removeOnNavigationErrorListener

open override fun removeOnNavigationErrorListener(listener: OnNavigationErrorListener)

Removes previously registered OnNavigationErrorListener.

removeOnNavigationStartedListener

open override fun removeOnNavigationStartedListener(listener: OnNavigationStartedListener)

Removes previously registered OnNavigationStartedListener.

removeOnProgressUpdateListener

open override fun removeOnProgressUpdateListener(listener: OnProgressUpdateListener)

Removes previously registered OnProgressUpdateListener.

removeOnReplannedRouteProposedListener

open override fun removeOnReplannedRouteProposedListener(listener: OnReplannedRouteProposedListener)

Removes previously registered OnReplannedRouteProposedListener.

removeOnRouteDeviationListener

open override fun removeOnRouteDeviationListener(listener: OnRouteDeviationListener)

Removes previously registered OnRouteDeviationListener.

removeOnRoutesChangedListener

open override fun removeOnRoutesChangedListener(listener: OnRoutesChangedListener)

Removes previously registered OnRoutesChangedListener.

removeOnRouteUpdatedListener

open override fun removeOnRouteUpdatedListener(listener: OnRouteUpdatedListener)

Removes previously registered OnRouteUpdatedListener.

removeOnWaypointVisitedListener

open override fun removeOnWaypointVisitedListener(listener: OnWaypointVisitedListener)

Removes previously registered OnWaypointVisitedListener.

routeProgressEngine

open override fun routeProgressEngine(): RouteProgressEngine

Returns the current RouteProgressEngine.

routeTrackingEngine

open override fun routeTrackingEngine(): RouteTrackingEngine

Returns the current RouteTrackingEngine.

setArrivalDetectionEngine

open override fun setArrivalDetectionEngine(engine: ArrivalDetectionEngine)

Replaces current ArrivalDetectionEngine with the new one.

setGuidanceEngine

open override fun setGuidanceEngine(engine: GuidanceEngine)

Replaces current GuidanceEngine with the new one.

setHorizonEngine

open override fun setHorizonEngine(engine: HorizonEngine)

Replaces current HorizonEngine with the new one.

setLocationContextProviderEngine

open override fun setLocationContextProviderEngine(engine: LocationContextProviderEngine)

Replaces current LocationContextProviderEngine with the new one.

setLocationProvider

open override fun setLocationProvider(engine: LocationProvider)

Replaces current LocationProvider with the new one.

setMapMatchingEngine

open override fun setMapMatchingEngine(engine: MapMatchingEngine)

Replaces current MapMatchingEngine with the new one.

setRouteProgressEngine

open override fun setRouteProgressEngine(engine: RouteProgressEngine)

Replaces current RouteProgressEngine with the new one.

setRouteTrackingEngine

open override fun setRouteTrackingEngine(engine: RouteTrackingEngine)

Replaces current RouteTrackingEngine with the new one.

setUnitSystem

open override fun setUnitSystem(unitSystem: UnitSystemType)

Sets the UnitSystem to be used within NavigationController.

start

open override fun start()

Starts navigation without a Route. In this case navigation will just provide a MatchedLocation and LocationContext, therefore navigation will interact only with OnLocationMatchedListener and OnLocationContextUpdateListener.

open override fun start(navigationOptions: NavigationOptions)

Starts navigation with provided NavigationOptions. Navigation will go through all steps:

stop

open override fun stop()

Stops current navigation session and clears data related to it. Calling this method will have no effect if start was not called previously.

unitSystem

open override fun unitSystem(): UnitSystemType

Returns the UnitSystem used within NavigationController.

update

open override fun update(routePlan: RoutePlan)

Updates the navigation session with a Route from a provided RoutePlan. If the navigation was started with a Route then this method will replace the current Route with the provided one. If the navigation was started without a Route then this method will start navigating on the provided Route.