RuntimeArtboard class
This artboard type is purely for use by the runtime system and should not be directly referenced. Use the Artboard type for any direct interactions with an artboard, and use extension methods to add functionality to Artboard.
- Inheritance
-
- Object
- WorldTransformComponentBase
- WorldTransformComponent
- ArtboardBase
- Artboard
- RuntimeArtboard
- Available extensions
Constructors
Properties
-
activeNestedArtboards
→ Iterable<
NestedArtboard> -
no setterinherited
- animates → bool
-
no setterinherited
-
animationControllers
→ Iterable<
RiveAnimationController> -
Access a read-only iterator of currently applied animation controllers.
no setterinherited
- animationData ↔ LayoutAnimationData
-
getter/setter pairinherited
- animations → AnimationList
-
List of animations and state machines in the artboard.
no setterinherited
- animationStyle → LayoutAnimationStyle
-
no setterinherited
- antialiasing ↔ bool
-
getter/setter pairinherited
- artboard → Artboard
-
The artboard this component belongs to.
no setterinherited
- canBeOrphaned → bool
-
Artboard are one of the few (only?) components that can be orphaned.
no setterinherited
- childOpacity → double
-
no setterinherited
- children → ContainerChildren
-
finalinherited
- clip ↔ bool
-
True when the layout component bounds clip its contents.
getter/setter pairinherited
- constraintBounds → AABB
-
Bounds to use for constraining to object space.
no setterinherited
- context ↔ RuntimeArtboard
-
covariantgetter/setter pairinherited
- coreType → int
-
no setterinherited
-
coreTypes
→ Set<
int> -
no setterinherited
-
dataBinds
→ Iterable<
DataBind> -
no setterinherited
- dataContext ↔ DataContext?
-
getter/setter pairinherited
- defaultStateMachine ↔ StateMachine?
-
getter/setter pairinherited
- defaultStateMachineId ↔ int
-
The default StateMachine attached to this artboard automatically when it
is initialized.
getter/setter pairinherited
-
dependencies
→ Set<
Component> -
no setterinherited
- dependencyRoot ↔ Artboard?
-
getter/setter pairinherited
-
dependents
→ Set<
Component> -
no setterinherited
- dirt ↔ int
-
getter/setter pairinherited
-
drawables
→ List<
Drawable> -
no setterinherited
- events → EventList
-
List of events in the artboard.
no setterinherited
-
fills
→ Set<
Fill> -
finalinherited
- firstDrawable ↔ Drawable?
-
getter/setter pairinherited
- frameOrigin ↔ bool
-
Returns true when the artboard will shift the origin from the top left to
the relative width/height of the artboard itself. This is what the editor
does visually when you change the origin value to give context as to where
the origin lies within the framed bounds.
getter/setter pairinherited
-
globalDataBinds
→ List<
DataBind> -
finalinherited
- graphOrder ↔ int
-
getter/setter pairinherited
- hasChangedDrawOrderInLastUpdate ↔ bool
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasValidated → bool
-
no setterinherited
- height ↔ double
-
Initial height of the item.
getter/setter pairinherited
- id ↔ int
-
getter/setter pairinherited
- interpolation → LayoutStyleInterpolation
-
no setterinherited
- interpolationTime → double
-
no setterinherited
- interpolator → KeyFrameInterpolator?
-
no setterinherited
- isCollapsed → bool
-
Whether this Component's update processes at all.
no setterinherited
- isPlaying → bool
-
no setteroverride
-
joysticks
→ Iterable<
Joystick> -
no setterinherited
- layoutBounds → AABB
-
no setterinherited
- layoutNode → LayoutNode
-
no setterinherited
- layoutStyle → LayoutStyle
-
no setterinherited
-
linearAnimations
→ Iterable<
LinearAnimation> -
List of linear animations in the artboard.
no setterinherited
- localBounds → AABB
-
no setterinherited
- name ↔ String
-
Non-unique identifier, used to give friendly names to elements in the
hierarchy. Runtimes provide an API for finding components by this
name
.getter/setter pairinherited -
objects
→ Iterable<
Core< CoreContext> ?> -
no setter
- opacity ↔ double
-
Change the
_opacity
field value. opacityChanged will be invoked only if the field's value has changed.getter/setter pairinherited - origin → Vec2D
-
no setterinherited
- originWorld → Vec2D
-
no setterinherited
- originX ↔ double
-
Origin x in normalized coordinates (0.5 = center, 0 = left, 1 = right).
getter/setter pairinherited
- originY ↔ double
-
Origin y in normalized coordinates (0.5 = center, 0 = top, 1 = bottom).
getter/setter pairinherited
- parent ↔ ContainerComponent?
-
getter/setter pairinherited
- parentId ↔ int
-
Identifier used to track parent ContainerComponent.
getter/setter pairinherited
- parentWorldTransform → Mat2D
-
Returns the world transform of the parent component. Returns the identity
if there is no parent (the artboard should be the only case here).
no setterinherited
- path → Path
-
finalinherited
- redraw → ChangeNotifier
-
no setter
- renderTransform → Mat2D
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stateMachines
→ Iterable<
StateMachine> -
List of state machines in the artboard.
no setterinherited
-
strokes
→ Set<
Stroke> -
finalinherited
- style ↔ LayoutComponentStyle?
-
getter/setter pairinherited
- styleId ↔ int
-
LayoutStyle that defines the styling for this LayoutComponent
getter/setter pairinherited
- userData ↔ dynamic
-
getter/setter pairinherited
- viewModelId ↔ int
-
The view model attached to this artboard data context.
getter/setter pairinherited
- viewModelInstance ↔ ViewModelInstance?
-
getter/setter pairinherited
- width ↔ double
-
Initial width of the item.
getter/setter pairinherited
- worldBounds → AABB
-
no setterinherited
- worldTransform → Mat2D
-
finalinherited
- worldTranslation → Vec2D
-
no setterinherited
- x ↔ double
-
X coordinate in editor world space.
getter/setter pairinherited
- y ↔ double
-
Y coordinate in editor world space.
getter/setter pairinherited
Methods
-
addComponent(
Component component) → void -
Adds a component to the artboard. Good place for the artboard to check for
components it'll later need to do stuff with (like draw them or sort them
when the draw order changes).
inherited
-
addController(
RiveAnimationController controller) → bool -
Add an animation controller to this artboard. Playing will be scheduled if
it's already playing.
inherited
-
addDependent(
Component dependent, {Component? via}) → bool -
Mark
dependent
as a component which must update after this. Providevia
as the Component registering the dependency when it is notdependent
itself. At edit time this allows the editor to rebuild bothdependent
andvia
whendependent
has its dependencies cleared.inherited -
addDirt(
int value, {bool recurse = false}) → bool -
inherited
-
addFill(
Fill fill) → bool -
inherited
-
addNestedArtboard(
NestedArtboard artboard) → void -
inherited
-
addNestedEventListener(
StateMachineController controller) → void -
addObject<
T extends Core< (CoreContext> >T? object) → T? -
addStroke(
Stroke stroke) → bool -
inherited
-
advance(
double elapsedSeconds, {bool nested = false}) → bool -
inherited
-
advanceInternal(
double elapsedSeconds, {bool nested = false, bool isRoot = false}) → bool -
Update any dirty components in this artboard.
inherited
-
allDependencies(
Set< Component> dependencies) → void -
inherited
-
appendChild(
Component child) → void -
Adds the child to the children list and re-wires the parent reference of
the child to the parent. Effectively detach and append.
inherited
-
applyJoysticks(
{bool isRoot = false}) → bool -
inherited
-
buildDependencies(
) → void -
inherited
-
buildDrawOrder(
List< Drawable> drawables, DrawRules? rules, List<DrawRules> allRules) → void -
inherited
-
canPreApplyJoysticks(
) → bool -
inherited
-
cascadeAnimationStyle(
LayoutStyleInterpolation inheritedInterpolation, KeyFrameInterpolator? inheritedInterpolator, double inheritedInterpolationTime) → void -
inherited
-
changeArtboard(
Artboard? value) → void -
inherited
-
childAdded(
Component child) → void -
inherited
-
childRemoved(
Component child) → void -
inherited
-
clean(
) → void -
clearDependencies(
) → void -
inherited
-
clearInheritedInterpolation(
) → void -
inherited
-
clipChanged(
bool from, bool to) → void -
inherited
-
clone<
K extends Core< (CoreContext> >) → K? -
Make a duplicate of this core object, N.B. that all properties excluding
object id are copied.
inherited
-
component<
T> (String name) → T? -
Find a component of a specific type with a specific name.
inherited
-
computeBindings(
bool isRoot) → void -
inherited
-
computeDrawOrder(
) → void -
inherited
-
copy(
covariant Core< CoreContext> source) → void -
Copies property values, currently doesn't trigger change callbacks. It's
meant to be a helper for clone.
inherited
-
dataContextFromInstance(
ViewModelInstance viewModelInstance, DataContext? parent, bool isRoot) → void -
inherited
-
defaultStateMachineIdChanged(
int from, int to) → void -
inherited
-
dirty(
void dirt()) → void -
draw(
Canvas canvas) → void -
Draw the drawable components in this artboard.
inherited
-
forAll(
DescentCallback cb) → bool -
inherited
-
forEachChild(
DescentCallback cb) → void -
inherited
-
forEachComponent(
void callback(Component)) → void -
Iterate each component and call callback for it.
inherited
-
getComponentWhereOrNull<
T> (bool callback(Component)) → T? -
Find a component that matches the given predicate.
inherited
-
hasLayoutMeasurements(
) → bool -
inherited
-
heightChanged(
double from, double to) → void -
inherited
-
import(
ImportStack stack) → bool -
inherited
-
instance(
) → Artboard -
override
-
internalAddAnimation(
Animation animation) → bool -
Called by rive_core to add an Animation to an Artboard. This should be
@internal when it's supported.
inherited
-
internalAddEvent(
Event event) → bool -
Called by rive_core to add an Event to an Artboard. This should be
@internal when it's supported.
inherited
-
internalDataContext(
DataContext dataContextValue, DataContext? parentDataContext, bool isRoot) → void -
inherited
-
internalRemoveAnimation(
Animation animation) → bool -
Called by rive_core to remove an Animation from an Artboard. This should
be @internal when it's supported.
inherited
-
internalRemoveEvent(
Event event) → bool -
Called by rive_core to remove an Event from an Artboard. This should
be @internal when it's supported.
inherited
-
invalidateStrokeEffects(
) → void -
Called whenever the compound path for this shape is changed so that the
effects can be invalidated on all the strokes.
inherited
-
isValidParent(
Component parent) → bool -
inherited
-
makeCoreInstance(
int typeKey) → Core< CoreContext> ? -
markDependenciesDirty(
covariant Core< CoreContext> object) → bool -
markDependencyOrderDirty(
) → void -
markDrawOrderDirty(
) → void -
Let the artboard know that the drawables need to be resorted before
drawing next.
inherited
-
markLayoutDirty(
LayoutComponent layoutComponent) → void -
inherited
-
markLayoutNodeDirty(
) → void -
inherited
-
markLayoutStyleDirty(
) → void -
inherited
-
markNeedsAdvance(
) → void -
markRebuildDependencies(
) → void -
inherited
-
markWorldTransformDirty(
) → void -
inherited
-
nameChanged(
String from, String to) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onAdded(
) → void -
inherited
-
onAddedDirty(
) → void -
inherited
-
onComponentDirty(
Component component) → void -
inherited
-
onDependencyRemoved(
Component dependent) → void -
Something we depend on has been removed. It's important to clear out any
stored references to that dependency so it can be garbage collected (if
necessary).
inherited
-
onDirty(
int mask) → void -
inherited
-
onFillsChanged(
) → void -
Called when a fill is added or removed.
inherited
-
onPaintMutatorChanged(
ShapePaintMutator mutator) → void -
Called whenever a new paint mutator is added/removed from the shape paints
(for example a linear gradient is added to a stroke).
inherited
-
onRemoved(
) → void -
When a component has been removed from the Core Context, we clean up any
dangling references left on the parent and on any other dependent
component. It's important for specialization of Component to respond to
override onDependencyRemoved and clean up any further stored references
to that component (for example the target of a Constraint).
inherited
-
onStrokesChanged(
) → void -
Called when a stroke is added or remoevd.
inherited
-
opacityChanged(
double from, double to) → void -
inherited
-
originXChanged(
double from, double to) → void -
inherited
-
originYChanged(
double from, double to) → void -
inherited
-
parentChanged(
ContainerComponent? from, ContainerComponent? to) → void -
inherited
-
parentIdChanged(
int from, int to) → void -
inherited
-
pause(
) → void -
override
-
play(
) → void -
override
-
populateDataBinds(
List< DataBind> globalDataBinds) → void -
inherited
-
prependChild(
Component child) → void -
inherited
-
propagateCollapse(
bool collapse) → bool -
inherited
-
propagateCollapseToChildren(
bool collapse) → void -
inherited
-
propagateSize(
) → void -
inherited
-
remove(
) → void -
inherited
-
removeComponent(
Component component) → void -
Remove a component from the artboard and its various tracked lists of
components.
inherited
-
removeController(
RiveAnimationController controller) → bool -
Remove an animation controller form this artboard.
inherited
-
removeFill(
Fill fill) → bool -
inherited
-
removeNestedArtboard(
NestedArtboard artboard) → void -
inherited
-
removeObject<
T extends Core< (CoreContext> >T object) → void -
removeRecursive(
) → void -
Recursive version of
Component.remove
. This should only be called when you know this is the only part of the branch you are removing in your operation. If your operation could remove items from the same branch multiple times, you should consider building up a list of the individual items to remove and then remove them individually to avoid calling remove multiple times on children.inherited -
removeStroke(
Stroke stroke) → bool -
inherited
-
renderTranslation(
Vec2D worldTranslation) → Vec2D -
inherited
-
resolve<
T> (int id) → T? -
resolveArtboard(
) → bool -
Find the artboard in the hierarchy.
inherited
-
resolveWithDefault<
T> (int id, T defaultValue) → T -
setInheritedInterpolation(
LayoutStyleInterpolation interpolation, KeyFrameInterpolator? interpolator, double interpolationTime) → void -
inherited
-
setupStyle(
LayoutComponentStyle style) → void -
inherited
-
sortDataBinds(
) → void -
inherited
-
sortDependencies(
) → void -
Sort the DAG for resolution in order of dependencies such that dependent
components process after their dependencies.
inherited
-
sortDrawOrder(
) → void -
inherited
-
styleIdChanged(
int from, int to) → void -
inherited
-
styleInterpolationChanged(
) → void -
inherited
-
styleValueChanged(
) → void -
inherited
-
syncLayoutChildren(
) → void -
inherited
-
syncStyle(
) → void -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
int dirt) → void -
inherited
-
updateComponents(
) → bool -
Walk the dependency tree and update components in order. Returns true if
any component updated.
inherited
-
updateDataBinds(
) → void -
inherited
-
updateLayoutBounds(
) → void -
inherited
-
userDataChanged(
dynamic from, dynamic to) → void -
inherited
-
validate(
) → bool -
inherited
-
viewModelIdChanged(
int from, int to) → void -
inherited
-
visitAncestor(
Component ancestor) → void -
Called whenever we're resolving the artboard, we piggy back on that
process to visit ancestors in the tree. This is a good opportunity to
check if we have an ancestor of a specific type. For example, a Path needs
to know which Shape it's within.
inherited
-
widthChanged(
double from, double to) → void -
inherited
-
xChanged(
double from, double to) → void -
inherited
-
yChanged(
double from, double to) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited