RoundaboutGuidanceInstruction

public struct RoundaboutGuidanceInstruction : GuidanceInstruction

Guidance Instruction indicating an upcoming roundabout.

Important

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

Lifecycle


                    
                    
                    init(id:routeOffset:travelTime:maneuverPoint:drivingSide:combinedWithNext:previousSignificantRoad:nextSignificantRoad:routePath:intersectionName:signpost:turnAngle:exitNumber:roundaboutDirection:quantizedAngle:)

Initializes the guidance instruction, specifying values for its fields.

Declaration

Swift

public init(
    id: UUID = UUID(),
    routeOffset: Measurement<UnitLength>,
    travelTime: Measurement<UnitDuration>,
    maneuverPoint: CLLocationCoordinate2D,
    drivingSide: DrivingSide,
    combinedWithNext: Bool,
    previousSignificantRoad: RoadInformation?,
    nextSignificantRoad: RoadInformation?,
    routePath: [RouteCoordinate],
    intersectionName: String,
    signpost: Signpost?,
    turnAngle: Measurement<UnitAngle>,
    exitNumber: Int? = nil,
    roundaboutDirection: RoundaboutDirection,
    quantizedAngle: QuantizedAngle? = nil
) throws

Parameters

`uuid`	The ID of the instruction.
`routeOffset`	The distance from the start of the route to the instruction point.
`travelTime`	Estimated travel time to the point at routeOffset.
`maneuverPoint`	Location of the maneuver expressed as `CLLocationCoordinate2D`.
`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 `RouteCoordinate`s 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.
`turnAngle`	Turn angle relative to the driving direction on the entry road to the roundabout, in the range `-180...180` degrees.
`exitNumber`	Exit number where the driver should leave the roundabout, counted from the entry point to the roundabout.
`roundaboutDirection`	Classification of the main direction to take at the roundabout.
`quantizedAngle`	Classification of the turn angle relative to the driving direction on the entry road to the roundabout, if available.
`Throws`	An exception of the type `RoundaboutGuidanceInstructionError`

init(instruction:)
Creates a guidance instruction initialized relative to the route instruction.

Throws an error if converting to guidance types fails.
Declaration
Swift

public init(instruction: RoundaboutInstruction) throws

Public

id
The ID of the instruction.
Declaration
Swift

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

public let routeOffset: Measurement<UnitLength>
travelTime
The estimated travel time to the point at routeOffset.
Declaration
Swift

public let travelTime: Measurement<UnitDuration>
maneuverPoint
Location of the maneuver expressed as a CLLocationCoordinate2D.
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 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
previousSignificantRoad
Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.
Declaration
Swift

public let previousSignificantRoad: RoadInformation?
nextSignificantRoad
Information about the road the driver will be on immediately after completing the maneuver, if available for this instruction.
Declaration
Swift

public let nextSignificantRoad: RoadInformation?
routePath
An array of RouteCoordinate‘s that represents a route path.
Declaration
Swift

public let routePath: [RouteCoordinate]
intersectionName
Name of the intersection at the maneuver point, if present for this instruction.
Declaration
Swift

public let intersectionName: String
signpost
Signpost information, if present for this instruction.
Declaration
Swift

public let signpost: Signpost?
turnAngle
Turn angle relative to the driving direction on the entry road to the roundabout, in the range -180...180 degrees.
Declaration
Swift

public var turnAngle: Measurement<UnitAngle>
exitNumber
Exit number where the driver should leave the roundabout, counted from the entry point to the roundabout. If the route starts on the roundabout, counting starts from the departure point.
Declaration
Swift

public var exitNumber: Int?
roundaboutDirection
Classification of the main direction to take at the roundabout.
Declaration
Swift

public var roundaboutDirection: RoundaboutDirection
quantizedAngle
Classification of the turn angle relative to the driving direction on the entry road to the roundabout, if available.
Declaration
Swift

public let quantizedAngle: QuantizedAngle?