com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route.instruction.turn/TurnInstruction

TurnInstruction

class TurnInstruction(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 at a road junction.

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.

routeOffset

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

maneuverPoint

Location of the maneuver expressed as a GeoPoint.

drivingSide

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

combineWithNext

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

announcements

Fine-grained Announcements for the Instruction.

previousSignificantRoad

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

nextSignificantRoad

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

routePath

A List of InstructionPoints that represents a route path.

intersectionName

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

signpost

Signpost information, if present for this instruction.

landmark

Landmark information, if present in this instruction.

sideStreetOffset

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

trafficLightOffset

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

The ID of the instruction.

Constructors

TurnInstruction

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

announcements

open override val ~~announcements~~: List<Announcement>

combineWithNext

open override val ~~combineWithNext~~: Boolean

drivingSide

open override val drivingSide: DrivingSide

open override val id: UniqueId

intersectionName

open override val intersectionName: TextWithPhonetics? = null

landmark

open override val landmark: Landmark? = null

maneuverPoint

open override val maneuverPoint: GeoPoint

nextSignificantRoad

open override val nextSignificantRoad: Road? = null

previousSignificantRoad

open override val previousSignificantRoad: Road? = null

routeOffset

open override val routeOffset: Distance

routePath

open override val routePath: List<InstructionPoint>

sideStreetOffset

open override val sideStreetOffset: Distance? = null

signpost

open override val signpost: Signpost? = null

trafficLightOffset

open override val trafficLightOffset: Distance? = null

turnAngle

val turnAngle: Angle

turnDirection

val turnDirection: TurnDirection

Functions

component1

operator fun ~~component1~~(): Angle

component10

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

component11

operator fun ~~component11~~(): TextWithPhonetics?

component12

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

component13

operator fun ~~component13~~(): Landmark?

component14

operator fun ~~component14~~(): Distance?

component15

operator fun ~~component15~~(): Distance?

component16

operator fun ~~component16~~(): UniqueId

component2

operator fun ~~component2~~(): TurnDirection

component3

operator fun ~~component3~~(): Distance

component4

operator fun ~~component4~~(): GeoPoint

component5

operator fun ~~component5~~(): DrivingSide

component6

operator fun ~~component6~~(): Boolean

component7

operator fun ~~component7~~(): List<Announcement>

component8

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

component9

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

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

TurnInstruction

Parameters

See also

Constructors

Properties

Functions