ShakeEffect class

Effect that shakes the target, using translation, rotation, or both. The hz parameter indicates approximately how many times to repeat the shake per second.

Defaults to a 5 degree (pi / 36) shake, 8 times per second — equivalent to:

Text("Hello").animate()
  .shake(hz: 8, rotation: pi / 36)

There are also shortcut extensions for applying horizontal / vertical shake. For example, this would shake 10 pixels horizontally (default is 5):

Text("Hello").animate().shakeX(amount: 10)
Inheritance
Annotations

Constructors

ShakeEffect({Duration? delay, Duration? duration, Curve? curve, int? hz, Offset? offset, double? rotation})
const

Properties

begin → double?
The begin value for the effect. If null, effects should use a reasonable default value when appropriate.
finalinherited
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.
finalinherited
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.
finalinherited
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.
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
hz → int
final
offset → Offset
final
rotation → double
final
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 necessary to implement the effect, 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

Constants

defaultHz → const int
defaultMove → const double
defaultRotation → const double