Classes

The following classes are available globally.

Navigation

  • 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.
    See more

    Declaration

    Swift

    public class Navigation : EngineActions
  • ConfirmationAnnouncementGenerator is a TypeBasedAnnouncementGenerator implementation that only generates announcements of the “confirmation” type.

    Important

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

    Declaration

    Swift

    public class ConfirmationAnnouncementGenerator : TypeBasedAnnouncementGenerator
  • EarlyAnnouncementGenerator is an AnnouncementGenerator implementation that only generates announcements of the “early” type.

    Important

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

    Declaration

    Swift

    public class EarlyAnnouncementGenerator : TypeBasedAnnouncementGenerator
  • MainAnnouncementGenerator is an AnnouncementGenerator implementation that only generates announcements of the “main” type.

    Important

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

    Declaration

    Swift

    public class MainAnnouncementGenerator : TypeBasedAnnouncementGenerator
  • TypeBasedAnnouncementGenerator is an AnnouncementGenerator implementation that only generates announcements of a specific type.

    Important

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

    Declaration

    Swift

    public class TypeBasedAnnouncementGenerator : AnnouncementGenerator

TomTomGuidanceEngine

  • TomTomGuidanceEngine generates Guidance using the list of TomTomSDKRoute.Instructions supplied within NavigationSnapshot.activeRoute.

    TomTomGuidanceEngine depends on the TomTomSDKRoute.Announcements included in the supplied TomTomSDKRoute.Instructions. The engine continuously checks the active route progress to provide up-to-date Guidance information. When the vehicle reaches an announcement point, the generated Guidance includes the GuidanceAnnouncement to be announced. Note that the set of supported languages may differ between different GuidanceEngines.

    TomTomGuidanceEngine should only be used with the online routing client that uses TomTomSDKRoutePlanner.GuidanceOnlineApiVersion.v1 as the TomTomSDKRoutePlanner.GuidanceOptions.guidanceVersion. This is because the instructions from offline and the online routing client configured with TomTomSDKRoutePlanner.GuidanceOnlineApiVersion.v1 are designed to be used by the DynamicGuidanceEngine and do not contain static announcement information.

    Important

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

    Declaration

    Swift

    public class TomTomGuidanceEngine : GuidanceEngine

TomTomDynamicGuidanceEngine

  • Creates a DynamicGuidanceEngine.

    DynamicGuidanceEngine generates dynamic Guidance for the TomTomSDKRoute.Instructions supplied within NavigationSnapshot.activeRoute.

    To generate dynamic Guidance, DynamicGuidanceEngine takes various parameters into account. These parameters include, but are not limited to:

    • Distance to the next maneuver.
    • Current speed of the vehicle.
    • Free-flow speed of the road between the current position and the next maneuver.
    • Traffic situation ahead.

    So, unlike TomTomGuidanceEngine, DynamicGuidanceEngine does not depend on TomTomSDKRoute.Announcement information that may or may not be included in the TomTomSDKRoute.Instruction. It continuously checks the active route progress to provide up-to-date Guidance information. Once the vehicle reaches an announcement point, the generated Guidance includes the (GuidanceAnnouncement) to be announced.

    Another difference between DynamicGuidanceEngine and TomTomGuidanceEngine is that DynamicGuidanceEngine uses TomTom’s advanced verbal instruction messages to synthesize GuidanceAnnouncements dynamically on the fly. Note that the set of supported languages may differ between different GuidanceEngines.

    DynamicGuidanceEngine can be used to provide turn-by-turn navigation with any routing client (offline, online with TomTomSDKRoutePlanner.GuidanceOptions.guidanceVersion v1 or v2).

    Important

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

    Declaration

    Swift

    public class TomTomDynamicGuidanceEngine : GuidanceEngine

NavKitLocationContextEngine

  • NavKitLocationContextEngine provides information about the driver locations. The information is retrieved from the NavKit database.

    Important

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

    Declaration

    Swift

    public class NavKitLocationContextEngine : LocationContextDetectionEngine
  • The DefaultMapMatchingEngine provides map matching using the NavKit SDK.

    Important

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

    Declaration

    Swift

    public class DefaultMapMatchingEngine : MapMatchingEngine

NavKitRouteProgressDetectionEngine

StandaloneRouteProgressEngine

TomTomReplanningRetryPolicy

TomTomRouteReplanningEngine

DefaultSimpleEngineCommonCalculator