navigation:engine/com.tomtom.sdk.navigation.guidance.instruction/GuidanceInstruction

GuidanceInstruction

Interface for a Guidance Instruction. Contains a set of attributes common to all GuidanceInstructions. e.g., 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

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

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

Properties

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: String

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

isPossibleToCombineWithNext

abstract val isPossibleToCombineWithNext: Boolean

Indicates if the instruction can be combined with the next one. This can be used to build messages like "Turn left and then turn right".

junctionType

abstract val junctionType: JunctionType?

Type of junction at which the maneuver takes place, if present for this instruction.

maneuverPoint

abstract val maneuverPoint: GeoCoordinate

Location of the maneuver expressed as a GeoCoordinate.

nextSignificantRoad

abstract val nextSignificantRoad: RoadInformation?

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

previousSignificantRoad

abstract val previousSignificantRoad: RoadInformation?

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<RouteCoordinate>

A List of RouteCoordinates that represents a route path.

signpost

abstract val signpost: Signpost?

Signpost information, if present for this instruction.

travelTime

abstract val travelTime: Duration

Estimated travel time to the point at routeOffset.

Inheritors

ArrivalGuidanceInstruction

BorderCrossingGuidanceInstruction

DepartureGuidanceInstruction

EnterAutoTransportGuidanceInstruction

EnterCarpoolLaneGuidanceInstruction

ExitAutoTransportGuidanceInstruction

ExitCarpoolLaneGuidanceInstruction

ExitHighwayGuidanceInstruction

ExitRoundaboutGuidanceInstruction

FollowGuidanceInstruction

ForkGuidanceInstruction

MandatoryTurnGuidanceInstruction

MergeGuidanceInstruction

RoundaboutGuidanceInstruction

SwitchHighwayGuidanceInstruction

TollgateGuidanceInstruction

TurnAroundWhenPossibleGuidanceInstruction

TurnGuidanceInstruction

WaypointGuidanceInstruction