feat: make AnimatableRenderObjectWidget work with InheritedWidgets (

#45)
blaugold · May 23, 2023 · 677060d · 677060d
1 parent fd94936
commit 677060d
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 13 deletions.
diff --git a/packages/fleet/lib/src/animatable_flutter_widgets.dart b/packages/fleet/lib/src/animatable_flutter_widgets.dart
@@ -33,6 +33,7 @@ class AAlign extends Align
 
   @override
   _AlignAnimatableParameters createAnimatableParameters(
+    covariant RenderPositionedBox renderObject,
     AnimatableParameterHost host,
   ) {
     return (
@@ -43,7 +44,10 @@ class AAlign extends Align
   }
 
   @override
-  void updateAnimatableParameters(_AlignAnimatableParameters parameters) {
+  void updateAnimatableParameters(
+    BuildContext context,
+    _AlignAnimatableParameters parameters,
+  ) {
     parameters
       ..alignment.value = alignment
       ..widthFactor.value = widthFactor
@@ -242,13 +246,17 @@ class AOpacity extends Opacity
 
   @override
   _OpacityAnimatableParameters createAnimatableParameters(
+    covariant RenderOpacity renderObject,
     AnimatableParameterHost host,
   ) {
     return (opacity: AnimatableDouble(opacity, host: host));
   }
 
   @override
-  void updateAnimatableParameters(_OpacityAnimatableParameters parameters) {
+  void updateAnimatableParameters(
+    BuildContext context,
+    _OpacityAnimatableParameters parameters,
+  ) {
     parameters.opacity.value = opacity;
   }
 
@@ -277,13 +285,17 @@ class APadding extends Padding
 
   @override
   _PaddingAnimatableParameters createAnimatableParameters(
+    covariant RenderPadding renderObject,
     AnimatableParameterHost host,
   ) {
     return (padding: AnimatableEdgeInsetsGeometry(padding, host: host),);
   }
 
   @override
-  void updateAnimatableParameters(_PaddingAnimatableParameters parameters) {
+  void updateAnimatableParameters(
+    BuildContext context,
+    _PaddingAnimatableParameters parameters,
+  ) {
     parameters.padding.value = padding;
   }
 
@@ -543,6 +555,7 @@ class ASizedBox extends SizedBox
 
   @override
   _SizedBoxAnimatableParameters createAnimatableParameters(
+    covariant RenderConstrainedBox renderObject,
     AnimatableParameterHost host,
   ) {
     return (
@@ -554,7 +567,10 @@ class ASizedBox extends SizedBox
   }
 
   @override
-  void updateAnimatableParameters(_SizedBoxAnimatableParameters parameters) {
+  void updateAnimatableParameters(
+    BuildContext context,
+    _SizedBoxAnimatableParameters parameters,
+  ) {
     parameters.additionalConstraints.value = _additionalConstraints;
   }
 
@@ -588,13 +604,15 @@ class ASliverOpacity extends SliverOpacity
 
   @override
   _SliverOpacityAnimatableParameters createAnimatableParameters(
+    covariant RenderSliverOpacity renderObject,
     AnimatableParameterHost host,
   ) {
     return (opacity: AnimatableDouble(opacity, host: host),);
   }
 
   @override
   void updateAnimatableParameters(
+    BuildContext context,
     _SliverOpacityAnimatableParameters parameters,
   ) {
     parameters.opacity.value = opacity;
@@ -627,13 +645,15 @@ class ASliverPadding extends SliverPadding
 
   @override
   _SliverPaddingAnimatableParameters createAnimatableParameters(
+    covariant RenderSliverPadding renderObject,
     AnimatableParameterHost host,
   ) {
     return (padding: AnimatableEdgeInsetsGeometry(padding, host: host),);
   }
 
   @override
   void updateAnimatableParameters(
+    BuildContext context,
     _SliverPaddingAnimatableParameters parameters,
   ) {
     parameters.padding.value = padding;
@@ -742,6 +762,7 @@ abstract class _TransformBase<T> extends ATransform
 
   @override
   _TransformAnimatableParameters<T> createAnimatableParameters(
+    covariant RenderTransform renderObject,
     AnimatableParameterHost host,
   ) {
     return (
@@ -753,6 +774,7 @@ abstract class _TransformBase<T> extends ATransform
 
   @override
   void updateAnimatableParameters(
+    BuildContext context,
     _TransformAnimatableParameters<T> parameters,
   ) {
     updateTransformInputParameters(parameters.transformInput);

diff --git a/packages/fleet/lib/src/animatable_render_object_widget.dart b/packages/fleet/lib/src/animatable_render_object_widget.dart
@@ -14,12 +14,15 @@ abstract class AnimatableRenderObjectWidget<T extends Object>
   const AnimatableRenderObjectWidget({super.key});
 
   /// Creates the [AnimatableParameter]s for this widget.
-  T createAnimatableParameters(AnimatableParameterHost host);
+  T createAnimatableParameters(
+    covariant RenderObject renderObject,
+    AnimatableParameterHost host,
+  );
 
   /// Updates the [AnimatableParameter]s with the new values.
   ///
   /// This is called when the widget is rebuilt.
-  void updateAnimatableParameters(T parameters);
+  void updateAnimatableParameters(BuildContext context, T parameters);
 
   /// Updates the [RenderObject] with the current
   /// [AnimatableParameter.animatedValue]s.
@@ -45,22 +48,32 @@ mixin _AnimatableRenderObjectElementMixin<T extends Object>
   void update(covariant RenderObjectWidget newWidget) {
     if (_animatableParameters == null) {
       if (Transaction.of(this) != null) {
-        _animatableParameters = widget.createAnimatableParameters(this);
+        _animatableParameters =
+            widget.createAnimatableParameters(renderObject, this);
       }
     }
 
     super.update(newWidget);
 
-    final animatableParameters = _animatableParameters;
-    if (animatableParameters != null) {
-      applyUpdateToAnimatableParameters();
-      _updateRenderObjectWithAnimatableParameters();
-    }
+    // TODO: It's inefficient to do this now, after the render object has
+    // already been updated by updateRenderObject. But there currently is no
+    // other way to do this.
+    _applyUpdateToAnimatableParameters();
+  }
+
+  @override
+  void performRebuild() {
+    super.performRebuild();
+
+    // TODO: It's inefficient to do this now, after the render object has
+    // already been updated by updateRenderObject. But there currently is no
+    // other way to do this.
+    _applyUpdateToAnimatableParameters();
   }
 
   @override
   void updateAnimatableParameters() {
-    widget.updateAnimatableParameters(_animatableParameters!);
+    widget.updateAnimatableParameters(this, _animatableParameters!);
   }
 
   @override
@@ -87,6 +100,14 @@ mixin _AnimatableRenderObjectElementMixin<T extends Object>
       _animatableParameters!,
     );
   }
+
+  void _applyUpdateToAnimatableParameters() {
+    final animatableParameters = _animatableParameters;
+    if (animatableParameters != null) {
+      applyUpdateToAnimatableParameters();
+      _updateRenderObjectWithAnimatableParameters();
+    }
+  }
 }
 
 /// A mixin that allows a [SingleChildRenderObjectWidget] to transparently