SwitchHighwayGuidanceInstruction

public struct SwitchHighwayGuidanceInstruction : GuidanceInstruction

Instruction indicating changing highways by following an exit ramp.

Important

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

Lifecycle

  • Declaration

    Swift

    public init(
        id: UUID = UUID(),
        routeOffsetInMeters: Double,
        travelTimeInSeconds: TimeInterval,
        maneuverPoint: CLLocationCoordinate2D,
        drivingSide: DrivingSide?,
        combinedWithNext: Bool,
        previousSignificantRoad: RoadInformation?,
        nextSignificantRoad: RoadInformation?,
        routePath: [RouteCoordinate],
        intersectionName: String?,
        signpost: Signpost?,
        exitDirection: ExitDirection
    )

    Parameters

    uuid

    The ID of the instruction.

    routeOffsetInMeters

    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.

    exitDirection

    direction of the switch maneuver relative to the direction of travel.

Public

  • id

    Unique ID of the instruction.

    Declaration

    Swift

    public let id: UUID
  • The distance from the start of the route to the point of the instruction

    Declaration

    Swift

    public let routeOffsetInMeters: Double
  • The estimated travel time up to the point corresponding to routeOffsetInMeters.

    Declaration

    Swift

    public let travelTimeInSeconds: TimeInterval
  • The coordinate of the maneuver

    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 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
  • Road information at some point on a [Route].

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    public let routePath: [RouteCoordinate]
  • Name of the intersection

    Declaration

    Swift

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

    Declaration

    Swift

    public let signpost: Signpost?
  • Direction of the switch maneuver relative to the direction of travel.

    Declaration

    Swift

    public let exitDirection: ExitDirection