TurnGuidanceInstruction

public struct TurnGuidanceInstruction : GuidanceInstruction

Instruction indicating a turn maneuver.

Important

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

Lifecycle


                    
                    
                    init(id:routeOffset:travelTimeInSeconds:maneuverPoint:drivingSide:combinedWithNext:previousSignificantRoad:nextSignificantRoad:routePath:intersectionName:signpost:turnAngleInDegrees:turnDirection:)

Declaration

Swift

public init(
    id: UUID = UUID(),
    routeOffset: Measurement<UnitLength>,
    travelTimeInSeconds: TimeInterval,
    maneuverPoint: CLLocationCoordinate2D,
    drivingSide: DrivingSide?,
    combinedWithNext: Bool,
    previousSignificantRoad: RoadInformation?,
    nextSignificantRoad: RoadInformation?,
    routePath: [RouteCoordinate],
    intersectionName: String?,
    signpost: Signpost?,
    turnAngleInDegrees: Int,
    turnDirection: TurnDirection
)

Parameters

`uuid`	The ID of the instruction.
`routeOffset`	Distance from the start of the route to the instruction point.
`travelTimeInSeconds`	Estimated travel time to the point at routeOffset.
`maneuverPoint`	Location of the maneuver expressed as a latitude longitude pair.
`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”.
`verbalMessagePhonetics`	Phonetic strings of all of the readable [Instruction] properties.
`previousSignificantRoad`	Information about the road the driver will be on immediately before starting the maneuver.
`nextSignificantRoad`	Information about the road the driver will be on immediately after completing the maneuver.
`routePath`	A List of [RoutePoint]s that represents a route path.
`intersectionName`	Name of the intersection at the maneuver point.
`signpost`	Signpost information, if present for this instruction.
`turnAngleInDegrees`	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.

Public

id
Unique ID of the instruction.
Declaration
Swift

public let id: UUID
routeOffset
The distance from the start of the route to the point of the instruction
Declaration
Swift

public let routeOffset: Measurement<UnitLength>
travelTimeInSeconds
The estimated travel time up to the point corresponding to routeOffset.
Declaration
Swift

public let travelTimeInSeconds: TimeInterval
maneuverPoint
The coordinate of the maneuver
Declaration
Swift

public let maneuverPoint: CLLocationCoordinate2D
drivingSide
Indicates left-hand vs. right-hand side driving at the point of the maneuver.
Declaration
Swift

public let drivingSide: DrivingSide?
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”.
Declaration
Swift

public let combinedWithNext: Bool
previousSignificantRoad
Road information at some point on a [Route].
Declaration
Swift

public let previousSignificantRoad: RoadInformation?
nextSignificantRoad
Road information at some point on a [Route].
Declaration
Swift

public let nextSignificantRoad: RoadInformation?
routePath
List of [RouteCoordinate] on the [Route] with information about distance from start in meters.
Declaration
Swift

public let routePath: [RouteCoordinate]
intersectionName
Name of the intersection
Declaration
Swift

public let intersectionName: String?
signpost
The Signpost contains information about the signpost for the [GuidanceInstruction].
Declaration
Swift

public let signpost: Signpost?
turnAngleInDegrees
Turn angle relative to the driving direction on the route, expressed in the range -180…180 degrees.
Declaration
Swift

public let turnAngleInDegrees: Int
turnDirection
Classification of the relative angle of the turn.
Declaration
Swift

public let turnDirection: TurnDirection