TurnGuidanceInstruction
public struct TurnGuidanceInstruction : GuidanceInstruction
Guidance Instruction indicating a turn at a road junction.
Indicates if the instruction should be combined with the next one. This can be used to build messages like “Turn left and then turn right”.
Declaration
Swift
public let combinedWithNext: Bool
Indicates left-hand vs. right-hand side driving at the point of the maneuver.
Declaration
Swift
public let drivingSide: TomTomSDKCommon.DrivingSide
The ID of the instruction.
Declaration
Swift
public let id: UUID
init(turnAngle:turnDirection:id:routeOffset:maneuverPoint:drivingSide:combinedWithNext:previousSignificantRoad:nextSignificantRoad:routePath:intersectionName:signpost:)
Initializes the guidance instruction, specifying values for its fields.
Throws
An exception of the typeTurnGuidanceInstructionError
Declaration
Swift
public init(
turnAngle: Measurement<UnitAngle>,
turnDirection: TurnDirection,
id: UUID,
routeOffset: Measurement<UnitLength>,
maneuverPoint: CLLocationCoordinate2D,
drivingSide: TomTomSDKCommon.DrivingSide,
combinedWithNext: Bool,
previousSignificantRoad: Road? = nil,
nextSignificantRoad: Road? = nil,
routePath: [InstructionPoint] = [],
intersectionName: String = "",
signpost: Signpost? = nil
) throws
Parameters
turnAngle
|
Turn angle relative to the driving direction on the route, expressed in the range -180…180 degrees. |
turnDirection
|
Classification of the relative angle of the turn. |
id
|
The ID of the instruction. |
routeOffset
|
The distance from the start of the route to the instruction point. |
maneuverPoint
|
Location of the maneuver expressed as |
drivingSide
|
Indicates left-hand vs. right-hand side driving at the point of the maneuver. |
combinedWithNext
|
Indicates whether the instruction should be combined with the next one. This can be used to build messages like “Turn left and then turn right”. |
previousSignificantRoad
|
Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction. |
nextSignificantRoad
|
Information about the road the driver will be on immediately after completing the maneuver. |
routePath
|
A list of |
intersectionName
|
Name of the intersection at the maneuver point, if present for this instruction. |
signpost
|
Signpost information, if present for this instruction. |
Name of the intersection at the maneuver point, if present for this instruction.
Declaration
Swift
public let intersectionName: String
Location of the maneuver expressed as a CLLocationCoordinate2D
.
Declaration
Swift
public let maneuverPoint: CLLocationCoordinate2D
Information about the road the driver will be on immediately after completing the maneuver, if available for this instruction.
Declaration
Swift
public let nextSignificantRoad: Road?
Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.
Declaration
Swift
public let previousSignificantRoad: Road?
The distance from the start of the route to the instruction point.
Declaration
Swift
public let routeOffset: Measurement<UnitLength>
An array of InstructionPoint
‘s that represents a route path.
Declaration
Swift
public let routePath: [InstructionPoint]
Signpost information, if present for this instruction.
Declaration
Swift
public let signpost: Signpost?
Turn angle relative to the driving direction on the route,
in the range -180...180
degrees.
Declaration
Swift
public let turnAngle: Measurement<UnitAngle>
Classification of the relative angle of the turn.
Declaration
Swift
public let turnDirection: TurnDirection