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

ViewModelArtboardProperty

class ViewModelArtboardProperty(unsafeCppPointer: Long, fileLock: ReentrantLock) : ViewModelProperty<Unit>

An artboard property of a ViewModelInstance.

Unlike other property types, this property can only be set. It cannot be read or observed. It's value and valueFlow are not applicable and will always return Unit.

Parameters

unsafeCppPointer

Pointer to the C++ counterpart.

fileLock

Lock shared by the File and native graph this property mutates. Updated through ViewModelProperty.updateFileLock when assigned to another native graph.

Constructors

ViewModelArtboardProperty

constructor(unsafeCppPointer: Long, fileLock: ReentrantLock)

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 property.

open val refCount: Int

override var refs: AtomicInteger

var value: Unit

The current value of the property, whether set by this property or by a data binding update.

val valueFlow: StateFlow<Unit>

A flow of the property's value. Use for observing changes.

Functions

open override fun acquire(): Int

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

open fun cppDelete(pointer: Long)

@VisibleForTesting(otherwise = 2)

external fun cppHasChanged(cppPointer: Long): Boolean

external fun cppName(cppPointer: Long): String

open override fun release(): Int

Release this property while holding the current file lock.

fun ~~set~~(artboard: Artboard)

Set the artboard for this property.

fun set(bindableArtboard: BindableArtboard?)

Set the bindable artboard for this property.