TomTom SDK for iOS ForkGuidanceInstruction

ForkGuidanceInstruction

public struct ForkGuidanceInstruction : GuidanceInstruction

Guidance Instruction indicating an upcoming fork in the road.


                    
                    
                    init(forkDirection:id:routeOffset:maneuverPoint:drivingSide:combinedWithNext:previousSignificantRoad:nextSignificantRoad:routePath:intersectionName:signpost:)

Initializes the guidance instruction, specifying values for its fields.

Declaration

Swift

public init(
    forkDirection: ForkDirection,
    id: UUID,
    routeOffset: Measurement<UnitLength>,
    maneuverPoint: CLLocationCoordinate2D,
    drivingSide: TomTomSDKCommon.DrivingSide,
    combinedWithNext: Bool,
    previousSignificantRoad: Road? = nil,
    nextSignificantRoad: Road? = nil,
    routePath: [InstructionPoint] = [],
    intersectionName: String = "",
    signpost: Signpost? = nil
)

Parameters

`forkDirection`	Direction to follow at the fork relative to the direction of travel.
`id`	The ID of the instruction.
`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.
`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 `RoutePoint`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.

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>
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: TomTomSDKCommon.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: Road?
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: Road?
routePath
An array of InstructionPoint‘s that represents a route path.
Declaration
Swift

public let routePath: [InstructionPoint]
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?
forkDirection
Indicates the direction to follow at the fork.
Declaration
Swift

public let forkDirection: ForkDirection