Effect controllers restructuring

examples/lib/stories/camera_and_viewport/follow_component_example.dart

@@ -188,7 +188,7 @@ class Rock extends SpriteComponent
  add(
  ScaleEffect.by(
  Vector2.all(10),
- StandardEffectController(duration: 0.3),
+ EffectController(duration: 0.3),
  ),
  );
  return true;

examples/lib/stories/collision_detection/simple_shapes_example.dart

@@ -65,7 +65,7 @@ class SimpleShapesExample extends FlameGame with HasTappables {
  component.add(
  MoveEffect.to(
  size / 2,
- StandardEffectController(
+ EffectController(
  duration: 5,
  reverseDuration: 5,
  infinite: true,
@@ -75,7 +75,7 @@ class SimpleShapesExample extends FlameGame with HasTappables {
  component.add(
  RotateEffect.to(
  3,
- StandardEffectController(
+ EffectController(
  duration: 1,
  reverseDuration: 1,
  infinite: true,

examples/lib/stories/effects/move_effect_example.dart

@@ -40,7 +40,7 @@ class MoveEffectExample extends FlameGame {
  )..add(
  MoveEffect.to(
  Vector2(380, 50),
- StandardEffectController(
+ EffectController(
  duration: 3,
  reverseDuration: 3,
  infinite: true,
@@ -58,7 +58,7 @@ class MoveEffectExample extends FlameGame {
  ..add(
  MoveEffect.to(
  Vector2(380, 150),
- StandardEffectController(
+ EffectController(
  duration: 3,
  reverseDuration: 3,
  infinite: true,
@@ -68,7 +68,7 @@ class MoveEffectExample extends FlameGame {
  ..add(
  MoveEffect.by(
  Vector2(0, -50),
- StandardEffectController(
+ EffectController(
  duration: 0.25,
  reverseDuration: 0.25,
  startDelay: 1,
@@ -92,7 +92,7 @@ class MoveEffectExample extends FlameGame {
  ..add(
  MoveEffect.along(
  path1,
- StandardEffectController(
+ EffectController(
  duration: 10,
  startDelay: i * 0.2,
  infinite: true,
@@ -110,7 +110,7 @@ class MoveEffectExample extends FlameGame {
  ..add(
  MoveEffect.along(
  path2,
- StandardEffectController(
+ EffectController(
  duration: 6,
  startDelay: i * 0.3,
  infinite: true,

examples/lib/stories/effects/opacity_effect_example.dart

@@ -2,7 +2,6 @@ import 'package:flame/components.dart';
 import 'package:flame/effects.dart';
 import 'package:flame/game.dart';
 import 'package:flame/input.dart';
-
 import '../../commons/ember.dart';
 
 class OpacityEffectExample extends FlameGame with TapDetector {
@@ -32,7 +31,7 @@ class OpacityEffectExample extends FlameGame with TapDetector {
  size: Vector2.all(100),
  )..add(
  OpacityEffect.fadeOut(
- StandardEffectController(
+ EffectController(
  duration: 1.5,
  reverseDuration: 1.5,
  infinite: true,
@@ -46,9 +45,9 @@ class OpacityEffectExample extends FlameGame with TapDetector {
  void onTap() {
  final opacity = sprite.paint.color.opacity;
  if (opacity >= 0.5) {
- sprite.add(OpacityEffect.fadeOut(StandardEffectController(duration: 1)));
+ sprite.add(OpacityEffect.fadeOut(EffectController(duration: 1)));
  } else {
- sprite.add(OpacityEffect.fadeIn(StandardEffectController(duration: 1)));
+ sprite.add(OpacityEffect.fadeIn(EffectController(duration: 1)));
  }
  }
 }

examples/lib/stories/effects/rotate_effect_example.dart

@@ -25,7 +25,7 @@ class RotateEffectExample extends FlameGame {
  compass.rim.add(
  RotateEffect.by(
  1.0,
- StandardEffectController(
+ EffectController(
  duration: 6,
  reverseDuration: 3,
  curve: Curves.ease,
@@ -37,7 +37,7 @@ class RotateEffectExample extends FlameGame {
  ..add(
  RotateEffect.to(
  Transform2D.tau,
- StandardEffectController(
+ EffectController(
  duration: 20,
  infinite: true,
  ),
@@ -46,7 +46,7 @@ class RotateEffectExample extends FlameGame {
  ..add(
  RotateEffect.by(
  Transform2D.tau * 0.015,
- StandardEffectController(
+ EffectController(
  duration: 0.1,
  reverseDuration: 0.1,
  infinite: true,
@@ -56,7 +56,7 @@ class RotateEffectExample extends FlameGame {
  ..add(
  RotateEffect.by(
  Transform2D.tau * 0.021,
- StandardEffectController(
+ EffectController(
  duration: 0.13,
  reverseDuration: 0.13,
  infinite: true,

examples/lib/stories/effects/scale_effect_example.dart

@@ -42,7 +42,7 @@ class ScaleEffectExample extends FlameGame with TapDetector {
  square.add(
  ScaleEffect.to(
  Vector2.all(s),
- StandardEffectController(
+ EffectController(
  duration: 1.5,
  curve: Curves.bounceInOut,
  ),

examples/lib/stories/effects/size_effect_example.dart

@@ -1,10 +1,12 @@
+import 'dart:ui';
+
 import 'package:flame/components.dart';
 import 'package:flame/effects.dart';
 import 'package:flame/extensions.dart';
 import 'package:flame/game.dart';
 import 'package:flame/input.dart';
 import 'package:flame/palette.dart';
-import 'package:flutter/material.dart';
+import 'package:flutter/animation.dart';
 
 class SizeEffectExample extends FlameGame with TapDetector {
  static const String description = '''
@@ -42,10 +44,7 @@ class SizeEffectExample extends FlameGame with TapDetector {
  square.add(
  SizeEffect.to(
  Vector2.all(s),
- StandardEffectController(
- duration: 1.5,
- curve: Curves.bounceInOut,
- ),
+ EffectController(duration: 1.5, curve: Curves.bounceInOut),
  ),
  );
  }

examples/lib/stories/input/joystick_advanced_example.dart

@@ -105,7 +105,7 @@ class JoystickAdvancedExample extends FlameGame
  onPressed: () => player.add(
  RotateEffect.by(
  8 * rng.nextDouble(),
- StandardEffectController(
+ EffectController(
  duration: 1,
  reverseDuration: 1,
  curve: Curves.bounceOut,
@@ -131,7 +131,7 @@ class JoystickAdvancedExample extends FlameGame
  onPressed: () => player.add(
  ScaleEffect.by(
  Vector2.all(1.5),
- StandardEffectController(duration: 1.0, reverseDuration: 1.0),
+ EffectController(duration: 1.0, reverseDuration: 1.0),
  ),
  ),
  );
@@ -152,7 +152,7 @@ class JoystickAdvancedExample extends FlameGame
  size: Vector2(185, 50),
  onPressed: () => player.add(
  OpacityEffect.fadeOut(
- StandardEffectController(duration: 0.5, reverseDuration: 0.5),
+ EffectController(duration: 0.5, reverseDuration: 0.5),
  ),
  ),
  );

packages/flame/CHANGELOG.md

@@ -3,10 +3,12 @@
 ## [Next]
  - Add `ButtonComponent` backed by two `PositionComponent`s
  - Add `SpriteButtonComponent` backed by two `Sprite`s
+ - Allow more flexible construction of `EffectController`s and make them able to run back in time
  - Remove old effects system
  - Export new effects system
  - Introduce `updateTree` to follow the `renderTree` convention
  - Fix `Parallax.load` with different loading times
+ - Fix render order of components and add tests
  - `isHud` renamed to `respectCamera`
 
 ## [1.0.0-releasecandidate.18]
@@ -15,7 +17,6 @@
  - Fixed position calculation in `HudMarginComponent` when using a viewport
  - Add noClip option to `FixedResolutionViewport`
  - Add a few missing helpers to SpriteAnimation
- - Fix render order of components and add tests
 
 ## [1.0.0-releasecandidate.17]
  - Added `StandardEffectController` class

packages/flame/lib/effects.dart

@@ -1,13 +1,21 @@
 export 'src/effects/component_effect.dart';
+export 'src/effects/controllers/curved_effect_controller.dart';
+export 'src/effects/controllers/delayed_effect_controller.dart';
+export 'src/effects/controllers/duration_effect_controller.dart';
+export 'src/effects/controllers/effect_controller.dart';
+export 'src/effects/controllers/infinite_effect_controller.dart';
+export 'src/effects/controllers/linear_effect_controller.dart';
+export 'src/effects/controllers/pause_effect_controller.dart';
+export 'src/effects/controllers/repeated_effect_controller.dart';
+export 'src/effects/controllers/reverse_curved_effect_controller.dart';
+export 'src/effects/controllers/reverse_linear_effect_controller.dart';
+export 'src/effects/controllers/sequence_effect_controller.dart';
 export 'src/effects/effect.dart';
-export 'src/effects/effect_controller.dart';
 export 'src/effects/move_effect.dart';
 export 'src/effects/opacity_effect.dart';
 export 'src/effects/remove_effect.dart';
 export 'src/effects/rotate_effect.dart';
 export 'src/effects/scale_effect.dart';
-export 'src/effects/simple_effect_controller.dart';
 export 'src/effects/size_effect.dart';
-export 'src/effects/standard_effect_controller.dart';
 export 'src/effects/transform2d_effect.dart';
 export 'src/extensions/vector2.dart';

packages/flame/lib/src/effects/component_effect.dart

@@ -1,8 +1,8 @@
 import 'package:flutter/cupertino.dart';
 
 import '../../components.dart';
+import 'controllers/effect_controller.dart';
 import 'effect.dart';
-import 'effect_controller.dart';
 
 /// Base class for effects that target a [Component] of type [T].
 ///

packages/flame/lib/src/effects/controllers/curved_effect_controller.dart

@@ -0,0 +1,18 @@
+import 'package:flutter/animation.dart';
+
+import 'duration_effect_controller.dart';
+
+/// A controller that grows non-linearly from 0 to 1 following the provided
+/// [curve]. The [duration] cannot be 0.
+class CurvedEffectController extends DurationEffectController {
+ CurvedEffectController(double duration, Curve curve)
+ : assert(duration > 0, 'Duration must be positive: $duration'),
+ _curve = curve,
+ super(duration);
+
+ Curve get curve => _curve;
+ final Curve _curve;
+
+ @override
+ double get progress => _curve.transform(timer / duration);
+}

packages/flame/lib/src/effects/controllers/delayed_effect_controller.dart

@@ -0,0 +1,77 @@
+import 'effect_controller.dart';
+
+/// An effect controller that waits for [delay] seconds before running the
+/// child controller. While waiting, the progress will be reported at 0.
+class DelayedEffectController extends EffectController {
+ DelayedEffectController(EffectController child, {required this.delay})
+ : assert(delay >= 0, 'Delay must be non-negative: $delay'),
+ _child = child,
+ _timer = 0,
+ super.empty();
+
+ final EffectController _child;
+ final double delay;
+ double _timer;
+
+ @override
+ bool get isInfinite => _child.isInfinite;
+
+ @override
+ bool get isRandom => _child.isRandom;
+
+ @override
+ bool get started => _timer == delay;
+
+ @override
+ bool get completed => started && _child.completed;
+
+ @override
+ double get progress => started ? _child.progress : 0;
+
+ @override
+ double? get duration {
+ final d = _child.duration;
+ return d == null ? null : d + delay;
+ }
+
+ @override
+ double advance(double dt) {
+ if (_timer == delay) {
+ return _child.advance(dt);
+ }
+ _timer += dt;
+ if (_timer > delay) {
+ final t = _child.advance(_timer - delay);
+ _timer = delay;
+ return t;
+ } else {
+ return 0;
+ }
+ }
+
+ @override
+ double recede(double dt) {
+ if (_timer == delay) {
+ _timer -= _child.recede(dt);
+ } else {
+ _timer -= dt;
+ }
+ if (_timer < 0) {
+ final leftoverTime = -_timer;
+ _timer = 0;
+ return leftoverTime;
+ }
+ return 0;
+ }
+
+ @override
+ void setToStart() {
+ _timer = 0;
+ }
+
+ @override
+ void setToEnd() {
+ _timer = delay;
+ _child.setToEnd();
+ }
+}