PaintCanvas class

A widget for creating a canvas for paint on images.

This widget allows you to create a canvas for paint on images loaded from various sources, including network URLs, asset paths, files, or memory (Uint8List). It provides customization options for appearance and behavior.

Inheritance

Constructors

PaintCanvas({Key? key, VoidCallback? onStart, dynamic onCreated(PaintedModel item)?, ValueChanged<List<String>>? onRemoveLayer, dynamic onTap(TapDownDetails details)?, bool freeStyleHighPerformance = false, required Size drawAreaSize, required Size editorBodySize, required PaintController paintCtrl, required PaintEditorConfigs paintEditorConfigs, required List<Layer> layers, required double layerStackScaleFactor})
Constructs a PaintCanvas widget.
const

Properties

drawAreaSize → Size
Size of the image.
final
editorBodySize → Size
Size of the paint editor body.
final
freeStyleHighPerformance → bool
Controls high-performance for free-style drawing.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
layers → List<Layer>
A list of layers that make up the paint canvas.
final
layerStackScaleFactor → double
The scale factor applied to the layer stack, used to adjust the size of the canvas layers relative to their original dimensions.
final
onCreated → dynamic Function(PaintedModel item)?
Callback function when the active paint is done.
final
onRemoveLayer → ValueChanged<List<String>>?
Callback invoked when layers are removed.
final
onStart → VoidCallback?
Callback invoked when paint starts.
final
onTap → dynamic Function(TapDownDetails details)?
Callback function that is triggered when a tap down event occurs on the canvas.
final
paintCtrl → PaintController
The PaintController class is responsible for managing and controlling the paint state.
final
paintEditorConfigs → PaintEditorConfigs
Configuration settings for the paint editor. This field holds an instance of PaintEditorConfigs which contains various settings and options used to customize the behavior and appearance of the paint editor.
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() → PaintCanvasState
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