-
- All Implemented Interfaces:
-
app.rive.runtime.kotlin.core.RefCount
public final class ViewModelArtboardProperty extends ViewModelProperty<Unit>
An artboard property of a ViewModelInstance.
Unlike other property types, this property can only be set. It cannot be read or observed. It's value and valueFlow are not applicable and will always return Unit.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringnameprivate Unitvalueprivate final <ERROR CLASS>valueFlowprivate final BooleanhasCppObjectprivate AtomicIntegerrefsprivate LongcppPointerprivate final List<RefCount>dependenciesprivate final IntegerrefCount
-
Constructor Summary
Constructors Constructor Description ViewModelArtboardProperty(Long unsafeCppPointer)
-
Method Summary
Modifier and Type Method Description final StringgetName()final UnitgetValue()final UnitsetValue(Unit value)final <ERROR CLASS>getValueFlow()A flow of the property's value. final BooleangetHasCppObject()final AtomicIntegergetRefs()final UnitsetRefs(AtomicInteger refs)final LonggetCppPointer()final UnitsetCppPointer(Long cppPointer)final List<RefCount>getDependencies()IntegergetRefCount()final Unitset(Artboard artboard)Set the artboard for this property. final Unitset(BindableArtboard bindableArtboard)Set the bindable artboard for this property. -
Methods inherited from class app.rive.runtime.kotlin.core.ViewModelArtboardProperty
cppHasChanged, cppName -
Methods inherited from class app.rive.runtime.kotlin.core.ViewModelProperty
acquire, cppDelete, release -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
ViewModelArtboardProperty
ViewModelArtboardProperty(Long unsafeCppPointer)
-
-
Method Detail
-
getValueFlow
final <ERROR CLASS> getValueFlow()
A flow of the property's value. Use for observing changes.
-
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()
-
set
@Deprecated(message = This method is unsafe as the Artboard's lifetime is bound to that of the File that created it. Use a BindableArtboard to ensure proper lifetimes., replaceWith = @ReplaceWith(imports = {}, expression = set(BindableArtboard?))) final Unit set(Artboard artboard)
-
set
final Unit set(BindableArtboard bindableArtboard)
Set the bindable artboard for this property.
To create a BindableArtboard, use File.createBindableArtboardByName or File.createDefaultBindableArtboard.
Pass
nullto clear the artboard from the property.⚠️ If you are done with the BindableArtboard instance, be sure to call BindableArtboard.release after assigning. The property will retain its own reference to the bindable artboard.
-
-
-
-