Skip to content

Commit

Permalink
Fix initialization of time in repeat on AnimationController (#142887)
Browse files Browse the repository at this point in the history
This PR fixes #142885.

The issue is that in `_RepeatingSimulation` the initial time is calculated as follows:

```
(initialValue / (max - min)) * (period.inMicroseconds / Duration.microsecondsPerSecond)
```

This calculation does not work in general. For instance, if `max` is 300, `min` is 100, and `initialValue` is 100 then `initialValue / (max - min)` is 1/2 when it should be 0

The current tests work by happenstance because the numbers used happen to work. To reveal the bug I've added some more tests similar to the existing ones but with different numbers.

A "side-effect" of the incorrect calculation is that if `initialValue` is 0, then the animation will always start from `min` no matter what. For instance, in one of the tests, an `AnimationController` with the value 0 is told to `repeat` between 0.5 and 1.0, and this starts the animation from 0.5. To preserve this behavior, and to more generally handle the case where the initial value is out of bounds, this PR clamps the initial value to be within the lower and upper bounds of the repetition.

Just for reference, this calculation was introduced at flutter/flutter#25125.
  • Loading branch information
paldepind authored Feb 21, 2024
1 parent 1e822ca commit 6c78e36
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,7 @@ typedef _DirectionSetter = void Function(_AnimationDirection direction);
class _RepeatingSimulation extends Simulation {
_RepeatingSimulation(double initialValue, this.min, this.max, this.reverse, Duration period, this.directionSetter)
: _periodInSeconds = period.inMicroseconds / Duration.microsecondsPerSecond,
_initialT = (max == min) ? 0.0 : (initialValue / (max - min)) * (period.inMicroseconds / Duration.microsecondsPerSecond) {
_initialT = (max == min) ? 0.0 : ((clampDouble(initialValue, min, max) - min) / (max - min)) * (period.inMicroseconds / Duration.microsecondsPerSecond) {
assert(_periodInSeconds > 0.0);
assert(_initialT >= 0.0);
}
Expand Down
45 changes: 43 additions & 2 deletions packages/flutter/test/animation/animation_controller_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -763,8 +763,8 @@ void main() {
);

test(
'calling repeat with specified min and max values makes the animation '
'alternate between min and max values on each repeat',
'calling repeat with specified min and max values between 0 and 1 makes '
'the animation alternate between min and max values on each repeat',
() {
final AnimationController controller = AnimationController(
duration: const Duration(milliseconds: 100),
Expand Down Expand Up @@ -799,6 +799,47 @@ void main() {
tick(Duration.zero);
tick(const Duration(milliseconds: 125));
expect(controller.value, 1.0);

controller.reset();
controller.value = 0.2;
expect(controller.value, 0.2);

controller.repeat(reverse: true, min: 0.2, max: 0.6);
tick(Duration.zero);
tick(const Duration(milliseconds: 50));
expect(controller.value, 0.4);
controller.dispose();
},
);

test(
'calling repeat with negative min value and positive max value makes the '
'animation alternate between min and max values on each repeat',
() {
final AnimationController controller = AnimationController(
duration: const Duration(milliseconds: 100),
value: 1.0,
lowerBound: -1,
upperBound: 3,
vsync: const TestVSync(),
);

expect(controller.value, 1.0);

controller.repeat(min: 1, max: 3);
tick(Duration.zero);
expect(controller.value, 1);
tick(const Duration(milliseconds: 50));
expect(controller.value, 2);

controller.reset();
controller.value = 0.0;

controller.repeat(min: -1, max: 3);
tick(Duration.zero);
expect(controller.value, 0);
tick(const Duration(milliseconds: 25));
expect(controller.value, 1);
controller.dispose();
},
);
Expand Down

0 comments on commit 6c78e36

Please sign in to comment.