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

ViewModelListProperty

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

A list property of ViewModelInstances.

The list is mutable, and can be modified at runtime using add, remove, removeAt, and swap.

The list does not have one particular value to get or set, so value and valueFlow are not applicable and will always return Unit.

See also

ViewModelNumberProperty

Constructors

ViewModelListProperty

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

The number of items in the list.

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.

fun add(item: ViewModelInstance)

Append the ViewModelInstance to the end of the list.

fun add(index: Int, item: ViewModelInstance)

Insert the ViewModelInstance at the specified index. The item currently at that index and all subsequent items will be shifted one position to the right.

open override fun cppDelete(pointer: Long)

@VisibleForTesting(otherwise = 2)

external fun cppHasChanged(cppPointer: Long): Boolean

external fun cppName(cppPointer: Long): String

fun elementAt(index: Int): ViewModelInstance

Get the ViewModelInstance at the specified index.

operator fun get(index: Int): ViewModelInstance

open override fun release(): Int

Release this property while holding the current file lock.

fun remove(item: ViewModelInstance)

Remove all instances of ViewModelInstance from the list.

fun removeAt(index: Int)

Remove the item at the specified index from the list. The items after the removed item will be shifted one position to the left.

fun swap(index1: Int, index2: Int)

Swap the items at indices index1 and index2.