VMERouteRequest

class VMERouteRequest(var requestType: VMERouteRequestType, var routeDestinationOrder: VMERouteDestinationsOrder, var isAccessible: Boolean = false, var animateAllRoute: Boolean = false, var distanceThreshold: Double = -1.0, var doNotComputeNavigation: Boolean = false)(source)

Represents an instance of route request

Since

1.19

Parameters

requestType

Determines the type of request

routeDestinationOrder

Determines the visiting order of the destination objects

Notes

By default:

  • VMERouteRequest.isAccessible() will return false.

Constructors

Link copied to clipboard
constructor(requestType: VMERouteRequestType, routeDestinationOrder: VMERouteDestinationsOrder, isAccessible: Boolean = false, animateAllRoute: Boolean = false, distanceThreshold: Double = -1.0, doNotComputeNavigation: Boolean = false)

Properties

Link copied to clipboard

If we want to animate all the route

Link copied to clipboard

distanceThreshold is used to force a max distance between position given and nearest node if specified, the routing will take this value to search for nearest nodes within this range if not specified, there will be not distance limit to search for a node

Link copied to clipboard

doNotComputeNavigation is used to optimise routing, avoid compute navigation

Link copied to clipboard

Requests that the computed route is accessible.

Link copied to clipboard

Ordered array of String objects, where each object must correspond to a poi Id

Link copied to clipboard
var origin: Any?

The poi id or location representing the origin of the route.

Link copied to clipboard

The desired route request type.

Link copied to clipboard

Sets the route destination order.

Functions

Link copied to clipboard

Adds a position object to the end of the destinations array’s content.

Adds a destination to the request.

Link copied to clipboard
fun addDestinations(destinations: Collection<Any>)

Adds the objects contained in the given array to the end of the destinations array’s content.

Link copied to clipboard

Remove all destinations objects from the destination array.

Link copied to clipboard

Remove destination object at the given index

Link copied to clipboard
fun replaceDestination(index: Int, destination: Any)

Repois the destination object at the given index with the given destination.

Link copied to clipboard
fun setOrigin(position: VMEPosition?)

The position representing the origin of the route.

fun setOrigin(poiID: String?)

The poi id representing the origin of the route.