Structures
The following structures are available globally.
-
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct NavigatedRoutes
-
Configurations for triggering guidance.
This outlines the configurations that can be used to trigger guidance for navigation instructions. Guidance instructions include both visual and audio components, which provide accurate and practical assistance to the user.
As the user approaches the maneuver point, there are four distinct ‘Instruction Stages’ at which audio information is communicated:
- Far away
- Early instruction
- Main instruction
- Confirmation
The default configurations for each of these
TriggeringPoint
s is accessed using theGuidanceTriggeringConfig
struct, which provides functions for retrieving configurations for each of the default attribute combinations. By using these configurations, developers can ensure that the distance to maneuver displayed in the navigation instruction panel corresponds to the spoken distance in the audio instruction, providing a more seamless and effective user experience.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct GuidanceTriggeringConfig
-
Holds collection of
TriggeringConfigVariant
s.Use
TriggeringConfig
to initializeGuidanceTriggeringConfig
with the configuration for guidance announcments. The configuration is an array ofTriggeringConfigVariant
s; it defines all the parameters for all types of roads, regions, instructions types, and at what distances to be triggered. Additionally, theTriggeringConfig
instance may validate an input list internally, allowing the developer to identify the problems during initialization.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TriggeringConfig
-
Defines a variant for which a trigger should be generated. The most vital part of the instance is the
triggeringPoints
property whereTriggerType
is the key, andTriggeringPoint
is the value associated with that key.For example, the following variant will be applicable for a trigger where the road is controlled access, for all countries, for comprehensive mode, only for roundabout instructions, and it has one triggering point (follow).
TriggeringConfigVariant( roadTypes: [.controlledAccess], regions: [.restOfTheWorld], announcementModes: [.comprehensive], instructionTypes: [.roundabout], triggeringPoints: [ .follow: TriggeringPoint( recommendedDistance: TriggeringDistances( defaultDistance: Measurement.tt.kilometers(1000.0) ), messageDuration: 2 ) ] )
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TriggeringConfigVariant : Hashable, Equatable
-
Holds one or more triggering distances.
By default, the distance specified in
defaultDistance
is the triggering distance. In case custom triggering distances are to be used in the US and/or UK, corresponding values can be specified incustomDistanceUS
andcustomDistanceUK
respectively.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TriggeringDistances : Hashable, Equatable
-
Defines a point on the route, where a trigger should be exposed.
Triggering point is associated with
TriggerType
based on distance to the maneuver. For example, the following trigger must be triggered on the route at least 13 kilometers or at most 10 kilometers to the maneuver point.TriggeringPoint( recommendedDistance: TriggeringDistances( defaultDistance: Measurement.tt.kilometers(10.0) ), earliestDistance: TriggeringDistances( defaultDistance: Measurement.tt.kilometers(13.0) ), recommendedTime: 370, messageDuration: 0, isAudible: false )
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct TriggeringPoint : Hashable, Equatable
-
Defines types of unit system handling.
See moreDeclaration
Swift
public struct UnitSystemType : Equatable
-
Navigation options define parameters required to start or update a navigation session.
To specify navigation options, first plan a
TomTomSDKRoute/Route
usingTomTomSDKRoutePlanner/RoutePlanner
andTomTomSDKRoutePlanner/RoutePlanningOptions
, then create aRoutePlan
.For more information on navigation session see:
See morestart()
,start(navigationOptions:)
,update(navigationOptions:)
andstop()
.Declaration
Swift
public struct NavigationOptions
-
The options used for
TomTomRouteReplanningEngine
configurationImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RouteReplanningEngineOptions
-
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SimpleEngineCalcResult