#include <KisRectangleEnclosingProducer.h>

Inheritance diagram for KisRectangleEnclosingProducer:

Signals
void	enclosingMaskProduced (KisPixelSelectionSP enclosingMask)

Signals inherited from KisToolRectangleBase
void	rectangleChanged (const QRectF &newRect)

void	sigRequestReloadConfig ()

Signals inherited from KisToolPaint
void	sigPaintingFinished ()

Signals inherited from KisTool
void	isActiveChanged (bool isActivated)

Signals inherited from KoToolBase
void	activateTool (const QString &id)

void	cursorChanged (const QCursor &cursor)

void	selectionChanged (bool hasSelection)

void	statusTextChanged (const QString &statusText)

void	textModeChanged (bool inTextMode)

Public Member Functions
bool	hasUserInteractionRunning () const

	KisRectangleEnclosingProducer (KoCanvasBase *canvas)

	~KisRectangleEnclosingProducer () override

Public Member Functions inherited from KisDynamicDelegateTool< KisToolRectangleBase >
	KisDynamicDelegateTool ()=delete

	KisDynamicDelegateTool (Args ... args)

	KisDynamicDelegateTool (const KisDynamicDelegateTool &)=delete

KisDynamicDelegateTool &	operator= (const KisDynamicDelegateTool &)=delete

	~KisDynamicDelegateTool () override

Public Member Functions inherited from KisToolRectangleBase
void	activate (const QSet< KoShape * > &shapes) override

void	beginPrimaryAction (KoPointerEvent *event) override

void	continuePrimaryAction (KoPointerEvent *event) override

QList< QPointer< QWidget > >	createOptionWidgets () override

void	deactivate () override

void	endPrimaryAction (KoPointerEvent *event) override

void	keyPressEvent (QKeyEvent *event) override

void	keyReleaseEvent (QKeyEvent *event) override

	KisToolRectangleBase (KoCanvasBase *canvas, KisToolRectangleBase::ToolType type, const QCursor &cursor=KisCursor::load("tool_rectangle_cursor.png", 6, 6))

void	paint (QPainter &gc, const KoViewConverter &converter) override

void	showSize ()

Public Member Functions inherited from KisToolShape
int	flags () const override

	KisToolShape (KoCanvasBase *canvas, const QCursor &cursor)

	~KisToolShape () override

Public Member Functions inherited from KisToolPaint
	KisToolPaint (KoCanvasBase *canvas, const QCursor &cursor)

void	mouseMoveEvent (KoPointerEvent *event) override

void	mousePressEvent (KoPointerEvent *event) override

void	mouseReleaseEvent (KoPointerEvent *event) override

KisPopupWidgetInterface *	popupWidget () override

	~KisToolPaint () override

Public Member Functions inherited from KisTool
virtual bool	alternateActionSupportsHiResEvents (AlternateAction action) const

virtual void	beginAlternateDoubleClickAction (KoPointerEvent *event, AlternateAction action)

virtual void	beginPrimaryDoubleClickAction (KoPointerEvent *event)

void	deleteSelection () override

bool	isActive () const

	KisTool (KoCanvasBase *canvas, const QCursor &cursor)

void	mouseDoubleClickEvent (KoPointerEvent *event) override

void	mouseTripleClickEvent (KoPointerEvent *event) override

virtual void	newActivationWithExternalSource (KisPaintDeviceSP externalSource)
	newActivationWithExternalSource Makes sure that the tool is active and starts a new stroke, which will be able to access the pixels from the specified external source.

KisTool::NodePaintAbility	nodePaintAbility ()

virtual bool	primaryActionSupportsHiResEvents () const

virtual bool	supportsPaintingAssistants () const

	~KisTool () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Member Functions inherited from KoToolBase
QAction *	action (const QString &name) const

KoCanvasBase *	canvas () const
	Returns the canvas the tool is working on.

virtual void	copy () const

QCursor	cursor () const
	return the last emitted cursor

virtual void	customMoveEvent (KoPointerEvent *event)

virtual void	customPressEvent (KoPointerEvent *event)

virtual void	customReleaseEvent (KoPointerEvent *event)

virtual void	cut ()

virtual QRectF	decorationsRect () const

int	decorationThickness () const
	decorationThickness The minimum thickness for tool decoration lines, this is derived from the screen magnification, thus the HiDPI settings. Note: to use this effectively, also set the pen to isCosmetic(true);

virtual void	deselect ()
	deselect the tool should clear the selection if it has one.

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event, const QPointF &point)

virtual void	dropEvent (QDropEvent *event, const QPointF &point)

virtual void	explicitUserStrokeEndRequest ()
	explicitUserStrokeEndRequest is called by the input manager when the user presses Enter key or any equivalent. This callback comes before requestStrokeEnd(), which comes from a different source.

KoToolFactoryBase *	factory () const

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual bool	hasSelection ()

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

bool	isInTextMode () const

bool	isOpacityPresetMode () const

	KoToolBase (KoCanvasBase *canvas)

bool	maskSyntheticEvents () const

QList< QPointer< QWidget > >	optionWidgets ()

virtual bool	paste ()

virtual QMenu *	popupActionsMenu ()

virtual bool	selectAll ()
	selectAll select all data the tool can select.

virtual KoToolSelection *	selection ()

Q_INVOKABLE QString	toolId () const

virtual bool	wantsAutoScroll () const

	~KoToolBase () override

Protected Slots
void	resetCursorStyle () override

Protected Slots inherited from KisTool
virtual void	resetCursorStyle ()

Protected Member Functions
void	beginShape () override

void	endShape () override

void	finishRect (const QRectF &rect, qreal roundCornersX, qreal roundCornersY) override

Protected Member Functions inherited from KisToolRectangleBase
void	applyConstraints (QSizeF &area, bool overrideRatio)

void	cancelStroke ()

virtual QRectF	createRect (const QPointF &start, const QPointF &end)

QPainterPath	drawX (const QPointF &pt)

void	endStroke ()

void	getRotatedPath (QPainterPath &path, const QPointF &center, const qreal &angle)

qreal	getRotationAngle ()

bool	isFixedSize ()

virtual void	paintRectangle (QPainter &gc, const QRectF &imageRect)

virtual bool	showRoundCornersGUI () const

void	updateArea ()

Protected Member Functions inherited from KisToolShape
void	addPathShape (KoPathShape *pathShape, const KUndo2MagicString &name)

void	addShape (KoShape *shape)

QWidget *	createOptionWidget () override

qreal	currentStrokeWidth () const

KisToolShapeUtils::FillStyle	fillStyle ()

QTransform	fillTransform ()

ShapeAddInfo	shouldAddShape (KisNodeSP currentNode) const

KisToolShapeUtils::StrokeStyle	strokeStyle ()

Protected Member Functions inherited from KisToolPaint
void	activateAlternateAction (AlternateAction action) override

void	activatePrimaryAction () override

void	addOptionWidgetLayout (QLayout *layout)
	Add the tool-specific layout to the default option widget layout.

virtual void	addOptionWidgetOption (QWidget control, QWidget label=nullptr)
	Add a widget and a label to the current option widget layout.

void	beginAlternateAction (KoPointerEvent *event, AlternateAction action) override

void	canvasResourceChanged (int key, const QVariant &v) override

void	continueAlternateAction (KoPointerEvent *event, AlternateAction action) override

void	deactivateAlternateAction (AlternateAction action) override

void	deactivatePrimaryAction () override

void	enableControl (QWidget *control, bool value)

void	endAlternateAction (KoPointerEvent *event, AlternateAction action) override

virtual KisOptimizedBrushOutline	getOutlinePath (const QPointF &documentPos, const KoPointerEvent *event, KisPaintOpSettings::OutlineMode outlineMode)

bool	isEraser () const

bool	isOutlineEnabled () const

bool	isOutlineVisible () const

virtual QString	quickHelp () const

virtual void	requestUpdateOutline (const QPointF &outlineDocPoint, const KoPointerEvent *event)

void	setMode (ToolMode mode) override

void	setOutlineEnabled (bool enabled)

void	setOutlineVisible (bool visible)

void	setSupportOutline (bool supportOutline)

void	showControl (QWidget *control, bool value)

Protected Member Functions inherited from KisTool
bool	blockUntilOperationsFinished ()

void	blockUntilOperationsFinishedForced ()

QPointF	convertDocumentToWidget (const QPointF &pt)

QPoint	convertToImagePixelCoordFloored (KoPointerEvent *e)

QPointF	convertToPixelCoord (const QPointF &pt)

QPointF	convertToPixelCoord (KoPointerEvent *e)

QPointF	convertToPixelCoordAndAlignOnWidget (const QPointF &pt)

QPointF	convertToPixelCoordAndSnap (const QPointF &pt, const QPointF &offset=QPointF())

QPointF	convertToPixelCoordAndSnap (KoPointerEvent *e, const QPointF &offset=QPointF(), bool useModifiers=true)

QRectF	convertToPt (const QRectF &rect)

qreal	convertToPt (qreal value)

KoColor	currentBgColor ()

KoColor	currentFgColor ()

KisFilterConfigurationSP	currentGenerator ()

KoAbstractGradientSP	currentGradient ()

KisImageWSP	currentImage ()

KisNodeSP	currentNode () const

KisPaintOpPresetSP	currentPaintOpPreset ()

KoPatternSP	currentPattern ()

QCursor	cursor () const

KisImageWSP	image () const

virtual bool	listeningToModifiers ()

virtual void	listenToModifiers (bool listen)

virtual ToolMode	mode () const

bool	nodeEditable ()
	Checks checks if the current node is editable.

bool	overrideCursorIfNotEditable ()
	Override the cursor appropriately if current node is not editable.

void	paintToolOutline (QPainter *painter, const KisOptimizedBrushOutline &path)

KisOptimizedBrushOutline	pixelToView (const KisOptimizedBrushOutline &path) const

QPainterPath	pixelToView (const QPainterPath &pixelPath) const
	Convert a pixel path into a view path.

QPointF	pixelToView (const QPoint &pixelCoord) const

QPointF	pixelToView (const QPointF &pixelCoord) const
	Convert a floating point pixel coordinate into a view coordinate.

QPolygonF	pixelToView (const QPolygonF &pixelPolygon) const
	Convert a pixel polygon into a view path.

QRectF	pixelToView (const QRectF &pixelRect) const
	Convert a pixel rectangle into a view rectangle.

KisNodeList	selectedNodes () const

bool	selectionEditable ()
	Checks checks if the selection is editable, only applies to local selection as global selection is always editable.

void	setCursor (const QCursor &cursor)

void	updateCanvasPixelRect (const QRectF &pixelRect)
	Update the canvas for the given rectangle in image pixel coordinates.

void	updateCanvasViewRect (const QRectF &viewRect)
	Update the canvas for the given rectangle in view coordinates.

QPointF	viewToPixel (const QPointF &viewCoord) const

QPointF	widgetCenterInWidgetPixels ()

Protected Member Functions inherited from KoToolBase
int	grabSensitivity () const
	Convenience function to get the current grab sensitivity.

qreal	handleDocRadius () const

QRectF	handleGrabRect (const QPointF &position) const

QRectF	handlePaintRect (const QPointF &position) const

int	handleRadius () const
	Convenience function to get the current handle radius.

bool	isActivated () const

	KoToolBase (KoToolBasePrivate &dd)

KoPointerEvent *	lastDeliveredPointerEvent () const

void	setAbstractResource (KoAbstractCanvasResourceInterfaceSP abstractResource)

void	setConverter (KoDerivedResourceConverterSP converter)

void	setIsOpacityPresetMode (bool value)

void	setMaskSyntheticEvents (bool value)

void	setTextMode (bool value)

QHash< int, KoAbstractCanvasResourceInterfaceSP >	toolAbstractResources ()

QHash< int, KoDerivedResourceConverterSP >	toolConverters ()

void	useCursor (const QCursor &cursor)

Private Attributes
bool	m_hasUserInteractionRunning {false}

Additional Inherited Members
Public Types inherited from KisToolRectangleBase
enum	ToolType { PAINT , SELECT }

Public Types inherited from KisTool
enum	{ FLAG_USES_CUSTOM_PRESET =0x01 , FLAG_USES_CUSTOM_COMPOSITEOP =0x02 , FLAG_USES_CUSTOM_SIZE =0x04 }

enum	AlternateAction { ChangeSize = AlternateChangeSize , ChangeSizeSnap = AlternateChangeSizeSnap , SampleFgNode = AlternateSampleFgNode , SampleBgNode = AlternateSampleBgNode , SampleFgImage = AlternateSampleFgImage , SampleBgImage = AlternateSampleBgImage , Secondary = AlternateSecondary , Third = AlternateThird , Fourth = AlternateFourth , Fifth = AlternateFifth , NONE = 10000 }

enum	NodePaintAbility { VECTOR , CLONE , PAINT , UNPAINTABLE , MYPAINTBRUSH_UNPAINTABLE }

enum	ToolAction { Primary , AlternateChangeSize , AlternateChangeSizeSnap , AlternateSampleFgNode , AlternateSampleBgNode , AlternateSampleFgImage , AlternateSampleBgImage , AlternateSecondary , AlternateThird , AlternateFourth , AlternateFifth , Alternate_NONE = 10000 }

Public Slots inherited from KisToolRectangleBase
void	constraintsChanged (bool forceRatio, bool forceWidth, bool forceHeight, float ratio, float width, float height)

void	requestStrokeCancellation () override

void	requestStrokeEnd () override

void	roundCornersChanged (int rx, int ry)

Public Slots inherited from KisToolShape
void	activate (const QSet< KoShape * > &shapes) override

virtual void	fillSettingChanged (int value)

virtual void	outlineSettingChanged (int value)

virtual void	patternRotationSettingChanged (qreal value)

virtual void	patternScaleSettingChanged (qreal value)

Public Slots inherited from KisToolPaint
void	activate (const QSet< KoShape * > &shapes) override

void	deactivate () override

Public Slots inherited from KisTool
void	activate (const QSet< KoShape * > &shapes) override

void	canvasResourceChanged (int key, const QVariant &res) override

void	deactivate () override

virtual void	updateSettingsViews ()

Public Slots inherited from KoToolBase
virtual void	documentResourceChanged (int key, const QVariant &res)

virtual void	repaintDecorations ()

virtual void	requestRedoDuringStroke ()

virtual void	requestStrokeCancellation ()

virtual void	requestStrokeEnd ()

virtual void	requestUndoDuringStroke ()

void	setStatusText (const QString &statusText)

void	updateOptionsWidgetIcons ()

Static Public Member Functions inherited from KisTool
static AlternateAction	actionToAlternateAction (ToolAction action)

Public Attributes inherited from KisToolShape
WdgGeometryOptions *	m_shapeOptionsWidget

Public Attributes inherited from KisTool
KoColor	currentBgColor

float	currentExposure {1.0}

KoColor	currentFgColor

KisFilterConfigurationSP	currentGenerator

KoAbstractGradientSP	currentGradient

KoPatternSP	currentPattern

QCursor	cursor

bool	m_isActive {false}

ToolMode	m_mode {HOVER_MODE}

QWidget *	optionWidget {0}

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Protected Types inherited from KisTool
enum	ToolMode : int { HOVER_MODE , PAINT_MODE , SECONDARY_PAINT_MODE , MIRROR_AXIS_SETUP_MODE , GESTURE_MODE , PAN_MODE , OTHER , OTHER_1 }

Protected Attributes inherited from KisToolRectangleBase
qreal	m_angle

qreal	m_angleBuffer

Qt::KeyboardModifiers	m_currentModifiers

QPointF	m_dragCenter

QPointF	m_dragEnd

QPointF	m_dragStart

float	m_forcedHeight

float	m_forcedRatio

float	m_forcedWidth

bool	m_isHeightForced

bool	m_isRatioForced

bool	m_isWidthForced

qreal	m_referenceAngle

bool	m_rotateActive

int	m_roundCornersX

int	m_roundCornersY

ToolType	m_type

Protected Attributes inherited from KisToolShape
KConfigGroup	m_configGroup

Protected Attributes inherited from KisToolPaint
KisOptimizedBrushOutline	m_currentOutline

QRectF	m_oldColorPreviewUpdateRect

QRectF	m_oldOutlineRect

QPointF	m_outlineDocPoint

bool	m_paintOutline {false}

Protected Attributes inherited from KoToolBase
KoToolBasePrivate *	d_ptr

Properties inherited from KisTool
bool	isActive

Detailed Description

Definition at line 17 of file KisRectangleEnclosingProducer.h.

Constructor & Destructor Documentation

◆ KisRectangleEnclosingProducer()

KisRectangleEnclosingProducer::KisRectangleEnclosingProducer ( KoCanvasBase * canvas )

Definition at line 15 of file KisRectangleEnclosingProducer.cpp.

    : KisDynamicDelegateTool<KisToolRectangleBase>(canvas, KisToolRectangleBase::PAINT, KisCursor::load("tool_rectangular_selection_cursor.png", 6, 6))
{
    setObjectName("enclosing_tool_rectangle");
    setSupportOutline(true);
    setOutlineEnabled(false);
 
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas);
 
    connect(kritaCanvas->viewManager()->canvasResourceProvider(), SIGNAL(sigEffectiveCompositeOpChanged()), SLOT(resetCursorStyle()));
}

References Private::canvas, KisViewManager::canvasResourceProvider(), connect(), resetCursorStyle(), KisToolPaint::setOutlineEnabled(), KisToolPaint::setSupportOutline(), and KisCanvas2::viewManager().

◆ ~KisRectangleEnclosingProducer()

KisRectangleEnclosingProducer::~KisRectangleEnclosingProducer ( )

override

Definition at line 27 of file KisRectangleEnclosingProducer.cpp.

28{}

Member Function Documentation

◆ beginShape()

void KisRectangleEnclosingProducer::beginShape ( )

overrideprotectedvirtual

Use these methods in subclassed to notify when the user starts and finishes making a shape, and override to be notified

Reimplemented from KisToolShape.

Definition at line 74 of file KisRectangleEnclosingProducer.cpp.

{
    m_hasUserInteractionRunning = true;
}

References m_hasUserInteractionRunning.

◆ enclosingMaskProduced

void KisRectangleEnclosingProducer::enclosingMaskProduced ( KisPixelSelectionSP enclosingMask )

signal

◆ endShape()

void KisRectangleEnclosingProducer::endShape ( )

overrideprotectedvirtual

Reimplemented from KisToolShape.

Definition at line 79 of file KisRectangleEnclosingProducer.cpp.

{
    m_hasUserInteractionRunning = false;
}

References m_hasUserInteractionRunning.

◆ finishRect()

void KisRectangleEnclosingProducer::finishRect	(	const QRectF &	rect,
		qreal	roundCornersX,
		qreal	roundCornersY )

overrideprotectedvirtual

Implements KisToolRectangleBase.

Definition at line 41 of file KisRectangleEnclosingProducer.cpp.

{
    QRect rc(rect.normalized().toRect());
    if (!rc.isValid()) {
        return;
    }
 
    KisPixelSelectionSP enclosingMask = KisPixelSelectionSP(new KisPixelSelection());
    QPainterPath path;
 
    if (roundCornersX > 0 || roundCornersY > 0) {
        path.addRoundedRect(rc, roundCornersX, roundCornersY);
    } else {
        path.addRect(rc);
    }
    getRotatedPath(path, rc.center(), getRotationAngle());
 
    KisPainter painter(enclosingMask);
    painter.setPaintColor(KoColor(Qt::white, enclosingMask->colorSpace()));
    painter.setAntiAliasPolygonFill(false);
    painter.setFillStyle(KisPainter::FillStyleForegroundColor);
    painter.setStrokeStyle(KisPainter::StrokeStyleNone);
 
    painter.paintPainterPath(path);
 
    Q_EMIT enclosingMaskProduced(enclosingMask);
}

References KisPaintDevice::colorSpace(), enclosingMaskProduced(), KisPainter::FillStyleForegroundColor, KisToolRectangleBase::getRotatedPath(), KisToolRectangleBase::getRotationAngle(), KisPainter::paintPainterPath(), KisPainter::setAntiAliasPolygonFill(), KisPainter::setFillStyle(), KisPainter::setPaintColor(), KisPainter::setStrokeStyle(), and KisPainter::StrokeStyleNone.

◆ hasUserInteractionRunning()

bool KisRectangleEnclosingProducer::hasUserInteractionRunning ( ) const

Definition at line 69 of file KisRectangleEnclosingProducer.cpp.

{
    return m_hasUserInteractionRunning;
}

References m_hasUserInteractionRunning.

◆ resetCursorStyle

void KisRectangleEnclosingProducer::resetCursorStyle ( )

overrideprotectedslot

Definition at line 30 of file KisRectangleEnclosingProducer.cpp.

{
    if (isEraser()) {
        useCursor(KisCursor::load("tool_rectangular_selection_enclose_eraser_cursor.png", 6, 6));
    } else {
        KisDynamicDelegateTool::resetCursorStyle();
    }
 
    overrideCursorIfNotEditable();
}

References KisToolPaint::isEraser(), KisCursor::load(), KisTool::overrideCursorIfNotEditable(), and KoToolBase::useCursor().

Member Data Documentation

◆ m_hasUserInteractionRunning

bool KisRectangleEnclosingProducer::m_hasUserInteractionRunning {false}

private

Definition at line 36 of file KisRectangleEnclosingProducer.h.

36{false};

The documentation for this class was generated from the following files:

plugins/tools/tool_enclose_and_fill/subtools/KisRectangleEnclosingProducer.h
plugins/tools/tool_enclose_and_fill/subtools/KisRectangleEnclosingProducer.cpp

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisRectangleEnclosingProducer()

◆ ~KisRectangleEnclosingProducer()

Member Function Documentation

◆ beginShape()

◆ enclosingMaskProduced

◆ endShape()

◆ finishRect()

◆ hasUserInteractionRunning()

◆ resetCursorStyle

Member Data Documentation

◆ m_hasUserInteractionRunning