Instruction

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

Inheritors

Properties

Link copied to clipboard

Fine-grained Announcements for the Instruction.

Link copied to clipboard
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".

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

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

Link copied to clipboard
abstract val landmark: Landmark?

Landmark information, if present in 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

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

A List of InstructionPoints that represents a route path.

Link copied to clipboard
abstract val sideStreetOffset: Distance?

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

Link copied to clipboard
abstract val signpost: Signpost?

Signpost information, if present for this instruction.

Link copied to clipboard

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

Inherited functions

Link copied to clipboard

Returns the offset along the route where the maneuver for the instruction ends.