Route
Fine-grained announcement points, each with its own message, location and distance to the instruction point.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct Announcement
Maneuver type to use in driving instructions.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum AnnouncementManeuver
Instruction indicating arrival at the destination.
See moreDeclaration
Swift
public struct ArrivalInstruction : Instruction
Indicates a type of auto transport system.
See moreDeclaration
Swift
public enum AutoTransportType
Indicates a border crossing between two countries.
See moreDeclaration
Swift
public struct BorderCrossing
Instruction indicating an upcoming border crossing.
See moreDeclaration
Swift
public struct BorderCrossingInstruction : Instruction
Indicates the direction to enter or exit a carpool lane.
See moreDeclaration
Swift
public enum CarpoolLaneDirection
The CarpoolSection
struct contains information about a part of the route that involves a toll carpool.
Declaration
Swift
public struct CarpoolSection : Section, SectionInitiable
The CarTrain
struct contains information about a part of the route that goes by car train.
Declaration
Swift
public struct CarTrainSection : Section, SectionInitiable
Represents information about the cause of a traffic event.
See moreDeclaration
Swift
public struct Cause
Represents a consumed or remaining amount of fuel or electric energy.
See moreDeclaration
Swift
public enum Consumption : Hashable
extension Consumption: CustomStringConvertible
Country information.
See moreDeclaration
Swift
public struct Country : Equatable
Provides predefined announcement types.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum DefaultAnnouncementType
Instruction indicating departure from the origin.
See moreDeclaration
Swift
public struct DepartureInstruction : Instruction
The Direction represents the direction of the road lane.
See moreDeclaration
Swift
public enum Direction
Indicates the driving side on the road.
Declaration
Swift
@available(*, deprecated, renamed: "TomTomSDKCommon.DrivingSide", message: "This API is deprecated and will be removed with the next major release.")
public typealias DrivingSide = TomTomSDKCommon.DrivingSide
Instruction indicating entering a vehicle transportation service through a terminal.
See moreDeclaration
Swift
public struct EnterAutoTransportInstruction : Instruction
Instruction indicating entering a carpool lane by changing lanes.
See moreDeclaration
Swift
public struct EnterCarpoolLaneInstruction : Instruction
Instruction indicating exiting a vehicle transportation service through a terminal.
See moreDeclaration
Swift
public struct ExitAutoTransportInstruction : Instruction
Instruction indicating exiting a carpool lane by changing lanes.
See moreDeclaration
Swift
public struct ExitCarpoolLaneInstruction : Instruction
Classification of an exit direction, relative to the direction of travel.
See moreDeclaration
Swift
public enum ExitDirection
Instruction indicating a highway or motorway exit.
See moreDeclaration
Swift
public struct ExitHighwayInstruction : Instruction
Instruction indicating exit from a roundabout.
See moreDeclaration
Swift
public struct ExitRoundaboutInstruction : Instruction
The FerrySection
struct contains information about a part of the route that goes by ferry.
Declaration
Swift
public struct FerrySection : Section, SectionInitiable
Instruction indicating that the current road should be followed for some distance.
See moreDeclaration
Swift
@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public struct FollowInstruction : Instruction
Indicates the direction to follow at a fork relative to the direction of travel.
See moreDeclaration
Swift
public enum ForkDirection
Instruction indicating an upcoming fork in the road.
See moreDeclaration
Swift
public struct ForkInstruction : Instruction
Represents an instruction for a maneuver along the Route
.
In order to guide a driver along the route, the navigation system invokes guiding Instruction
s for every maneuver.
Contains a set of attributes common to all instructions.
Is a part of the RouteLeg
which itself is a part of the Route
.
Different types of Instruction will implement this. They may also add extra attributes specific to their Instruction type.
e.g., TurnInstruction
will contain turnAngle
and turnDirection
.
Declaration
Swift
public protocol Instruction
Represents the route instruction coordinate and its distance offset along the route.
See moreDeclaration
Swift
public struct InstructionPoint
Indicates the side of the road of an itinerary point.
See moreDeclaration
Swift
public enum ItineraryPointRelativePosition
Provides the information about the landmark types.
See moreDeclaration
Swift
public enum Landmark
The Lane class provides information about the lane on the road.
See moreDeclaration
Swift
public struct Lane
extension Lane: Equatable
The LaneSeparator represents the lane separator painted on the road surface.
See moreDeclaration
Swift
public enum LaneSeparator
The LowEmissionZoneSection
struct contains information about a part of the route that crosses a low-emission zone.
Declaration
Swift
public struct LowEmissionZoneSection : Section, SectionInitiable
Magnitude of delay caused by the incident.
See moreDeclaration
Swift
public enum MagnitudeOfDelay
Instruction indicating a turn which is legally required.
See moreDeclaration
Swift
public struct MandatoryTurnInstruction : Instruction
Instruction indicating a merge to another road.
See moreDeclaration
Swift
public struct MergeInstruction : Instruction
Indicates the direction to follow at a fork.
See moreDeclaration
Swift
public enum MergeSide
The MotorwaySection
struct contains information about a part of the route that goes by the motorway.
Declaration
Swift
public struct MotorwaySection : Section, SectionInitiable
The PedestrianSection
struct contains information about a part of the route related to the pedestrian.
Declaration
Swift
public struct PedestrianSection : Section, SectionInitiable
Phonetic strings of all of the readable Instruction
properties.
Declaration
Swift
public struct Phonetics : Equatable
Represents a phonetic string.
See moreDeclaration
Swift
public struct PhoneticString : Equatable
Represents the planning reason returned from the route planner.
See moreDeclaration
Swift
public enum PlanningReason
extension PlanningReason: CustomStringConvertible
Indicates the quantized turn angle relative to driving direction.
See moreDeclaration
Swift
public enum QuantizedTurnAngle
Represents a road shield, a sign used to indicate the route number and the road’s classification.
Declaration
Swift
@available(*, deprecated, renamed: "TomTomSDKCommon.RoadShield", message: "This API is deprecated and will be removed with the next major release.")
public typealias RoadShield = TomTomSDKCommon.RoadShield
Contains information about the road shields of the next significant road segment after the maneuver.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct RoadShieldReference
The RoadShieldSection
struct contains information about a part of the route going by roads with road shields.
Declaration
Swift
public struct RoadShieldSection : Section, SectionInitiable
Represents the side of the road at which RouteStop is located.
See moreDeclaration
Swift
public enum RoadSide
Indicates a road type.
See moreDeclaration
Swift
public enum RoadType : Equatable
Instruction indicating a roundabout maneuver.
See moreDeclaration
Swift
public struct RoundaboutInstruction : Instruction
Represents information about a part of a Route
between two RouteStops
.
Contains a list of Instruction
s for all the maneuvers along the route leg.
Declaration
Swift
public struct RouteLeg
Information about the route creation and the last update.
See moreDeclaration
Swift
public struct RouteModificationHistory
Represents a route point together with its distance offset along the route and estimated travel time.
See moreDeclaration
Swift
public struct RoutePoint
Represents a predetermined point on a Route
that is used as a reference point for navigation - Origin, Destination, Waypoint.
RouteStop
objects are received as part of the route response from the route planning API.
RouteStop
is added to the route response because either the location was requested by the user
or it was automatically generated by the system (see SourceType
).
Declaration
Swift
public struct RouteStop
Information about route creation or modification time.
See moreDeclaration
Swift
public struct RouteTimestamp
The Section protocol contains information about a part of the route.
See moreDeclaration
Swift
public protocol Section
The SectionInitiable protocol contains init to create simple section.
See moreDeclaration
Swift
public protocol SectionInitiable
The SectionLocation struct contains information about the location of the section.
See moreDeclaration
Swift
public struct SectionLocation
The Sections structure contains information about various sections on the route.
See moreDeclaration
Swift
public struct Sections
Represents a line between two RoutePoint
s.
Declaration
Swift
public struct Segment
The Signpost
class contains information about the signpost for the Instruction
.
Declaration
Swift
public struct Signpost
The route summary contains the high-level route data.
See moreDeclaration
Swift
public struct Summary
Instruction indicating changing highways by following an exit ramp.
See moreDeclaration
Swift
public struct SwitchHighwayInstruction : Instruction
The Tec class contains details of a traffic event.
See moreDeclaration
Swift
public struct Tec
Represents a localized string with optional phonetics information.
See moreDeclaration
Swift
public struct TextWithPhonetics : Equatable
Instruction indicating the driver is approaching a tollgate or ETC terminal.
See moreDeclaration
Swift
public struct TollgateInstruction : Instruction
Indicates the payment type accepted for a toll.
See moreDeclaration
Swift
public enum TollPaymentType : Hashable
The TollRoadSection
struct contains information about a part of the route going via a toll road.
Declaration
Swift
@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.\nPlease use TomTomSDKRoute.TollSection instead.")
public struct TollRoadSection : Section
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
extension Array where Element == CLLocationCoordinate2D
extension Array where Element == RoutePoint
The TunnelSection
struct contains information about a part of the route that goes through a tunnel.
Declaration
Swift
public struct TunnelSection : Section, SectionInitiable
Instruction indicating that the driver should turn around when it is possible.
See moreDeclaration
Swift
public struct TurnAroundWhenPossibleInstruction : Instruction
Indicates the direction of a turn maneuver.
See moreDeclaration
Swift
public enum TurnDirection
Instruction indicating a turn at a road junction.
See moreDeclaration
Swift
public struct TurnInstruction : Instruction
The UnpavedSection
struct contains information about a part of the route related to the unpaved road.
Declaration
Swift
public struct UnpavedSection : Section, SectionInitiable
The UrbanSection
struct contains information about a part of the route going through a city.
Declaration
Swift
public struct UrbanSection : Section, SectionInitiable
Instruction indicating that a waypoint on the route is reached.
See moreDeclaration
Swift
public struct WaypointInstruction : Instruction