CustomEffect class

Provide an easy way to add custom animated effects via a builder method that accepts a BuildContext, target child, and calculated animation value between begin and end.

For example, this would animate custom padding on the target from 0 to 40.

foo.animate()
  .custom(
    duration: 1000.ms,
    end: 40,
    builder: (_, value, child) =>
      Padding(padding: EdgeInsets.all(value), child: child)
  )

Note that the above could also be accomplished in a more reusable way by creating a new Effect class.

Inheritance
Annotations

Constructors

CustomEffect({Duration? delay, Duration? duration, Curve? curve, double? begin, double? end, required CustomEffectBuilder builder})
const

Properties

begin → double?
The begin value for the effect. If null, effects should use a reasonable default value when appropriate.
finalinherited
builder → CustomEffectBuilder
final
curve → Curve?
The specified easing curve for the effect. If null, will inherit the curve from the previous effect, or use Animate.defaultCurve if this is the first effect.
finalinherited
delay → Duration?
The specified delay for the effect. If null, will inherit the delay from the previous effect, or use Duration.zero if this is the first effect.
finalinherited
duration → Duration?
The specified duration for the effect. If null, will inherit the duration from the previous effect, or use Animate.defaultDuration if this is the first effect.
finalinherited
end → double?
The end value for the effect. If null, effects should use a reasonable default value when appropriate.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context, Widget child, AnimationController controller, EffectEntry entry) → Widget
Builds the widgets that implement the effect on the target child, based on the provided AnimationController and EffectEntry.
override
buildAnimation(AnimationController controller, EffectEntry entry) → Animation<double>
Returns an animation based on the controller, entry, and begin/end values.
inherited
getBeginRatio(AnimationController controller, EffectEntry entry) → double
Returns a ratio corresponding to the beginning of the specified entry.
inherited
getEndRatio(AnimationController controller, EffectEntry entry) → double
Returns a ratio corresponding to the end of the specified entry.
inherited
getOptimizedBuilder<U>({required ValueListenable<U> animation, Widget? child, required TransitionBuilder builder}) → AnimatedBuilder
Returns an optimized AnimatedBuilder that doesn't rebuild if the value hasn't changed.
inherited
getToggleBuilder({required ValueListenable<double> animation, required Widget child, required bool toggle(), required ToggleEffectBuilder builder}) → AnimatedBuilder
Returns an AnimatedBuilder that rebuilds when the boolean value returned by the toggle function changes.
inherited
isAnimationActive(Animation animation) → bool
Check if the animation is currently running / active.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited