Rive class
Constructors
Rive.new ({required Artboard artboard , Key ? key , bool useArtboardSize = false , bool antialiasing = true , bool enablePointerEvents = false , MouseCursor cursor = MouseCursor.defer , RiveHitTestBehavior behavior = RiveHitTestBehavior.opaque , BoxFit fit = BoxFit.contain , Alignment alignment = Alignment.center , Rect ? clipRect , double speedMultiplier = 1.0 , bool isTouchScrollEnabled = false })
const
Properties
alignment
→ Alignment
Alignment for the rendering artboard
final
antialiasing
→ bool
Enables/disables antialiasing
final
artboard
→ Artboard
Artboard used for drawing
final
behavior
→ RiveHitTestBehavior
How to behave during hit testing to consider targets behind this
animation.
final
clipRect
→ Rect ?
Clip the artboard to this rect.
final
cursor
→ MouseCursor
The mouse cursor for mouse pointers that are hovering over the region.
final
enablePointerEvents
→ bool
Enable input listeners (such as hover, pointer down, etc.) on the
artboard.
final
fit
→ BoxFit
Fit for the rendering artboard
final
hashCode
→ int
The hash code for this object.
no setter inherited
isTouchScrollEnabled
→ bool
For Rive Listeners, allows scrolling behavior to still occur on Rive
widgets when a touch/drag action is performed on touch-enabled devices.
Otherwise, scroll behavior may be prevented on touch/drag actions on the
widget by default.
final
key
→ Key ?
Controls how one widget replaces another widget in the tree.
final inherited
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
speedMultiplier
→ double
A multiplier for controlling the speed of the Rive animation playback.
final
useArtboardSize
→ bool
Determines whether to use the inherent size of the artboard , i.e. the
absolute size defined by the artboard, or size the widget based on the
available constraints only (sized by parent).
final
Methods
createElement ()
→ LeafRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderObject (BuildContext context )
→ RenderObject
Creates an instance of the RenderObject class that this
RenderObjectWidget represents, using the configuration described by this
RenderObjectWidget .
override
debugDescribeChildren ()
→ List <DiagnosticsNode >
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
debugFillProperties (DiagnosticPropertiesBuilder properties )
→ void
Add additional properties associated with the node.
inherited
didUnmountRenderObject (covariant RenderObject renderObject )
→ void
A render object previously associated with this widget has been removed
from the tree. The given RenderObject will be of the same type as
returned by this object's createRenderObject .
inherited
noSuchMethod (Invocation invocation )
→ dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode ({String ? name , DiagnosticsTreeStyle ? style })
→ DiagnosticsNode
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep .
inherited
toString ({DiagnosticLevel minLevel = DiagnosticLevel.info })
→ String
A string representation of this object.
inherited
toStringDeep ({String prefixLineOne = '' , String ? prefixOtherLines , DiagnosticLevel minLevel = DiagnosticLevel.debug , int wrapWidth = 65 })
→ String
Returns a string representation of this node and its descendants.
inherited
toStringShallow ({String joiner = ', ' , DiagnosticLevel minLevel = DiagnosticLevel.debug })
→ String
Returns a one-line detailed description of the object.
inherited
toStringShort ()
→ String
A short, textual description of this widget.
inherited
updateRenderObject (BuildContext context , covariant RiveRenderObject renderObject )
→ void
Copies the configuration described by this RenderObjectWidget to the
given RenderObject , which will be of the same type as returned by this
object's createRenderObject .
override