WavePainter class
A custom painter that draws a dynamic wave based on progress and animation.
This painter renders a sine wave animation inside a container, useful for visual progress indicators with a water or liquid fill effect.
Parameters:
- progress: A value between 0.0 and 1.0 representing the fill level.
- waveHeight: The height/amplitude of the wave.
- animationValue: A looping animation value between 0.0 and 1.0 to animate the wave movement.
- gradientColors: Used if gradient is not provided to create a linear gradient fill.
- gradient: Optional. If provided, overrides gradientColors and is used for the wave fill.
- Inheritance
-
- Object
- Listenable
- CustomPainter
- WavePainter
Constructors
-
WavePainter({required double progress, required double waveHeight, required double animationValue, required List<
Color> gradientColors, LinearGradient? gradient}) -
const
Properties
- animationValue → double
-
final
- gradient → LinearGradient?
-
final
-
gradientColors
→ List<
Color> -
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- progress → double
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticsBuilder → SemanticsBuilderCallback?
-
Returns a function that builds semantic information for the picture drawn
by this painter.
no setterinherited
- waveHeight → double
-
final
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be notified when it is time to repaint.
inherited
-
hitTest(
Offset position) → bool? -
Called whenever a hit test is being performed on an object that is using
this custom paint delegate.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
paint(
Canvas canvas, Size size) → void -
Called whenever the object needs to paint. The given Canvas has its
coordinate space configured such that the origin is at the top left of the
box. The area of the box is the size of the
sizeargument.override -
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that the
object notifies when it is time to repaint.
inherited
-
shouldRebuildSemantics(
covariant CustomPainter oldDelegate) → bool -
Called whenever a new instance of the custom painter delegate class is
provided to the RenderCustomPaint object, or any time that a new
CustomPaint object is created with a new instance of the custom painter
delegate class (which amounts to the same thing, because the latter is
implemented in terms of the former).
inherited
-
shouldRepaint(
covariant CustomPainter oldDelegate) → bool -
Called whenever a new instance of the custom painter delegate class is
provided to the RenderCustomPaint object, or any time that a new
CustomPaint object is created with a new instance of the custom painter
delegate class (which amounts to the same thing, because the latter is
implemented in terms of the former).
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited