Maps SDK for Android/com.magiclane.sdk.places/LandmarkStore

LandmarkStore

class LandmarkStore(address: Long) : GemNativeObj

Landmark store object.

Constructors

LandmarkStore

constructor(address: Long)

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.

Functions

addCategory

external fun addCategory(value: LandmarkCategory): Int

Adds a new category to the store. After this method call, the category object that is passed as a parameter belongs to this landmark store. The category must have a name.

addLandmark

external fun addLandmark(value: Landmark, categoryId: Int = UncategorizedLandmarkCategId): Int

Add a landmark to the specified category in the landmark store.

cancelImportLandmarks

external fun cancelImportLandmarks()

Cancel async import landmarks operation

createLandmarkBrowseSession

external fun createLandmarkBrowseSession(settings: LandmarkBrowseSessionSettings = LandmarkBrowseSessionSettings()): LandmarkBrowseSession?

Creates a landmarks browse session for the specified settings.

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

getCategories

external fun getCategories(landmarkId: Int): ArrayList<LandmarkCategory>?

Gets the list of categories for the specified landmark.

getCategoryById

external fun getCategoryById(categoryId: Int): LandmarkCategory?

Gets the category by ID.

getLandmark

external fun getLandmark(landmarkId: Int): Landmark?

Gets the specified landmark.

getLandmarkCount

external fun getLandmarkCount(categoryId: Int = InvalidLandmarkCategId): Int

getLandmarks

external fun getLandmarks(categoryId: Int = InvalidLandmarkCategId): LandmarkList?

Get the landmarks within the specified category.

getLandmarksByArea

external fun getLandmarksByArea(area: GeographicArea, categoryId: Int = InvalidLandmarkCategId): LandmarkList?

Get the landmarks within the specified area.

importLandmarks

fun importLandmarks(path: String, format: ELandmarkFileFormat, image: Image, listener: ProgressListener): Int

Async import landmarks from given file format.

importLandmarksBuffer

fun importLandmarksBuffer(buffer: DataBuffer, format: ELandmarkFileFormat, image: Image, listener: ProgressListener): Int

Async import landmarks from given buffer format

isFastUpdateMode

external fun isFastUpdateMode(): Boolean

Get fast update mode state

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:

removeAllLandmarks

external fun removeAllLandmarks(): Int

Remove all landmarks from store.

removeCategory

external fun removeCategory(categoryId: Int, removeLmkContent: Boolean = false): Int

Remove the specified category.

removeLandmark

external fun removeLandmark(landmarkId: Int): Int

Removes the specified landmark.

setLandmarkCategory

external fun setLandmarkCategory(landmark: Landmark, categoryId: Int): Int

Set landmark category id

startFastUpdateMode

external fun startFastUpdateMode()

Start landmark store fast update mode

stopFastUpdateMode

external fun stopFastUpdateMode(discard: Boolean = false)

Stop landmark store fast update mode

updateCategory

external fun updateCategory(value: LandmarkCategory): Int

Update the specified category. The category object must belong to this landmark store. No fields of the parameter will be updated by this call.

updateLandmark

external fun updateLandmark(value: Landmark): Int

Update the information about a landmark.