HolePainter class

Creates a cutout hole.

Inheritance

Constructors

HolePainter({required Rect rect, double radius = 12, Color overlayColor = Colors.black, double overlayColorOpacity = 0.75, Color borderColor = Colors.white, double borderColorOpacity = 0.75, double borderWidth = 1})

Properties

borderColor Color
Color of the cutout hole border. Defaults to Colors.white.
final
borderColorOpacity double
Opacity of the cutout hole border. Defaults to 0.75.
final
borderWidth double
Width of the cutout hole border. Defaults to 1.
final
hashCode int
The hash code for this object.
no setterinherited
overlayColor Color
Color of the overlay background. Defaults to Colors.black.
final
overlayColorOpacity double
Opacity of the overlay background. Defaults to 0.75.
final
radius double
Border radius of the hole. Defaults to 12.
final
rect Rect
Position and size of the cutout hole.
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

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 size argument.
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