Enhanced enum features for `AnimationStatus` #147801

nate-thegrate · 2024-05-03T19:35:22Z

Based on issue #147799, this pull request adds two AnimationStatus getters.

bool get isRunning => switch (this) {
  forward   || reverse   => true,
  completed || dismissed => false,
};

bool get aimedForward => switch (this) {
  forward || completed => true,
  reverse || dismissed => false,
};

I also added a .toggle() method for animation controllers that makes use of aimedForward.

nate-thegrate · 2024-05-03T20:15:55Z

packages/flutter/test/animation/animation_controller_test.dart

+    controller.dispose();
+


I noticed that a controller was being reassigned here without a .dispose() call, so I added this as well.

packages/flutter/lib/src/animation/animation.dart

goderbauer · 2024-05-15T20:59:48Z

packages/flutter/lib/src/animation/animation.dart

+  ///
+  /// Useful for toggling animations back and forth.
+  /// {@endtemplate}
+  bool get aimedForward => switch (this) {


I am not super in love with this name. I wish I had a better suggestion...

me too 🥲

I asked gemini, it came up with the very explicit isForwardOrCompleted name. Still not great, I like it slightly better then aimedForward, though.

I'm good with that!

goderbauer · 2024-05-15T22:37:40Z

packages/flutter/lib/src/animation/animation_controller.dart

+  /// The most recently returned [TickerFuture], if any, is marked as having been
+  /// canceled, meaning the future never completes and its [TickerFuture.orCancel]
+  /// derivative future completes with a [TickerCanceled] error.
+  TickerFuture toggle({ double? from }) {


Can you document the parameter?

Sure can!

I copied the documentation over from the forward/reverse functions, so I'll document the parameter for those as well.

… aimed-forward

goderbauer

LGTM

goderbauer · 2024-05-16T16:21:54Z

packages/flutter/lib/src/animation/animation.dart

+  ///
+  /// Useful for toggling animations back and forth.
+  /// {@endtemplate}
+  bool get aimedForward => switch (this) {


I asked gemini, it came up with the very explicit isForwardOrCompleted name. Still not great, I like it slightly better then aimedForward, though.

…er#147801)

flutter/flutter@0d22d91...00425ef 2024-05-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from d575e511f9e5 to a19d3722922d (2 revisions) (flutter/flutter#148534) 2024-05-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8d1a1d8d7b48 to d575e511f9e5 (5 revisions) (flutter/flutter#148529) 2024-05-17 engine-flutter-autoroll@skia.org Manual roll Flutter Engine from 6fa734d68688 to 8d1a1d8d7b48 (8 revisions) (flutter/flutter#148528) 2024-05-17 32538273+ValentinVignal@users.noreply.github.com Add test for material_banner.0.dart and material_banner.1.dart (flutter/flutter#148452) 2024-05-17 nate.w5687@gmail.com `switch` statement cleanup (flutter/flutter#148382) 2024-05-16 goderbauer@google.com const vs. non-const widget build benchmark (flutter/flutter#148261) 2024-05-16 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 4.1.5 to 4.1.6 (flutter/flutter#148516) 2024-05-16 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 6fa734d68688 to 1850def2ccff (1 revision) (#148507)" (flutter/flutter#148517) 2024-05-16 stuartmorgan@google.com Add PrivacyInfo.xcprivacy to plugin template (flutter/flutter#148485) 2024-05-16 stuartmorgan@google.com Fix iOS reference in macOS Cocoapods error (flutter/flutter#148506) 2024-05-16 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6fa734d68688 to 1850def2ccff (1 revision) (flutter/flutter#148507) 2024-05-16 engine-flutter-autoroll@skia.org Roll Flutter Engine from 460df6caef0e to 6fa734d68688 (4 revisions) (flutter/flutter#148500) 2024-05-16 nate.w5687@gmail.com Enhanced enum features for `AnimationStatus` (flutter/flutter#147801) 2024-05-16 matej.knopp@gmail.com [macOS] codesign native assets during embed (flutter/flutter#148310) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

PR #147801 introduced some convenient `AnimationStatus` getters, but I just realized that `AnimationController` now has 2 getters for the same thing: `isAnimating` and `isRunning`. The intent of this pull request is to correct that mistake, and implement the getters in the appropriate places.

…r#6753) flutter/flutter@0d22d91...00425ef 2024-05-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from d575e511f9e5 to a19d3722922d (2 revisions) (flutter/flutter#148534) 2024-05-17 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8d1a1d8d7b48 to d575e511f9e5 (5 revisions) (flutter/flutter#148529) 2024-05-17 engine-flutter-autoroll@skia.org Manual roll Flutter Engine from 6fa734d68688 to 8d1a1d8d7b48 (8 revisions) (flutter/flutter#148528) 2024-05-17 32538273+ValentinVignal@users.noreply.github.com Add test for material_banner.0.dart and material_banner.1.dart (flutter/flutter#148452) 2024-05-17 nate.w5687@gmail.com `switch` statement cleanup (flutter/flutter#148382) 2024-05-16 goderbauer@google.com const vs. non-const widget build benchmark (flutter/flutter#148261) 2024-05-16 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 4.1.5 to 4.1.6 (flutter/flutter#148516) 2024-05-16 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 6fa734d68688 to 1850def2ccff (1 revision) (#148507)" (flutter/flutter#148517) 2024-05-16 stuartmorgan@google.com Add PrivacyInfo.xcprivacy to plugin template (flutter/flutter#148485) 2024-05-16 stuartmorgan@google.com Fix iOS reference in macOS Cocoapods error (flutter/flutter#148506) 2024-05-16 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6fa734d68688 to 1850def2ccff (1 revision) (flutter/flutter#148507) 2024-05-16 engine-flutter-autoroll@skia.org Roll Flutter Engine from 460df6caef0e to 6fa734d68688 (4 revisions) (flutter/flutter#148500) 2024-05-16 nate.w5687@gmail.com Enhanced enum features for `AnimationStatus` (flutter/flutter#147801) 2024-05-16 matej.knopp@gmail.com [macOS] codesign native assets during embed (flutter/flutter#148310) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

nate-thegrate added 5 commits May 2, 2024 19:24

add aimedForward getter

f59c3d4

add animation controller .toggle() method

cdf0991

add tests

9d442a9

add controller.dispose() calls

6f99ce8

add running getter

362f843

github-actions bot added framework flutter/packages/flutter repository. See also f: labels. a: animation Animation APIs labels May 3, 2024

nate-thegrate marked this pull request as ready for review May 3, 2024 20:12

nate-thegrate commented May 3, 2024

View reviewed changes

nate-thegrate mentioned this pull request May 4, 2024

Proposal: use "enhanced enums" in the repo for reduced boilerplate #147799

Open

goderbauer self-requested a review May 7, 2024 22:08

implement isDismissed / isCompleted in the enum

99db2f1

nate-thegrate marked this pull request as draft May 15, 2024 02:11

nate-thegrate marked this pull request as ready for review May 15, 2024 05:38

goderbauer reviewed May 15, 2024

View reviewed changes

nate-thegrate added 5 commits May 15, 2024 17:05

implement @goderbauer's feedback

8f0ce2d

Merge branch 'master' into aimed-forward

fa95e87

verbose doc comments

e7f1cd6

Merge branch 'aimed-forward' of github.com:nate-thegrate/flutter into…

3382520

… aimed-forward

Merge github.com:flutter/flutter into aimed-forward

fc39147

goderbauer approved these changes May 16, 2024

View reviewed changes

nate-thegrate added 2 commits May 16, 2024 10:27

rename the variable!

a7a23d2

(forgot the "d")

148e2f7

nate-thegrate added the autosubmit Merge PR when tree becomes green via auto submit App label May 16, 2024

auto-submit bot merged commit 6b38361 into flutter:master May 16, 2024
73 checks passed

nate-thegrate deleted the aimed-forward branch May 16, 2024 17:58

engine-flutter-autoroll mentioned this pull request May 17, 2024

Roll Flutter from 0d22d9101aac to 7f32df42187c (13 revisions) flutter/packages#6752

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 17, 2024

6b383615c Enhanced enum features for AnimationStatus (flutter/flutt…

e966360

…er#147801)

engine-flutter-autoroll mentioned this pull request May 17, 2024

Roll Flutter from 0d22d9101aac to 00425ef1be26 (14 revisions) flutter/packages#6753

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 17, 2024

6b383615c Enhanced enum features for AnimationStatus (flutter/flutt…

9520ef8

…er#147801)

nate-thegrate mentioned this pull request May 17, 2024

Implement new AnimationStatus getters #148570

Merged

Piinks mentioned this pull request May 17, 2024

Flutter Framework Team: Notable Commits #121415

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhanced enum features for `AnimationStatus` #147801

Enhanced enum features for `AnimationStatus` #147801

nate-thegrate commented May 3, 2024 •

edited

nate-thegrate May 3, 2024 •

edited

goderbauer May 15, 2024

nate-thegrate May 15, 2024

goderbauer May 16, 2024

nate-thegrate May 16, 2024

goderbauer May 15, 2024

nate-thegrate May 15, 2024

goderbauer left a comment

goderbauer May 16, 2024

Enhanced enum features for AnimationStatus #147801

Enhanced enum features for AnimationStatus #147801

Conversation

nate-thegrate commented May 3, 2024 • edited

nate-thegrate May 3, 2024 • edited

Choose a reason for hiding this comment

goderbauer May 15, 2024

Choose a reason for hiding this comment

nate-thegrate May 15, 2024

Choose a reason for hiding this comment

goderbauer May 16, 2024

Choose a reason for hiding this comment

nate-thegrate May 16, 2024

Choose a reason for hiding this comment

goderbauer May 15, 2024

Choose a reason for hiding this comment

nate-thegrate May 15, 2024

Choose a reason for hiding this comment

goderbauer left a comment

Choose a reason for hiding this comment

goderbauer May 16, 2024

Choose a reason for hiding this comment

Enhanced enum features for `AnimationStatus` #147801

Enhanced enum features for `AnimationStatus` #147801

nate-thegrate commented May 3, 2024 •

edited

nate-thegrate May 3, 2024 •

edited