GuidanceInstruction

public protocol GuidanceInstruction

The protocol for a Guidance Instruction.

Contains a set of attributes common to all GuidanceInstructions. It contains a set of default attributes common to all GuidanceInstruction‘s.

e.g., 'Turn right’, ‘Keep left’, ‘Take the ferry’, ‘Take the motorway’, ‘Arrive’.

Different types of GuidanceInstruction‘s will implement this, and may add extra attributes specific to the Instruction type.

e.g., TurnInstruction will contain turnAngleInDegrees and turnDirection.

  • id

    The ID of the instruction.

    Declaration

    Swift

    var id: UUID { get }

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

    Declaration

    Swift

    var routeOffset: Measurement<UnitLength> { get }

  • Location of the maneuver expressed as a CLLocationCoordinate2D.

    Declaration

    Swift

    var maneuverPoint: CLLocationCoordinate2D { get }

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

    Important

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

    Declaration

    Swift

    var drivingSide: DrivingSide { get }

  • 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

    var combinedWithNext: Bool { get }

  • Information about the road the driver will be on immediately before starting the maneuver, if available for this instruction.

    Declaration

    Swift

    var previousSignificantRoad: Road? { get }

  • Information about the road the driver will be on immediately after completing the maneuver, if available for this instruction.

    Declaration

    Swift

    var nextSignificantRoad: Road? { get }

  • An array of InstructionPoint‘s that represents a route path.

    Declaration

    Swift

    var routePath: [InstructionPoint] { get }

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

    Declaration

    Swift

    var intersectionName: String { get }

  • Signpost information, if present for this instruction.

    Declaration

    Swift

    var signpost: Signpost? { get }