MandatoryTurnInstruction

public struct MandatoryTurnInstruction : Instruction

Instruction indicating a turn which is legally required.

Lifecycle

  • Initializes the route instruction, specifying values for its fields.

    Throws

    InitializationError.invalidTurnAngle if turnAngle not meets requirement.

    Requires

    turnAngle in the range -180...180 degrees.

    Important

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

    Declaration

    Swift

    public init(
    turnAngle: Measurement<UnitAngle>,
    turnDirection: TurnDirection,
    routeOffset: Measurement<UnitLength>,
    maneuverPoint: CLLocationCoordinate2D,
    drivingSide: DrivingSide,
    combineWithNext: Bool,
    announcements: [Announcement] = [],
    previousSignificantRoad: Road? = nil,
    nextSignificantRoad: Road? = nil,
    routePath: [InstructionPoint] = [],
    intersectionName: TextWithPhonetics? = nil,
    signpost: Signpost? = nil,
    landmark: Landmark? = nil,
    sideStreetOffset: Measurement<UnitLength>? = nil,
    trafficLightOffset: Measurement<UnitLength>? = nil,
    id: UUID = UUID()
) throws

    Parameters

    turnAngle

    Turn angle relative to the driving direction on the route, in the range -180...180 degrees.
    turnDirection

    Classification of the relative angle of the turn.
    routeOffset

    The distance from the start of the route to the instruction point.
    maneuverPoint

    Location of the maneuver expressed as CLLocationCoordinate2D.
    drivingSide

    Indicates left-hand vs. right-hand side driving at the point of the maneuver.
    combineWithNext

    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”.
    announcements

    Fine-grained Announcements for the Instruction.
    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

    An array of RoutePoints that represents a route path.
    intersectionName

    Name of the intersection at the maneuver point, if present for this instruction.
    signpost

    Signpost information, if present for this instruction.
    landmark

    Landmark information, if present in this instruction.
    sideStreetOffset

    Distance to the maneuver point from the intermediate side street, if any.
    trafficLightOffset

    Distance to the maneuver point from the preceding traffic light, if any.
    id

    The ID of the instruction.

Public

  • id

    The ID of the instruction.

    Declaration

    Swift

    public let id: UUID

  • The distance from the start of the route to the instruction point.

    Declaration

    Swift

    public let routeOffset: Measurement<UnitLength>

  • Location of the maneuver expressed as CLLocationCoordinate2D.

    Declaration

    Swift

    public let maneuverPoint: CLLocationCoordinate2D

  • Indicates left-hand vs. right-hand side driving at the point of the maneuver.

    Declaration

    Swift

    public let drivingSide: DrivingSide

  • Indicates whether it is possible to combine the instruction with the next one. This can be used to build messages like “Turn left and then turn right”.

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public let combineWithNext: Bool

  • Fine-grained Announcements for the Instruction.

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public let announcements: [Announcement]

  • 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?

  • 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?

  • An array of RoutePoints that represents a route path.

    Declaration

    Swift

    public let routePath: [InstructionPoint]

  • Name of the intersection at the maneuver point, if present for this instruction.

    Declaration

    Swift

    public let intersectionName: TextWithPhonetics?

  • Signpost information, if present for this instruction.

    Declaration

    Swift

    public let signpost: Signpost?

  • Landmark information, if present in this instruction.

    Declaration

    Swift

    public let landmark: Landmark?

  • Distance to the maneuver point from the intermediate side street, if any.

    Declaration

    Swift

    public let sideStreetOffset: Measurement<UnitLength>?

  • Distance to the maneuver point from the preceding traffic light, if any.

    Declaration

    Swift

    public let trafficLightOffset: Measurement<UnitLength>?

  • 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

MandatoryTurnInstruction.InitializationError