TomTomSDKRoute
-
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
-
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
-
Represents a consumed or remaining amount of fuel or electric energy.
See moreDeclaration
Swift
public enum Consumption : Hashable
extension Consumption: CustomStringConvertible
-
Indicates driving side at the point of the maneuver.
See moreDeclaration
Swift
public enum DrivingSide
-
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
-
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
-
Instruction indicating entering a vehicle transportation service through a terminal.
See moreDeclaration
Swift
public struct EnterAutoTransportInstruction : Instruction
-
Instruction indicating exiting a vehicle transportation service through a terminal.
See moreDeclaration
Swift
public struct ExitAutoTransportInstruction : Instruction
-
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
-
Instruction indicating entering a carpool lane by changing lanes.
See moreDeclaration
Swift
public struct EnterCarpoolLaneInstruction : Instruction
-
Instruction indicating exiting a carpool lane by changing lanes.
See moreDeclaration
Swift
public struct ExitCarpoolLaneInstruction : Instruction
-
Indicates a border crossing between two countries.
See moreDeclaration
Swift
public struct BorderCrossing
-
Country information.
See moreDeclaration
Swift
public struct Country : Equatable
-
Classification of an exit direction, relative to the direction of travel.
See moreDeclaration
Swift
public enum ExitDirection
-
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
-
Indicates the quantized turn angle relative to driving direction.
See moreDeclaration
Swift
public enum QuantizedTurnAngle
-
Indicates the payment type accepted for a toll.
See moreDeclaration
Swift
public enum TollPaymentType : Hashable
-
Indicates the direction of a turn maneuver.
See moreDeclaration
Swift
public enum TurnDirection
-
Instruction indicating departure from the origin.
See moreDeclaration
Swift
public struct DepartureInstruction : Instruction
-
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
-
Instruction indicating a highway or motorway exit.
See moreDeclaration
Swift
public struct ExitHighwayInstruction : Instruction
-
Instruction indicating changing highways by following an exit ramp.
See moreDeclaration
Swift
public struct SwitchHighwayInstruction : Instruction
-
Represents an instruction for a maneuver along the
Route
. In order to guide a driver along the route, the navigation system invokes guidingInstruction
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 theRoute
.Different types of Instruction will implement this. They may also add extra attributes specific to their Instruction type. e.g.,
See moreTurnInstruction
will containturnAngle
andturnDirection
.Declaration
Swift
public protocol Instruction
-
Represents the route instruction coordinate and its distance offset along the route.
See moreDeclaration
Swift
public struct InstructionPoint
-
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
-
Represents a phonetic string.
See moreDeclaration
Swift
public struct PhoneticString : Equatable
-
Phonetic strings of all of the readable
See moreInstruction
properties.Declaration
Swift
public struct Phonetics : Equatable
-
Represents a road shield.
See moreDeclaration
Swift
public struct RoadShield : Equatable
-
Indicates a road type.
See moreDeclaration
Swift
public enum RoadType : Equatable
-
Instruction indicating exit from a roundabout.
See moreDeclaration
Swift
public struct ExitRoundaboutInstruction : Instruction
-
Instruction indicating a roundabout maneuver.
See moreDeclaration
Swift
public struct RoundaboutInstruction : Instruction
-
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
-
Instruction indicating a turn at a road junction.
See moreDeclaration
Swift
public struct TurnInstruction : Instruction
-
Instruction indicating that the driver should turn around when it is possible.
See moreDeclaration
Swift
public struct TurnAroundWhenPossibleInstruction : Instruction
-
Instruction indicating that a waypoint on the route is reached.
See moreDeclaration
Swift
public struct WaypointInstruction : Instruction
-
Represents information about a part of a
Route
between twoRouteStops
.Contains a list of
See moreInstruction
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
-
Information about route creation or modification time.
See moreDeclaration
Swift
public struct RouteTimestamp
-
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
See moreRoute
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 (seeSourceType
).Declaration
Swift
public struct RouteStop
-
The
See moreCarTrain
struct contains information about a part of the route that goes by car train.Declaration
Swift
public struct CarTrainSection : Section, SectionInitiable
-
The
See moreCarpoolSection
struct contains information about a part of the route that involves a toll carpool.Declaration
Swift
public struct CarpoolSection : Section, SectionInitiable
-
The
See moreFerrySection
struct contains information about a part of the route that goes by ferry.Declaration
Swift
public struct FerrySection : Section, SectionInitiable
-
The Direction represents the direction of the road lane.
See moreDeclaration
Swift
public enum Direction
-
The Lane class provides information about the lane on the road.
See moreDeclaration
Swift
public struct Lane
-
The LaneSeparator represents the lane separator painted on the road surface.
See moreDeclaration
Swift
public enum LaneSeparator
-
The
See moreLowEmissionZoneSection
struct contains information about a part of the route that crosses a low-emission zone.Declaration
Swift
public struct LowEmissionZoneSection : Section, SectionInitiable
-
The
See moreMotorwaySection
struct contains information about a part of the route that goes by motorway.Declaration
Swift
public struct MotorwaySection : Section, SectionInitiable
-
The
See morePedestrianSection
struct contains information about a part of the route related to the pedestrian.Declaration
Swift
public struct PedestrianSection : Section, SectionInitiable
-
The
See moreRoadShieldSection
struct contains information about a part of the route going by roads with road shields.Declaration
Swift
public struct RoadShieldSection : Section, SectionInitiable
-
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
-
The
See moreTunnelSection
struct contains information about a part of the route that goes through a tunnel.Declaration
Swift
public struct TunnelSection : Section, SectionInitiable
-
The
See moreUnpavedSection
struct contains information about a part of the route related to the unpaved road.Declaration
Swift
public struct UnpavedSection : Section, SectionInitiable
-
The
See moreUrbanSection
struct contains information about a part of the route going through a city.Declaration
Swift
public struct UrbanSection : Section, SectionInitiable
-
Represents a line between two
See moreRoutePoint
s.Declaration
Swift
public struct Segment
-
The
See moreSignpost
class contains information about the signpost for theInstruction
.Declaration
Swift
public struct Signpost
-
The route summary contains the high-level route data.
See moreDeclaration
Swift
public struct Summary
-
Represents information about the cause of a traffic event.
See moreDeclaration
Swift
public struct Cause
-
Magnitude of delay caused by the incident.
See moreDeclaration
Swift
public enum MagnitudeOfDelay
-
The Tec class contains details of a traffic event.
See moreDeclaration
Swift
public struct Tec
-
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