#include <KisToolOutlineBase.h>

Inheritance diagram for KisToolOutlineBase:

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	activate (const QSet< KoShape * > &shapes) override

void	deactivate () override

void	requestStrokeCancellation () override

void	requestStrokeEnd () override

void	undoLastPoint ()

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	activate (const QSet< KoShape * > &shapes)

virtual void	deactivate ()

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

Public Member Functions
void	beginPrimaryAction (KoPointerEvent *event) override

void	continuePrimaryAction (KoPointerEvent *event) override

void	endPrimaryAction (KoPointerEvent *event) override

bool	eventFilter (QObject obj, QEvent event) override

bool	hasUserInteractionRunning () const

void	keyPressEvent (QKeyEvent *event) override

void	keyReleaseEvent (QKeyEvent *event) override

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

void	mouseMoveEvent (KoPointerEvent *event) override

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

KisPopupWidgetInterface *	popupWidget () override

	~KisToolOutlineBase () override

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
virtual void	finishOutline (const QVector< QPointF > &points)=0

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

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

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
virtual QList< QPointer< QWidget > >	createOptionWidgets ()

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 Member Functions
void	cancelStroke ()

QRectF	dragBoundingRect ()

void	endStroke ()

void	installBlockActionGuard ()

void	uninstallBlockActionGuard ()

void	updateCanvas ()

void	updateContinuedMode ()

void	updateFeedback ()

Private Attributes
QScopedPointer< KisInputActionGroupsMaskGuard >	m_blockModifyingActionsGuard

bool	m_continuedMode

bool	m_hasUserInteractionRunning

QPointF	m_lastCursorPos

int	m_numberOfContinuedModePoints

QPainterPath	m_paintPath

QVector< QPointF >	m_points

ToolType	m_type

Static Private Attributes
static constexpr int	FEEDBACK_LINE_WIDTH {2}

Additional Inherited Members
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)

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

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 18 of file KisToolOutlineBase.h.

Member Enumeration Documentation

◆ ToolType

enum KisToolOutlineBase::ToolType

Enumerator
PAINT
SELECT

Definition at line 23 of file KisToolOutlineBase.h.

                  {
        PAINT,
        SELECT
    };

Constructor & Destructor Documentation

◆ KisToolOutlineBase()

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

Definition at line 25 of file KisToolOutlineBase.cpp.

    : KisToolShape(canvas, cursor)
    , m_continuedMode(false)
    , m_type(type)
    , m_numberOfContinuedModePoints(0)
    , m_hasUserInteractionRunning(false)
{}

◆ ~KisToolOutlineBase()

KisToolOutlineBase::~KisToolOutlineBase ( )

override

Definition at line 33 of file KisToolOutlineBase.cpp.

34{}

Member Function Documentation

◆ activate

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

overrideslot

Definition at line 73 of file KisToolOutlineBase.cpp.

{
    KisToolShape::activate(shapes);
    connect(action("undo_polygon_selection"), SIGNAL(triggered()), SLOT(undoLastPoint()), Qt::UniqueConnection);
 
    KisInputManager *inputManager = (static_cast<KisCanvas2*>(canvas()))->globalInputManager();
    if (inputManager) {
        inputManager->attachPriorityEventFilter(this);
    }
}

References KoToolBase::action(), KisToolShape::activate(), KisInputManager::attachPriorityEventFilter(), Private::canvas, connect(), and undoLastPoint().

◆ beginPrimaryAction()

void KisToolOutlineBase::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< __KisToolSelectOutlineLocal >.

Definition at line 156 of file KisToolOutlineBase.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);
 
    if (!m_continuedMode || m_points.isEmpty()) {
        m_hasUserInteractionRunning = true;
        beginShape();
    }
 
    if (m_continuedMode) {
        m_points.append(convertToPixelCoordAndSnap(event));
        ++m_numberOfContinuedModePoints;
    } else {
        m_numberOfContinuedModePoints = 0;
        m_points.append(convertToPixelCoord(event));
    }
}

References KisToolShape::beginShape(), Private::canvas, KisTool::CLONE, KisTool::convertToPixelCoord(), KisTool::convertToPixelCoordAndSnap(), koIcon, m_continuedMode, m_hasUserInteractionRunning, m_numberOfContinuedModePoints, m_points, m_type, KisTool::MYPAINTBRUSH_UNPAINTABLE, KisTool::nodeEditable(), KisTool::nodePaintAbility(), PAINT, KisTool::PAINT_MODE, SELECT, KisTool::selectionEditable(), KisToolPaint::setMode(), KisViewManager::showFloatingMessage(), KisTool::UNPAINTABLE, and KisCanvas2::viewManager().

◆ cancelStroke()

void KisToolOutlineBase::cancelStroke ( )

private

Definition at line 282 of file KisToolOutlineBase.cpp.

{
    if (!hasUserInteractionRunning()) {
        return;
    }
    uninstallBlockActionGuard();
    setMode(KisTool::HOVER_MODE);
    m_hasUserInteractionRunning = false;
 
    m_points.clear();
    endShape();
}

References KisToolShape::endShape(), hasUserInteractionRunning(), KisTool::HOVER_MODE, m_hasUserInteractionRunning, m_points, KisToolPaint::setMode(), and uninstallBlockActionGuard().

◆ continuePrimaryAction()

void KisToolOutlineBase::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< __KisToolSelectOutlineLocal >.

Definition at line 193 of file KisToolOutlineBase.cpp.

{
    CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
 
    QPointF point = convertToPixelCoord(event);
    m_points.append(point);
    updateFeedback();
}

References CHECK_MODE_SANITY_OR_RETURN, KisTool::convertToPixelCoord(), m_points, KisTool::PAINT_MODE, and updateFeedback().

◆ deactivate

void KisToolOutlineBase::deactivate ( )

overrideslot

Definition at line 84 of file KisToolOutlineBase.cpp.

{
    cancelStroke();
    
    KisCanvas2 * kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
    kisCanvas->updateCanvas();
 
    m_continuedMode = false;
 
    KisInputManager *inputManager = kisCanvas->globalInputManager();
    if (inputManager) {
        inputManager->detachPriorityEventFilter(this);
    }
 
    KisToolShape::deactivate();
}

References cancelStroke(), Private::canvas, KoToolBase::deactivate(), KisInputManager::detachPriorityEventFilter(), KisCanvas2::globalInputManager(), KIS_ASSERT_RECOVER_RETURN, m_continuedMode, and KisCanvas2::updateCanvas().

◆ dragBoundingRect()

QRectF KisToolOutlineBase::dragBoundingRect ( )

private

Definition at line 249 of file KisToolOutlineBase.cpp.

{
    QRectF updateRect = pixelToView(QRectF(m_points.last(), m_lastCursorPos).normalized());
    updateRect = kisGrowRect(updateRect, FEEDBACK_LINE_WIDTH);
    return updateRect;
}

References FEEDBACK_LINE_WIDTH, kisGrowRect(), m_lastCursorPos, m_points, and KisTool::pixelToView().

◆ endPrimaryAction()

void KisToolOutlineBase::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< __KisToolSelectOutlineLocal >.

Definition at line 202 of file KisToolOutlineBase.cpp.

{
    CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
    setMode(KisTool::HOVER_MODE);
    if (!m_continuedMode) {
        // 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::HOVER_MODE, m_continuedMode, KisTool::PAINT_MODE, KisToolPaint::setMode(), and KoPointerEvent::spontaneous().

◆ endStroke()

void KisToolOutlineBase::endStroke ( )

private

Definition at line 268 of file KisToolOutlineBase.cpp.

{
    if (!hasUserInteractionRunning()) {
        return;
    }
    uninstallBlockActionGuard();
    setMode(KisTool::HOVER_MODE);
    m_hasUserInteractionRunning = false;
 
    finishOutline(m_points);
    m_points.clear();
    endShape();
}

References KisToolShape::endShape(), finishOutline(), hasUserInteractionRunning(), KisTool::HOVER_MODE, m_hasUserInteractionRunning, m_points, KisToolPaint::setMode(), and uninstallBlockActionGuard().

◆ eventFilter()

bool KisToolOutlineBase::eventFilter	(	QObject *	obj,
		QEvent *	event )

override

Definition at line 109 of file KisToolOutlineBase.cpp.

{
    Q_UNUSED(obj);
 
    if (m_points.isEmpty()) {
        return false;
    }
    if (event->type() == QEvent::MouseButtonPress ||
        event->type() == QEvent::MouseButtonDblClick) {
        QMouseEvent *mouseEvent = static_cast<QMouseEvent*>(event);
        if (mouseEvent->button() == Qt::RightButton) {
            undoLastPoint();
            return true;
        }
    } else if (event->type() == QEvent::TabletPress) {
        QTabletEvent *tabletEvent = static_cast<QTabletEvent*>(event);
        if (tabletEvent->button() == Qt::RightButton) {
            undoLastPoint();
            return true;
        }
    }
    return false;
}

References m_points, and undoLastPoint().

◆ finishOutline()

virtual void KisToolOutlineBase::finishOutline ( const QVector< QPointF > & points )

protectedpure virtual

Implemented in KisToolSelectOutline, and KisLassoEnclosingProducer.

◆ hasUserInteractionRunning()

bool KisToolOutlineBase::hasUserInteractionRunning ( ) const

Definition at line 263 of file KisToolOutlineBase.cpp.

{
    return m_hasUserInteractionRunning;
}

References m_hasUserInteractionRunning.

◆ installBlockActionGuard()

void KisToolOutlineBase::installBlockActionGuard ( )

private

Definition at line 305 of file KisToolOutlineBase.cpp.

{
    if (m_blockModifyingActionsGuard)
        return;
    m_blockModifyingActionsGuard.reset(new KisInputActionGroupsMaskGuard(
        static_cast<KisCanvas2*>(canvas())->inputActionGroupsMaskInterface(),
                                 ViewTransformActionGroup | ToolInvoactionActionGroup
                                ));
}

References Private::canvas, m_blockModifyingActionsGuard, ToolInvoactionActionGroup, and ViewTransformActionGroup.

◆ keyPressEvent()

void KisToolOutlineBase::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< __KisToolSelectOutlineLocal >.

Definition at line 36 of file KisToolOutlineBase.cpp.

{
    // Allow to enter continued mode only if we started drawing the shape
    if (mode() == PAINT_MODE && event->key() == Qt::Key_Control) {
        m_continuedMode = true;
        installBlockActionGuard();
    }
    KisToolShape::keyPressEvent(event);
}

References installBlockActionGuard(), KoToolBase::keyPressEvent(), m_continuedMode, KisTool::mode(), and KisTool::PAINT_MODE.

◆ keyReleaseEvent()

void KisToolOutlineBase::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< __KisToolSelectOutlineLocal >.

Definition at line 46 of file KisToolOutlineBase.cpp.

{
    if (event->key() == Qt::Key_Control ||
        !(event->modifiers() & Qt::ControlModifier)) {
        m_continuedMode = false;
        if (mode() != PAINT_MODE) {
            endStroke();
        }
    }
    KisToolShape::keyReleaseEvent(event);
}

References endStroke(), KoToolBase::keyReleaseEvent(), m_continuedMode, KisTool::mode(), and KisTool::PAINT_MODE.

◆ mouseMoveEvent()

void KisToolOutlineBase::mouseMoveEvent ( KoPointerEvent * event )

overridevirtual

Called when the mouse or stylus moved over the canvas. Implementors should call event->ignore() if they do not actually use the event.

Parameters

event state and reason of this mouse or stylus move

Reimplemented from KisTool.

Reimplemented in KisToolSelectBase< __KisToolSelectOutlineLocal >.

Definition at line 58 of file KisToolOutlineBase.cpp.

{
    if (m_continuedMode && mode() != PAINT_MODE) {
        updateContinuedMode();
        m_lastCursorPos = convertToPixelCoordAndSnap(event);
    } else {
        m_lastCursorPos = convertToPixelCoord(event);
    }
    if (mode() == PAINT_MODE) {
        KisToolShape::requestUpdateOutline(event->point, event);
    }
 
    KisToolShape::mouseMoveEvent(event);
}

References KisTool::convertToPixelCoord(), KisTool::convertToPixelCoordAndSnap(), m_continuedMode, m_lastCursorPos, KisTool::mode(), KoToolBase::mouseMoveEvent(), KisTool::PAINT_MODE, KoPointerEvent::point, KisToolPaint::requestUpdateOutline(), and updateContinuedMode().

◆ paint()

void KisToolOutlineBase::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.

Implements KoToolBase.

Definition at line 220 of file KisToolOutlineBase.cpp.

{
    if ((mode() == KisTool::PAINT_MODE || m_continuedMode) && !m_points.isEmpty()) {
        QPainterPath outline;
        outline.moveTo(pixelToView(m_points.first()));
        for (qint32 i = 1; i < m_points.size(); ++i) {
            outline.lineTo(pixelToView(m_points[i]));
        }
        if (m_continuedMode && mode() != KisTool::PAINT_MODE) {
            outline.lineTo(pixelToView(m_lastCursorPos));
        }
        paintToolOutline(&gc, outline);
    }
 
    KisToolShape::paint(gc, converter);
}

References m_continuedMode, m_lastCursorPos, m_points, KisTool::mode(), KoToolBase::paint(), KisTool::PAINT_MODE, KisTool::paintToolOutline(), and KisTool::pixelToView().

◆ popupWidget()

KisPopupWidgetInterface * KisToolOutlineBase::popupWidget ( )

overridevirtual

Returns: a widget with useful controls to be popped up on top of the canvas. Will not be called if popupActionsMenu() does not return null.

Reimplemented from KoToolBase.

Reimplemented in KisToolSelectBase< __KisToolSelectOutlineLocal >.

Definition at line 102 of file KisToolOutlineBase.cpp.

{
    return !m_points.isEmpty() || m_type == SELECT ? nullptr : KisToolShape::popupWidget();
}

References m_points, m_type, KoToolBase::popupWidget(), and SELECT.

◆ requestStrokeCancellation

void KisToolOutlineBase::requestStrokeCancellation ( )

overrideslot

Definition at line 300 of file KisToolOutlineBase.cpp.

{
    cancelStroke();
}

References cancelStroke().

◆ requestStrokeEnd

void KisToolOutlineBase::requestStrokeEnd ( )

overrideslot

Definition at line 295 of file KisToolOutlineBase.cpp.

{
    endStroke();
}

References endStroke().

◆ undoLastPoint

void KisToolOutlineBase::undoLastPoint ( )

slot

Definition at line 133 of file KisToolOutlineBase.cpp.

{
    if(!m_points.isEmpty() && m_continuedMode && mode() != PAINT_MODE && m_numberOfContinuedModePoints > 0) {
        // Initialize with the dragging segment's rect
        QRectF updateRect = dragBoundingRect();
 
        if (m_points.size() > 1) {
            // Add the rect for the last segment
            const QRectF lastSegmentRect =
                pixelToView(QRectF(m_points.last(), m_points.at(m_points.size() - 2)).normalized())
                .adjusted(-FEEDBACK_LINE_WIDTH, -FEEDBACK_LINE_WIDTH, FEEDBACK_LINE_WIDTH, FEEDBACK_LINE_WIDTH);
            updateRect = updateRect.united(lastSegmentRect);
 
            m_points.pop_back();
            --m_numberOfContinuedModePoints;
        }
 
        // Add the new dragging segment's rect
        updateRect = updateRect.united(dragBoundingRect());
        updateCanvasViewRect(updateRect);
    }
}

References dragBoundingRect(), FEEDBACK_LINE_WIDTH, m_continuedMode, m_numberOfContinuedModePoints, m_points, KisTool::mode(), KisTool::PAINT_MODE, KisTool::pixelToView(), and KisTool::updateCanvasViewRect().

◆ uninstallBlockActionGuard()

void KisToolOutlineBase::uninstallBlockActionGuard ( )

private

Definition at line 315 of file KisToolOutlineBase.cpp.

{
    m_blockModifyingActionsGuard.reset();
}

References m_blockModifyingActionsGuard.

◆ updateCanvas()

void KisToolOutlineBase::updateCanvas ( )

private

◆ updateContinuedMode()

void KisToolOutlineBase::updateContinuedMode ( )

private

Definition at line 256 of file KisToolOutlineBase.cpp.

{
    if (!m_points.isEmpty()) {
        updateCanvasViewRect(dragBoundingRect());
    }
}

References dragBoundingRect(), m_points, and KisTool::updateCanvasViewRect().

◆ updateFeedback()

void KisToolOutlineBase::updateFeedback ( )

private

Definition at line 237 of file KisToolOutlineBase.cpp.

{
    if (m_points.count() > 1) {
        qint32 lastPointIndex = m_points.count() - 1;
 
        QRectF updateRect = QRectF(m_points[lastPointIndex - 1], m_points[lastPointIndex]).normalized();
        updateRect = kisGrowRect(updateRect, FEEDBACK_LINE_WIDTH);
 
        updateCanvasPixelRect(updateRect);
    }
}

References FEEDBACK_LINE_WIDTH, kisGrowRect(), m_points, and KisTool::updateCanvasPixelRect().

Member Data Documentation

◆ FEEDBACK_LINE_WIDTH

constexpr int KisToolOutlineBase::FEEDBACK_LINE_WIDTH {2}

staticconstexprprivate

Definition at line 58 of file KisToolOutlineBase.h.

58{2};

◆ m_blockModifyingActionsGuard

QScopedPointer<KisInputActionGroupsMaskGuard> KisToolOutlineBase::m_blockModifyingActionsGuard

private

Definition at line 67 of file KisToolOutlineBase.h.

◆ m_continuedMode

bool KisToolOutlineBase::m_continuedMode

private

Definition at line 62 of file KisToolOutlineBase.h.

◆ m_hasUserInteractionRunning

bool KisToolOutlineBase::m_hasUserInteractionRunning

private

Definition at line 66 of file KisToolOutlineBase.h.

◆ m_lastCursorPos

QPointF KisToolOutlineBase::m_lastCursorPos

private

Definition at line 63 of file KisToolOutlineBase.h.

◆ m_numberOfContinuedModePoints

int KisToolOutlineBase::m_numberOfContinuedModePoints

private

Definition at line 65 of file KisToolOutlineBase.h.

◆ m_paintPath

QPainterPath KisToolOutlineBase::m_paintPath

private

Definition at line 60 of file KisToolOutlineBase.h.

◆ m_points

QVector<QPointF> KisToolOutlineBase::m_points

private

Definition at line 61 of file KisToolOutlineBase.h.

◆ m_type

ToolType KisToolOutlineBase::m_type

private

Definition at line 64 of file KisToolOutlineBase.h.

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

libs/ui/tool/KisToolOutlineBase.h
libs/ui/tool/KisToolOutlineBase.cpp

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ToolType

Constructor & Destructor Documentation

◆ KisToolOutlineBase()

◆ ~KisToolOutlineBase()

Member Function Documentation

◆ activate

◆ beginPrimaryAction()

◆ cancelStroke()

◆ continuePrimaryAction()

◆ deactivate

◆ dragBoundingRect()

◆ endPrimaryAction()

◆ endStroke()

◆ eventFilter()

◆ finishOutline()

◆ hasUserInteractionRunning()

◆ installBlockActionGuard()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ mouseMoveEvent()

◆ paint()

◆ popupWidget()

◆ requestStrokeCancellation

◆ requestStrokeEnd

◆ undoLastPoint

◆ uninstallBlockActionGuard()

◆ updateCanvas()

◆ updateContinuedMode()

◆ updateFeedback()

Member Data Documentation

◆ FEEDBACK_LINE_WIDTH

◆ m_blockModifyingActionsGuard

◆ m_continuedMode

◆ m_hasUserInteractionRunning

◆ m_lastCursorPos

◆ m_numberOfContinuedModePoints

◆ m_paintPath

◆ m_points

◆ m_type