Route

Route object

Constructors

Link copied to clipboard
constructor()
constructor(address: Long)
constructor(address: Long, isRef: Boolean)

Properties

Link copied to clipboard

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

Link copied to clipboard

Dominant road names

Link copied to clipboard

Geographic area of the route. The geographic area is the smallest rectangle that can be drawn around the route.

Link copied to clipboard

All RouteInstructions contained by this Route.

Link copied to clipboard

Polygon area of the route

Link copied to clipboard

Route preferences

Link copied to clipboard

Route related events listener.

Link copied to clipboard

Route segments.

Link copied to clipboard

Route status

Link copied to clipboard

Summary of the route segment.

Link copied to clipboard

Route terrain profile

Link copied to clipboard

Tiles collection area of the route

Link copied to clipboard

Length in meters and estimated travel time in seconds for the route / route segment

Link copied to clipboard

List of traffic events affecting the route.

Link copied to clipboard

List of waypoints. The waypoints are ordered like: departure, first waypoint, ..., destination. Only the route can have intermediate waypoints. The segments have only departure and destination.

Functions

Link copied to clipboard
external fun equalsTo(value: Route?): Boolean

Returns true if the routes are identical

Link copied to clipboard
external fun exportAs(format: Int): DataBuffer?

Export route data in the requested data format

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getClosestSegment(coordinates: Coordinates): Int

Get index of the closest route segment to the given coordinates

Link copied to clipboard
external fun getCoordinateOnRoute(distance: Int): Coordinates?

Get a coordinate on route at the given distance

Link copied to clipboard
external fun getDistanceOnRoute(coordinates: Coordinates, activePart: Boolean): Int

Get route distance from departure at the given coordinate

Link copied to clipboard
external fun getPath(start: Int, end: Int): Path?

Build path from route start - end segment

Link copied to clipboard
external fun getTimeDistance(activePart: Boolean): TimeDistance?

Get length in meters and estimated travel time in seconds for the route

Link copied to clipboard
external fun getTimeDistanceCoordinates(start: Int, end: Int, step: Int, stepType: Boolean): TimeDistanceCoordinateList?

Build a list of timestamp coordinates from a route

Link copied to clipboard

Returns true is the route contains ferry connections

Link copied to clipboard
external fun hasIncursCosts(): Boolean

Method to check if traveling the route or route segment incurs cost to the user.

Link copied to clipboard
external fun hasTollRoads(): Boolean

Returns true is route contains toll roads

Link copied to clipboard
external fun isPTRoute(): Boolean

Returns true if the route is a PT route

Link copied to clipboard

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
external fun toPTRoute(): PTRoute?

Convert to a PTRoute from this one