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

SignpostImage

class SignpostImage(address: Long, isRef: Boolean) : Image

Signpost image object

Constructors

SignpostImage

constructor(address: Long, isRef: Boolean)

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.

aspectRatio

val aspectRatio: SizeF?

Icon aspect ratio as pair of width_aspect( 0, 1.f ), height_aspect( 0, 1.f )

size

val size: Size?

Preferred size of the Image. This can be used to preserve the aspect ratio when requesting different sizes.

type

val type: Int

Type of the image. See EImageFileFormat

uid

val uid: Long

Unique ID of the instance

Functions

asBitmap

open override fun asBitmap(width: Int, height: Int): Bitmap?

Converts SignpostImage as an Bitmap.

assign

open external fun assign(value: Image)

Assign from existing Image

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

isEqualTo

open external fun isEqualTo(value: Image): Boolean

Tests for equality

isReference

fun isReference(): Boolean

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

isValid

open external fun isValid(): Boolean

Checks if the Image is valid or not.

not

operator fun not(): Boolean

Checks if this object is valid.

release

fun release()

Releases the native referenced value of this object if:

render

open external fun render(bitmap: IBitmap): Int

Render the Image into the provided IBitmap.

external fun render(bitmap: IAdjustableBitmap, settings: SignpostImageRenderSettings? = null, blend: Boolean = true): Int

Render the specified SignpostImage into the provided IAdjustableBitmap.