RoutePlan

open class RoutePlan : BaseNativeParcelable

RoutePlan contains all information needed to calculate a route. It contains start, destination and waypoints.

Constructors

RoutePlan

open fun RoutePlan()

Default constructor.

Functions

addViaPoint

open fun addViaPoint(viaPoint: GeoCoordinates)

Adds a waypoint location to the route plan.

open fun addViaPoint(waypoint: Waypoint)

Adds a waypoint location to the route plan.

open fun addViaPoint(viaPoint: GeoCoordinates, @Nullable() customName: String)

Adds a waypoint location to the route plan.

describeContents

abstract fun describeContents(): Int

open fun describeContents(): Int

For documentation, see android.os.Parcelable.

getDestination

open fun getDestination(): Waypoint

getRoutingOptions

open fun getRoutingOptions(): RoutingOptions

Returns the wanted RoutingOptions.

getStart

open fun getStart(): Waypoint

Returns the GeoCoordinates of starting position.

getViaPoints

open fun getViaPoints(): List<Waypoint>

Returns all the waypoints on the route.

isValidParcelable

open fun isValidParcelable(): Boolean

If object after recreate from parcel contains all of reference like original object method returntrue.

setDestination

open fun setDestination(destination: GeoCoordinates)

Sets a destination location for calculating a route.

open fun setDestination(waypoint: Waypoint)

Sets a destination location for calculating a route.

open fun setDestination(destination: GeoCoordinates, @Nullable() customName: String)

Sets a destination location for calculating a route.

setRoutingOptions

open fun setRoutingOptions(options: RoutingOptions)

Sets the route options.

setStart

open fun setStart(start: GeoCoordinates)

Sets a start location for calculating a route.

open fun setStart(waypoint: Waypoint)

Sets a start location for calculating a route.

open fun setStart(start: GeoCoordinates, @Nullable() customName: String)

Sets a start location for calculating a route.

writeToParcel

abstract fun writeToParcel(p: Parcel, p1: Int)

open fun writeToParcel(dest: Parcel, flags: Int)

For documentation, see android.os.Parcelable.

Properties

CREATOR

val CREATOR: Parcelable.Creator<RoutePlan>