LiquidTransitionPlugin class

Reveals a widget with a liquid wave effect using a custom ClipPath.

⚠️ EXPENSIVE — uses ClipPath with custom CustomClipper.

Params:

  • waveHeight (double) — Max wave amplitude in pixels. Default: 20.0
  • waveCount (double) — Number of wave cycles. Default: 1.5
  • fromBottom (bool) — Reveal from bottom up. Default: true

Usage:

MotionWidget(
  transition: LiquidTransitionPlugin(),
  params: {'waveHeight': 30.0, 'waveCount': 2.0},
  child: myHeroImage,
)
Inheritance

Constructors

LiquidTransitionPlugin()
const

Properties

affectedProperties List<AnimatableProperty>
All widget properties this transition modifies. Used by FrameBudgeter to decide whether to skip expensive effects.
no setteroverride
description String
Human-readable description of this transition (optional, for tooling).
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
id String
Unique identifier used to look up this plugin in TransitionRegistry.
no setteroverride
isExpensive bool
True when this effect uses expensive GPU operations (blur, shader, clip). The FrameBudgeter will disable expensive plugins under FPS threshold.
no setteroverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

build({required Animation<double> animation, required Widget child, Map<String, Object?> params = const {}}) Widget
Builds the animated widget for the forward direction.
override
buildCurved({required Animation<double> animation, required Curve curve, required Widget child, Map<String, Object?> params = const {}}) Widget
Helper — wraps build with a CurvedAnimation.
inherited
buildReverse({required Animation<double> animation, required Widget child, Map<String, Object?> params = const {}}) Widget
Builds the animated widget for the reverse direction.
override
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