Structures

The following structures are available globally.

  • Important

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

    Declaration

    Swift

    public struct DestinationArrivalStatus
  • Holds arrival status to a unique waypoint.

    Important

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

    Declaration

    Swift

    public struct WaypointArrivalStatus

GuidanceAnnouncement

  • Guidance announcement relating to a maneuver during navigation. The announcement text message is provided in both Speech Synthesis Markup Language (SSML) and plain-text formats.

    See more

    Declaration

    Swift

    public struct GuidanceAnnouncement : Equatable

Guidance

  • Guidance update provided while navigating a route, including the list of upcoming instructions, guidance announcement and distance to the next maneuver.

    See more

    Declaration

    Swift

    public struct Guidance

ArrivalGuidanceInstruction

BorderCrossing

  • Indicates a border crossing between two countries.

    See more

    Declaration

    Swift

    public struct BorderCrossing

BorderCrossingGuidanceInstruction

Country

  • Country information.

    See more

    Declaration

    Swift

    public struct Country : Equatable

DepartureGuidanceInstruction

EnterAutoTransportGuidanceInstruction

EnterCarpoolLaneGuidanceInstruction

ExitCarpoolLaneGuidanceInstruction

ExitHighwayGuidanceInstruction

ExitRoundaboutGuidanceInstruction

FollowGuidanceInstruction

ForkGuidanceInstruction

MandatoryTurnGuidanceInstruction

MergeGuidanceInstruction

Road

RoundaboutGuidanceInstruction

Signpost

SwitchHighwayGuidanceInstruction

TollgateGuidanceInstruction

TurnAroundWhenPossibleGuidanceInstruction

TurnGuidanceInstruction

  • Guidance Instruction indicating a turn at a road junction.

    Important

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

    Declaration

    Swift

    public struct TurnGuidanceInstruction : GuidanceInstruction

WaypointGuidanceInstruction

  • Guidance Instruction indicating that a waypoint on the route is reached.

    See more

    Declaration

    Swift

    public struct WaypointGuidanceInstruction : GuidanceInstruction
  • Contains information about lane guidance.

    Lanes are stored in order from curb side to middle side. That is, in left-hand driving locales such as Japan, the lanes are ordered from left to right, while in right-hand driving locales such as the USA, the lanes are ordered from right to left.

    See more

    Declaration

    Swift

    public struct LaneGuidance

LaneGuidanceUpdate

LocationContext

  • LocationContext provides information about the driver’s location, which has been matched against the road network.

    Important

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

    Declaration

    Swift

    public struct LocationContext : Equatable

MapMatchingResult

  • The MapMatchingResult provides information about the matched location and its details.

    Important

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

    Declaration

    Swift

    public struct MapMatchingResult
  • The RouteProgress class provides information about the driver’s progress along the route.

    Important

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

    Declaration

    Swift

    public struct RouteProgress
  • Important

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

    Declaration

    Swift

    public struct RouteStopProgress
  • Represents a projected route with missing map reference data.

    Important

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

    Declaration

    Swift

    public struct ProjectedRoute
  • Describes part of the ProjectedRoute.

    Important

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

    Declaration

    Swift

    public struct ProjectedRouteSection

NavigationSnapshot

  • Navigation snapshot containing information about the state of the trip at a certain moment

    Important

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

    Declaration

    Swift

    public struct NavigationSnapshot
  • Keeps state of currently followed route’s waypoints, provide methods to change this state.

    Important

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

    Declaration

    Swift

    public struct RouteWaypointsState
  • RoutePlan specifies all required parameters for a single route navigation session.

    Important

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

    Declaration

    Swift

    public struct RoutePlan
  • Describes a city on the horizon element.

    Important

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

    Declaration

    Swift

    public struct City : HorizonElement

GeneralRoadElements

  • Describes the general road properties on the horizon element.

    Important

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

    Declaration

    Swift

    public struct GeneralRoadElements : HorizonElement
  • POI

    Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct POI : HorizonElement
  • Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct PathGeometry : HorizonElement
  • Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct Region : HorizonElement
  • Describes path geometry of the horizon element

    Important

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

    Declaration

    Swift

    public struct SafetyLocation : HorizonElement

SpeedLimits

  • Element with Speed limit information.

    To retrieve the speed limits for a specific vehicle e.g., for trucks, you need to set the proper TomTomSDKCommon.VehicleType using TomTomSDKVehicle.DefaultVehicleProvider.setVehicle. An instance of the TomTomSDKVehicle.DefaultVehicleProvider should be the same as provided to the TomTomSDKNavigation.NavigationConfiguration. After that, the horizon provides speed limits for the specific vehicle type.

    Attention

    speed limits are affected mostly by vehicle type TomTomSDKCommon.VehicleType, but some other vehicle characteristics might be considered such as weight, type of load and many others

    Important

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

    See more

    Declaration

    Swift

    public struct SpeedLimits : HorizonElement
  • Describes a street on the horizon element.

    Important

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

    Declaration

    Swift

    public struct Street : HorizonElement
  • Policy that specifies a search distance for the main path. Main path - the path that the user is currently on, extending along the most likely trajectory. When enabling this search policy, the horizon engine only searches within an explicitly specified distance when extending the main path. To search along the entire route use the route length policy. If the search distance is not specified, a default value corresponding to a maximum horizon length of 2 km is used.

    Important

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

    Declaration

    Swift

    public struct ExplicitDistancePolicy : PathSearchDistancePolicy

HorizonResponse

  • A response from HorizonEngine. Contains a horizon snapshot and a vehicle position per each set of previously registered horizon subscription options.

    Important

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

    Declaration

    Swift

    public struct HorizonResponse

HorizonOptions

  • Horizon options define the extent of the paths in the horizon and the map attributes to be collected for these paths. A set of horizon options consists of the following: A subscription configuration consists of four types of search options:

    1. The set of horizon element types the client is interested in
    2. The path search options for the main path (the path that the user is currently on, extending along the most likely trajectory).
    3. The path search options for the sub-paths (any horizon path that is not the main path).
    4. The maximum number of paths the client can receive.

Important

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

Declaration

Swift

public struct HorizonOptions
extension HorizonOptions: Hashable