Rive Android/app.rive.runtime.kotlin.core/BindableArtboard

BindableArtboard

class BindableArtboard(unsafeCppPointer: Long, val viewModelInstance: ViewModelInstance? = null) : NativeObject

A BindableArtboard is an artboard reference that can be assigned to a ViewModelArtboardProperty. It should only be used for that purpose and cannot be used as a regular Artboard.

Instances of this class are created via File.createBindableArtboardByName or File.createDefaultBindableArtboard.

⚠️Important: This bindable artboard can outlive the File instance that created it, but in order to do so it has an extra reference count. You need to call release when you are done with it, otherwise it will leak memory.

Parameters

unsafeCppPointer

The pointer to the native object.

viewModelInstance

The view model instance to apply to the artboard instance when bound.

Throws

IllegalArgumentException

If the supplied instance has been disposed.

Constructors

BindableArtboard

constructor(unsafeCppPointer: Long, viewModelInstance: ViewModelInstance? = null)

Properties

var cppPointer: Long

Getter/Setter for the underlying C++ pointer value.

val dependencies: MutableList<RefCount>

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

val name: String

The name of the artboard.

open val refCount: Int

override var refs: AtomicInteger

viewModelInstance

val viewModelInstance: ViewModelInstance?

Functions

open override fun acquire(): Int

Increments the references for this counter. Cannot be used for initialization - use refs.incrementAndGet instead.

open external override fun cppDelete(pointer: Long)

external fun cppName(pointer: Long): String

open override fun release(): Int

Decrements the reference counter.