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

MandatoryTurnGuidanceInstruction

class MandatoryTurnGuidanceInstruction(val turnAngle: Angle, val turnDirection: TurnDirection, val id: UniqueId, val routeOffset: Distance, val maneuverPoint: GeoPoint, val drivingSide: DrivingSide, val combineWithNext: Boolean, val previousSignificantRoad: Road? = null, val nextSignificantRoad: Road? = null, val routePath: List<InstructionPoint> = emptyList(), val intersectionName: String = "", val signpost: Signpost? = null) : GuidanceInstruction

Guidance Instruction indicating a turn which is legally required.

Throws

IllegalArgumentException

if turnAngle is not within the range of -180, 180.

Constructors

MandatoryTurnGuidanceInstruction

constructor(turnAngle: Angle, turnDirection: TurnDirection, id: UniqueId, routeOffset: Distance, maneuverPoint: GeoPoint, drivingSide: DrivingSide, combineWithNext: Boolean, previousSignificantRoad: Road? = null, nextSignificantRoad: Road? = null, routePath: List<InstructionPoint> = emptyList(), intersectionName: String = "", signpost: Signpost? = null)

Properties

combineWithNext

open override val combineWithNext: Boolean

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

drivingSide

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.

maneuverPoint

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.

routeOffset

open override val routeOffset: Distance

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

routePath

open override val routePath: List<InstructionPoint>

A List of RoutePoints that represents a route path.

signpost

open override val signpost: Signpost? = null

Signpost information, if present for this instruction.

turnAngle

val turnAngle: Angle

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

turnDirection

val turnDirection: TurnDirection

Classification of the relative angle of the turn.

Functions

component1

operator fun ~~component1~~(): Angle

component10

operator fun ~~component10~~(): List<InstructionPoint>

component11

operator fun ~~component11~~(): String

component12

operator fun ~~component12~~(): Signpost?

component2

operator fun ~~component2~~(): TurnDirection

component3

operator fun ~~component3~~(): UniqueId

component4

operator fun ~~component4~~(): Distance

component5

operator fun ~~component5~~(): GeoPoint

component6

operator fun ~~component6~~(): DrivingSide

component7

operator fun ~~component7~~(): Boolean

component8

operator fun ~~component8~~(): Road?

component9

operator fun ~~component9~~(): Road?

copy

fun ~~copy~~(turnAngle: Angle = this.turnAngle, turnDirection: TurnDirection = this.turnDirection, id: UniqueId = this.id, routeOffset: Distance = this.routeOffset, maneuverPoint: GeoPoint = this.maneuverPoint, drivingSide: DrivingSide = this.drivingSide, combineWithNext: Boolean = this.combineWithNext, previousSignificantRoad: Road? = this.previousSignificantRoad, nextSignificantRoad: Road? = this.nextSignificantRoad, routePath: List<InstructionPoint> = this.routePath, intersectionName: String = this.intersectionName, signpost: Signpost? = this.signpost): MandatoryTurnGuidanceInstruction

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String