Maps SDK for Android/com.magiclane.sdk.core/Path

Path

class Path : GemNativeObj

Path object

Constructors

Path

constructor()

constructor(address: Long)

constructor(address: Long, isRef: Boolean)

Types

Companion

object Companion

Path's companion object.

Properties

address

val address: Long

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

area

val area: RectangleGeographicArea?

Gets path rectangle

coordinates

val coordinates: CoordinatesList?

Coordinates list.

name

var name: String?

Path name

waypoints

val waypoints: ArrayList<Int>?

Waypoint list

Functions

cloneReverse

external fun cloneReverse(): Path?

Clone reverse order path

cloneStartEnd

external fun cloneStartEnd(start: Coordinates, end: Coordinates): Path?

Clone path from the given coordinate Set start = end to create a circuit track

exportAs

fun exportAs(format: EPathFileFormat): DataBuffer?

Export path coordinates in the requested data format

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

getCoordinatesAtPercent

external fun getCoordinatesAtPercent(coords: CoordinatesList, percent: Double): Coordinates?

Gets a coordinate on path from at the given percent

isReference

fun isReference(): Boolean

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

not

operator fun not(): Boolean

Checks if this object is valid.

release

fun release()

Releases the native referenced value of this object if:

toLandmark

fun toLandmark(): Landmark

Creates a landmark based on this path.