TomTomGuidanceEngine Class Reference
TomTomGuidanceEngine
public class TomTomGuidanceEngine : GuidanceEngineTomTomGuidanceEngine 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.-
Initializer.
- announcementGenerators:List of announcement generators used to generate announcements at the current position on the route.
- appendInstructionDistanceThreshold:Distance threshold to be taken into account when creating the next instruction list.
Declaration
Swift
public convenience init( announcementGenerators: [AnnouncementGenerator] = defaultAnnouncementGenerators, appendInstructionDistanceThreshold: Double = defaultAppendInstructionDistanceThreshold )
-
Default distance threshold to be taken into account when creating a next instruction list.
Declaration
Swift
public static let defaultAppendInstructionDistanceThreshold: Double -
Default announcements generators
Declaration
Swift
public static let defaultAnnouncementGenerators: [AnnouncementGenerator] -
The language to be used by GuidanceEngine
Declaration
Swift
public var language: String? { get set } -
Declaration
Swift
public var announcementsEnabled: Bool { get set } -
Declaration
Swift
public var announcementMode: AnnouncementMode { get set } -
Declaration
Swift
public func generateGuidance(navigationSnapshot: NavigationSnapshot) throws -> Guidance -
Declaration
Swift
public func generateLaneGuidance(navigationSnapshot: NavigationSnapshot) -> LaneGuidanceUpdate? -
Declaration
Swift
public func reset()