navigation:navigation-engines/com.tomtom.sdk.navigation.guidance.instruction/GuidanceInstruction

GuidanceInstruction

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

Properties

Link copied to clipboard
abstract val combineWithNext: Boolean

Indicates if the instruction should be combined with the next one.

Link copied to clipboard
abstract val drivingSide: DrivingSide

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

Link copied to clipboard
abstract val id: UniqueId

The ID of the instruction.

Link copied to clipboard
abstract val intersectionName: String

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

Link copied to clipboard
abstract val maneuverPoint: GeoPoint

Location of the maneuver expressed as a GeoPoint.

Link copied to clipboard
abstract val nextSignificantRoad: Road?

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

Link copied to clipboard
abstract val previousSignificantRoad: Road?

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

Link copied to clipboard
abstract val routeOffset: Distance

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

Link copied to clipboard
abstract val routePath: List<InstructionPoint>

A List of RoutePoints that represents a route path.

Link copied to clipboard
abstract val signpost: Signpost?

Signpost information, if present for this instruction.