TomTomSDKRoute

  • Provides predefined announcement types.

    Important

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

    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.
    See more

    Declaration

    Swift

    public enum AnnouncementManeuver

Consumption

  • Represents a consumed or remaining amount of fuel or electric energy.

    See more

    Declaration

    Swift

    public enum Consumption : Hashable
    extension Consumption: CustomStringConvertible
  • Indicates driving side at the point of the maneuver.

    See more

    Declaration

    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.
    See more

    Declaration

    Swift

    public struct Announcement

ArrivalInstruction

EnterAutoTransportInstruction

ExitAutoTransportInstruction

BorderCrossingInstruction

EnterCarpoolLaneInstruction

ExitCarpoolLaneInstruction

BorderCrossing

  • Indicates a border crossing between two countries.

    See more

    Declaration

    Swift

    public struct BorderCrossing

Country

  • Country information.

    See more

    Declaration

    Swift

    public struct Country : Equatable
  • Classification of an exit direction, relative to the direction of travel.

    See more

    Declaration

    Swift

    public enum ExitDirection
  • Indicates the side of the road of an itinerary point.

    See more

    Declaration

    Swift

    public enum ItineraryPointRelativePosition
  • Provides the information about the landmark types.

    See more

    Declaration

    Swift

    public enum Landmark
  • Indicates the quantized turn angle relative to driving direction.

    See more

    Declaration

    Swift

    public enum QuantizedTurnAngle
  • Indicates the payment type accepted for a toll.

    See more

    Declaration

    Swift

    public enum TollPaymentType : Hashable
  • Indicates the direction of a turn maneuver.

    See more

    Declaration

    Swift

    public enum TurnDirection

DepartureInstruction

FollowInstruction

  • Instruction indicating that the current road should be followed for some distance.

    See more

    Declaration

    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 more

    Declaration

    Swift

    public enum ForkDirection

ForkInstruction

ExitHighwayInstruction

SwitchHighwayInstruction

Instruction

  • Represents an instruction for a maneuver along the Route. In order to guide a driver along the route, the navigation system invokes guiding Instructions 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.

    See more

    Declaration

    Swift

    public protocol Instruction

InstructionPoint

  • Represents the route instruction coordinate and its distance offset along the route.

    See more

    Declaration

    Swift

    public struct InstructionPoint

MandatoryTurnInstruction

MergeInstruction

PhoneticString

  • Represents a phonetic string.

    See more

    Declaration

    Swift

    public struct PhoneticString : Equatable

Phonetics

Road

  • Road information at a given point on a Route.

    See more

    Declaration

    Swift

    public struct Road : Equatable

RoadShield

  • Represents a road shield.

    See more

    Declaration

    Swift

    public struct RoadShield : Equatable

RoadType

  • Indicates a road type.

    See more

    Declaration

    Swift

    public enum RoadType : Equatable

ExitRoundaboutInstruction

RoundaboutInstruction

TextWithPhonetics

  • Represents a localized string with optional phonetics information.

    See more

    Declaration

    Swift

    public struct TextWithPhonetics : Equatable

TollgateInstruction

TurnInstruction

TurnAroundWhenPossibleInstruction

WaypointInstruction

PlanningReason

  • Represents the planning reason returned from the route planner.

    See more

    Declaration

    Swift

    public enum PlanningReason
    extension PlanningReason: CustomStringConvertible
  • Represents the side of the road at which RouteStop is located.

    See more

    Declaration

    Swift

    public enum RoadSide

Route

  • The route represents the result of the route planning including geometry and generated instructions.

    See more

    Declaration

    Swift

    public struct Route : CustomStringConvertible

RouteLeg

  • Represents information about a part of a Route between two RouteStops.

    Contains a list of Instructions for all the maneuvers along the route leg.

    See more

    Declaration

    Swift

    public struct RouteLeg

RouteModificationHistory

RouteTimestamp

  • Information about route creation or modification time.

    See more

    Declaration

    Swift

    public struct RouteTimestamp

RoutePoint

  • Represents a route point together with its distance offset along the route and estimated travel time.

    See more

    Declaration

    Swift

    public struct RoutePoint

RouteStop

  • 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).

    See more

    Declaration

    Swift

    public struct RouteStop

SourceType

CarTrainSection

CarpoolSection

CountrySection

  • The CountrySection struct contains information about a part of the route related to a country.

    See more

    Declaration

    Swift

    public struct CountrySection : Section

FerrySection

  • The FerrySection struct contains information about a part of the route that goes by ferry.

    See more

    Declaration

    Swift

    public struct FerrySection : Section, SectionInitiable
  • The Direction represents the direction of the road lane.

    See more

    Declaration

    Swift

    public enum Direction
  • The Lane class provides information about the lane on the road.

    See more

    Declaration

    Swift

    public struct Lane

LaneSection

  • The LaneSection struct is used to describe lane information for a part of the route. It contains information regarding the lanes, lane separators, location, and length of the section.

    See more

    Declaration

    Swift

    public struct LaneSection : Section
  • The LaneSeparator represents the lane separator painted on the road surface.

    See more

    Declaration

    Swift

    public enum LaneSeparator

LowEmissionZoneSection

MotorwaySection

PedestrianSection

RoadShieldSection

Section

  • The Section protocol contains information about a part of the route.

    See more

    Declaration

    Swift

    public protocol Section
  • The SectionInitiable protocol contains init to create simple section.

    See more

    Declaration

    Swift

    public protocol SectionInitiable
  • The SectionLocation struct contains information about the location of the section.

    See more

    Declaration

    Swift

    public struct SectionLocation
  • The Sections structure contains information about various sections on the route.

    See more

    Declaration

    Swift

    public struct Sections

SpeedLimitSection

  • The SpeedLimitSection struct represents a route section with speed limits available.

    See more

    Declaration

    Swift

    public struct SpeedLimitSection : Section

TollRoadSection

  • The TollRoadSection struct contains information about a part of the route going via a toll road.

    See more

    Declaration

    Swift

    public struct TollRoadSection : Section

TollVignetteSection

  • The TollVignetteSection struct contains information about a part of the route where a toll vignette is required.

    See more

    Declaration

    Swift

    public struct TollVignetteSection : Section

TrafficSection

  • The TrafficSection struct contains information about a part of the route related to traffic incidents.

    See more

    Declaration

    Swift

    public struct TrafficSection : Section

TunnelSection

UnpavedSection

UrbanSection

VehicleRestrictedSection

Signpost

  • The Signpost class contains information about the signpost for the Instruction.

    See more

    Declaration

    Swift

    public struct Signpost

Summary

  • The route summary contains the high-level route data.

    See more

    Declaration

    Swift

    public struct Summary
  • Represents information about the cause of a traffic event.

    See more

    Declaration

    Swift

    public struct Cause
  • Magnitude of delay caused by the incident.

    See more

    Declaration

    Swift

    public enum MagnitudeOfDelay
  • Tec

    The Tec class contains details of a traffic event.

    See more

    Declaration

    Swift

    public struct Tec
  • Important

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

    Declaration

    Swift

    extension Array where Element == CLLocationCoordinate2D
    extension Array where Element == RoutePoint