Skip to content

Commit

Permalink
feat: expose speed multiplier for flutter runtime
Browse files Browse the repository at this point in the history
Community contribution: #423

This also came from an internal request.

Diffs=
38c0d394bc feat: expose speed multiplier for flutter runtime (#8571)
527276dee4 Dart bump to 3.5.0 (#8550)
cda96cff1b Nnnn joystick not advancing (#8567)
6f1304ef0b Add a skeleton workflow for android gms on browserstack (#8566)
b9a4114eba Render gms to the screen when the test app is launched without a harness (#8559)
51c3bbcde2 return keep going when a state machine has changed its state (#8564)
f34822a124 accept constraints without targets (#8552)

Co-authored-by: Gordon <pggordonhayes@gmail.com>
Co-authored-by: tguerin <thomas.guerin2@gmail.com>
  • Loading branch information
3 people committed Nov 15, 2024
1 parent 5495a00 commit ec139a8
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .rive_head
Original file line number Diff line number Diff line change
@@ -1 +1 @@
aea593c2dfdc4eae136ea9aa7fd16ccb305c4854
38c0d394bc0b1eaf2c64ab20aa074985ba8bfc43
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.13.17

- Expose `speedMultiplier` on the `RiveAnimation` and `Rive` widgets. With this you can adjust the playback speed of an animation or state machine. Thanks [tguerin](https://github.com/tguerin) for the contribution. See [423](https://github.com/rive-app/rive-flutter/pull/423)

## 0.13.16

- Avoid audio init on empty assets. See PR [431](https://github.com/rive-app/rive-flutter/pull/431).
Expand Down
24 changes: 21 additions & 3 deletions lib/src/rive.dart
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ class Rive extends LeafRenderObjectWidget {
/// {@endtemplate}
final Rect? clipRect;

/// A multiplier for controlling the speed of the Rive animation playback.
///
/// Default `1.0`.
final double speedMultiplier;

const Rive({
required this.artboard,
super.key,
Expand All @@ -105,6 +110,7 @@ class Rive extends LeafRenderObjectWidget {
this.fit = BoxFit.contain,
this.alignment = Alignment.center,
this.clipRect,
this.speedMultiplier = 1.0,
});

@override
Expand All @@ -121,7 +127,8 @@ class Rive extends LeafRenderObjectWidget {
..tickerModeEnabled = tickerModeValue
..enableHitTests = enablePointerEvents
..cursor = cursor
..behavior = behavior;
..behavior = behavior
..speedMultiplier = speedMultiplier;
}

@override
Expand All @@ -139,12 +146,14 @@ class Rive extends LeafRenderObjectWidget {
..tickerModeEnabled = tickerModeValue
..enableHitTests = enablePointerEvents
..cursor = cursor
..behavior = behavior;
..behavior = behavior
..speedMultiplier = speedMultiplier;
}
}

class RiveRenderObject extends RiveRenderBox implements MouseTrackerAnnotation {
RuntimeArtboard _artboard;
double _speedMultiplier = 1;
RiveRenderObject(
this._artboard, {
this.behavior = RiveHitTestBehavior.opaque,
Expand All @@ -167,6 +176,14 @@ class RiveRenderObject extends RiveRenderBox implements MouseTrackerAnnotation {
markNeedsLayout();
}

double get speedMultiplier => _speedMultiplier;

set speedMultiplier(double value) {
if (value != _speedMultiplier) {
_speedMultiplier = value;
}
}

/// Local offset to global artboard position
Vec2D _toArtboard(Offset local) {
final globalCoordinates = localToGlobal(local);
Expand Down Expand Up @@ -333,7 +350,8 @@ class RiveRenderObject extends RiveRenderBox implements MouseTrackerAnnotation {

@override
bool advance(double elapsedSeconds) =>
_artboard.isPlaying && _artboard.advance(elapsedSeconds, nested: true);
_artboard.isPlaying &&
_artboard.advance(elapsedSeconds * _speedMultiplier, nested: true);

@override
void beforeDraw(Canvas canvas, Offset offset) {
Expand Down
10 changes: 10 additions & 0 deletions lib/src/widgets/rive_animation.dart
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ class RiveAnimation extends StatefulWidget {
/// rendering.
final ObjectGenerator? objectGenerator;

/// A multiplier for controlling the speed of the Rive animation playback.
///
/// Default `1.0`.
final double speedMultiplier;

/// Creates a new [RiveAnimation] from an asset bundle.
///
/// *Example:*
Expand All @@ -92,6 +97,7 @@ class RiveAnimation extends StatefulWidget {
this.onInit,
this.behavior = RiveHitTestBehavior.opaque,
this.objectGenerator,
this.speedMultiplier = 1,
Key? key,
}) : name = asset,
file = null,
Expand Down Expand Up @@ -121,6 +127,7 @@ class RiveAnimation extends StatefulWidget {
this.headers,
this.behavior = RiveHitTestBehavior.opaque,
this.objectGenerator,
this.speedMultiplier = 1,
Key? key,
}) : name = url,
file = null,
Expand Down Expand Up @@ -148,6 +155,7 @@ class RiveAnimation extends StatefulWidget {
this.onInit,
this.behavior = RiveHitTestBehavior.opaque,
this.objectGenerator,
this.speedMultiplier = 1,
Key? key,
}) : name = path,
file = null,
Expand Down Expand Up @@ -176,6 +184,7 @@ class RiveAnimation extends StatefulWidget {
this.clipRect,
this.controllers = const [],
this.onInit,
this.speedMultiplier = 1,
Key? key,
this.behavior = RiveHitTestBehavior.opaque,
}) : name = null,
Expand Down Expand Up @@ -346,6 +355,7 @@ class RiveAnimationState extends State<RiveAnimation> {
clipRect: widget.clipRect,
enablePointerEvents: _shouldAddHitTesting,
behavior: widget.behavior,
speedMultiplier: widget.speedMultiplier,
)
: widget.placeHolder ?? const SizedBox();
}
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: rive
version: 0.13.16
version: 0.13.17
homepage: https://rive.app
description: Rive Flutter Runtime. This package provides runtime functionality for playing back and interacting with animations built with the Rive editor available at https://rive.app.
repository: https://github.com/rive-app/rive-flutter
Expand Down

0 comments on commit ec139a8

Please sign in to comment.