Maps SDK for Android/com.magiclane.sdk.d3scene/OverlayMutableCollection

OverlayMutableCollection

class OverlayMutableCollection(address: Long, isRef: Boolean) : GemNativeObj

OverlayMutableCollection object.

Constructors

Link copied to clipboard
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
val overlays: ArrayList<OverlayInfo>?

Returns a list with all overlays contained by this.

Link copied to clipboard
val size: Int

The number of stores in the list.

Functions

Link copied to clipboard
fun add(info: ArrayList<OverlayInfo>)
external fun add(overlayId: Int)

Add an online overlay to the collection.

Link copied to clipboard
external fun addByCategory(overlayId: Int, categoryId: Int)

Add an online overlay category to the collection.

Link copied to clipboard
external fun contains(overlayId: Int): Boolean

Check if overlay is added to the collection

Link copied to clipboard
external fun containsByCategory(overlayId: Int, categoryId: Int): Boolean

Check if overlay category is added to the collection

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getOverlayAt(index: Int): OverlayInfo?

Get the overlay at the specified index.

Link copied to clipboard
fun getOverlayByUid(overlayUid: ECommonOverlayId): OverlayInfo?
external fun getOverlayByUid(overlayUid: Int): OverlayInfo?

Get the overlay having the specified UID.

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
fun remove(info: ArrayList<OverlayInfo>)
external fun remove(overlayId: Int): Int

Remove the overlay

Link copied to clipboard
external fun removeAt(index: Int): Int

Remove the overlay at the specified index

Link copied to clipboard
external fun removeByCategory(overlayId: Int, categoryId: Int): Int

Remove the overlay category id