ShakeEffect class

Effect that shakes the target, using translation, rotation, or both (via Transform).

The hz parameter indicates approximately how many times to repeat the shake per second. It defaults to 8.

Specify rotation, offset, or both to indicate the type and strength of the shaking. Defaults to rotation=pi/36, offset=Offset.zero, which results in a light rotational shake.

This example would shake left and right slowly by 10px:

Text("Hello").animate()
  .shake(hz: 3, offset: Offset(10, 0))

There are also shakeX and shakeY shortcut extension methods.

Inheritance

• Object
• Effect<double>
• ShakeEffect

Annotations

• @immutable

Constructors

ShakeEffect({Duration? delay, Duration? duration, Curve? curve, double? 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.

final, inherited

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.

final, inherited

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.

final, inherited

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.

final, inherited

end → double?

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

hz → double

final

offset → Offset

final

rotation → double

final

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 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

Constants

defaultHz → const double

defaultMove → const double

defaultRotation → const double