FloatAnimation class

An Animation<double> that produces a sinusoidal float value in the range [-amplitude, +amplitude].

Combine with Transform.translate to make a widget bob up and down.

Usage

final ctrl = AnimationController(
  vsync: this,
  duration: const Duration(milliseconds: 2000),
)..repeat();

final float = FloatAnimation(controller: ctrl, amplitude: 8.0);

AnimatedBuilder(
  animation: float,
  builder: (ctx, child) => Transform.translate(
    offset: Offset(0, float.value),
    child: child,
  ),
  child: MyWidget(),
)
Inheritance
Mixed-in types

Constructors

FloatAnimation({required AnimationController controller, double amplitude = 6.0, double phase = 0.0})

Properties

amplitude → double
Peak displacement in logical pixels.
final
controller → AnimationController
final
hashCode → int
The hash code for this object.
no setterinherited
isAnimating → bool
Whether this animation is running in either direction.
no setterinherited
isCompleted → bool
Whether this animation is stopped at the end.
no setterinherited
isDismissed → bool
Whether this animation is stopped at the beginning.
no setterinherited
isForwardOrCompleted → bool
Whether the current aim of the animation is toward completion.
no setterinherited
parent → Animation<double>
The animation whose value this animation will proxy.
no setteroverride
phase → double
Phase offset in 0, 1 — useful for staggering multiple floaters.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → AnimationStatus
The current status of this animation.
no setterinherited
value → double
The current value of the animation.
no setteroverride

Methods

addListener(VoidCallback listener) → void
Calls the listener every time the value of the animation changes.
inherited
addStatusListener(AnimationStatusListener listener) → void
Calls listener every time the status of the animation changes.
inherited
drive<U>(Animatable<U> child) → Animation<U>
Chains a Tween (or CurveTween) to this Animation.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeListener(VoidCallback listener) → void
Stop calling the listener every time the value of the animation changes.
inherited
removeStatusListener(AnimationStatusListener listener) → void
Stops calling the listener every time the status of the animation changes.
inherited
toString() → String
A string representation of this object.
inherited
toStringDetails() → String
Provides a string describing the status of this object, but not including information about the object itself.
inherited

Operators

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