ForkGuidanceInstruction

data class ForkGuidanceInstruction(val id: UniqueId, val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null, val forkDirection: ForkDirection) : GuidanceInstruction

Guidance Instruction indicating an upcoming fork in the road.

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

See also

Parameters

forkDirection

Indicates the direction to follow at the fork.

Constructors

Link copied to clipboard
fun ForkGuidanceInstruction(id: UniqueId, routeOffset: Distance, travelTime: Duration, maneuverPoint: GeoPoint, drivingSide: DrivingSide, combineWithNext: Boolean, previousSignificantRoad: RoadInformation? = null, nextSignificantRoad: RoadInformation? = null, routePath: List<RouteCoordinate> = emptyList(), intersectionName: String = "", signpost: Signpost? = null, forkDirection: ForkDirection)

Properties

Link copied to clipboard
open override val combineWithNext: Boolean

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

Link copied to clipboard
open override val drivingSide: DrivingSide

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

Link copied to clipboard
Link copied to clipboard
open override val id: UniqueId

The ID of the instruction.

Link copied to clipboard
open override val intersectionName: String

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

Link copied to clipboard
open override val maneuverPoint: GeoPoint

Location of the maneuver expressed as a GeoPoint.

Link copied to clipboard
open override val nextSignificantRoad: RoadInformation? = null

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

Link copied to clipboard
open override val previousSignificantRoad: RoadInformation? = null

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

Link copied to clipboard
open override val routeOffset: Distance

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

Link copied to clipboard
open override val routePath: List<RouteCoordinate>

A List of RouteCoordinates that represents a route path.

Link copied to clipboard
open override val signpost: Signpost? = null

Signpost information, if present for this instruction.

Link copied to clipboard
open override val travelTime: Duration

Estimated travel time to the point at routeOffset.