Maps SDK for Android/com.magiclane.sdk.routesandnavigation/MapViewRoutesCollection

MapViewRoutesCollection

class MapViewRoutesCollection : GemNativeObj

Routes collection for MapView preferences

Constructors

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

Properties

Link copied to clipboard
val address: Long

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

Link copied to clipboard
var mainRoute: Route?

Main route in the collection

Link copied to clipboard
val size: Int

Number of routes in this collection.

Functions

Link copied to clipboard
external fun add(route: Route, mainRoute: Boolean)

Adds a route in the collection.

Link copied to clipboard
external fun addMapViewRoute(route: MapViewRoute)

Add or update a map view route in the collection

Link copied to clipboard
external fun addWithAttributes(route: Route, bMainRoute: Boolean, label: String = String(), images: ImageList = ImageList())

Add or update a route in the collection.

Link copied to clipboard
external fun addWithRenderSettings(route: Route, settings: RouteRenderSettings, label: String = String(), images: ImageList = ImageList())

Add or update a route in the collection with the given render settings

Link copied to clipboard
external fun clear()

Removes all routes

Link copied to clipboard
external fun contains(route: Route): Boolean

Check if a route object is in collection

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getImages(route: Route): ImageList

Get route bubble image list

Link copied to clipboard
external fun getLabel(route: Route): String

Get route label text

Link copied to clipboard
external fun getMapViewRoute(route: Route): MapViewRoute?

Get map view route in collection by route

Link copied to clipboard
external fun getMapViewRouteByIndex(index: Int): MapViewRoute?

Get map view route in collection by index

Link copied to clipboard
external fun getMapViewRoutes(): ArrayList<MapViewRoute>?

Get all map view routes.

Link copied to clipboard
external fun getRenderSettings(route: Route): RouteRenderSettings?

Gets the route custom render settings

Link copied to clipboard
external fun getRoute(index: Int): Route?

Get route specified by index.

Link copied to clipboard
external fun hideLabel(route: Route)

Hide route label

Link copied to clipboard
external fun indexOf(route: Route): Int

Get index of the specified route - return < 0 for error

Link copied to clipboard
external fun isMainRoute(route: Route): Boolean

Returns if the route is the main route in the collection

Link copied to clipboard
fun isReference(): Boolean

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 remove(route: Route)

Removes the route specified by index.

Link copied to clipboard
external fun setImages(route: Route, images: ImageList)

Set route bubble images list, see @setLabel for details

Link copied to clipboard
external fun setLabel(route: Route, text: String)

Set route bubble text

Link copied to clipboard
external fun setRenderSettings(route: Route, settings: RouteRenderSettings)

Sets the route custom render settings