All Implemented Interfaces:

app.rive.runtime.kotlin.core.PlayableInstance , app.rive.runtime.kotlin.core.RefCount
```
public final class StateMachineInstance
extends NativeObject implements PlayableInstance
                    
```
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.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`name`
`private final Integer`	`layerCount`
`private ViewModelInstance`	`viewModelInstance`
`private final Integer`	`inputCount`
`private final List<SMIInput>`	`inputs`
`private final List<String>`	`inputNames`
`private final List<LayerState>`	`statesChanged`
`private final List<RiveEvent>`	`eventsReported`
`private final Boolean`	`hasCppObject`
`private AtomicInteger`	`refs`
`private Long`	`cppPointer`
`private final List<RefCount>`	`dependencies`
`private final Integer`	`refCount`

Constructor Summary

Constructors
Constructor	Description
`StateMachineInstance(Long unsafeCppPointer, ReentrantLock lock)`

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`
`final Integer`	`getLayerCount()`
`final ViewModelInstance`	`getViewModelInstance()`	The ViewModelInstance assigned to this artboard.
`final Unit`	`setViewModelInstance(ViewModelInstance viewModelInstance)`
`final Integer`	`getInputCount()`
`final List<SMIInput>`	`getInputs()`
`final List<String>`	`getInputNames()`
`final List<LayerState>`	`getStatesChanged()`
`final List<RiveEvent>`	`getEventsReported()`
`final Boolean`	`getHasCppObject()`
`final AtomicInteger`	`getRefs()`
`final Unit`	`setRefs(AtomicInteger refs)`
`final Long`	`getCppPointer()`
`final Unit`	`setCppPointer(Long cppPointer)`
`final List<RefCount>`	`getDependencies()`
`Integer`	`getRefCount()`
`Unit`	`cppDelete(Long pointer)`
`final ViewModelInstance`	`receiveViewModelInstance(ViewModelInstance.Transfer transfer)`
`final Boolean`	`advance(Float elapsed)`	Advance the state machine.
`final Unit`	`pointerDown(Float x, Float y)`
`final Unit`	`pointerUp(Float x, Float y)`
`final Unit`	`pointerMove(Float x, Float y)`
`final SMIInput`	`input(Integer index)`	Get the input instance at a given index in the state machine.
`final SMIInput`	`input(String name)`	Get the input with a given name in the state machine.
`final LayerState`	`stateChanged(Integer index)`	Get a specific state changed in the last advance.
`final RiveEvent`	`eventAt(Integer index)`	Get a specific event fired in the last advance.

Methods inherited from class app.rive.runtime.kotlin.core.StateMachineInstance
acquire, release
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StateMachineInstance

StateMachineInstance(Long unsafeCppPointer, ReentrantLock lock)

Method Detail

getName
```
 String getName()
```

getLayerCount
```
 final Integer getLayerCount()
```

getViewModelInstance
```
 final ViewModelInstance getViewModelInstance()
```
The ViewModelInstance assigned to this artboard. Once assigned, modifications to the. properties of the instance will be reflected in the bindings of this state machine.
Assigning will apply to both the StateMachineInstance and the parent Artboard. Assigning null will do nothing.

setViewModelInstance

 final Unit setViewModelInstance(ViewModelInstance viewModelInstance)

getInputCount
```
 final Integer getInputCount()
```

getInputs
```
 final List<SMIInput> getInputs()
```

getInputNames
```
 final List<String> getInputNames()
```

getStatesChanged

 final List<LayerState> getStatesChanged()

getEventsReported

 final List<RiveEvent> getEventsReported()

getHasCppObject
```
 final Boolean getHasCppObject()
```

getRefs
```
 final AtomicInteger getRefs()
```

setRefs

 final Unit setRefs(AtomicInteger refs)

getCppPointer
```
 final Long getCppPointer()
```

setCppPointer

 final Unit setCppPointer(Long cppPointer)

getDependencies
```
 final List<RefCount> getDependencies()
```

getRefCount
```
 Integer getRefCount()
```

cppDelete
```
 Unit cppDelete(Long pointer)
```

receiveViewModelInstance

 final ViewModelInstance receiveViewModelInstance(ViewModelInstance.Transfer transfer)

advance
```
 final Boolean advance(Float elapsed)
```
Advance the state machine.

Parameters:

elapsed - The time in seconds to advance by.

pointerDown

 final Unit pointerDown(Float x, Float y)

pointerUp

 final Unit pointerUp(Float x, Float y)

pointerMove

 final Unit pointerMove(Float x, Float y)

input
```
 final SMIInput input(Integer index)
```
Get the input instance at a given index in the state machine.
This starts at 0.

input
```
 final SMIInput input(String name)
```
Get the input with a given name in the state machine.

stateChanged
```
 final LayerState stateChanged(Integer index)
```
Get a specific state changed in the last advance.

Parameters:

index - The index of the state.

eventAt
```
 final RiveEvent eventAt(Integer index)
```
Get a specific event fired in the last advance.

Parameters:

index - The index of the event.

Class StateMachineInstance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class app.rive.runtime.kotlin.core.StateMachineInstance

Methods inherited from class java.lang.Object

Constructor Detail

StateMachineInstance

Method Detail

getName

getLayerCount

getViewModelInstance

setViewModelInstance

getInputCount

getInputs

getInputNames

getStatesChanged

getEventsReported

getHasCppObject

getRefs

setRefs

getCppPointer

setCppPointer

getDependencies

getRefCount

cppDelete

receiveViewModelInstance

advance

pointerDown

pointerUp

pointerMove

input

input

stateChanged

eventAt