ColorEffect class

An effect that animates between two colors, composited with the target with the specified BlendMode.

See also: TintEffect, which provides a simpler interface for single color tints.

blendMode lets you adjust how the color fill is composited. It defaults to BlendMode.color. Note that most blend modes in Flutter (including color) do not respect the alpha channel correctly. See BlendMode.srcATop or BlendMode.srcIn for options that do maintain alpha.

For example, this would animate from red to blue with a multiply blend:

Image.asset('assets/rainbow.jpg').animate()
  .color(begin: Colors.red, end: Colors.blue, blendMode: BlendMode.multiply)

Inheritance

• Object
• Effect<Color?>
• ColorEffect

Annotations

• @immutable

Constructors

ColorEffect({Duration? delay, Duration? duration, Curve? curve, Color? begin, Color? end, BlendMode? blendMode})

const

Properties

begin → Color?

The begin value for the effect. If null, effects should use a reasonable default value when appropriate.

final, inherited

blendMode → BlendMode?

final

curve → Curve?

The specified curve for the effect. If null, will use the curve from the previous effect, or Animate.defaultCurve if this is the first effect.

final, inherited

delay → Duration?

The specified delay for the effect. If null, will use the delay from the previous effect, or Duration.zero if this is the first effect.

final, inherited

duration → Duration?

The specified duration for the effect. If null, will use the duration from the previous effect, or Animate.defaultDuration if this is the first effect.

final, inherited

end → Color?

The end value for the effect. If null, effects should use a reasonable default value when appropriate.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build(BuildContext context, Widget child, AnimationController controller, EffectEntry entry) → Widget

Builds the widgets necessary to implement the effect, based on the provided AnimationController and EffectEntry.

override

buildAnimation(AnimationController controller, EffectEntry entry) → Animation<Color?>

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

Constants

defaultBlendMode → const BlendMode

defaultValue → const Color

neutralValue → const Color?