routing:model/com.tomtom.sdk.routing.route.instruction/Instruction

Instruction

Represents an instruction for a maneuver along the Route. In order to guide a driver along the route, the navigation system invokes guiding Instructions for every maneuver.

Contains a set of attributes common to all instructions. Is a part of the RouteLeg which itself is a part of the Route.

Different types of instruction will implement this. They may also add extra attributes specific to their instruction type.

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

Properties

announcements

abstract val announcements: List<Announcement>

Fine-grained Announcements for the Instruction.

combineWithNext

abstract val combineWithNext: Boolean

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".

drivingSide

abstract val drivingSide: DrivingSide

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

abstract val id: UniqueId

The ID of the instruction.

intersectionName

abstract val intersectionName: TextWithPhonetics?

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

landmark

abstract val landmark: Landmark?

Landmark information, if present in this instruction.

maneuverPoint

abstract val maneuverPoint: GeoPoint

Location of the maneuver expressed as a GeoPoint.

nextSignificantRoad

abstract val nextSignificantRoad: Road?

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

previousSignificantRoad

abstract val previousSignificantRoad: Road?

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

routeOffset

abstract val routeOffset: Distance

Distance from the start of the route to the instruction point.

routePath

abstract val routePath: List<InstructionPoint>

A List of InstructionPoints that represents a route path.

sideStreetOffset

abstract val sideStreetOffset: Distance?

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

signpost

abstract val signpost: Signpost?

Signpost information, if present for this instruction.

trafficLightOffset

abstract val trafficLightOffset: Distance?

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

Inheritors

ArrivalInstruction

EnterAutoTransportInstruction

ExitAutoTransportInstruction

BorderCrossingInstruction

EnterCarpoolLaneInstruction

ExitCarpoolLaneInstruction

DepartureInstruction

FollowInstruction

ForkInstruction

ExitHighwayInstruction

SwitchHighwayInstruction

MandatoryTurnInstruction

MergeInstruction

ExitRoundaboutInstruction

RoundaboutInstruction

TollgateInstruction

TurnInstruction

TurnAroundWhenPossibleInstruction

WaypointInstruction

Extensions

routeEndOffset

fun Instruction.routeEndOffset(): Distance