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

OverlayService

class OverlayService : GemNativeObj

MarkerOverlaysService object. This behaves like a singleton, i.e. all instances are sharing behind the same API interface

Constructors

Link copied to clipboard
constructor()

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.

Functions

Link copied to clipboard
external fun disableOverlay(uid: Int, categoryId: Int = -1): Int

Disables the overlay with the given uid. This will deactivate the overlay for all registered services ( map views, alarms, etc )

Link copied to clipboard
external fun disableOverlayOfflineDataGrabber(uid: Int): Int

Disables the offline data grabber for the overlay with the given uid

Link copied to clipboard
external fun enableOverlay(uid: Int, categoryId: Int = -1): Int

Enables the overlay with the given uid. This will activate the overlay for all registered services ( map views, alarms, etc )

Link copied to clipboard
external fun enableOverlayOfflineDataGrabber(uid: Int): Int

Enables the offline data grabber for the overlay with the given uid

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
external fun getAvailableOverlays(listener: ProgressListener? = null): Pair<ArrayList<OverlayInfo>?, Boolean>?
fun getAvailableOverlays(onCompleted: OnCompleted): Pair<ArrayList<OverlayInfo>?, Boolean>?

Get list of SDK available overlays

Link copied to clipboard
fun getOverlayById(id: ECommonOverlayId, onCompleted: OnCompleted? = null): Pair<OverlayInfo?, Boolean>

Get list of SDK available overlays

Link copied to clipboard
fun getOverlaysById(ids: ArrayList<ECommonOverlayId>, onCompleted: OnCompleted? = null): Pair<ArrayList<OverlayInfo>, Boolean>

Get list of SDK available overlays

Link copied to clipboard
external fun isOverlayEnabled(uid: Int, categoryId: Int = -1): Boolean

Check if the overlay with the given uid is enabled.

Link copied to clipboard
external fun isOverlayOfflineDataGrabberEnabled(uid: Int): Boolean

Check if the offline data grabber for the given overlay uid is enabled

Link copied to clipboard
external fun isOverlayOfflineDataGrabberSupported(uid: Int): Boolean

Check if the offline data grabber for the given overlay uid is supported

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: