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

ViewModelInstance

Represents an instantiated set of properties on a ViewModel. With this class you have access to the individual properties to get and set values from bindings.

Before the property modifications have any effect, you need to assign the instance to an artboard with Artboard.viewModelInstance.

Instances can be created from one File and applied to another. See transfer for more information.

Parameters

unsafeCppPointer

Pointer to the C++ counterpart.

fileLock

Lock shared by the File and native graph this instance belongs to. Updated through updateFileLock when assigned to another native graph.

Types

Transfer

class Transfer

Wrapper type for transferring a view model instance between Files.

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

Get the name of the view model instance.

refCount

open val refCount: Int

refs

override var refs: AtomicInteger

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 override fun cppDelete(pointer: Long)

getArtboardProperty

fun getArtboardProperty(path: String): ViewModelArtboardProperty

getBooleanProperty

fun getBooleanProperty(path: String): ViewModelBooleanProperty

Get a named boolean property.

getColorProperty

fun getColorProperty(path: String): ViewModelColorProperty

Get a named color property.

getEnumProperty

fun getEnumProperty(path: String): ViewModelEnumProperty

Get a named enum property.

getImageProperty

fun getImageProperty(path: String): ViewModelImageProperty

Get a named image property.

getInstanceProperty

fun getInstanceProperty(path: String): ViewModelInstance

Get a nested, named ViewModelInstance.

getListProperty

fun getListProperty(path: String): ViewModelListProperty

Get a named list property.

getNumberProperty

fun getNumberProperty(path: String): ViewModelNumberProperty

Get a named number property.

getStringProperty

fun getStringProperty(path: String): ViewModelStringProperty

Get a named string property.

getTriggerProperty

fun getTriggerProperty(path: String): ViewModelTriggerProperty

Get a named trigger property.

release

open override fun release(): Int

Release this instance while holding the current file lock.

setInstanceProperty

fun setInstanceProperty(path: String, instance: ViewModelInstance)

Set a nested, named ViewModelInstance.

transfer

fun transfer(): ViewModelInstance.Transfer

Start a transfer of this ViewModelInstance to another File. This is necessary because normally the C++ lifetime of the instance is managed by the File it belongs to. When transferring, the instance needs to survive the possible deletion of its owning File.