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

StateMachineInstance

class StateMachineInstance(unsafeCppPointer: Long, fileLock: ReentrantLock) : PlayableInstance, NativeObject

The StateMachineInstance is a helper to wrap common operations to play a state machine.

This object has a counterpart in C++, which implements a lot of functionality. The unsafeCppPointer keeps track of this relationship.

Use this to keep track of a state machine's current state and progress, and to help apply changes that the state machine makes to components in an Artboard.

Parameters

unsafeCppPointer

Pointer to the C++ counterpart.

fileLock

Lock shared by the File and native graph this state machine belongs to.

Constructors

StateMachineInstance

constructor(unsafeCppPointer: Long, fileLock: ReentrantLock)

Properties

cppPointer

var cppPointer: Long

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

dependencies

val dependencies: MutableList<RefCount>

eventsReported

val eventsReported: List<RiveEvent>

hasCppObject

val hasCppObject: Boolean

Whether this objects underlying pointer is still valid.

inputCount

val inputCount: Int

inputNames

val inputNames: List<String>

inputs

val inputs: List<SMIInput>

layerCount

val layerCount: Int

name

open override val name: String

refCount

open val refCount: Int

refs

override var refs: AtomicInteger

statesChanged

val statesChanged: List<LayerState>

viewModelInstance

var viewModelInstance: ViewModelInstance?

The ViewModelInstance assigned to this state machine. Once assigned, modifications to the properties of the instance will be reflected in the bindings of this state machine.