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

Package-level declarations

Types

Link copied to clipboard
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.

Link copied to clipboard
class BorderCrossing(val fromCountry: Country, val toCountry: Country)

Indicates a border crossing between two countries.

Link copied to clipboard
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.

Link copied to clipboard
class Country(val code: String, val name: String)

Country information.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
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.

Link copied to clipboard
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.

Link copied to clipboard
interface GuidanceInstruction

Interface for a Guidance Instruction, which provides information to the user about the next action to take on the route. This interface contains a set of attributes common to all GuidanceInstructions, e.g., 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
class Road(val name: String, val numbers: List<String>, val shields: List<RoadShield>, val types: Set<RoadType> = emptySet())

Road information relating to a GuidanceInstruction.

Link copied to clipboard
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.

Link copied to clipboard
class Signpost(val exitNumber: String = "", val exitName: String = "", val towardName: String = "")

Signpost information for a GuidanceInstruction.

Link copied to clipboard
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.

Link copied to clipboard
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.

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.

Link copied to clipboard
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.

Link copied to clipboard
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.