#include <kis_tool_rectangle_base.h>

Inheritance diagram for KisToolRectangleBase:

Public Types
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
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 ()

Signals
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
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 Member Functions
void	applyConstraints (QSizeF &area, bool overrideRatio)

void	cancelStroke ()

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

QPainterPath	drawX (const QPointF &pt)

void	endStroke ()

virtual void	finishRect (const QRectF &rect, qreal roundCornersX, qreal roundCornersY)=0

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)

virtual void	beginShape ()

QWidget *	createOptionWidget () override

qreal	currentStrokeWidth () const

virtual void	endShape ()

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)

Protected Attributes
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

Additional Inherited Members
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 Slots inherited from KisTool
virtual void	resetCursorStyle ()

Properties inherited from KisTool
bool	isActive

Detailed Description

Definition at line 13 of file kis_tool_rectangle_base.h.

Member Enumeration Documentation

◆ ToolType

enum KisToolRectangleBase::ToolType

Enumerator
PAINT
SELECT

Definition at line 29 of file kis_tool_rectangle_base.h.

                  {
        PAINT,
        SELECT
    };

Constructor & Destructor Documentation

◆ KisToolRectangleBase()

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

explicit

Definition at line 23 of file kis_tool_rectangle_base.cpp.

    : KisToolShape(canvas, cursor)
    , m_dragStart(0, 0)
    , m_dragEnd(0, 0)
    , m_type(type)
    , m_isRatioForced(false)
    , m_isWidthForced(false)
    , m_isHeightForced(false)
    , m_rotateActive(false)
    , m_forcedRatio(1.0)
    , m_forcedWidth(0)
    , m_forcedHeight(0)
    , m_roundCornersX(0)
    , m_roundCornersY(0)
    , m_referenceAngle(0)
    , m_angle(0)
    , m_angleBuffer(0)
    , m_currentModifiers(Qt::NoModifier)
{
}

Member Function Documentation

◆ activate()

void KisToolRectangleBase::activate ( const QSet< KoShape * > & shapes )

overridevirtual

This method is called when this tool instance is activated. For any main window there is only one tool active at a time, which then gets all user input. Switching between tools will call deactivate on one and activate on the new tool allowing the tool to flush items (like a selection) when it is not in use.

Parameters

shapes the set of shapes that are selected or suggested for editing by a selected shape for the tool to work on. Not all shapes will be meant for this tool.

See also: deactivate()

Reimplemented from KoToolBase.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 110 of file kis_tool_rectangle_base.cpp.

{
    KisToolShape::activate(shapes);
 
    Q_EMIT sigRequestReloadConfig();
}

References KisToolShape::activate(), and sigRequestReloadConfig().

◆ applyConstraints()

void KisToolRectangleBase::applyConstraints	(	QSizeF &	area,
		bool	overrideRatio )

protected

Definition at line 201 of file kis_tool_rectangle_base.cpp.

                                                                            {
  if (m_isWidthForced) {
    area.setWidth(m_forcedWidth);
  }
  if (m_isHeightForced) {
    area.setHeight(m_forcedHeight);
  }
 
  if (m_isHeightForced && m_isWidthForced) return;
 
  if (m_isRatioForced || overrideRatio) {
    float ratio = m_isRatioForced ? m_forcedRatio : 1.0f;
 
    if (m_isWidthForced) {
      area.setHeight(area.width() / ratio);
    } else {
      area.setWidth(area.height() * ratio);
    }
  }
}

References m_forcedHeight, m_forcedRatio, m_forcedWidth, m_isHeightForced, m_isRatioForced, and m_isWidthForced.

◆ beginPrimaryAction()

void KisToolRectangleBase::beginPrimaryAction ( KoPointerEvent * event )

overridevirtual

Called by KisToolProxy when a primary action for the tool is started. The event stores the original event that started the stroke. The event is accepted by default. If the tool decides to ignore this particular action (e.g. when the node is not editable), it should call event->ignore(). Then no further continuePrimaryAction() or endPrimaryAction() will be called until the next user action.

Reimplemented from KisTool.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 151 of file kis_tool_rectangle_base.cpp.

{
    NodePaintAbility paintability = nodePaintAbility();
    if ((m_type == PAINT && (!nodeEditable() || paintability == UNPAINTABLE || paintability  == KisToolPaint::CLONE || paintability == KisToolPaint::MYPAINTBRUSH_UNPAINTABLE)) || (m_type == SELECT && !selectionEditable())) {
 
        if (paintability == KisToolPaint::CLONE){
            KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
            QString message = i18n("This tool cannot paint on clone layers.  Please select a paint or vector layer or mask.");
            kiscanvas->viewManager()->showFloatingMessage(message, koIcon("object-locked"));
        }
 
        if (paintability == KisToolPaint::MYPAINTBRUSH_UNPAINTABLE) {
            KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
            QString message = i18n("The MyPaint Brush Engine is not available for this colorspace");
            kiscanvas->viewManager()->showFloatingMessage(message, koIcon("object-locked"));
        }
 
        event->ignore();
        return;
    }
    setMode(KisTool::PAINT_MODE);
    beginShape();
 
    m_currentModifiers = Qt::NoModifier;
 
    QPointF pos = convertToPixelCoordAndSnap(event, QPointF(), false);
    m_dragStart = m_dragCenter = pos;
    m_angle = m_angleBuffer = 0;
    m_rotateActive = false;
 
    QSizeF area = QSizeF(0,0);
 
    applyConstraints(area, false);
 
    m_dragEnd.setX(m_dragStart.x() + area.width());
    m_dragEnd.setY(m_dragStart.y() + area.height());
 
    m_dragCenter = QPointF((m_dragStart.x() + m_dragEnd.x()) / 2,
                           (m_dragStart.y() + m_dragEnd.y()) / 2);
    showSize();
    event->accept();
}

References applyConstraints(), KisToolShape::beginShape(), Private::canvas, KisTool::CLONE, KisTool::convertToPixelCoordAndSnap(), koIcon, m_angle, m_angleBuffer, m_currentModifiers, m_dragCenter, m_dragEnd, m_dragStart, m_rotateActive, m_type, KisTool::MYPAINTBRUSH_UNPAINTABLE, KisTool::nodeEditable(), KisTool::nodePaintAbility(), PAINT, KisTool::PAINT_MODE, SELECT, KisTool::selectionEditable(), KisToolPaint::setMode(), KisViewManager::showFloatingMessage(), showSize(), KisTool::UNPAINTABLE, and KisCanvas2::viewManager().

◆ cancelStroke()

void KisToolRectangleBase::cancelStroke ( )

protected

Definition at line 345 of file kis_tool_rectangle_base.cpp.

{
    setMode(KisTool::HOVER_MODE);
    updateArea();
    endShape();
}

References KisToolShape::endShape(), KisTool::HOVER_MODE, KisToolPaint::setMode(), and updateArea().

◆ constraintsChanged

void KisToolRectangleBase::constraintsChanged	(	bool	forceRatio,
		bool	forceWidth,
		bool	forceHeight,
		float	ratio,
		float	width,
		float	height )

slot

Definition at line 70 of file kis_tool_rectangle_base.cpp.

{
    m_isWidthForced = forceWidth;
    m_isHeightForced = forceHeight;
    m_isRatioForced = forceRatio;
 
    m_forcedHeight = height;
    m_forcedWidth = width;
    m_forcedRatio = ratio;
 
    // Avoid division by zero in size calculations
    if (ratio < 0.0001f)
        m_isRatioForced = false;
}

References m_forcedHeight, m_forcedRatio, m_forcedWidth, m_isHeightForced, m_isRatioForced, and m_isWidthForced.

◆ continuePrimaryAction()

void KisToolRectangleBase::continuePrimaryAction ( KoPointerEvent * event )

overridevirtual

Called by KisToolProxy when the primary action is in progress of pointer movement. If the tool has ignored the event in beginPrimaryAction(), this method will not be called.

Reimplemented from KisTool.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 222 of file kis_tool_rectangle_base.cpp.

{
    CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
 
    bool constraintToggle = m_currentModifiers & Qt::ShiftModifier;
    bool translateMode = m_currentModifiers & Qt::AltModifier;
    bool expandFromCenter = m_currentModifiers & Qt::ControlModifier;
 
    bool rotateMode = expandFromCenter && translateMode;
    bool fixedSize = isFixedSize() && !constraintToggle;
 
    QPointF pos = convertToPixelCoordAndSnap(event, QPointF(), false);
 
    if (rotateMode) {
        QPointF angleVector;
        if (!m_rotateActive) {
            m_rotateActive = true;
            angleVector = (fixedSize)? m_dragEnd: pos;
            angleVector -= m_dragStart;
            m_referenceAngle = atan2(angleVector.y(), angleVector.x());
        }
        angleVector = pos - m_dragStart;
        qreal a2 = atan2(angleVector.y(), angleVector.x());
        m_angleBuffer = a2 - m_referenceAngle;
    } else {
        m_rotateActive = false;
        m_angle += m_angleBuffer;
        m_angleBuffer = 0;
    }
 
    if (fixedSize && !rotateMode) {
      m_dragStart = pos;
    } else if (translateMode && !rotateMode) {
      QPointF trans = pos - m_dragEnd;
      m_dragStart += trans;
      m_dragEnd += trans;
 
    }
 
    QPointF diag = pos - m_dragStart;
    QTransform t1, t2;
    t1.rotateRadians(-getRotationAngle());
    QPointF baseDiag = t1.map(diag);
    QSizeF area = QSizeF(fabs(baseDiag.x()), fabs(baseDiag.y()));
 
    bool overrideRatio = constraintToggle && !(m_isHeightForced || m_isWidthForced || m_isRatioForced);
    if (!constraintToggle || overrideRatio) {
      applyConstraints(area, overrideRatio);
    }
 
    baseDiag = QPointF(
      (baseDiag.x() < 0) ? -area.width() : area.width(),
      (baseDiag.y() < 0) ? -area.height() : area.height()
    );
 
    t2.rotateRadians(getRotationAngle());
    diag = t2.map(baseDiag);
 
    // resize around center point?
    if (expandFromCenter && !fixedSize && !rotateMode) {
      m_dragStart = m_dragCenter - diag / 2;
      m_dragEnd = m_dragCenter + diag / 2;
    } else {
      m_dragEnd = m_dragStart + diag;
    }
 
    if(!translateMode) {
        showSize();
    }
    else {
        KisCanvas2 *kisCanvas =dynamic_cast<KisCanvas2*>(canvas());
        KIS_ASSERT(kisCanvas);
        kisCanvas->viewManager()->showFloatingMessage(i18n("X: %1 px\nY: %2 px"
                                                           , QString::number(m_dragStart.x(), 'f', 1)
                                                           , QString::number(m_dragStart.y(), 'f', 1)), QIcon(), 1000
                                                           , KisFloatingMessage::High,  Qt::AlignLeft | Qt::TextWordWrap | Qt::AlignVCenter);
    }
    updateArea();
    m_dragCenter = QPointF((m_dragStart.x() + m_dragEnd.x()) / 2,
                           (m_dragStart.y() + m_dragEnd.y()) / 2);
 
    KisToolPaint::requestUpdateOutline(event->point, event);
}

References applyConstraints(), Private::canvas, CHECK_MODE_SANITY_OR_RETURN, KisTool::convertToPixelCoordAndSnap(), getRotationAngle(), KisFloatingMessage::High, isFixedSize(), KIS_ASSERT, m_angle, m_angleBuffer, m_currentModifiers, m_dragCenter, m_dragEnd, m_dragStart, m_isHeightForced, m_isRatioForced, m_isWidthForced, m_referenceAngle, m_rotateActive, KisTool::PAINT_MODE, KoPointerEvent::point, KisToolPaint::requestUpdateOutline(), KisViewManager::showFloatingMessage(), showSize(), updateArea(), and KisCanvas2::viewManager().

◆ createOptionWidgets()

QList< QPointer< QWidget > > KisToolRectangleBase::createOptionWidgets ( )

overridevirtual

Reimplemented from KoToolBase.

Definition at line 45 of file kis_tool_rectangle_base.cpp.

{
    QList<QPointer<QWidget>> widgetsList = KisToolShape::createOptionWidgets();
 
    KisRectangleConstraintWidget *widget =
        new KisRectangleConstraintWidget(0, this, showRoundCornersGUI());
 
    if (widgetsList.size() > 0
        && dynamic_cast<KisOptionCollectionWidget *>(
            widgetsList.first().data())) {
        KisOptionCollectionWidget *baseOptions =
            dynamic_cast<KisOptionCollectionWidget *>(
                widgetsList.first().data());
        KisOptionCollectionWidgetWithHeader *sectionRectangle =
            new KisOptionCollectionWidgetWithHeader(widget->windowTitle());
        sectionRectangle->appendWidget("rectangleConstraintWidget", widget);
        baseOptions->appendWidget("sectionRectangle", sectionRectangle);
    } else {
        widget->setContentsMargins(10, 10, 10, 10);
        widgetsList.append(widget);
    }
 
    return widgetsList;
}

References KisOptionCollectionWidget::appendWidget(), KisOptionCollectionWidgetWithHeader::appendWidget(), KoToolBase::createOptionWidgets(), and showRoundCornersGUI().

◆ createRect()

QRectF KisToolRectangleBase::createRect	(	const QPointF &	start,
		const QPointF &	end )

protectedvirtual

Definition at line 352 of file kis_tool_rectangle_base.cpp.

{
    QTransform t;
    t.translate(start.x(), start.y());
    t.rotateRadians(-getRotationAngle());
    t.translate(-start.x(), -start.y());
    const QTransform tInv = t.inverted();
 
    const QPointF end1 = t.map(end);
    const QPointF newStart(qRound(start.x()), qRound(start.y()));
    const QPointF newEnd(qRound(end1.x()), qRound(end1.y()));
    const QPointF newCenter = (newStart + newEnd) / 2.0;
   
    QRectF result(newStart, newEnd);
    result.moveCenter(tInv.map(newCenter));
 
    return result.normalized();
}

References getRotationAngle().

◆ deactivate()

void KisToolRectangleBase::deactivate ( )

overridevirtual

This method is called whenever this tool is no longer the active tool

See also: activate()

Reimplemented from KoToolBase.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 117 of file kis_tool_rectangle_base.cpp.

{
    cancelStroke();
    KisToolShape::deactivate();
}

References cancelStroke(), and KoToolBase::deactivate().

◆ drawX()

QPainterPath KisToolRectangleBase::drawX ( const QPointF & pt )

protected

Definition at line 415 of file kis_tool_rectangle_base.cpp.

                                                          {
    QPainterPath path;
    path.moveTo(QPointF(pt.x() - 5.0, pt.y() - 5.0)); path.lineTo(QPointF(pt.x() + 5.0, pt.y() + 5.0));
    path.moveTo(QPointF(pt.x() - 5.0, pt.y() + 5.0)); path.lineTo(QPointF(pt.x() + 5.0, pt.y() - 5.0));
    return path;
}

◆ endPrimaryAction()

void KisToolRectangleBase::endPrimaryAction ( KoPointerEvent * event )

overridevirtual

Called by KisToolProxy when the primary action is being finished, that is while mouseRelease or tabletRelease event. If the tool has ignored the event in beginPrimaryAction(), this method will not be called.

Reimplemented from KisTool.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 306 of file kis_tool_rectangle_base.cpp.

{
    CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
    // If the event was not originated by the user releasing the button
    // (for example due to the canvas loosing focus), then we just cancel the
    // operation. This prevents some issues with shapes being added after
    // the image was closed while the shape was being made
    if (event->spontaneous()) {
        endStroke();
    } else {
        cancelStroke();
    }
    event->accept();
}

References cancelStroke(), CHECK_MODE_SANITY_OR_RETURN, endStroke(), KisTool::PAINT_MODE, and KoPointerEvent::spontaneous().

◆ endStroke()

void KisToolRectangleBase::endStroke ( )

protected

Definition at line 337 of file kis_tool_rectangle_base.cpp.

{
    setMode(KisTool::HOVER_MODE);
    updateArea();
    finishRect(createRect(m_dragStart, m_dragEnd), m_roundCornersX, m_roundCornersY);
    endShape();
}

References createRect(), KisToolShape::endShape(), finishRect(), KisTool::HOVER_MODE, m_dragEnd, m_dragStart, m_roundCornersX, m_roundCornersY, KisToolPaint::setMode(), and updateArea().

◆ finishRect()

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

protectedpure virtual

Implemented in KisToolEllipse, KisToolRectangle, KisToolSelectElliptical, KisToolSelectRectangular, KisEllipseEnclosingProducer, and KisRectangleEnclosingProducer.

◆ getRotatedPath()

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

protected

Definition at line 422 of file kis_tool_rectangle_base.cpp.

                                                                                                       {
    QTransform t;
    t.translate(center.x(), center.y());
    t.rotateRadians(angle);
    t.translate(-center.x(), -center.y());
 
    path = t.map(path);
}

◆ getRotationAngle()

qreal KisToolRectangleBase::getRotationAngle ( )

protected

Definition at line 411 of file kis_tool_rectangle_base.cpp.

                                             {
    return m_angle + m_angleBuffer;
}

References m_angle, and m_angleBuffer.

◆ isFixedSize()

bool KisToolRectangleBase::isFixedSize ( )

protected

Definition at line 194 of file kis_tool_rectangle_base.cpp.

                                       {
  if (m_isWidthForced && m_isHeightForced) return true;
  if (m_isRatioForced && (m_isWidthForced || m_isHeightForced)) return true;
 
  return false;
}

References m_isHeightForced, m_isRatioForced, and m_isWidthForced.

◆ keyPressEvent()

void KisToolRectangleBase::keyPressEvent ( QKeyEvent * event )

overridevirtual

Called when a key is pressed. Implementors should call event->ignore() if they do not actually use the event. Default implementation ignores this event.

Parameters

event state and reason of this key press

Reimplemented from KoToolBase.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 123 of file kis_tool_rectangle_base.cpp.

                                                         {
    const Qt::Key key = KisExtendedModifiersMapper::workaroundShiftAltMetaHell(event);
 
    if (key == Qt::Key_Control) {
        m_currentModifiers |= Qt::ControlModifier;
    } else if (key == Qt::Key_Shift) {
        m_currentModifiers |= Qt::ShiftModifier;
    } else if (key == Qt::Key_Alt) {
        m_currentModifiers |= Qt::AltModifier;
    }
 
    KisToolShape::keyPressEvent(event);
}

References KoToolBase::keyPressEvent(), m_currentModifiers, and KisExtendedModifiersMapper::workaroundShiftAltMetaHell().

◆ keyReleaseEvent()

void KisToolRectangleBase::keyReleaseEvent ( QKeyEvent * event )

overridevirtual

Called when a key is released Implementors should call event->ignore() if they do not actually use the event. Default implementation ignores this event.

Parameters

event state and reason of this key release

Reimplemented from KoToolBase.

Reimplemented in KisToolSelectBase< __KisToolSelectEllipticalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 137 of file kis_tool_rectangle_base.cpp.

                                                           {
    const Qt::Key key = KisExtendedModifiersMapper::workaroundShiftAltMetaHell(event);
 
    if (key == Qt::Key_Control) {
        m_currentModifiers &= ~Qt::ControlModifier;
    } else if (key == Qt::Key_Shift) {
        m_currentModifiers &= ~Qt::ShiftModifier;
    } else if (key == Qt::Key_Alt) {
        m_currentModifiers &= ~Qt::AltModifier;
    }
 
    KisToolShape::keyReleaseEvent(event);
}

References KoToolBase::keyReleaseEvent(), m_currentModifiers, and KisExtendedModifiersMapper::workaroundShiftAltMetaHell().

◆ paint()

void KisToolRectangleBase::paint	(	QPainter &	painter,
		const KoViewConverter &	converter )

overridevirtual

Called by the canvas to paint any decorations that the tool deems needed. The painter has the top left of the canvas as its origin.

Parameters

painter	used for painting the shape
converter	to convert between internal and view coordinates.

Reimplemented from KisToolPaint.

Definition at line 101 of file kis_tool_rectangle_base.cpp.

{
    if(mode() == KisTool::PAINT_MODE) {
        paintRectangle(gc, createRect(m_dragStart, m_dragEnd));
    }
 
    KisToolPaint::paint(gc, converter);
}

References createRect(), m_dragEnd, m_dragStart, KisTool::mode(), KisToolPaint::paint(), KisTool::PAINT_MODE, and paintRectangle().

◆ paintRectangle()

void KisToolRectangleBase::paintRectangle	(	QPainter &	gc,
		const QRectF &	imageRect )

protectedvirtual

Reimplemented in KisToolEllipseBase.

Definition at line 376 of file kis_tool_rectangle_base.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(canvas());
 
    const QRect viewRect = pixelToView(imageRect).toAlignedRect();
 
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_SAFE_ASSERT_RECOVER_RETURN(kritaCanvas);
 
    const KisCoordinatesConverter *converter = kritaCanvas->coordinatesConverter();
    const qreal roundCornersX = converter->effectiveZoom() * m_roundCornersX;
    const qreal roundCornersY = converter->effectiveZoom() * m_roundCornersY;
 
    QPainterPath path;
    if (m_roundCornersX > 0 || m_roundCornersY > 0) {
        path.addRoundedRect(viewRect,
                            roundCornersX, roundCornersY);
    } else {
        path.addRect(viewRect);
    }
 
    getRotatedPath(path, viewRect.center(), getRotationAngle());
    path.addPath(drawX(pixelToView(m_dragStart)));
    path.addPath(drawX(pixelToView(m_dragCenter)));
    paintToolOutline(&gc, path);
}

References Private::canvas, KisCanvas2::coordinatesConverter, drawX(), KisCoordinatesConverter::effectiveZoom(), getRotatedPath(), getRotationAngle(), KIS_ASSERT_RECOVER_RETURN, KIS_SAFE_ASSERT_RECOVER_RETURN, m_dragCenter, m_dragStart, m_roundCornersX, m_roundCornersY, KisTool::paintToolOutline(), and KisTool::pixelToView().

◆ rectangleChanged

void KisToolRectangleBase::rectangleChanged ( const QRectF & newRect )

signal

◆ requestStrokeCancellation

void KisToolRectangleBase::requestStrokeCancellation ( )

overrideslot

Definition at line 329 of file kis_tool_rectangle_base.cpp.

{
    if (mode() != KisTool::PAINT_MODE) {
        return;
    }
    cancelStroke();
}

References cancelStroke(), KisTool::mode(), and KisTool::PAINT_MODE.

◆ requestStrokeEnd

void KisToolRectangleBase::requestStrokeEnd ( )

overrideslot

Definition at line 321 of file kis_tool_rectangle_base.cpp.

{
    if (mode() != KisTool::PAINT_MODE) {
        return;
    }
    endStroke();
}

References endStroke(), KisTool::mode(), and KisTool::PAINT_MODE.

◆ roundCornersChanged

void KisToolRectangleBase::roundCornersChanged	(	int	rx,
		int	ry )

slot

Definition at line 85 of file kis_tool_rectangle_base.cpp.

{
    m_roundCornersX = rx;
    m_roundCornersY = ry;
}

References m_roundCornersX, and m_roundCornersY.

◆ showRoundCornersGUI()

bool KisToolRectangleBase::showRoundCornersGUI ( ) const

protectedvirtual

Reimplemented in KisToolEllipseBase.

Definition at line 371 of file kis_tool_rectangle_base.cpp.

{
    return true;
}

◆ showSize()

void KisToolRectangleBase::showSize ( )

Definition at line 91 of file kis_tool_rectangle_base.cpp.

{
    KisCanvas2 *kisCanvas =dynamic_cast<KisCanvas2*>(canvas());
    KIS_SAFE_ASSERT_RECOVER_RETURN(kisCanvas);
    kisCanvas->viewManager()->showFloatingMessage(i18n("Width: %1 px\nHeight: %2 px"
                                                       , createRect(m_dragStart, m_dragEnd).width()
                                                       , createRect(m_dragStart, m_dragEnd).height()), QIcon(), 1000
                                                       , KisFloatingMessage::High,  Qt::AlignLeft | Qt::TextWordWrap | Qt::AlignVCenter);
 
}

References Private::canvas, createRect(), KisFloatingMessage::High, KIS_SAFE_ASSERT_RECOVER_RETURN, m_dragEnd, m_dragStart, KisViewManager::showFloatingMessage(), and KisCanvas2::viewManager().

◆ sigRequestReloadConfig

void KisToolRectangleBase::sigRequestReloadConfig ( )

signal

◆ updateArea()

void KisToolRectangleBase::updateArea ( )

protected

Definition at line 403 of file kis_tool_rectangle_base.cpp.

                                      {
    const QRectF bound = createRect(m_dragStart, m_dragEnd);
 
    canvas()->updateCanvas(convertToPt(bound).adjusted(-100, -100, +200, +200));
 
    Q_EMIT rectangleChanged(bound);
}

References Private::canvas, KisTool::convertToPt(), createRect(), m_dragEnd, m_dragStart, rectangleChanged(), and KisCanvas2::updateCanvas().

Member Data Documentation

◆ m_angle

qreal KisToolRectangleBase::m_angle

protected

Definition at line 67 of file kis_tool_rectangle_base.h.

◆ m_angleBuffer

qreal KisToolRectangleBase::m_angleBuffer

protected

Definition at line 68 of file kis_tool_rectangle_base.h.

◆ m_currentModifiers

Qt::KeyboardModifiers KisToolRectangleBase::m_currentModifiers

protected

Definition at line 69 of file kis_tool_rectangle_base.h.

◆ m_dragCenter

QPointF KisToolRectangleBase::m_dragCenter

protected

Definition at line 52 of file kis_tool_rectangle_base.h.

◆ m_dragEnd

QPointF KisToolRectangleBase::m_dragEnd

protected

Definition at line 54 of file kis_tool_rectangle_base.h.

◆ m_dragStart

QPointF KisToolRectangleBase::m_dragStart

protected

Definition at line 53 of file kis_tool_rectangle_base.h.

◆ m_forcedHeight

float KisToolRectangleBase::m_forcedHeight

protected

Definition at line 63 of file kis_tool_rectangle_base.h.

◆ m_forcedRatio

float KisToolRectangleBase::m_forcedRatio

protected

Definition at line 61 of file kis_tool_rectangle_base.h.

◆ m_forcedWidth

float KisToolRectangleBase::m_forcedWidth

protected

Definition at line 62 of file kis_tool_rectangle_base.h.

◆ m_isHeightForced

bool KisToolRectangleBase::m_isHeightForced

protected

Definition at line 59 of file kis_tool_rectangle_base.h.

◆ m_isRatioForced

bool KisToolRectangleBase::m_isRatioForced

protected

Definition at line 57 of file kis_tool_rectangle_base.h.

◆ m_isWidthForced

bool KisToolRectangleBase::m_isWidthForced

protected

Definition at line 58 of file kis_tool_rectangle_base.h.

◆ m_referenceAngle

qreal KisToolRectangleBase::m_referenceAngle

protected

Definition at line 66 of file kis_tool_rectangle_base.h.

◆ m_rotateActive

bool KisToolRectangleBase::m_rotateActive

protected

Definition at line 60 of file kis_tool_rectangle_base.h.

◆ m_roundCornersX

int KisToolRectangleBase::m_roundCornersX

protected

Definition at line 64 of file kis_tool_rectangle_base.h.

◆ m_roundCornersY

int KisToolRectangleBase::m_roundCornersY

protected

Definition at line 65 of file kis_tool_rectangle_base.h.

◆ m_type

ToolType KisToolRectangleBase::m_type

protected

Definition at line 55 of file kis_tool_rectangle_base.h.

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

libs/ui/tool/kis_tool_rectangle_base.h
libs/ui/tool/kis_tool_rectangle_base.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ToolType

Constructor & Destructor Documentation

◆ KisToolRectangleBase()

Member Function Documentation

◆ activate()

◆ applyConstraints()

◆ beginPrimaryAction()

◆ cancelStroke()

◆ constraintsChanged

◆ continuePrimaryAction()

◆ createOptionWidgets()

◆ createRect()

◆ deactivate()

◆ drawX()

◆ endPrimaryAction()

◆ endStroke()

◆ finishRect()

◆ getRotatedPath()

◆ getRotationAngle()

◆ isFixedSize()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ paint()

◆ paintRectangle()

◆ rectangleChanged

◆ requestStrokeCancellation

◆ requestStrokeEnd

◆ roundCornersChanged

◆ showRoundCornersGUI()

◆ showSize()

◆ sigRequestReloadConfig

◆ updateArea()

Member Data Documentation

◆ m_angle

◆ m_angleBuffer

◆ m_currentModifiers

◆ m_dragCenter

◆ m_dragEnd

◆ m_dragStart

◆ m_forcedHeight

◆ m_forcedRatio

◆ m_forcedWidth

◆ m_isHeightForced

◆ m_isRatioForced

◆ m_isWidthForced

◆ m_referenceAngle

◆ m_rotateActive

◆ m_roundCornersX

◆ m_roundCornersY

◆ m_type