WaveSplash class

WaveSplash, which is an ink feature that draws a wave (like a blurred circle).

See also:

  • LineSplash, which is an ink splash feature that draws a single line across a button.
  • splash.NoSplash, which disables all ripple or splash effects.
  • PathSplash, which animates a drawing of a path.
  • WaveSplash, which is an ink feature that draws a wave (like a blurred circle).
Inheritance

Constructors

WaveSplash({required MaterialInkController controller, required RenderBox referenceBox, required TextDirection textDirection, required Offset position, required Color color, bool containedInkWell = false, RectCallback? rectCallback, BorderRadius? borderRadius, ShapeBorder? customBorder, double? radius, VoidCallback? onRemoved})

Properties

color ↔ Color
The ink's color.
getter/setter pairinherited
controller → MaterialInkController
The MaterialInkController associated with this InkFeature.
no setterinherited
customBorder ↔ ShapeBorder?
The ink's optional custom border.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
onRemoved → VoidCallback?
Called when the ink feature is no longer visible on the material.
finalinherited
referenceBox → RenderBox
The render box whose visual position defines the frame of reference for this ink feature.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancel() → void
Called when the user input that triggered this feature's appearance was canceled.
override
confirm() → void
Called when the user input that triggered this feature's appearance was confirmed.
override
dispose() → void
Free up the resources associated with this ink feature.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paintBlurredCircle({required Canvas canvas, required Matrix4 transform, required Paint paint, required Offset center, required double radius, required TextDirection textDirection, ShapeBorder? customBorder, BorderRadius borderRadius = BorderRadius.zero, RectCallback? clipCallback}) → void
paintFeature(Canvas canvas, Matrix4 transform) → void
Override this method to paint the ink feature.
override
paintInkCircle({required Canvas canvas, required Matrix4 transform, required Paint paint, required Offset center, required double radius, TextDirection? textDirection, ShapeBorder? customBorder, BorderRadius borderRadius = BorderRadius.zero, RectCallback? clipCallback}) → void
Draws an ink splash or ink ripple on the passed in Canvas.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

customSplashFactory({double strokeWidth = 30, double blurStrength = 5}) → InteractiveInkFeatureFactory

Constants

splashFactory → const InteractiveInkFeatureFactory
Used to specify this type of ink splash for an InkWell, InkResponse or material Theme.