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

ViewModelProperty

abstract class ViewModelProperty<T>(unsafeCppPointer: Long, fileLock: ReentrantLock) : NativeObject

A property of type T of a ViewModelInstance. Use value to mutate the property. use valueFlow to subscribe to changes on the value.

Parameters

unsafeCppPointer

Pointer to the C++ counterpart.

fileLock

Lock shared by the File and native graph this property mutates. Subclasses use it to synchronize native access and to migrate dependent wrappers in updateFileLock. Writes should be limited to updateFileLock implementations.

Inheritors

ViewModelNumberProperty

ViewModelStringProperty

ViewModelBooleanProperty

ViewModelColorProperty

ViewModelEnumProperty

ViewModelTriggerProperty

ViewModelImageProperty

ViewModelListProperty

ViewModelArtboardProperty

Constructors

ViewModelProperty

constructor(unsafeCppPointer: Long, fileLock: ReentrantLock)

Properties

cppPointer

var cppPointer: Long

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

dependencies

val dependencies: MutableList<RefCount>

hasCppObject

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

name

val name: String

The name of the property.

refCount

open val refCount: Int

refs

override var refs: AtomicInteger

value

var value: T

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

valueFlow

val valueFlow: StateFlow<T>

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

Functions

acquire

@Synchronized

open override fun acquire(): Int

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

cppDelete

open fun cppDelete(pointer: Long)

cppHasChanged

@VisibleForTesting(otherwise = 2)

external fun cppHasChanged(cppPointer: Long): Boolean

cppName

external fun cppName(cppPointer: Long): String

release

open override fun release(): Int

Release this property while holding the current file lock.