All Implemented Interfaces:

app.rive.runtime.kotlin.core.RefCount
```
@OpenForTesting() 
public final class Artboard
extends NativeObject
                    
```
Artboards as designed in the Rive animation editor.
Artboards provide access to available animations, and some basic properties. You can draw artboards using a Renderer that is tied to a canvas.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`name`
`private final LinearAnimationInstance`	`firstAnimation`
`private final StateMachineInstance`	`firstStateMachine`
`private Float`	`volume`
`private final Integer`	`animationCount`
`private final Integer`	`stateMachineCount`
`private ViewModelInstance`	`viewModelInstance`
`private final RectF`	`bounds`
`private Float`	`width`
`private Float`	`height`
`private final List<String>`	`animationNames`
`private final List<String>`	`stateMachineNames`
`private final Boolean`	`hasCppObject`
`private AtomicInteger`	`refs`
`private Long`	`cppPointer`
`private final <ERROR CLASS>`	`dependencies`
`private final Integer`	`refCount`

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`final String`	`getName()`
`final LinearAnimationInstance`	`getFirstAnimation()`
`final StateMachineInstance`	`getFirstStateMachine()`
`final Float`	`getVolume()`
`final Unit`	`setVolume(Float volume)`
`final Integer`	`getAnimationCount()`
`final Integer`	`getStateMachineCount()`
`final ViewModelInstance`	`getViewModelInstance()`	The ViewModelInstance assigned to this artboard.
`final Unit`	`setViewModelInstance(ViewModelInstance viewModelInstance)`
`final RectF`	`getBounds()`
`final Float`	`getWidth()`
`final Unit`	`setWidth(Float width)`
`final Float`	`getHeight()`
`final Unit`	`setHeight(Float height)`
`final List<String>`	`getAnimationNames()`
`final List<String>`	`getStateMachineNames()`
`final Boolean`	`getHasCppObject()`
`final AtomicInteger`	`getRefs()`
`final Unit`	`setRefs(AtomicInteger refs)`
`final Long`	`getCppPointer()`
`final Unit`	`setCppPointer(Long cppPointer)`
`final <ERROR CLASS>`	`getDependencies()`
`Integer`	`getRefCount()`
`Unit`	`cppDelete(Long pointer)`
`final LinearAnimationInstance`	`animation(Integer index)`	Get the animation at a given index in the Artboard.
`final LinearAnimationInstance`	`animation(String name)`	Get the animation with a given name in the Artboard.
`final StateMachineInstance`	`stateMachine(Integer index)`	Get the animation at a given index in the artboard.
`final StateMachineInstance`	`stateMachine(String name)`	Get the animation with a given name in the artboard.
`final SMIInput`	`input(String name, String path)`	Get the input instance with a given name on the nested artboard represented at path.
`final RiveTextValueRun`	`textRun(String name)`	Get a RiveTextValueRun with a given name in the artboard.
`final RiveTextValueRun`	`textRun(String name, String path)`	Get a RiveTextValueRun with a given name on the nested artboard represented at path.
`final String`	`getTextRunValue(String name)`	Get the text value for a text run named name.
`final String`	`getTextRunValue(String name, String path)`	Get the text value for a text run named name on the nested artboard represented at path.
`final Unit`	`setTextRunValue(String name, String textValue)`	Set the text value for a text run named name to textValue.
`final Unit`	`setTextRunValue(String name, String textValue, String path)`	Set the text value for a text run named name to textValue on the nested artboard represented at path.
`final ViewModelInstance`	`receiveViewModelInstance(ViewModelInstance.Transfer transfer)`
`final Boolean`	`advance(Float elapsedTime)`	Advancing the artboard: Updates the layout for all dirty components contained in the artboard Updates the positions Forces all components in the artboard to be laid out Components are all the shapes, bones and groups of an artboard.
`final <ERROR CLASS>`	`draw(Long rendererAddress)`	Draw the the artboard to the renderer.
`final Unit`	`draw(Long rendererAddress, Fit fit, Alignment alignment, Float scaleFactor)`	Draw the the artboard to the renderer.
`final Unit`	`resetArtboardSize()`	Reset the artboard size to its defaults.

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

- Constructor Detail
  - Artboard
```
Artboard(Long unsafeCppPointer, ReentrantLock lock)
```
    Parameters:
    
    unsafeCppPointer - Pointer to the C++ counterpart.
- Method Detail
  - getName
```
 final String getName()
```
  - getFirstAnimation
```
 final LinearAnimationInstance getFirstAnimation()
```
  - getFirstStateMachine
```
 final StateMachineInstance getFirstStateMachine()
```
  - getVolume
```
 final Float getVolume()
```
  - setVolume
```
 final Unit setVolume(Float volume)
```
  - getAnimationCount
```
 final Integer getAnimationCount()
```
  - getStateMachineCount
```
 final Integer getStateMachineCount()
```
  - 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 artboard.
    Assigning null will do nothing.
    You should only use assign this property if your file does not contain a state machine. If it does, prefer StateMachineInstance.viewModelInstance instead, as it will set the view model for both the state machine and the artboard.
  - setViewModelInstance
```
 final Unit setViewModelInstance(ViewModelInstance viewModelInstance)
```
  - getBounds
```
 final RectF getBounds()
```
  - getWidth
```
 final Float getWidth()
```
  - setWidth
```
 final Unit setWidth(Float width)
```
  - getHeight
```
 final Float getHeight()
```
  - setHeight
```
 final Unit setHeight(Float height)
```
  - getAnimationNames
```
 final List<String> getAnimationNames()
```
  - getStateMachineNames
```
 final List<String> getStateMachineNames()
```
  - 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 <ERROR CLASS> getDependencies()
```
  - getRefCount
```
 Integer getRefCount()
```
  - cppDelete
```
 Unit cppDelete(Long pointer)
```
  - animation
```
 final LinearAnimationInstance animation(Integer index)
```
    Get the animation at a given index in the Artboard.
    This starts at 0.
  - animation
```
 final LinearAnimationInstance animation(String name)
```
    Get the animation with a given name in the Artboard.
  - stateMachine
```
 final StateMachineInstance stateMachine(Integer index)
```
    Get the animation at a given index in the artboard.
    This starts at 0.
  - stateMachine
```
 final StateMachineInstance stateMachine(String name)
```
    Get the animation with a given name in the artboard.
  - input
```
 final SMIInput input(String name, String path)
```
    Get the input instance with a given name on the nested artboard represented at path.
  - textRun
```
 final RiveTextValueRun textRun(String name)
```
    Get a RiveTextValueRun with a given name in the artboard.
  - textRun
```
 final RiveTextValueRun textRun(String name, String path)
```
    Get a RiveTextValueRun with a given name on the nested artboard represented at path.
  - getTextRunValue
```
 final String getTextRunValue(String name)
```
    Get the text value for a text run named name.
  - getTextRunValue
```
 final String getTextRunValue(String name, String path)
```
    Get the text value for a text run named name on the nested artboard represented at path.
  - setTextRunValue
```
 final Unit setTextRunValue(String name, String textValue)
```
    Set the text value for a text run named name to textValue.
  - setTextRunValue
```
 final Unit setTextRunValue(String name, String textValue, String path)
```
    Set the text value for a text run named name to textValue on the nested artboard represented at path.
  - receiveViewModelInstance
```
 final ViewModelInstance receiveViewModelInstance(ViewModelInstance.Transfer transfer)
```
  - advance
```
 final Boolean advance(Float elapsedTime)
```
    Advancing the artboard:
    Updates the layout for all dirty components contained in the artboard
    Updates the positions
    Forces all components in the artboard to be laid out
    Components are all the shapes, bones and groups of an artboard. Whenever components are added to an artboard, for example when an artboard is first loaded, they are considered dirty. Whenever animations change properties of components, move a shape, or change a color, they are marked as dirty.
    Before any changes to components will be visible in the next rendered frame, the artboard needs to be advanced.
    elapsedTime is currently not taken into account.
  - draw
```
@WorkerThread() final <ERROR CLASS> draw(Long rendererAddress)
```
    Draw the the artboard to the renderer.
  - draw
```
@WorkerThread() final Unit draw(Long rendererAddress, Fit fit, Alignment alignment, Float scaleFactor)
```
    Draw the the artboard to the renderer. Also align the artboard to the render surface.
  - resetArtboardSize
```
 final Unit resetArtboardSize()
```
    Reset the artboard size to its defaults.

Class Artboard

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Artboard

Method Detail

getName

getFirstAnimation

getFirstStateMachine

getVolume

setVolume

getAnimationCount

getStateMachineCount

getViewModelInstance

setViewModelInstance

getBounds

getWidth

setWidth

getHeight

setHeight

getAnimationNames

getStateMachineNames

getHasCppObject

getRefs

setRefs

getCppPointer

setCppPointer

getDependencies

getRefCount

cppDelete

animation

animation

stateMachine

stateMachine

input

textRun

textRun

getTextRunValue

getTextRunValue

setTextRunValue

setTextRunValue

receiveViewModelInstance

advance

draw

draw

resetArtboardSize