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

MandatoryTurnGuidanceInstruction

data class MandatoryTurnGuidanceInstruction(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 turnAngle: Angle, val turnDirection: TurnDirection) : GuidanceInstruction

Guidance Instruction indicating a turn which is legally required.

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

See also

GuidanceInstruction

Parameters

turnAngle

Turn angle relative to the driving direction on the route. Expressed in the range -180...180 degrees.

turnDirection

Classification of the relative angle of the turn.

Constructors

MandatoryTurnGuidanceInstruction

fun MandatoryTurnGuidanceInstruction(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, turnAngle: Angle, turnDirection: TurnDirection)

Properties

combineWithNext

open override val combineWithNext: Boolean

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

open override val drivingSide: DrivingSide

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

open override val id: UniqueId

The ID of the instruction.

intersectionName

open override val intersectionName: String

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

open override val maneuverPoint: GeoPoint

Location of the maneuver expressed as a GeoPoint.

nextSignificantRoad

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.

previousSignificantRoad

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.

open override val routeOffset: Distance

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

open override val routePath: List<RouteCoordinate>

A List of RouteCoordinates that represents a route path.

open override val signpost: Signpost? = null

Signpost information, if present for this instruction.

open override val travelTime: Duration

Estimated travel time to the point at routeOffset.

val turnAngle: Angle

val turnDirection: TurnDirection