com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route.instruction.mandatoryturn/MandatoryTurnInstruction

MandatoryTurnInstruction

data class MandatoryTurnInstruction(val turnAngle: Angle, val turnDirection: TurnDirection, val routeOffset: Distance, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val announcements: List<Announcement> = emptyList(), val previousSignificantRoad: Road? = null, val nextSignificantRoad: Road? = null, val routePath: List<InstructionPoint> = emptyList(), val intersectionName: TextWithPhonetics? = null, val signpost: Signpost? = null, val landmark: Landmark? = null, val sideStreetOffset: Distance? = null, val trafficLightOffset: Distance? = null, val id: UniqueId = UniqueId()) : Instruction

Instruction indicating a turn which is legally required.

Parameters

turnAngle

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

turnDirection

Classification of the relative angle of the turn.

See also

Constructors

MandatoryTurnInstruction

constructor(turnAngle: Angle, turnDirection: TurnDirection, routeOffset: Distance, maneuverPoint: GeoPoint, drivingSide: DrivingSide, combineWithNext: Boolean, announcements: List<Announcement> = emptyList(), previousSignificantRoad: Road? = null, nextSignificantRoad: Road? = null, routePath: List<InstructionPoint> = emptyList(), intersectionName: TextWithPhonetics? = null, signpost: Signpost? = null, landmark: Landmark? = null, sideStreetOffset: Distance? = null, trafficLightOffset: Distance? = null, id: UniqueId = UniqueId())

Properties

open override val announcements: List<Announcement>

Fine-grained Announcements for the Instruction.

combineWithNext

open override 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".

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: TextWithPhonetics? = null

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

open override val landmark: Landmark? = null

Landmark information, if present in this instruction.

open override val maneuverPoint: GeoPoint

Location of the maneuver expressed as a GeoPoint.

nextSignificantRoad

open override val nextSignificantRoad: Road? = 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: Road? = 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<InstructionPoint>

A List of InstructionPoints that represents a route path.

sideStreetOffset

open override val sideStreetOffset: Distance? = null

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

open override val signpost: Signpost? = null

Signpost information, if present for this instruction.

trafficLightOffset

open override val trafficLightOffset: Distance? = null

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

val turnAngle: Angle

val turnDirection: TurnDirection

Inherited functions

fun Instruction.routeEndOffset(): Distance