VisioMoveEssential/com.visioglobe.visiomoveessential.models/VMERouteRequest

VMERouteRequest

class VMERouteRequest(requestType: VMERouteRequestType, routeDestinationOrder: VMERouteDestinationsOrder, isAccessible: Boolean, animateAllRoute: Boolean, distanceThreshold: Double)

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

VMERouteRequest

fun VMERouteRequest(requestType: VMERouteRequestType, routeDestinationOrder: VMERouteDestinationsOrder, isAccessible: Boolean = false, animateAllRoute: Boolean = false, distanceThreshold: Double = -1.0)

Functions

addDestination

fun addDestination(position: VMEPosition)

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

fun addDestination(poiID: String)

Adds a destination to the request.

addDestinations

fun addDestinations(destinations: Collection<Any>)

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

removeAllDestinations

fun removeAllDestinations()

Remove all destinations objects from the destination array.

removeDestinationAtIndex

fun removeDestinationAtIndex(index: Int)

Remove destination object at the given index

replaceDestination

fun replaceDestination(index: Int, destination: Any)

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

setOrigin

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.

Properties

animateAllRoute

var animateAllRoute: Boolean = false

If we want to animate all the route

distanceThreshold

val distanceThreshold: Double

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

isAccessible

var isAccessible: Boolean = false

Requests that the computed route is accessible.

mDestinations

val mDestinations: <ERROR CLASS><Any>

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

origin

var origin: Any? = null

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

requestType

var requestType: VMERouteRequestType

The desired route request type.

routeDestinationOrder

var routeDestinationOrder: VMERouteDestinationsOrder

Sets the route destination order.