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

Package-level declarations

Types

data class ArrivalGuidanceInstruction( val arrivalSide: ItineraryPointRelativePosition, 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 arrival at the destination.

BorderCrossing

data class BorderCrossing(val fromCountry: Country, val toCountry: Country)

Indicates a border crossing between two countries.

BorderCrossingGuidanceInstruction

data class BorderCrossingGuidanceInstruction( val borderCrossing: BorderCrossing, 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 that a border between two countries will be crossed.

Country

data class Country(val code: String, val name: String)

Country information.

DepartureGuidanceInstruction

data class DepartureGuidanceInstruction( 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 departure from the origin.

EnterAutoTransportGuidanceInstruction

data class EnterAutoTransportGuidanceInstruction( val autoTransportType: AutoTransportType, val borderCrossing: BorderCrossing?, 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 entering a vehicle transportation service through a terminal.

EnterCarpoolLaneGuidanceInstruction

data class EnterCarpoolLaneGuidanceInstruction( val carpoolLaneDirection: CarpoolLaneDirection, 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 entering a carpool lane by changing lanes.

ExitAutoTransportGuidanceInstruction

data class ExitAutoTransportGuidanceInstruction( val autoTransportType: AutoTransportType, val borderCrossing: BorderCrossing?, 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 exiting a vehicle transportation service through a terminal.

ExitCarpoolLaneGuidanceInstruction

data class ExitCarpoolLaneGuidanceInstruction( val carpoolLaneDirection: CarpoolLaneDirection, 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 exiting a carpool lane by changing lanes.

ExitHighwayGuidanceInstruction

data class ExitHighwayGuidanceInstruction( val exitDirection: ExitDirection, 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 taking a highway exit.

ExitRoundaboutGuidanceInstruction

data class ExitRoundaboutGuidanceInstruction( val turnAngle: Angle, val exitNumber: Int?, val roundaboutDirection: RoundaboutDirection, val quantizedTurnAngle: QuantizedTurnAngle?, 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 an exit from a roundabout.

FollowGuidanceInstruction

data class ~~FollowGuidanceInstruction~~( 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 that the current road should be followed for some distance.

ForkGuidanceInstruction

data class ForkGuidanceInstruction( val forkDirection: ForkDirection, 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 an upcoming fork in the road.

MandatoryTurnGuidanceInstruction

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

MergeGuidanceInstruction

data class MergeGuidanceInstruction( val mergeSide: MergeSide?, 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 merge onto another road.

RoundaboutGuidanceInstruction

data class RoundaboutGuidanceInstruction( val turnAngle: Angle, val exitNumber: Int?, val roundaboutDirection: RoundaboutDirection, val quantizedTurnAngle: QuantizedTurnAngle?, 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 an upcoming roundabout.

SwitchHighwayGuidanceInstruction

data class SwitchHighwayGuidanceInstruction( val exitDirection: ExitDirection, 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 changing highways by following an exit ramp.

TollgateGuidanceInstruction

data class TollgateGuidanceInstruction( val tollgateName: String, val paymentTypes: Set<TollgatePaymentType>, 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 an upcoming tollgate.

TurnAroundWhenPossibleGuidanceInstruction

data class TurnAroundWhenPossibleGuidanceInstruction( 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 the driver should turn around when it is possible.

TurnGuidanceInstruction

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

WaypointGuidanceInstruction

data class WaypointGuidanceInstruction( val waypointSide: ItineraryPointRelativePosition, 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 that a waypoint on the route is reached.