animations.dart 23.9 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5

6
import 'dart:math' as math;
7

8 9
import 'package:flutter/foundation.dart';

10 11
import 'animation.dart';
import 'curves.dart';
12 13
import 'listener_helpers.dart';

14
// Examples can assume:
15
// late AnimationController controller;
16

17 18
class _AlwaysCompleteAnimation extends Animation<double> {
  const _AlwaysCompleteAnimation();
19

20
  @override
21
  void addListener(VoidCallback listener) { }
22 23

  @override
24
  void removeListener(VoidCallback listener) { }
25 26

  @override
27
  void addStatusListener(AnimationStatusListener listener) { }
28 29

  @override
30
  void removeStatusListener(AnimationStatusListener listener) { }
31 32

  @override
33
  AnimationStatus get status => AnimationStatus.completed;
34 35

  @override
36
  double get value => 1.0;
37 38 39

  @override
  String toString() => 'kAlwaysCompleteAnimation';
40 41
}

42 43 44 45 46
/// An animation that is always complete.
///
/// Using this constant involves less overhead than building an
/// [AnimationController] with an initial value of 1.0. This is useful when an
/// API expects an animation but you don't actually want to animate anything.
47
const Animation<double> kAlwaysCompleteAnimation = _AlwaysCompleteAnimation();
48

49 50
class _AlwaysDismissedAnimation extends Animation<double> {
  const _AlwaysDismissedAnimation();
51

52
  @override
53
  void addListener(VoidCallback listener) { }
54 55

  @override
56
  void removeListener(VoidCallback listener) { }
57 58

  @override
59
  void addStatusListener(AnimationStatusListener listener) { }
60 61

  @override
62
  void removeStatusListener(AnimationStatusListener listener) { }
63 64

  @override
65
  AnimationStatus get status => AnimationStatus.dismissed;
66 67

  @override
68
  double get value => 0.0;
69 70 71

  @override
  String toString() => 'kAlwaysDismissedAnimation';
72 73
}

74 75 76 77 78
/// An animation that is always dismissed.
///
/// Using this constant involves less overhead than building an
/// [AnimationController] with an initial value of 0.0. This is useful when an
/// API expects an animation but you don't actually want to animate anything.
79
const Animation<double> kAlwaysDismissedAnimation = _AlwaysDismissedAnimation();
80

81
/// An animation that is always stopped at a given value.
82 83
///
/// The [status] is always [AnimationStatus.forward].
84
class AlwaysStoppedAnimation<T> extends Animation<T> {
85 86 87
  /// Creates an [AlwaysStoppedAnimation] with the given value.
  ///
  /// Since the [value] and [status] of an [AlwaysStoppedAnimation] can never
88
  /// change, the listeners can never be called. It is therefore safe to reuse
89
  /// an [AlwaysStoppedAnimation] instance in multiple places. If the [value] to
90
  /// be used is known at compile time, the constructor should be called as a
91
  /// `const` constructor.
92 93
  const AlwaysStoppedAnimation(this.value);

94
  @override
95
  final T value;
96

97
  @override
98
  void addListener(VoidCallback listener) { }
99 100

  @override
101
  void removeListener(VoidCallback listener) { }
102 103

  @override
104
  void addStatusListener(AnimationStatusListener listener) { }
105 106

  @override
107
  void removeStatusListener(AnimationStatusListener listener) { }
108 109

  @override
110
  AnimationStatus get status => AnimationStatus.forward;
111 112 113 114 115

  @override
  String toStringDetails() {
    return '${super.toStringDetails()} $value; paused';
  }
116 117
}

118 119 120 121 122 123 124 125
/// Implements most of the [Animation] interface by deferring its behavior to a
/// given [parent] Animation.
///
/// To implement an [Animation] that is driven by a parent, it is only necessary
/// to mix in this class, implement [parent], and implement `T get value`.
///
/// To define a mapping from values in the range 0..1, consider subclassing
/// [Tween] instead.
126
mixin AnimationWithParentMixin<T> {
127 128 129
  /// The animation whose value this animation will proxy.
  ///
  /// This animation must remain the same for the lifetime of this object. If
130
  /// you wish to proxy a different animation at different times, consider using
131 132
  /// [ProxyAnimation].
  Animation<T> get parent;
133

134 135 136
  // keep these next five dartdocs in sync with the dartdocs in Animation<T>

  /// Calls the listener every time the value of the animation changes.
137 138
  ///
  /// Listeners can be removed with [removeListener].
139
  void addListener(VoidCallback listener) => parent.addListener(listener);
140 141

  /// Stop calling the listener every time the value of the animation changes.
142 143
  ///
  /// Listeners can be added with [addListener].
144
  void removeListener(VoidCallback listener) => parent.removeListener(listener);
145 146

  /// Calls listener every time the status of the animation changes.
147 148
  ///
  /// Listeners can be removed with [removeStatusListener].
149
  void addStatusListener(AnimationStatusListener listener) => parent.addStatusListener(listener);
150 151

  /// Stops calling the listener every time the status of the animation changes.
152 153
  ///
  /// Listeners can be added with [addStatusListener].
154 155
  void removeStatusListener(AnimationStatusListener listener) => parent.removeStatusListener(listener);

156
  /// The current status of this animation.
157 158 159
  AnimationStatus get status => parent.status;
}

160 161 162 163
/// An animation that is a proxy for another animation.
///
/// A proxy animation is useful because the parent animation can be mutated. For
/// example, one object can create a proxy animation, hand the proxy to another
164
/// object, and then later change the animation from which the proxy receives
165
/// its value.
166
class ProxyAnimation extends Animation<double>
167
  with AnimationLazyListenerMixin, AnimationLocalListenersMixin, AnimationLocalStatusListenersMixin {
168 169 170 171 172

  /// Creates a proxy animation.
  ///
  /// If the animation argument is omitted, the proxy animation will have the
  /// status [AnimationStatus.dismissed] and a value of 0.0.
173
  ProxyAnimation([Animation<double>? animation]) {
174 175
    _parent = animation;
    if (_parent == null) {
176
      _status = AnimationStatus.dismissed;
177 178 179 180
      _value = 0.0;
    }
  }

181 182
  AnimationStatus? _status;
  double? _value;
183

184 185 186 187
  /// The animation whose value this animation will proxy.
  ///
  /// This value is mutable. When mutated, the listeners on the proxy animation
  /// will be transparently updated to be listening to the new parent animation.
188 189 190
  Animation<double>? get parent => _parent;
  Animation<double>? _parent;
  set parent(Animation<double>? value) {
191
    if (value == _parent) {
192
      return;
193
    }
194
    if (_parent != null) {
195 196
      _status = _parent!.status;
      _value = _parent!.value;
197
      if (isListening) {
198
        didStopListening();
199
      }
200
    }
201 202
    _parent = value;
    if (_parent != null) {
203
      if (isListening) {
204
        didStartListening();
205 206
      }
      if (_value != _parent!.value) {
207
        notifyListeners();
208 209
      }
      if (_status != _parent!.status) {
210
        notifyStatusListeners(_parent!.status);
211
      }
212 213 214 215 216
      _status = null;
      _value = null;
    }
  }

217
  @override
218
  void didStartListening() {
219
    if (_parent != null) {
220 221
      _parent!.addListener(notifyListeners);
      _parent!.addStatusListener(notifyStatusListeners);
222 223 224
    }
  }

225
  @override
226
  void didStopListening() {
227
    if (_parent != null) {
228 229
      _parent!.removeListener(notifyListeners);
      _parent!.removeStatusListener(notifyStatusListeners);
230 231 232
    }
  }

233
  @override
234
  AnimationStatus get status => _parent != null ? _parent!.status : _status!;
235 236

  @override
237
  double get value => _parent != null ? _parent!.value : _value!;
238 239 240

  @override
  String toString() {
241
    if (parent == null) {
242
      return '${objectRuntimeType(this, 'ProxyAnimation')}(null; ${super.toStringDetails()} ${value.toStringAsFixed(3)})';
243
    }
244
    return '$parent\u27A9${objectRuntimeType(this, 'ProxyAnimation')}';
245
  }
246 247
}

248 249 250
/// An animation that is the reverse of another animation.
///
/// If the parent animation is running forward from 0.0 to 1.0, this animation
251 252 253 254 255
/// is running in reverse from 1.0 to 0.0.
///
/// Using a [ReverseAnimation] is different from simply using a [Tween] with a
/// begin of 1.0 and an end of 0.0 because the tween does not change the status
/// or direction of the animation.
256 257 258 259 260 261 262
///
/// See also:
///
///  * [Curve.flipped] and [FlippedCurve], which provide a similar effect but on
///    [Curve]s.
///  * [CurvedAnimation], which can take separate curves for when the animation
///    is going forward than for when it is going in reverse.
263
class ReverseAnimation extends Animation<double>
264
  with AnimationLazyListenerMixin, AnimationLocalStatusListenersMixin {
265 266 267 268

  /// Creates a reverse animation.
  ///
  /// The parent argument must not be null.
269 270
  ReverseAnimation(this.parent)
    : assert(parent != null);
271

272
  /// The animation whose value and direction this animation is reversing.
273
  final Animation<double> parent;
274

275
  @override
276 277
  void addListener(VoidCallback listener) {
    didRegisterListener();
278
    parent.addListener(listener);
279
  }
280 281

  @override
282
  void removeListener(VoidCallback listener) {
283
    parent.removeListener(listener);
284 285 286
    didUnregisterListener();
  }

287
  @override
288
  void didStartListening() {
289
    parent.addStatusListener(_statusChangeHandler);
290 291
  }

292
  @override
293
  void didStopListening() {
294
    parent.removeStatusListener(_statusChangeHandler);
295 296
  }

297
  void _statusChangeHandler(AnimationStatus status) {
298 299 300
    notifyStatusListeners(_reverseStatus(status));
  }

301
  @override
302
  AnimationStatus get status => _reverseStatus(parent.status);
303 304

  @override
305
  double get value => 1.0 - parent.value;
306

307
  AnimationStatus _reverseStatus(AnimationStatus status) {
308
    assert(status != null);
309
    switch (status) {
310 311 312 313
      case AnimationStatus.forward: return AnimationStatus.reverse;
      case AnimationStatus.reverse: return AnimationStatus.forward;
      case AnimationStatus.completed: return AnimationStatus.dismissed;
      case AnimationStatus.dismissed: return AnimationStatus.completed;
314 315
    }
  }
316 317 318

  @override
  String toString() {
319
    return '$parent\u27AA${objectRuntimeType(this, 'ReverseAnimation')}';
320
  }
321 322
}

323 324
/// An animation that applies a curve to another animation.
///
325
/// [CurvedAnimation] is useful when you want to apply a non-linear [Curve] to
326 327
/// an animation object, especially if you want different curves when the
/// animation is going forward vs when it is going backward.
328
///
329 330 331 332
/// Depending on the given curve, the output of the [CurvedAnimation] could have
/// a wider range than its input. For example, elastic curves such as
/// [Curves.elasticIn] will significantly overshoot or undershoot the default
/// range of 0.0 to 1.0.
333 334
///
/// If you want to apply a [Curve] to a [Tween], consider using [CurveTween].
335
///
336
/// {@tool snippet}
337 338 339 340 341 342 343 344 345 346
///
/// The following code snippet shows how you can apply a curve to a linear
/// animation produced by an [AnimationController] `controller`.
///
/// ```dart
/// final Animation<double> animation = CurvedAnimation(
///   parent: controller,
///   curve: Curves.ease,
/// );
/// ```
347
/// {@end-tool}
348
/// {@tool snippet}
349 350 351 352 353 354 355 356 357 358 359 360 361
///
/// This second code snippet shows how to apply a different curve in the forward
/// direction than in the reverse direction. This can't be done using a
/// [CurveTween] (since [Tween]s are not aware of the animation direction when
/// they are applied).
///
/// ```dart
/// final Animation<double> animation = CurvedAnimation(
///   parent: controller,
///   curve: Curves.easeIn,
///   reverseCurve: Curves.easeOut,
/// );
/// ```
362
/// {@end-tool}
363 364 365 366 367 368 369 370 371 372 373
///
/// By default, the [reverseCurve] matches the forward [curve].
///
/// See also:
///
///  * [CurveTween], for an alternative way of expressing the first sample
///    above.
///  * [AnimationController], for examples of creating and disposing of an
///    [AnimationController].
///  * [Curve.flipped] and [FlippedCurve], which provide the reverse of a
///    [Curve].
374
class CurvedAnimation extends Animation<double> with AnimationWithParentMixin<double> {
375 376 377
  /// Creates a curved animation.
  ///
  /// The parent and curve arguments must not be null.
378
  CurvedAnimation({
379 380
    required this.parent,
    required this.curve,
381
    this.reverseCurve,
382 383
  }) : assert(parent != null),
       assert(curve != null) {
384 385
    _updateCurveDirection(parent.status);
    parent.addStatusListener(_updateCurveDirection);
386 387
  }

388
  /// The animation to which this animation applies a curve.
389
  @override
390 391 392 393 394 395 396
  final Animation<double> parent;

  /// The curve to use in the forward direction.
  Curve curve;

  /// The curve to use in the reverse direction.
  ///
397 398 399 400 401 402 403 404 405 406
  /// If the parent animation changes direction without first reaching the
  /// [AnimationStatus.completed] or [AnimationStatus.dismissed] status, the
  /// [CurvedAnimation] stays on the same curve (albeit in the opposite
  /// direction) to avoid visual discontinuities.
  ///
  /// If you use a non-null [reverseCurve], you might want to hold this object
  /// in a [State] object rather than recreating it each time your widget builds
  /// in order to take advantage of the state in this object that avoids visual
  /// discontinuities.
  ///
407
  /// If this field is null, uses [curve] in both directions.
408
  Curve? reverseCurve;
409 410 411 412 413

  /// The direction used to select the current curve.
  ///
  /// The curve direction is only reset when we hit the beginning or the end of
  /// the timeline to avoid discontinuities in the value of any variables this
414
  /// animation is used to animate.
415
  AnimationStatus? _curveDirection;
416

417 418 419
  /// True if this CurvedAnimation has been disposed.
  bool isDisposed = false;

420
  void _updateCurveDirection(AnimationStatus status) {
421 422 423 424 425 426
    switch (status) {
      case AnimationStatus.dismissed:
      case AnimationStatus.completed:
        _curveDirection = null;
        break;
      case AnimationStatus.forward:
Adam Barth's avatar
Adam Barth committed
427
        _curveDirection ??= AnimationStatus.forward;
428 429
        break;
      case AnimationStatus.reverse:
Adam Barth's avatar
Adam Barth committed
430
        _curveDirection ??= AnimationStatus.reverse;
431 432 433 434
        break;
    }
  }

435 436 437 438
  bool get _useForwardCurve {
    return reverseCurve == null || (_curveDirection ?? parent.status) != AnimationStatus.reverse;
  }

439 440 441 442 443 444
  /// Cleans up any listeners added by this CurvedAnimation.
  void dispose() {
    isDisposed = true;
    parent.removeStatusListener(_updateCurveDirection);
  }

445
  @override
446
  double get value {
447
    final Curve? activeCurve = _useForwardCurve ? curve : reverseCurve;
448

449
    final double t = parent.value;
450
    if (activeCurve == null) {
451
      return t;
452
    }
453
    if (t == 0.0 || t == 1.0) {
454 455 456 457
      assert(() {
        final double transformedValue = activeCurve.transform(t);
        final double roundedTransformedValue = transformedValue.round().toDouble();
        if (roundedTransformedValue != t) {
458 459 460 461
          throw FlutterError(
            'Invalid curve endpoint at $t.\n'
            'Curves must map 0.0 to near zero and 1.0 to near one but '
            '${activeCurve.runtimeType} mapped $t to $transformedValue, which '
462
            'is near $roundedTransformedValue.',
463
          );
464 465
        }
        return true;
466
      }());
467 468 469 470
      return t;
    }
    return activeCurve.transform(t);
  }
471 472 473

  @override
  String toString() {
474
    if (reverseCurve == null) {
475
      return '$parent\u27A9$curve';
476 477
    }
    if (_useForwardCurve) {
478
      return '$parent\u27A9$curve\u2092\u2099/$reverseCurve';
479
    }
480 481
    return '$parent\u27A9$curve/$reverseCurve\u2092\u2099';
  }
482 483
}

484 485
enum _TrainHoppingMode { minimize, maximize }

486 487
/// This animation starts by proxying one animation, but when the value of that
/// animation crosses the value of the second (either because the second is
488
/// going in the opposite direction, or because the one overtakes the other),
489 490 491 492 493 494 495 496 497 498
/// the animation hops over to proxying the second animation.
///
/// When the [TrainHoppingAnimation] starts proxying the second animation
/// instead of the first, the [onSwitchedTrain] callback is called.
///
/// If the two animations start at the same value, then the
/// [TrainHoppingAnimation] immediately hops to the second animation, and the
/// [onSwitchedTrain] callback is not called. If only one animation is provided
/// (i.e. if the second is null), then the [TrainHoppingAnimation] just proxies
/// the first animation.
499 500 501 502 503
///
/// Since this object must track the two animations even when it has no
/// listeners of its own, instead of shutting down when all its listeners are
/// removed, it exposes a [dispose()] method. Call this method to shut this
/// object down.
504
class TrainHoppingAnimation extends Animation<double>
505
  with AnimationEagerListenerMixin, AnimationLocalListenersMixin, AnimationLocalStatusListenersMixin {
506 507 508 509

  /// Creates a train-hopping animation.
  ///
  /// The current train argument must not be null but the next train argument
510 511
  /// can be null. If the next train is null, then this object will just proxy
  /// the first animation and never hop.
512 513 514 515 516
  TrainHoppingAnimation(
    Animation<double> this._currentTrain,
    this._nextTrain, {
    this.onSwitchedTrain,
  }) : assert(_currentTrain != null) {
517
    if (_nextTrain != null) {
518
      if (_currentTrain!.value == _nextTrain!.value) {
519
        _currentTrain = _nextTrain;
520
        _nextTrain = null;
521
      } else if (_currentTrain!.value > _nextTrain!.value) {
522 523
        _mode = _TrainHoppingMode.maximize;
      } else {
524
        assert(_currentTrain!.value < _nextTrain!.value);
525 526 527
        _mode = _TrainHoppingMode.minimize;
      }
    }
528 529
    _currentTrain!.addStatusListener(_statusChangeHandler);
    _currentTrain!.addListener(_valueChangeHandler);
530
    _nextTrain?.addListener(_valueChangeHandler);
531
    assert(_mode != null || _nextTrain == null);
532 533
  }

534 535 536 537
  /// The animation that is currently driving this animation.
  ///
  /// The identity of this object will change from the first animation to the
  /// second animation when [onSwitchedTrain] is called.
538 539 540 541
  Animation<double>? get currentTrain => _currentTrain;
  Animation<double>? _currentTrain;
  Animation<double>? _nextTrain;
  _TrainHoppingMode? _mode;
542

543 544 545 546 547
  /// Called when this animation switches to be driven by the second animation.
  ///
  /// This is not called if the two animations provided to the constructor have
  /// the same value at the time of the call to the constructor. In that case,
  /// the second animation is used from the start, and the first is ignored.
548
  VoidCallback? onSwitchedTrain;
549

550
  AnimationStatus? _lastStatus;
551
  void _statusChangeHandler(AnimationStatus status) {
552 553 554 555 556 557 558 559
    assert(_currentTrain != null);
    if (status != _lastStatus) {
      notifyListeners();
      _lastStatus = status;
    }
    assert(_lastStatus != null);
  }

560
  @override
561
  AnimationStatus get status => _currentTrain!.status;
562

563
  double? _lastValue;
564 565 566 567
  void _valueChangeHandler() {
    assert(_currentTrain != null);
    bool hop = false;
    if (_nextTrain != null) {
568
      assert(_mode != null);
569
      switch (_mode!) {
570
        case _TrainHoppingMode.minimize:
571
          hop = _nextTrain!.value <= _currentTrain!.value;
572 573
          break;
        case _TrainHoppingMode.maximize:
574
          hop = _nextTrain!.value >= _currentTrain!.value;
575 576 577
          break;
      }
      if (hop) {
578
        _currentTrain!
579 580
          ..removeStatusListener(_statusChangeHandler)
          ..removeListener(_valueChangeHandler);
581
        _currentTrain = _nextTrain;
582
        _nextTrain = null;
583 584
        _currentTrain!.addStatusListener(_statusChangeHandler);
        _statusChangeHandler(_currentTrain!.status);
585 586
      }
    }
587
    final double newValue = value;
588 589 590 591 592
    if (newValue != _lastValue) {
      notifyListeners();
      _lastValue = newValue;
    }
    assert(_lastValue != null);
593
    if (hop && onSwitchedTrain != null) {
594
      onSwitchedTrain!();
595
    }
596 597
  }

598
  @override
599
  double get value => _currentTrain!.value;
600 601 602

  /// Frees all the resources used by this performance.
  /// After this is called, this object is no longer usable.
603
  @override
604 605
  void dispose() {
    assert(_currentTrain != null);
606 607
    _currentTrain!.removeStatusListener(_statusChangeHandler);
    _currentTrain!.removeListener(_valueChangeHandler);
608
    _currentTrain = null;
609 610
    _nextTrain?.removeListener(_valueChangeHandler);
    _nextTrain = null;
611 612
    clearListeners();
    clearStatusListeners();
613
    super.dispose();
614
  }
615 616 617

  @override
  String toString() {
618
    if (_nextTrain != null) {
619
      return '$currentTrain\u27A9${objectRuntimeType(this, 'TrainHoppingAnimation')}(next: $_nextTrain)';
620
    }
621
    return '$currentTrain\u27A9${objectRuntimeType(this, 'TrainHoppingAnimation')}(no next)';
622
  }
623
}
624 625 626 627 628 629 630

/// An interface for combining multiple Animations. Subclasses need only
/// implement the `value` getter to control how the child animations are
/// combined. Can be chained to combine more than 2 animations.
///
/// For example, to create an animation that is the sum of two others, subclass
/// this class and define `T get value = first.value + second.value;`
631 632 633
///
/// By default, the [status] of a [CompoundAnimation] is the status of the
/// [next] animation if [next] is moving, and the status of the [first]
634
/// animation otherwise.
635 636 637 638 639
abstract class CompoundAnimation<T> extends Animation<T>
  with AnimationLazyListenerMixin, AnimationLocalListenersMixin, AnimationLocalStatusListenersMixin {
  /// Creates a CompoundAnimation. Both arguments must be non-null. Either can
  /// be a CompoundAnimation itself to combine multiple animations.
  CompoundAnimation({
640 641
    required this.first,
    required this.next,
642 643
  }) : assert(first != null),
       assert(next != null);
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667

  /// The first sub-animation. Its status takes precedence if neither are
  /// animating.
  final Animation<T> first;

  /// The second sub-animation.
  final Animation<T> next;

  @override
  void didStartListening() {
    first.addListener(_maybeNotifyListeners);
    first.addStatusListener(_maybeNotifyStatusListeners);
    next.addListener(_maybeNotifyListeners);
    next.addStatusListener(_maybeNotifyStatusListeners);
  }

  @override
  void didStopListening() {
    first.removeListener(_maybeNotifyListeners);
    first.removeStatusListener(_maybeNotifyStatusListeners);
    next.removeListener(_maybeNotifyListeners);
    next.removeStatusListener(_maybeNotifyStatusListeners);
  }

668
  /// Gets the status of this animation based on the [first] and [next] status.
669
  ///
670 671
  /// The default is that if the [next] animation is moving, use its status.
  /// Otherwise, default to [first].
672 673
  @override
  AnimationStatus get status {
674
    if (next.status == AnimationStatus.forward || next.status == AnimationStatus.reverse) {
675
      return next.status;
676
    }
677 678 679 680 681
    return first.status;
  }

  @override
  String toString() {
682
    return '${objectRuntimeType(this, 'CompoundAnimation')}($first, $next)';
683 684
  }

685
  AnimationStatus? _lastStatus;
686
  void _maybeNotifyStatusListeners(AnimationStatus _) {
687 688 689
    if (status != _lastStatus) {
      _lastStatus = status;
      notifyStatusListeners(status);
690 691 692
    }
  }

693
  T? _lastValue;
694
  void _maybeNotifyListeners() {
695 696
    if (value != _lastValue) {
      _lastValue = value;
697 698 699 700
      notifyListeners();
    }
  }
}
701 702 703 704 705 706 707 708 709 710 711

/// An animation of [double]s that tracks the mean of two other animations.
///
/// The [status] of this animation is the status of the `right` animation if it is
/// moving, and the `left` animation otherwise.
///
/// The [value] of this animation is the [double] that represents the mean value
/// of the values of the `left` and `right` animations.
class AnimationMean extends CompoundAnimation<double> {
  /// Creates an animation that tracks the mean of two other animations.
  AnimationMean({
712 713
    required Animation<double> left,
    required Animation<double> right,
714 715 716 717 718
  }) : super(first: left, next: right);

  @override
  double get value => (first.value + next.value) / 2.0;
}
719 720 721

/// An animation that tracks the maximum of two other animations.
///
722
/// The [value] of this animation is the maximum of the values of
723 724
/// [first] and [next].
class AnimationMax<T extends num> extends CompoundAnimation<T> {
725 726 727 728
  /// Creates an [AnimationMax].
  ///
  /// Both arguments must be non-null. Either can be an [AnimationMax] itself
  /// to combine multiple animations.
729
  AnimationMax(Animation<T> first, Animation<T> next) : super(first: first, next: next);
730 731 732 733 734 735 736

  @override
  T get value => math.max(first.value, next.value);
}

/// An animation that tracks the minimum of two other animations.
///
737
/// The [value] of this animation is the maximum of the values of
738 739
/// [first] and [next].
class AnimationMin<T extends num> extends CompoundAnimation<T> {
740 741 742 743
  /// Creates an [AnimationMin].
  ///
  /// Both arguments must be non-null. Either can be an [AnimationMin] itself
  /// to combine multiple animations.
744
  AnimationMin(Animation<T> first, Animation<T> next) : super(first: first, next: next);
745 746 747

  @override
  T get value => math.min(first.value, next.value);
748
}