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

ViewModel

@OpenForTesting

class ViewModel : NativeObject

A description of a ViewModel in the Rive file. It can be used to retrieve property definitions at runtime. However, properties cannot be modified - that requires an instance. Use one of the createInstance methods to create an instance with mutable properties from this ViewModel.

Parameters

unsafeCppPointer

Pointer to the C++ counterpart.

fileLock

Lock shared by this view model's File and native objects derived from it.

Types

data class Property(val type: ViewModel.PropertyDataType, val name: String)

A description of a property in the ViewModel.

PropertyDataType

enum PropertyDataType : Enum<ViewModel.PropertyDataType>

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 instanceCount: Int

The number of instances of this ViewModel. Useful for index-based iteration.

val name: String

Get the name of the ViewModel.

val properties: List<ViewModel.Property>

The available properties of the ViewModel.

val propertyCount: Int

The number of properties in this ViewModel.

open val refCount: Int

override var refs: AtomicInteger

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)

createBlankInstance

fun createBlankInstance(): ViewModelInstance

Create a new blank ViewModelInstance. Use Artboard::setViewModel to apply it. The instance name will be an empty string.

createDefaultInstance

fun createDefaultInstance(): ViewModelInstance

Create a new ViewModelInstance. Use Artboard::setViewModel to apply it.

createInstanceFromIndex

fun createInstanceFromIndex(index: Int): ViewModelInstance

Create a new ViewModelInstance. Use Artboard::setViewModel to apply it.

createInstanceFromName

fun createInstanceFromName(name: String): ViewModelInstance

Create a new ViewModelInstance. Use Artboard::setViewModel to apply it.

open override fun release(): Int

Decrements the reference counter.