RiveWidgetController class base
This controller builds on top of the concept of a Rive painter, but provides a more convenient API for building Rive widgets.
To be used with RiveWidget and RiveWidgetBuilder widgets.
- Inheritance
-
- Object
- ChangeNotifier
- RivePainter
- ProceduralPainter
- ArtboardPainter
- BasicArtboardPainter
- RiveWidgetController
- Mixed-in types
Constructors
- RiveWidgetController(File file, {ArtboardSelector artboardSelector = const ArtboardDefault(), StateMachineSelector stateMachineSelector = const StateMachineDefault()})
- This controller builds on top of the concept of a Rive painter, but provides a more convenient API for building Rive widgets.
Properties
- active ↔ bool
-
getter/setter pair
- alignment ↔ Alignment
-
getter/setter pairinherited
- artboard ↔ Artboard
-
The artboard that the RiveWidgetController is painting.
latefinaloverride-getter
- cursor ↔ MouseCursor
-
The cursor to use when the pointer is over the hit test area.
getter/setter pairinherited
- file → File
-
The Rive file to this controller is built from.
final
- fit ↔ Fit
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
- hitTestBehavior ↔ RiveHitTestBehavior
-
The hit test behavior to use when determining if a pointer event occurred
within the widget's bounds and to check if a hit occurred on a Rive
listener.
getter/setter pairinherited
- lastPaintPixelRatio → double
-
no setterinherited
- lastSize → Size
-
The last size of the paint area.
no setterinherited
- layoutScaleFactor ↔ double
-
The scale factor to use for a fit of type
Fit.layout.getter/setter pairinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stateMachine ↔ StateMachine
-
The state machine that the RiveWidgetController is using.
latefinal
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
advance(
double elapsedSeconds) → bool -
Called each frame to advance the animation.
override
-
artboardChanged(
Artboard artboard) → void -
Called when the underlying artboard changes.
override
-
dataBind(
DataBind dataBind) → ViewModelInstance - Binds a ViewModelInstance to the StateMachine.
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
override
-
hitTest(
Offset position) → bool -
Determine if a pointer event occurred within the widget's bounds and
to check if a hit occurred on a Rive listener.
override
-
localToArtboard(
{required Offset position, required AABB artboardBounds, required Fit fit, required Alignment alignment, required Size size, double scaleFactor = RiveDefaults.layoutScaleFactor}) → Vec2D -
Convert a local offset to the artboard coordinate space.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
paint(
Renderer renderer, Size size, double paintPixelRatio) → void -
Called each frame to paint the artboard.
inherited
-
pointerEvent(
PointerEvent event, HitTestEntry< HitTestTarget> entry) → void -
Handle a pointer event.
override
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
scheduleRepaint(
) → void -
Request a repaint of the artboard.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited