ScratchCard class

A widget that provides a scratch-card (eraser) effect over child.

Place any widget under the scratch layer via child; users can scratch the cover using touch/pointer input. The widget supports configurable brushSize, coverColor, and automatic reveal when the scratched area exceeds revealThreshold.

Inheritance

Constructors

ScratchCard({Key? key, required Widget child, double brushSize = 40.0, Color coverColor = const Color(0xFFBDBDBD), double revealThreshold = 0.6, RevealCallback? onRevealed, double gridCellSize = 8.0})
Creates a ScratchCard.
const

Properties

brushSize → double
Diameter of the eraser/brush in logical pixels. Defaults to 40.0.
final
child → Widget
The content beneath the scratch layer that will be revealed.
final
coverColor → Color
The color of the cover layer that will be scratched away.
final
gridCellSize → double
Grid cell size used for estimating percent scratched (internal).
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onRevealed → RevealCallback?
Optional callback invoked when the card becomes fully revealed.
final
revealThreshold → double
Fraction (0.0 - 1.0) of area that must be scratched to auto-reveal.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ScratchCard>
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