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 DestinationArrivalStatus
-
Holds arrival status to a unique waypoint.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct WaypointArrivalStatus
-
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 moreDeclaration
Swift
public struct GuidanceAnnouncement : Equatable
-
Guidance update provided while navigating a route, including the list of upcoming instructions, guidance announcement and distance to the next maneuver.
See moreDeclaration
Swift
public struct Guidance
-
Guidance Instruction indicating arrival at the destination.
See moreDeclaration
Swift
public struct ArrivalGuidanceInstruction : GuidanceInstruction
-
Indicates a border crossing between two countries.
See moreDeclaration
Swift
public struct BorderCrossing
-
Instruction indicating an upcoming border crossing.
See moreDeclaration
Swift
public struct BorderCrossingGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating departure from the origin.
See moreDeclaration
Swift
public struct DepartureGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating entering a vehicle transportation service through a terminal.
See moreDeclaration
Swift
public struct EnterAutoTransportGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating entering a carpool lane by changing lanes.
See moreDeclaration
Swift
public struct EnterCarpoolLaneGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating exiting a vehicle transportation service through a terminal.
See moreDeclaration
Swift
public struct ExitAutoTransportGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating exiting a carpool lane by changing lanes.
See moreDeclaration
Swift
public struct ExitCarpoolLaneGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating taking a highway exit.
See moreDeclaration
Swift
public struct ExitHighwayGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating an exit from a roundabout.
See moreDeclaration
Swift
public struct ExitRoundaboutGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating that the current road should be followed for some distance.
See moreDeclaration
Swift
public struct FollowGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating an upcoming fork in the road.
See moreDeclaration
Swift
public struct ForkGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating a turn which is legally required.
See moreDeclaration
Swift
public struct MandatoryTurnGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating a merge onto another road.
See moreDeclaration
Swift
public struct MergeGuidanceInstruction : GuidanceInstruction
-
Road information relating to a
See moreGuidanceInstruction
.Declaration
Swift
public struct Road : Equatable
-
Guidance Instruction indicating an upcoming roundabout.
See moreDeclaration
Swift
public struct RoundaboutGuidanceInstruction : GuidanceInstruction
-
Contains information about the signpost for the
See moreGuidanceInstruction
.Declaration
Swift
public struct Signpost : Equatable
-
Guidance Instruction indicating changing highways by following an exit ramp.
See moreDeclaration
Swift
public struct SwitchHighwayGuidanceInstruction : GuidanceInstruction
-
Guidance instruction indicating the driver is approaching a tollgate or ETC terminal.
See moreDeclaration
Swift
public struct TollgateGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating the driver should turn around when it is possible.
See moreDeclaration
Swift
public struct TurnAroundWhenPossibleGuidanceInstruction : GuidanceInstruction
-
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.Declaration
Swift
public struct TurnGuidanceInstruction : GuidanceInstruction
-
Guidance Instruction indicating that a waypoint on the route is reached.
See moreDeclaration
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 moreDeclaration
Swift
public struct LaneGuidance
-
Holds information about
See moreLaneGuidance
and whether it is starting or ending.Declaration
Swift
public struct LaneGuidanceUpdate
-
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.Declaration
Swift
public struct LocationContext : Equatable
-
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.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.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.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.Declaration
Swift
public struct ProjectedRouteSection
-
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.Declaration
Swift
public struct NavigationSnapshot
-
Keeps the state of the waypoints in the current route, providing methods to change the state (as necessary).
Important
This is a Public Preview API. It may be changed or removed at any time.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.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.Declaration
Swift
public struct City : HorizonElement
-
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.Declaration
Swift
public struct GeneralRoadElements : HorizonElement
-
Describes path geometry of the horizon element
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct PathGeometry : HorizonElement
-
Describes a region on the horizon element.
Important
This is a Public Preview API. It may be changed or removed at any time.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.Declaration
Swift
public struct SafetyLocation : HorizonElement
-
Element with Speed limit information.
To retrieve the speed limits for a specific vehicle, configure proper
TomTomSDKCommon.Vehicle', e.g. for trucks configure a
Truckinstance, by implementing
TomTomSDKVehicle.VehicleProvideror using default implementation
TomTomSDKVehicle.DefaultVehicleProvider. An instance of the
TomTomSDKVehicle.VehicleProvidershould 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 othersImportant
This is a Public Preview API. It may be changed or removed at any time.
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.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
HorizonEngine
only searches within an explicitly specified distance when extending the main path. To search along the entire route use theRouteLengthPolicy
. If the search distance is not specified, a default value corresponding to a maximum horizon length ofDefaults.pathSearchDistance
is used.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ExplicitDistancePolicy : PathSearchDistancePolicy
-
Output of the
HorizonEngine
, consisting of oneHorizonSnapshot
,HorizonPosition
and set of previously registeredHorizonOptions
.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct HorizonResult
-
Horizon options. For information on how to manage horizon options see
HorizonEngine
.registerHorizonOptions
andHorizonEngine
.unregisterHorizonOptions
. 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:- The set of horizon element types in which the client is interested,
- The path search options for the main path (the path that the user is currently on, extending along the most likely trajectory),
- The path search options for the sub-paths (any horizon path that is not the main path),
- 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
-
Defines the interface to horizon element types.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct HorizonElementType : RawRepresentable, Hashable
-
Horizon search options for the main path. The main path is the path the user currently follows, extending along the most likely trajectory. The search distance policy and the search time define the extent of the paths in the horizon.
If both search time and search distance policy are provided (i.e., the
HorizonOptions
specifies both a search time and a search distance policy) for the main path, theHorizonEngine
extends the main path until both time and distance have reached their limits. If the search time is not specified, the horizon engine will work with a default value ofDefaults.pathSearchTime
for the search time and will extend the main path based on the search distance directly specified by or derived from the search policy.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct MainPathSearchOptions
-
Horizon search options for a sub-path level. Sub-path level - the number of times the driver would have to deviate from the main path to reach a particular sub-path. Search distance and the search time, define the extent of the paths in the horizon.
If both search time and search distance are specified (i.e., the
HorizonOptions
specify both a search time and a search distance) for a given sub-path level, theHorizonEngine
extends horizon sub-paths of that level until both time and distance have reached the limit.If only the search distance is specified for a given sub-path level, the horizon engine will work with a default value
Defaults.pathSearchTime
for the search time and extends the sub-paths of that level based on the search distance.If only the search time is specified for a given sub-path level, the horizon engine will work with a default value of
Defaults.pathSearchDistance
maximum extension length for the search distance and extends sub-paths of that level until both the time and distance reach the limit.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct SubPathSearchOptions
-
Snapshot of the horizon provided by the
HorizonEngine
based on a set of previously registered horizon options. Subscription options define the extent of the paths on the horizon as well as which map attributes are collected for those paths.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct HorizonSnapshot
-
Path in the horizon. The length of the path as well as which types of horizon elements it contains are determined by the horizon options.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct HorizonPath : Equatable
-
The best map-matched position on the horizon. It can be either on-road or off-road. If off-road, it can be either:
- the likeliest on-road position on the horizon, but flagged as off-road, if there are on-road candidates. The user can extract horizon elements to facilitate the decision to join the road.
- or an off-road position with an invalid path id and an unmatched raw location, if there are no on-road candidates on the horizon.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct HorizonPosition
-
State of the horizon snapshot provided by the
HorizonEngine
. It is based on a set of previously registered horizon options.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct HorizonSnapshotState : Equatable
-
Horizon path search distance configuration. It specifies the maximum horizon length.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct PathSearchDistance : Equatable