WaterRipple class
Draws looping concentric waves behind its child, like water ripples.
The waves are purely decorative paint and never appear in the semantics tree. Use autoPlay to loop from the start, or drive playback with a WaterRippleController. When the platform requests reduced motion the animation never loops and the widget renders static.
WaterRipple(
controller: _waves,
child: const Icon(Icons.mic, size: 48),
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- WaterRipple
Constructors
- WaterRipple({Key? key, required Widget child, Color? rippleColor, int waveCount = 5, Duration duration = const Duration(seconds: 2), bool autoPlay = true, WaterRippleController? controller})
-
Creates a water ripple widget.
const
Properties
- autoPlay → bool
-
Whether the animation starts playing on its own. Ignored when the
platform requests reduced motion.
final
- child → Widget
-
The widget drawn on top of the waves.
final
- controller → WaterRippleController?
-
Optional controller to start and stop the waves. The caller owns
and disposes it.
final
- duration → Duration
-
Duration of one full wave cycle.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- rippleColor → Color?
-
Color of the waves. Defaults to the theme's primary color.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- waveCount → int
-
Number of concurrent wave rings.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< WaterRipple> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited