The scale factor to use for Fit.LAYOUT. If null, it will use a density determined by Rive (automatic). See RiveFileController.layoutScaleFactorAutomatic for more details.

layoutScaleFactorAutomatic

var layoutScaleFactorAutomatic: Float

The automatic scale factor set by Rive. This value will only be used if layoutScaleFactor is not set (null).

listeners

@VisibleForTesting(otherwise = 2)

val listeners: HashSet<RiveFileController.Listener>

loop

var loop: Loop

onStart

var onStart: OnStartCallback?

pausedAnimations

val pausedAnimations: Set<LinearAnimationInstance>

pausedStateMachines

val pausedStateMachines: Set<StateMachineInstance>

playingAnimations

val playingAnimations: HashSet<LinearAnimationInstance>

playingStateMachines

val playingStateMachines: HashSet<StateMachineInstance>

refCount

open val refCount: Int

refs

open override var refs: AtomicInteger

The number of objects referencing this controller.

stateMachines

val stateMachines: List<StateMachineInstance>

targetBounds

var targetBounds: RectF

Functions

acquire

@CallSuper

open fun acquire(): Int

addEventListener

fun addEventListener(listener: RiveFileController.RiveEventListener)

Adds a RiveEventListener to get notified on RiveEvents.

advance

@WorkerThread

fun advance(elapsed: Float)

Note: This is happening in the render thread: this function is synchronized with a ReentrantLock stored on the File because this is a critical section with the UI thread. When advancing or performing operations around an animations data structure, be conscious of thread safety.

autoplay

fun autoplay()

fireState

fun fireState(stateMachineName: String, inputName: String, path: String? = null)

fireStateAtPath

fun fireStateAtPath(inputName: String, path: String)

getTextRunValue

fun getTextRunValue(textRunName: String): String?

Get the current value for a text run named textRunName on the active artboard if it exists.

fun getTextRunValue(textRunName: String, path: String): String?

Get the text value for a text run named textRunName on the nested artboard represented at path.

getVolume

fun getVolume(): Float?

Get the active Artboard's volume.

pause

fun pause()

fun pause(animationName: String, isStateMachine: Boolean = false)

fun pause(animationNames: List<String>, areStateMachines: Boolean = false)

play

fun play(loop: Loop = Loop.AUTO, direction: Direction = Direction.AUTO, settleInitialState: Boolean = true)

Restarts paused animations if there are any. Otherwise, it starts playing the first animation (timeline or state machine) in the Artboard.

fun play(animationName: String, loop: Loop = Loop.AUTO, direction: Direction = Direction.AUTO, isStateMachine: Boolean = false, settleInitialState: Boolean = true)

fun play(animationNames: List<String>, loop: Loop = Loop.AUTO, direction: Direction = Direction.AUTO, areStateMachines: Boolean = false, settleInitialState: Boolean = true)

pointerEvent

fun pointerEvent(eventType: PointerEvents, pointerID: Int, x: Float, y: Float)

registerListener

open override fun registerListener(listener: RiveFileController.Listener)

release

open override fun release(): Int

Release a reference associated with this Controller. If refs == 0, then give up all resources and release the file.

removeEventListener

fun removeEventListener(listener: RiveFileController.RiveEventListener)

Removes the listener.

restoreControllerState

fun restoreControllerState(state: ControllerState)

Restore a copy of the state to this Controller.

saveControllerState

fun saveControllerState(): ControllerState?

Get a copy of the state of this controller and acquire a reference to the file to prevent it being released from memory.

selectArtboard

fun selectArtboard(name: String? = null)

Instances the artboard with the specified name. If none is provided, it instantiates the first (i.e. default) artboard. If this controller is set to autoplay it will also start playing.

setBooleanState

fun setBooleanState(stateMachineName: String, inputName: String, value: Boolean, path: String? = null)

setBooleanStateAtPath

fun setBooleanStateAtPath(inputName: String, value: Boolean, path: String)

setNumberState

fun setNumberState(stateMachineName: String, inputName: String, value: Float, path: String? = null)

setNumberStateAtPath

fun setNumberStateAtPath(inputName: String, value: Float, path: String)

setRiveFile

fun setRiveFile(file: File, artboardName: String? = null)

Assigns the file to this Controller and instances the artboard provided via artboardName. If none is provided, it instantiates the first (i.e. default) artboard. If this controller is set to autoplay it will also start playing.

setTextRunValue

fun setTextRunValue(textRunName: String, textValue: String)

Set the text value for a text run named textRunName to textValue on the active artboard.

fun setTextRunValue(textRunName: String, textValue: String, path: String)

Set the text value for a text run named textRunName to textValue on the nested artboard represented at path.

setVolume

fun setVolume(value: Float)

Set the active Artboard's volume to value.

stopAnimations

fun stopAnimations()

Named stopAnimations to avoid conflicting with stop.

fun stopAnimations(animationName: String, isStateMachine: Boolean = false)

fun stopAnimations(animationNames: List<String>, areStateMachines: Boolean = false)

unregisterListener

open override fun unregisterListener(listener: RiveFileController.Listener)