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

volume

var volume: Float

Get and set the volume of the artboard.

width

var width: Float

The width of the artboard.

Functions

acquire

@Synchronized

open override fun acquire(): Int

Increments the references for this counter. Cannot be used for initialization - use refs.incrementAndGet instead.

advance

fun advance(elapsedTime: Float): Boolean

Advancing the artboard:

animation

fun animation(index: Int): LinearAnimationInstance

Get the animation at a given 0-based index in the Artboard.

fun animation(name: String): LinearAnimationInstance

Get the animation with a given name in the Artboard.

cppDelete

open external override fun cppDelete(pointer: Long)

draw

@WorkerThread

fun draw(rendererAddress: Long)

Draw the the artboard to the renderer.

@WorkerThread

fun draw(rendererAddress: Long, fit: Fit, alignment: Alignment, scaleFactor: Float = 1.0f)

Draw the the artboard to the renderer. Also align the artboard to the render surface.

getTextRunValue

fun getTextRunValue(name: String): String?

Get the text value for a text run named name.

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

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

input

fun input(name: String, path: String): SMIInput

Get the input instance with a given name on the nested artboard represented at path.

receiveViewModelInstance

fun receiveViewModelInstance(transfer: ViewModelInstance.Transfer): ViewModelInstance

release

open override fun release(): Int

Decrements the reference counter.

resetArtboardSize

fun resetArtboardSize()

Reset the artboard size to its defaults.

setTextRunValue

fun setTextRunValue(name: String, textValue: String)

Set the text value for a text run named name to textValue.

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

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

stateMachine

fun stateMachine(index: Int): StateMachineInstance

Get the state machine at a given 0-based index in the artboard.

fun stateMachine(name: String): StateMachineInstance

Get the state machine with a given name in the artboard.

textRun

fun textRun(name: String): RiveTextValueRun

Get a RiveTextValueRun with a given name in the artboard.

fun textRun(name: String, path: String): RiveTextValueRun

Get a RiveTextValueRun with a given name on the nested artboard represented at path.