common:route/com.tomtom.sdk.common.route.instruction.waypoint/WaypointInstruction

WaypointInstruction

data class WaypointInstruction( val id: UniqueId = UniqueId(), val routeOffset: Distance, val travelTime: Duration, val maneuverPoint: GeoCoordinate, val drivingSide: DrivingSide, val isPossibleToCombineWithNext: Boolean, val announcements: List<Announcement> = emptyList(), val previousSignificantRoad: RoadInformation? = null, val nextSignificantRoad: RoadInformation? = null, val routePath: List<RouteCoordinate> = emptyList(), val intersectionName: TextWithPhonetics? = null, val signpost: Signpost? = null, val landmark: Landmark? = null, val startPointIndex: Int = 0, val sideStreetOffset: Distance? = null, val trafficLightOffset: Distance? = null, val waypointSide: ItineraryPointSide = ItineraryPointSide.UNDETERMINED) : Instruction

Instruction indicating that a waypoint on the route is reached.

Important: This is a Public Preview API. It may be changed or removed at any time.

See also

com.tomtom.sdk.common.route.instruction.Instruction

Parameters

waypointSide

indicates the side of the road of the waypoint.

Constructors

WaypointInstruction

fun WaypointInstruction( id: UniqueId = UniqueId(), routeOffset: Distance, travelTime: Duration, maneuverPoint: GeoCoordinate, drivingSide: DrivingSide, isPossibleToCombineWithNext: Boolean, announcements: List<Announcement> = emptyList(), previousSignificantRoad: RoadInformation? = null, nextSignificantRoad: RoadInformation? = null, routePath: List<RouteCoordinate> = emptyList(), intersectionName: TextWithPhonetics? = null, signpost: Signpost? = null, landmark: Landmark? = null, startPointIndex: Int = 0, sideStreetOffset: Distance? = null, trafficLightOffset: Distance? = null, waypointSide: ItineraryPointSide = ItineraryPointSide.UNDETERMINED)

Properties

open override val announcements: List<Announcement>

Fine-grained Announcements for the Instruction.

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.

isPossibleToCombineWithNext

open override val isPossibleToCombineWithNext: Boolean

Indicates if the instruction can be combined with the next one. This can be used to build messages like "Turn left and then turn right".

open override val landmark: Landmark? = null

Landmark information, if present in this instruction.

open override val maneuverPoint: GeoCoordinate

Location of the maneuver expressed as a GeoCoordinate.

nextSignificantRoad

open override val nextSignificantRoad: RoadInformation? = 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: RoadInformation? = 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<RouteCoordinate>

A List of RouteCoordinates 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.

startPointIndex

open override val startPointIndex: Int = 0

Index of the first point of the maneuver.

trafficLightOffset

open override val trafficLightOffset: Distance? = null

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

open override val travelTime: Duration

Estimated travel time to the point at routeOffset.

val waypointSide: ItineraryPointSide