Structures

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 TriggeringPoints is accessed using the GuidanceTriggeringConfig 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.

Holds collection of TriggeringConfigVariants.

Use TriggeringConfig to initialize GuidanceTriggeringConfig with the configuration for guidance announcments. The configuration is an array of TriggeringConfigVariants; it defines all the parameters for all types of roads, regions, instructions types, and at what distances to be triggered. Additionally, the TriggeringConfig instance may validate an input list internally, allowing the developer to identify the problems during initialization.

Defines a variant for which a trigger should be generated. The most vital part of the instance is the triggeringPoints property where TriggerType is the key, and TriggeringPoint 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
       )
   ]
)

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 in customDistanceUS and customDistanceUK respectively.

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
  )

Defines types of unit system handling.

Navigation options define parameters required to start or update a navigation session.

To specify navigation options, first plan a TomTomSDKRoute/Route using TomTomSDKRoutePlanner/RoutePlanner and TomTomSDKRoutePlanner/RoutePlanningOptions, then create a RoutePlan.

For more information on navigation session see: start(), start(navigationOptions:), update(navigationOptions:) and stop().

The options used for TomTomRouteReplanningEngine configuration