#include <kis_tool.h>

Inheritance diagram for KisTool:

Public Types
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	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	canvasResourceChanged (int key, const QVariant &res)

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

Signals
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
virtual void	activateAlternateAction (AlternateAction action)

virtual void	activatePrimaryAction ()

virtual bool	alternateActionSupportsHiResEvents (AlternateAction action) const

virtual void	beginAlternateAction (KoPointerEvent *event, AlternateAction action)

virtual void	beginAlternateDoubleClickAction (KoPointerEvent *event, AlternateAction action)

virtual void	beginPrimaryAction (KoPointerEvent *event)

virtual void	beginPrimaryDoubleClickAction (KoPointerEvent *event)

virtual void	continueAlternateAction (KoPointerEvent *event, AlternateAction action)

virtual void	continuePrimaryAction (KoPointerEvent *event)

virtual void	deactivateAlternateAction (AlternateAction action)

virtual void	deactivatePrimaryAction ()

void	deleteSelection () override

virtual void	endAlternateAction (KoPointerEvent *event, AlternateAction action)

virtual void	endPrimaryAction (KoPointerEvent *event)

virtual int	flags () const

bool	isActive () const

	KisTool (KoCanvasBase *canvas, const QCursor &cursor)

void	mouseDoubleClickEvent (KoPointerEvent *event) override

void	mouseMoveEvent (KoPointerEvent *event) override

void	mousePressEvent (KoPointerEvent *event) override

void	mouseReleaseEvent (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

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

	KoToolBase (KoCanvasBase *canvas)

bool	maskSyntheticEvents () const

QList< QPointer< QWidget > >	optionWidgets ()

virtual void	paint (QPainter &painter, const KoViewConverter &converter)=0

virtual bool	paste ()

virtual QMenu *	popupActionsMenu ()

virtual KisPopupWidgetInterface *	popupWidget ()

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

Static Public Member Functions
static AlternateAction	actionToAlternateAction (ToolAction action)

Public Attributes
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
enum	ToolMode : int { HOVER_MODE , PAINT_MODE , SECONDARY_PAINT_MODE , MIRROR_AXIS_SETUP_MODE , GESTURE_MODE , PAN_MODE , OTHER , OTHER_1 }

Protected Slots
virtual void	resetCursorStyle ()

Protected Member Functions
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)

QWidget *	createOptionWidget () override

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)

virtual void	setMode (ToolMode mode)

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)

Properties
bool	isActive

Private Attributes
Private *const	d

Friends
class	KisToolPaintingInformationBuilder

Additional Inherited Members
Protected Attributes inherited from KoToolBase
KoToolBasePrivate *	d_ptr

Detailed Description

Definition at line 63 of file kis_tool.cc.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
FLAG_USES_CUSTOM_PRESET
FLAG_USES_CUSTOM_COMPOSITEOP
FLAG_USES_CUSTOM_SIZE

Definition at line 47 of file kis_tool.h.

47{ FLAG_USES_CUSTOM_PRESET=0x01, FLAG_USES_CUSTOM_COMPOSITEOP=0x02, FLAG_USES_CUSTOM_SIZE=0x04 };

KisTool::FLAG_USES_CUSTOM_SIZE

@ FLAG_USES_CUSTOM_SIZE

Definition kis_tool.h:47

KisTool::FLAG_USES_CUSTOM_COMPOSITEOP

@ FLAG_USES_CUSTOM_COMPOSITEOP

Definition kis_tool.h:47

KisTool::FLAG_USES_CUSTOM_PRESET

@ FLAG_USES_CUSTOM_PRESET

Definition kis_tool.h:47

◆ AlternateAction

enum KisTool::AlternateAction

Enumerator
ChangeSize
ChangeSizeSnap
SampleFgNode
SampleBgNode
SampleFgImage
SampleBgImage
Secondary
Third
Fourth
Fifth
NONE

Definition at line 134 of file kis_tool.h.

                         {
        ChangeSize = AlternateChangeSize, // Default: Shift+Left click
        ChangeSizeSnap = AlternateChangeSizeSnap, // Default: Shift+Z+Left click
        SampleFgNode = AlternateSampleFgNode, // Default: Ctrl+Alt+Left click
        SampleBgNode = AlternateSampleBgNode, // Default: Ctrl+Alt+Right click
        SampleFgImage = AlternateSampleFgImage, // Default: Ctrl+Left click
        SampleBgImage = AlternateSampleBgImage, // Default: Ctrl+Right click
        Secondary = AlternateSecondary,
        Third = AlternateThird,
        Fourth = AlternateFourth,
        Fifth = AlternateFifth,
        NONE = 10000
    };

◆ NodePaintAbility

enum KisTool::NodePaintAbility

Enumerator
VECTOR
CLONE
PAINT
UNPAINTABLE
MYPAINTBRUSH_UNPAINTABLE

Definition at line 148 of file kis_tool.h.

                          {
        VECTOR,
        CLONE,
        PAINT,
        UNPAINTABLE,
        MYPAINTBRUSH_UNPAINTABLE
    };

◆ ToolAction

enum KisTool::ToolAction

Enumerator
Primary
AlternateChangeSize
AlternateChangeSizeSnap
AlternateSampleFgNode
AlternateSampleBgNode
AlternateSampleFgImage
AlternateSampleBgImage
AlternateSecondary
AlternateThird
AlternateFourth
AlternateFifth
Alternate_NONE

Definition at line 117 of file kis_tool.h.

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

◆ ToolMode

enum KisTool::ToolMode : int

protected

Enumerator
HOVER_MODE
PAINT_MODE
SECONDARY_PAINT_MODE
MIRROR_AXIS_SETUP_MODE
GESTURE_MODE
PAN_MODE
OTHER
OTHER_1

Definition at line 298 of file kis_tool.h.

                 : int {
        HOVER_MODE,
        PAINT_MODE,
        SECONDARY_PAINT_MODE,
        MIRROR_AXIS_SETUP_MODE,
        GESTURE_MODE,
        PAN_MODE,
        OTHER, // tool-specific modes, like multibrush's symmetry axis setup
        OTHER_1
    };

Constructor & Destructor Documentation

◆ KisTool()

KisTool::KisTool	(	KoCanvasBase *	canvas,
		const QCursor &	cursor )

Definition at line 78 of file kis_tool.cc.

    : KoToolBase(canvas)
    , d(new Private)
{
    d->cursor = cursor;
 
    connect(KisConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(resetCursorStyle()));
    connect(this, SIGNAL(isActiveChanged(bool)), SLOT(resetCursorStyle()));
}

References connect(), cursor, d, KisConfigNotifier::instance(), isActiveChanged(), and resetCursorStyle().

◆ ~KisTool()

KisTool::~KisTool ( )

override

Definition at line 88 of file kis_tool.cc.

{
    delete d;
}

References d.

Member Function Documentation

◆ actionToAlternateAction()

KisTool::AlternateAction KisTool::actionToAlternateAction ( ToolAction action )

static

Definition at line 416 of file kis_tool.cc.

                                                                         {
    KIS_ASSERT_RECOVER_RETURN_VALUE(action != Primary, Secondary);
    return (AlternateAction)action;
}

References KoToolBase::action(), KIS_ASSERT_RECOVER_RETURN_VALUE, Primary, and Secondary.

◆ activate

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

overrideslot

Definition at line 93 of file kis_tool.cc.

{
    KoToolBase::activate(shapes);
 
    resetCursorStyle();
 
    if (!canvas()) return;
    if (!canvas()->resourceManager()) return;
 
 
    d->currentFgColor = canvas()->resourceManager()->resource(KoCanvasResource::ForegroundColor).value<KoColor>();
    d->currentBgColor = canvas()->resourceManager()->resource(KoCanvasResource::BackgroundColor).value<KoColor>();
 
    if (canvas()->resourceManager()->hasResource(KoCanvasResource::CurrentPattern)) {
        d->currentPattern = canvas()->resourceManager()->resource(KoCanvasResource::CurrentPattern).value<KoPatternSP>();
    }
 
    if (canvas()->resourceManager()->hasResource(KoCanvasResource::CurrentGradient)) {
        d->currentGradient = canvas()->resourceManager()->resource(KoCanvasResource::CurrentGradient).value<KoAbstractGradientSP>();
    }
 
    KisPaintOpPresetSP preset = canvas()->resourceManager()->resource(KoCanvasResource::CurrentPaintOpPreset).value<KisPaintOpPresetSP>();
    if (preset && preset->settings()) {
        preset->settings()->activate();
    }
 
    if (canvas()->resourceManager()->hasResource(KoCanvasResource::HdrExposure)) {
        d->currentExposure = static_cast<float>(canvas()->resourceManager()->resource(KoCanvasResource::HdrExposure).toDouble());
    }
 
    if (canvas()->resourceManager()->hasResource(KoCanvasResource::CurrentGeneratorConfiguration)) {
        d->currentGenerator = canvas()->resourceManager()->resource(KoCanvasResource::CurrentGeneratorConfiguration).value<KisFilterConfiguration*>();
    }
 
    d->m_isActive = true;
    Q_EMIT isActiveChanged(true);
}

References KoToolBase::activate(), KoCanvasResource::BackgroundColor, Private::canvas, KoCanvasResource::CurrentGeneratorConfiguration, KoCanvasResource::CurrentGradient, KoCanvasResource::CurrentPaintOpPreset, KoCanvasResource::CurrentPattern, d, KoCanvasResource::ForegroundColor, KoCanvasResource::HdrExposure, isActiveChanged(), resetCursorStyle(), and KoCanvasBase::resourceManager.

◆ activateAlternateAction()

void KisTool::activateAlternateAction ( AlternateAction action )

virtual

Reimplemented in KisToolFreehand, KisToolPaint, KisToolEncloseAndFill, KisToolBasicBrushBase, KisToolLazyBrush, KisToolTransform, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 456 of file kis_tool.cc.

{
    Q_UNUSED(action);
}

References KoToolBase::action().

◆ activatePrimaryAction()

void KisTool::activatePrimaryAction ( )

virtual

Called by KisToolProxy when the primary action of the tool is going to be started now, that is when all the modifiers are pressed and the only thing left is just to press the mouse button. On coming of this callback the tool is supposed to prepare the cursor and/or the outline to show the user shat is going to happen next

Reimplemented in KisToolPaint, KisToolColorSampler, KisDynamicDelegatedTool< KisToolShape >, KisToolLazyBrush, KisToolSmartPatch, and KisToolTransform.

Definition at line 421 of file kis_tool.cc.

{
    resetCursorStyle();
}

References resetCursorStyle().

◆ alternateActionSupportsHiResEvents()

bool KisTool::alternateActionSupportsHiResEvents ( AlternateAction action ) const

virtual

Reimplemented in KisToolSelectOutline.

Definition at line 489 of file kis_tool.cc.

{
    Q_UNUSED(action);
    return false;
}

References KoToolBase::action().

◆ beginAlternateAction()

void KisTool::beginAlternateAction	(	KoPointerEvent *	event,
		AlternateAction	action )

virtual

Reimplemented in KisToolFreehand, KisToolPaint, KisToolPolylineBase, KisToolFill, KisToolMove, KisToolMultihand, KisToolEncloseAndFill, KisToolBasicBrushBase, KisToolLazyBrush, KisToolTransform, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, KisToolSelectBase< __KisToolSelectRectangularLocal >, and KisAssistantTool.

Definition at line 466 of file kis_tool.cc.

{
    Q_UNUSED(event);
    Q_UNUSED(action);
}

References KoToolBase::action().

◆ beginAlternateDoubleClickAction()

void KisTool::beginAlternateDoubleClickAction	(	KoPointerEvent *	event,
		AlternateAction	action )

virtual

Reimplemented in KisToolEncloseAndFill.

Definition at line 472 of file kis_tool.cc.

{
    beginAlternateAction(event, action);
}

References KoToolBase::action(), and beginAlternateAction().

◆ beginPrimaryAction()

void KisTool::beginPrimaryAction ( KoPointerEvent * event )

virtual

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 in KisToolFreehand, KisToolPolylineBase, KisToolRectangleBase, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, KisToolSelectBase< __KisToolSelectRectangularLocal >, KisToolOutlineBase, KisAssistantTool, KisToolColorSampler, KisToolFill, KisToolGradient, KisToolLine, KisToolMeasure, KisToolMove, KisToolMultihand, KisToolPan, KisToolCrop, KisToolDyna, KisToolEncloseAndFill, KisDynamicDelegatedTool< KisToolShape >, KisToolBasicBrushBase, KisToolLazyBrush, KisToolSmartPatch, and KisToolTransform.

Definition at line 431 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ beginPrimaryDoubleClickAction()

void KisTool::beginPrimaryDoubleClickAction ( KoPointerEvent * event )

virtual

The same as beginPrimaryAction(), but called when the stroke is started by a double-click

See also: beginPrimaryAction()

Reimplemented in KisToolPolylineBase, KisToolCrop, and KisDynamicDelegatedTool< KisToolShape >.

Definition at line 436 of file kis_tool.cc.

{
    beginPrimaryAction(event);
}

References beginPrimaryAction().

◆ blockUntilOperationsFinished()

bool KisTool::blockUntilOperationsFinished ( )

protected

Definition at line 632 of file kis_tool.cc.

{
    KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
    KisViewManager* viewManager = kiscanvas->viewManager();
    return viewManager->blockUntilOperationsFinished(image());
}

References KisViewManager::blockUntilOperationsFinished(), Private::canvas, image(), and KisCanvas2::viewManager().

◆ blockUntilOperationsFinishedForced()

void KisTool::blockUntilOperationsFinishedForced ( )

protected

Definition at line 639 of file kis_tool.cc.

{
    KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
    KisViewManager* viewManager = kiscanvas->viewManager();
    viewManager->blockUntilOperationsFinishedForced(image());
}

References KisViewManager::blockUntilOperationsFinishedForced(), Private::canvas, image(), and KisCanvas2::viewManager().

◆ canvasResourceChanged

void KisTool::canvasResourceChanged	(	int	key,
		const QVariant &	res )

overrideslot

Definition at line 139 of file kis_tool.cc.

{
    switch (key) {
    case(KoCanvasResource::ForegroundColor):
        d->currentFgColor = v.value<KoColor>();
        break;
    case(KoCanvasResource::BackgroundColor):
        d->currentBgColor = v.value<KoColor>();
        break;
    case(KoCanvasResource::CurrentPattern):
        d->currentPattern = v.value<KoPatternSP>();
        break;
    case(KoCanvasResource::CurrentGradient):
        d->currentGradient = v.value<KoAbstractGradientSP>();
        break;
    case(KoCanvasResource::HdrExposure):
        d->currentExposure = static_cast<float>(v.toDouble());
        break;
    case(KoCanvasResource::CurrentGeneratorConfiguration):
        d->currentGenerator = static_cast<KisFilterConfiguration*>(v.value<void *>());
        break;
    case(KoCanvasResource::CurrentKritaNode):
        resetCursorStyle();
        break;
    default:
        break; // Do nothing
    };
}

References KoCanvasResource::BackgroundColor, KoCanvasResource::CurrentGeneratorConfiguration, KoCanvasResource::CurrentGradient, KoCanvasResource::CurrentKritaNode, KoCanvasResource::CurrentPattern, d, KoCanvasResource::ForegroundColor, KoCanvasResource::HdrExposure, resetCursorStyle(), and v.

◆ continueAlternateAction()

void KisTool::continueAlternateAction	(	KoPointerEvent *	event,
		AlternateAction	action )

virtual

Reimplemented in KisToolFreehand, KisToolPaint, KisAssistantTool, KisToolFill, KisToolMove, KisToolMultihand, KisToolEncloseAndFill, KisToolBasicBrushBase, KisToolLazyBrush, KisToolTransform, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 477 of file kis_tool.cc.

{
    Q_UNUSED(event);
    Q_UNUSED(action);
}

References KoToolBase::action().

◆ continuePrimaryAction()

void KisTool::continuePrimaryAction ( KoPointerEvent * event )

virtual

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 in KisToolFreehand, KisToolRectangleBase, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, KisToolSelectBase< __KisToolSelectRectangularLocal >, KisToolOutlineBase, KisAssistantTool, KisToolColorSampler, KisToolFill, KisToolGradient, KisToolLine, KisToolMeasure, KisToolMove, KisToolMultihand, KisToolPan, KisToolCrop, KisToolDyna, KisDynamicDelegatedTool< KisToolShape >, KisToolBasicBrushBase, KisToolLazyBrush, KisToolSmartPatch, and KisToolTransform.

Definition at line 441 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ convertDocumentToWidget()

QPointF KisTool::convertDocumentToWidget ( const QPointF & pt )

protected

Definition at line 181 of file kis_tool.cc.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    return kritaCanvas->coordinatesConverter()->documentToWidget(pt);
}

References Private::canvas, KisCanvas2::coordinatesConverter, and KisCoordinatesConverter::documentToWidget().

◆ convertToImagePixelCoordFloored()

QPoint KisTool::convertToImagePixelCoordFloored ( KoPointerEvent * e )

protected

Convert from native (postscript points) to integer image pixel coordinates. This rounds down (not truncate) the pixel coordinates and should be used in preference to QPointF::toPoint(), which rounds, to ensure the cursor acts on the pixel it is visually over.

Definition at line 236 of file kis_tool.cc.

{
    if (!image())
        return e->point.toPoint();
 
    return image()->documentToImagePixelFloored(e->point);
}

References KisImage::documentToImagePixelFloored(), image(), and KoPointerEvent::point.

◆ convertToPixelCoord() [1/2]

QPointF KisTool::convertToPixelCoord ( const QPointF & pt )

protected

Definition at line 197 of file kis_tool.cc.

{
    if (!image())
        return pt;
 
    return image()->documentToPixel(pt);
}

References KisImage::documentToPixel(), and image().

◆ convertToPixelCoord() [2/2]

QPointF KisTool::convertToPixelCoord ( KoPointerEvent * e )

protected

Convert from native (postscript points) to image pixel coordinates.

Definition at line 189 of file kis_tool.cc.

{
    if (!image())
        return e->point;
 
    return image()->documentToPixel(e->point);
}

References KisImage::documentToPixel(), image(), and KoPointerEvent::point.

◆ convertToPixelCoordAndAlignOnWidget()

QPointF KisTool::convertToPixelCoordAndAlignOnWidget ( const QPointF & pt )

protected

Definition at line 205 of file kis_tool.cc.

{
    KisCanvas2 *canvas2 = dynamic_cast<KisCanvas2 *>(canvas());
    KIS_ASSERT(canvas2);
    const KisCoordinatesConverter *converter = canvas2->coordinatesConverter();
    const QPointF imagePos = converter->widgetToImage(QPointF(converter->documentToWidget(pt).toPoint()));
    return imagePos;
}

References Private::canvas, KisCanvas2::coordinatesConverter, KisCoordinatesConverter::documentToWidget(), KIS_ASSERT, and KisCoordinatesConverter::widgetToImage().

◆ convertToPixelCoordAndSnap() [1/2]

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

protected

Definition at line 225 of file kis_tool.cc.

{
    if (!image())
        return pt;
 
    KoSnapGuide *snapGuide = canvas()->snapGuide();
    QPointF pos = snapGuide->snap(pt, offset, Qt::NoModifier);
 
    return image()->documentToPixel(pos);
}

References Private::canvas, KisImage::documentToPixel(), image(), KoSnapGuide::snap(), and KoCanvasBase::snapGuide.

◆ convertToPixelCoordAndSnap() [2/2]

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

protected

Definition at line 214 of file kis_tool.cc.

{
    if (!image())
        return e->point;
 
    KoSnapGuide *snapGuide = canvas()->snapGuide();
    QPointF pos = snapGuide->snap(e->point, offset, useModifiers ? e->modifiers() : Qt::NoModifier);
 
    return image()->documentToPixel(pos);
}

References Private::canvas, KisImage::documentToPixel(), image(), KoPointerEvent::modifiers(), KoPointerEvent::point, KoSnapGuide::snap(), and KoCanvasBase::snapGuide.

◆ convertToPt() [1/2]

QRectF KisTool::convertToPt ( const QRectF & rect )

protected

Definition at line 252 of file kis_tool.cc.

{
    if (!image())
        return rect;
    QRectF r;
    //We add 1 in the following to the extreme coords because a pixel always has size
    r.setCoords(int(rect.left()) / image()->xRes(), int(rect.top()) / image()->yRes(),
                int(rect.right()) / image()->xRes(), int( rect.bottom()) / image()->yRes());
    return r;
}

References image().

◆ convertToPt() [2/2]

qreal KisTool::convertToPt ( qreal value )

protected

Definition at line 263 of file kis_tool.cc.

{
    const qreal avgResolution = 0.5 * (image()->xRes() + image()->yRes());
    return value / avgResolution;
}

References image(), value(), KisImage::xRes(), and KisImage::yRes().

◆ createOptionWidget()

QWidget * KisTool::createOptionWidget ( )

overrideprotectedvirtual

Reimplement this if your tool actually has an option widget. Sets the option widget to 0 by default.

Reimplemented from KoToolBase.

Reimplemented in KisToolPaint, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, KisToolSelectBase< __KisToolSelectRectangularLocal >, KisToolShape, KisToolBrush, KisToolColorSampler, KisToolFill, KisToolGradient, KisToolLine, KisToolMeasure, KisToolMove, KisToolMultihand, KisToolCrop, KisToolDyna, KisToolEncloseAndFill, KisToolLazyBrush, KisToolPolyline, KisToolSmartPatch, and KisToolTransform.

Definition at line 578 of file kis_tool.cc.

{
    d->optionWidget = new QLabel(i18n("No options"));
    d->optionWidget->setObjectName("SpecialSpacer");
    return d->optionWidget;
}

References d.

◆ currentBgColor()

KoColor KisTool::currentBgColor ( )

protected

◆ currentFgColor()

KoColor KisTool::currentFgColor ( )

protected

◆ currentGenerator()

KisFilterConfigurationSP KisTool::currentGenerator ( )

protected

◆ currentGradient()

KoAbstractGradientSP KisTool::currentGradient ( )

protected

◆ currentImage()

KisImageWSP KisTool::currentImage ( )

protected

Definition at line 393 of file kis_tool.cc.

{
    return image();
}

References image().

◆ currentNode()

KisNodeSP KisTool::currentNode ( ) const

protected

Definition at line 370 of file kis_tool.cc.

{
    KisNodeSP node = canvas()->resourceManager()->resource(KoCanvasResource::CurrentKritaNode).value<KisNodeWSP>();
    return node;
}

References Private::canvas, KoCanvasResource::CurrentKritaNode, and KoCanvasBase::resourceManager.

◆ currentPaintOpPreset()

KisPaintOpPresetSP KisTool::currentPaintOpPreset ( )

protected

Definition at line 359 of file kis_tool.cc.

{
    QVariant v = canvas()->resourceManager()->resource(KoCanvasResource::CurrentPaintOpPreset);
    if (v.isNull()) {
        return 0;
    }
    else {
        return v.value<KisPaintOpPresetSP>();
    }
}

References Private::canvas, KoCanvasResource::CurrentPaintOpPreset, KoCanvasBase::resourceManager, and v.

◆ currentPattern()

KoPatternSP KisTool::currentPattern ( )

protected

◆ cursor()

QCursor KisTool::cursor ( ) const

protected

◆ deactivate

void KisTool::deactivate ( )

overrideslot

Definition at line 131 of file kis_tool.cc.

{
    d->m_isActive = false;
    Q_EMIT isActiveChanged(false);
 
    KoToolBase::deactivate();
}

References d, KoToolBase::deactivate(), and isActiveChanged().

◆ deactivateAlternateAction()

void KisTool::deactivateAlternateAction ( AlternateAction action )

virtual

Reimplemented in KisToolFreehand, KisToolPaint, KisToolEncloseAndFill, KisToolBasicBrushBase, KisToolLazyBrush, KisToolTransform, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 461 of file kis_tool.cc.

{
    Q_UNUSED(action);
}

References KoToolBase::action().

◆ deactivatePrimaryAction()

void KisTool::deactivatePrimaryAction ( )

virtual

Called by KisToolProxy when the primary is no longer possible to be started now, e.g. when its modifiers and released. The tool is supposed to revert all the preparations it has done in activatePrimaryAction().

Reimplemented in KisToolPaint, KisToolColorSampler, KisDynamicDelegatedTool< KisToolShape >, KisToolLazyBrush, KisToolSmartPatch, and KisToolTransform.

Definition at line 426 of file kis_tool.cc.

{
    resetCursorStyle();
}

References resetCursorStyle().

◆ deleteSelection()

void KisTool::deleteSelection ( )

overridevirtual

Delete the tools selection. The default implementation is empty to aid tools that don't have any selection.

See also: selection()

Reimplemented from KoToolBase.

Definition at line 525 of file kis_tool.cc.

{
    KisResourcesSnapshotSP resources =
        new KisResourcesSnapshot(image(), currentNode(), this->canvas()->resourceManager(), 0, selectedNodes());
 
    if (!blockUntilOperationsFinished()) {
        return;
    }
 
    if (!KisToolUtils::clearImage(image(), resources->selectedNodes(), resources->activeSelection())) {
        KoToolBase::deleteSelection();
    }
}

References KisResourcesSnapshot::activeSelection(), blockUntilOperationsFinished(), Private::canvas, KisToolUtils::clearImage(), currentNode(), KoToolBase::deleteSelection(), image(), KisResourcesSnapshot::selectedNodes(), and selectedNodes().

◆ endAlternateAction()

void KisTool::endAlternateAction	(	KoPointerEvent *	event,
		AlternateAction	action )

virtual

Reimplemented in KisToolFreehand, KisToolPaint, KisAssistantTool, KisToolFill, KisToolMove, KisToolMultihand, KisToolEncloseAndFill, KisToolBasicBrushBase, KisToolLazyBrush, KisToolTransform, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, and KisToolSelectBase< __KisToolSelectRectangularLocal >.

Definition at line 483 of file kis_tool.cc.

{
    Q_UNUSED(event);
    Q_UNUSED(action);
}

References KoToolBase::action().

◆ endPrimaryAction()

void KisTool::endPrimaryAction ( KoPointerEvent * event )

virtual

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 in KisToolFreehand, KisToolPolylineBase, KisToolRectangleBase, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, KisToolSelectBase< __KisToolSelectRectangularLocal >, KisToolOutlineBase, KisAssistantTool, KisToolColorSampler, KisToolFill, KisToolGradient, KisToolLine, KisToolMeasure, KisToolMove, KisToolMultihand, KisToolPan, KisToolCrop, KisDynamicDelegatedTool< KisToolShape >, KisToolBasicBrushBase, KisToolLazyBrush, KisToolSmartPatch, and KisToolTransform.

Definition at line 446 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ flags()

virtual int KisTool::flags ( ) const

inlinevirtual

Reimplemented in KisToolFreehand, KisToolPaint, KisToolShape, KisToolEncloseAndFill, and KisToolSmartPatch.

Definition at line 52 of file kis_tool.h.

52{ return 0; }

◆ image()

KisImageWSP KisTool::image ( ) const

protected

Definition at line 332 of file kis_tool.cc.

{
    // For now, krita tools only work in krita, not for a krita shape. Krita shapes are for 2.1
    KisCanvas2 * kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    if (kisCanvas) {
        return kisCanvas->currentImage();
    }
 
    return 0;
 
}

References Private::canvas, and KisCanvas2::currentImage().

◆ isActive()

bool KisTool::isActive ( ) const

Definition at line 646 of file kis_tool.cc.

{
    return d->m_isActive;
}

References d.

◆ isActiveChanged

void KisTool::isActiveChanged ( bool isActivated )

signal

◆ listeningToModifiers()

bool KisTool::listeningToModifiers ( )

protectedvirtual

To determine whether this tool will change its behavior when modifier keys are pressed

Reimplemented in KisDynamicDelegatedTool< KisToolShape >.

Definition at line 714 of file kis_tool.cc.

{
    return false;
}

◆ listenToModifiers()

void KisTool::listenToModifiers ( bool listen )

protectedvirtual

Request that this tool no longer listen to modifier keys (Responding to the request is optional)

Reimplemented in KisDynamicDelegatedTool< KisToolShape >.

Definition at line 709 of file kis_tool.cc.

{
    Q_UNUSED(listen);
}

◆ mode()

KisTool::ToolMode KisTool::mode ( ) const

protectedvirtual

Reimplemented in KisDynamicDelegatedTool< KisToolShape >.

Definition at line 407 of file kis_tool.cc.

                                    {
    return d->m_mode;
}

References d.

◆ mouseDoubleClickEvent()

void KisTool::mouseDoubleClickEvent ( KoPointerEvent * event )

overridevirtual

Called when (one of) the mouse or stylus buttons is double clicked. 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 mouse or stylus press

Reimplemented from KoToolBase.

Definition at line 500 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ mouseMoveEvent()

void KisTool::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

Implements KoToolBase.

Reimplemented in KisToolCrop, KisToolTransform, KisToolFreehand, KisToolPaint, KisToolPolylineBase, KisToolSelectBase< __KisToolSelectEllipticalLocal >, KisToolSelectBase< __KisToolSelectOutlineLocal >, KisToolSelectBase< __KisToolSelectPolygonalLocal >, KisToolSelectBase< __KisToolSelectRectangularLocal >, KisToolOutlineBase, KisToolColorSampler, KisToolMove, KisToolMultihand, and KisToolBasicBrushBase.

Definition at line 520 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ mousePressEvent()

void KisTool::mousePressEvent ( KoPointerEvent * event )

overridevirtual

Called when (one of) the mouse or stylus buttons is pressed. Implementors should call event->ignore() if they do not actually use the event.

Parameters

event state and reason of this mouse or stylus press

Implements KoToolBase.

Reimplemented in KisToolTransform, and KisToolPaint.

Definition at line 510 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ mouseReleaseEvent()

void KisTool::mouseReleaseEvent ( KoPointerEvent * event )

overridevirtual

Called when (one of) the mouse or stylus buttons is released. Implementors should call event->ignore() if they do not actually use the event.

Parameters

event state and reason of this mouse or stylus release

Implements KoToolBase.

Reimplemented in KisToolTransform, and KisToolPaint.

Definition at line 515 of file kis_tool.cc.

{
    Q_UNUSED(event);
}

◆ mouseTripleClickEvent()

void KisTool::mouseTripleClickEvent ( KoPointerEvent * event )

overridevirtual

Called when (one of) the mouse or stylus buttons is triple clicked. 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 mouse or stylus press

Reimplemented from KoToolBase.

Definition at line 505 of file kis_tool.cc.

{
    mouseDoubleClickEvent(event);
}

References mouseDoubleClickEvent().

◆ newActivationWithExternalSource()

void KisTool::newActivationWithExternalSource ( KisPaintDeviceSP externalSource )

virtual

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.

This is currently implemented by the Transform tool to paste an image into the current layer and transform it.

Reimplemented in KisDynamicDelegatedTool< KisToolShape >, and KisToolTransform.

Definition at line 573 of file kis_tool.cc.

{
    Q_UNUSED(externalSource);
}

◆ nodeEditable()

bool KisTool::nodeEditable ( )

protected

Checks checks if the current node is editable.

Definition at line 651 of file kis_tool.cc.

{
    KisNodeSP node = currentNode();
    if (!node) {
        return false;
    }
 
    if (!currentPaintOpPreset()) {
        return false;
    }
 
    bool blockedNoIndirectPainting = false;
 
    const bool presetUsesIndirectPainting =
        !currentPaintOpPreset()->settings()->paintIncremental();
 
    if (!presetUsesIndirectPainting) {
        const KisIndirectPaintingSupport *indirectPaintingLayer =
                dynamic_cast<const KisIndirectPaintingSupport*>(node.data());
        if (indirectPaintingLayer) {
            blockedNoIndirectPainting = !indirectPaintingLayer->supportsNonIndirectPainting();
        }
    }
 
    bool nodeEditable = node->isEditable() && !blockedNoIndirectPainting;
 
    if (!nodeEditable) {
        KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
        QString message;
        if (!node->visible() && node->userLocked()) {
            message = i18n("Layer is locked and invisible.");
        } else if (node->userLocked()) {
            message = i18n("Layer is locked.");
        } else if(!node->visible()) {
            message = i18n("Layer is invisible.");
        } else if (blockedNoIndirectPainting) {
            message = i18n("Layer can be painted in Wash Mode only.");
        } else {
            message = i18n("Group not editable.");
        }
        kiscanvas->viewManager()->showFloatingMessage(message, KisIconUtils::loadIcon("object-locked"));
    }
    return nodeEditable;
}

References Private::canvas, currentNode(), currentPaintOpPreset(), KisSharedPtr< T >::data(), KisBaseNode::isEditable(), KisIconUtils::loadIcon(), nodeEditable(), KisViewManager::showFloatingMessage(), KisIndirectPaintingSupport::supportsNonIndirectPainting(), KisBaseNode::userLocked(), KisCanvas2::viewManager(), and KisBaseNode::visible().

◆ nodePaintAbility()

KisTool::NodePaintAbility KisTool::nodePaintAbility ( )

Definition at line 539 of file kis_tool.cc.

{
    KisNodeSP node = currentNode();
 
    if (canvas()->resourceManager()->resource(KoCanvasResource::CurrentPaintOpPreset).isNull()) {
        return NodePaintAbility::UNPAINTABLE;
    }
 
    if (!node) {
        return NodePaintAbility::UNPAINTABLE;
    }
 
    if (node->inherits("KisShapeLayer")) {
        return NodePaintAbility::VECTOR;
    }
    if (node->inherits("KisCloneLayer")) {
        return NodePaintAbility::CLONE;
    }
    if (node->paintDevice()) {
 
        KisPaintOpPresetSP currentPaintOpPreset = canvas()->resourceManager()->resource(KoCanvasResource::CurrentPaintOpPreset).value<KisPaintOpPresetSP>();
        if (currentPaintOpPreset->paintOp().id() == "mypaintbrush") {
            const KoColorSpace *colorSpace = node->paintDevice()->colorSpace();
            if (colorSpace->colorModelId() != RGBAColorModelID) {
                return NodePaintAbility::MYPAINTBRUSH_UNPAINTABLE;
            }
        }
 
        return NodePaintAbility::PAINT;
    }
 
    return NodePaintAbility::UNPAINTABLE;
}

References Private::canvas, CLONE, KoColorSpace::colorModelId(), KisPaintDevice::colorSpace(), currentNode(), KoCanvasResource::CurrentPaintOpPreset, currentPaintOpPreset(), MYPAINTBRUSH_UNPAINTABLE, PAINT, KisBaseNode::paintDevice(), KoCanvasBase::resourceManager, RGBAColorModelID, UNPAINTABLE, and VECTOR.

◆ overrideCursorIfNotEditable()

bool KisTool::overrideCursorIfNotEditable ( )

protected

Override the cursor appropriately if current node is not editable.

Definition at line 618 of file kis_tool.cc.

{
    // override cursor for canvas iff this tool is active
    // and we can't paint on the active layer
    if (isActive()) {
        KisNodeSP node = currentNode();
        if (node && !node->isEditable()) {
            canvas()->setCursor(Qt::ForbiddenCursor);
            return true;
        }
    }
    return false;
}

References Private::canvas, currentNode(), isActive, KisBaseNode::isEditable(), and KisCanvas2::setCursor().

◆ paintToolOutline()

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

protected

paint the path which is in view coordinates, default paint mode is XOR_MODE, BW_MODE is also possible never apply transformations to the painter, they would be useless, if drawing in OpenGL mode. The coordinates in the path should be in view coordinates.

Definition at line 589 of file kis_tool.cc.

{
    KisOpenGLCanvas2 *canvasWidget = dynamic_cast<KisOpenGLCanvas2 *>(canvas()->canvasWidget());
    if (canvasWidget)  {
        painter->beginNativePainting();
        canvasWidget->paintToolOutline(path, decorationThickness());
        painter->endNativePainting();
    }
    else {
        painter->save();
        painter->setCompositionMode(QPainter::RasterOp_SourceXorDestination);
        QPen p = QColor(128, 255, 128);
        p.setCosmetic(true);
        p.setWidth(decorationThickness());
        painter->setPen(p);
 
        for (auto it = path.begin(); it != path.end(); ++it) {
            painter->drawPolyline(*it);
        }
 
        painter->restore();
    }
}

References Private::canvas, KisCanvas2::canvasWidget, KoToolBase::decorationThickness(), p, and KisOpenGLCanvas2::paintToolOutline().

◆ pixelToView() [1/6]

KisOptimizedBrushOutline KisTool::pixelToView ( const KisOptimizedBrushOutline & path ) const

protected

Definition at line 304 of file kis_tool.cc.

{
    KisCanvas2 *canvas2 = dynamic_cast<KisCanvas2 *>(canvas());
    KIS_ASSERT(canvas2);
    const KisCoordinatesConverter *coordsConverter = canvas2->coordinatesConverter();
    return path.mapped(coordsConverter->imageToDocumentTransform() * coordsConverter->documentToFlakeTransform());
}

References Private::canvas, KisCanvas2::coordinatesConverter, KisCoordinatesConverter::documentToFlakeTransform(), KisCoordinatesConverter::imageToDocumentTransform(), and KIS_ASSERT.

◆ pixelToView() [2/6]

QPainterPath KisTool::pixelToView ( const QPainterPath & pixelPath ) const

protected

Convert a pixel path into a view path.

Definition at line 295 of file kis_tool.cc.

{
    QTransform matrix;
    qreal zoomX, zoomY;
    canvas()->viewConverter()->zoom(&zoomX, &zoomY);
    matrix.scale(zoomX/image()->xRes(), zoomY/ image()->yRes());
    return matrix.map(pixelPolygon);
}

References Private::canvas, image(), KisCanvas2::viewConverter(), and KoViewConverter::zoom().

◆ pixelToView() [3/6]

QPointF KisTool::pixelToView ( const QPoint & pixelCoord ) const

protected

Convert an integer pixel coordinate into a view coordinate. The view coordinate is at the centre of the pixel.

Definition at line 269 of file kis_tool.cc.

{
    if (!image())
        return pixelCoord;
    QPointF documentCoord = image()->pixelToDocument(pixelCoord);
    return canvas()->viewConverter()->documentToView(documentCoord);
}

References Private::canvas, KoViewConverter::documentToView(), image(), KisImage::pixelToDocument(), and KisCanvas2::viewConverter().

◆ pixelToView() [4/6]

QPointF KisTool::pixelToView ( const QPointF & pixelCoord ) const

protected

Convert a floating point pixel coordinate into a view coordinate.

Definition at line 277 of file kis_tool.cc.

{
    if (!image())
        return pixelCoord;
    QPointF documentCoord = image()->pixelToDocument(pixelCoord);
    return canvas()->viewConverter()->documentToView(documentCoord);
}

References Private::canvas, KoViewConverter::documentToView(), image(), KisImage::pixelToDocument(), and KisCanvas2::viewConverter().

◆ pixelToView() [5/6]

QPolygonF KisTool::pixelToView ( const QPolygonF & pixelPolygon ) const

protected

Convert a pixel polygon into a view path.

Definition at line 313 of file kis_tool.cc.

{
    QTransform matrix;
    qreal zoomX, zoomY;
    canvas()->viewConverter()->zoom(&zoomX, &zoomY);
    matrix.scale(zoomX/image()->xRes(), zoomY/ image()->yRes());
    return matrix.map(pixelPath);
}

References Private::canvas, image(), KisCanvas2::viewConverter(), and KoViewConverter::zoom().

◆ pixelToView() [6/6]

QRectF KisTool::pixelToView ( const QRectF & pixelRect ) const

protected

Convert a pixel rectangle into a view rectangle.

Definition at line 285 of file kis_tool.cc.

{
    if (!image()) {
        return pixelRect;
    }
    QPointF topLeft = pixelToView(pixelRect.topLeft());
    QPointF bottomRight = pixelToView(pixelRect.bottomRight());
    return {topLeft, bottomRight};
}

References image(), and pixelToView().

◆ primaryActionSupportsHiResEvents()

bool KisTool::primaryActionSupportsHiResEvents ( ) const

virtual

Returns true if the tool can handle (and wants to handle) a very tight flow of input events from the tablet

Reimplemented in KisToolFreehand, KisToolLine, KisToolSelectOutline, and KisDynamicDelegatedTool< KisToolShape >.

Definition at line 451 of file kis_tool.cc.

{
    return false;
}

◆ resetCursorStyle

void KisTool::resetCursorStyle ( )

protectedvirtualslot

Called whenever the configuration settings change.

Reimplemented in KisToolSelectElliptical, KisToolSelectOutline, KisToolSelectPolygonal, and KisToolSelectRectangular.

Definition at line 613 of file kis_tool.cc.

{
    useCursor(d->cursor);
}

References d, and KoToolBase::useCursor().

◆ selectedNodes()

KisNodeList KisTool::selectedNodes ( ) const

protected

Definition at line 376 of file kis_tool.cc.

{
    KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
    KisViewManager* viewManager = kiscanvas->viewManager();
    return viewManager->nodeManager()->selectedNodes();
}

References Private::canvas, KisViewManager::nodeManager(), KisNodeManager::selectedNodes(), and KisCanvas2::viewManager().

◆ selectionEditable()

bool KisTool::selectionEditable ( )

protected

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

Definition at line 696 of file kis_tool.cc.

{
    KisCanvas2 * kisCanvas = static_cast<KisCanvas2*>(canvas());
    KisViewManager * view = kisCanvas->viewManager();
 
    bool editable = view->selectionEditable();
    if (!editable) {
        KisCanvas2 * kiscanvas = static_cast<KisCanvas2*>(canvas());
        kiscanvas->viewManager()->showFloatingMessage(i18n("Local selection is locked."), KisIconUtils::loadIcon("object-locked"));
    }
    return editable;
}

References Private::canvas, KisIconUtils::loadIcon(), KisViewManager::selectionEditable(), KisViewManager::showFloatingMessage(), and KisCanvas2::viewManager().

◆ setCursor()

void KisTool::setCursor ( const QCursor & cursor )

protected

Definition at line 411 of file kis_tool.cc.

{
    d->cursor = cursor;
}

References cursor, and d.

◆ setMode()

void KisTool::setMode ( ToolMode mode )

protectedvirtual

Reimplemented in KisToolPaint.

Definition at line 403 of file kis_tool.cc.

                                   {
    d->m_mode = mode;
}

References d, and mode().

◆ supportsPaintingAssistants()

bool KisTool::supportsPaintingAssistants ( ) const

virtual

Reimplemented in KisToolFreehand, KisToolEllipse, KisToolLine, KisToolRectangle, KisToolPolygon, and KisToolPolyline.

Definition at line 495 of file kis_tool.cc.

{
    return false;
}

◆ updateCanvasPixelRect()

void KisTool::updateCanvasPixelRect ( const QRectF & pixelRect )

protected

Update the canvas for the given rectangle in image pixel coordinates.

Definition at line 322 of file kis_tool.cc.

{
    canvas()->updateCanvas(convertToPt(pixelRect));
}

References Private::canvas, convertToPt(), and KisCanvas2::updateCanvas().

◆ updateCanvasViewRect()

void KisTool::updateCanvasViewRect ( const QRectF & viewRect )

protected

Update the canvas for the given rectangle in view coordinates.

Definition at line 327 of file kis_tool.cc.

{
    canvas()->updateCanvas(canvas()->viewConverter()->viewToDocument(viewRect));
}

References Private::canvas, and KisCanvas2::updateCanvas().

◆ updateSettingsViews

void KisTool::updateSettingsViews ( )

virtualslot

Definition at line 168 of file kis_tool.cc.

169{

170}

◆ viewToPixel()

QPointF KisTool::viewToPixel ( const QPointF & viewCoord ) const

protected

Definition at line 244 of file kis_tool.cc.

{
    if (!image())
        return viewCoord;
 
    return image()->documentToPixel(canvas()->viewConverter()->viewToDocument(viewCoord));
}

References Private::canvas, KisImage::documentToPixel(), and image().

◆ widgetCenterInWidgetPixels()

QPointF KisTool::widgetCenterInWidgetPixels ( )

protected

Definition at line 172 of file kis_tool.cc.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    const KisCoordinatesConverter *converter = kritaCanvas->coordinatesConverter();
    return converter->flakeToWidget(converter->flakeCenterPoint());
}

References Private::canvas, KisCanvas2::coordinatesConverter, KisCoordinatesConverter::flakeCenterPoint(), and KisCoordinatesConverter::flakeToWidget().

Friends And Related Symbol Documentation

◆ KisToolPaintingInformationBuilder

friend class KisToolPaintingInformationBuilder

friend

Definition at line 204 of file kis_tool.h.

Member Data Documentation

◆ currentBgColor

KoColor KisTool::currentBgColor

Definition at line 70 of file kis_tool.cc.

◆ currentExposure

float KisTool::currentExposure {1.0}

Definition at line 71 of file kis_tool.cc.

71{1.0};

◆ currentFgColor

KoColor KisTool::currentFgColor

Definition at line 69 of file kis_tool.cc.

◆ currentGenerator

KisFilterConfigurationSP KisTool::currentGenerator

Definition at line 72 of file kis_tool.cc.

◆ currentGradient

KoAbstractGradientSP KisTool::currentGradient

Definition at line 68 of file kis_tool.cc.

◆ currentPattern

KoPatternSP KisTool::currentPattern

Definition at line 67 of file kis_tool.cc.

◆ cursor

QCursor KisTool::cursor

Definition at line 64 of file kis_tool.cc.

◆ d

Private* const KisTool::d

private

Definition at line 321 of file kis_tool.h.

◆ m_isActive

bool KisTool::m_isActive {false}

Definition at line 75 of file kis_tool.cc.

75{false};

◆ m_mode

ToolMode KisTool::m_mode {HOVER_MODE}

Definition at line 74 of file kis_tool.cc.

74{HOVER_MODE};

◆ optionWidget

QWidget* KisTool::optionWidget {0}

Definition at line 73 of file kis_tool.cc.

73{0};

Property Documentation

◆ isActive

bool KisTool::isActive

read

Definition at line 44 of file kis_tool.h.

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

libs/ui/tool/kis_tool.cc
libs/ui/tool/kis_tool.h

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Slots

Protected Member Functions

Properties

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ AlternateAction

◆ NodePaintAbility

◆ ToolAction

◆ ToolMode

Constructor & Destructor Documentation

◆ KisTool()

◆ ~KisTool()

Member Function Documentation

◆ actionToAlternateAction()

◆ activate

◆ activateAlternateAction()

◆ activatePrimaryAction()

◆ alternateActionSupportsHiResEvents()

◆ beginAlternateAction()

◆ beginAlternateDoubleClickAction()

◆ beginPrimaryAction()

◆ beginPrimaryDoubleClickAction()

◆ blockUntilOperationsFinished()

◆ blockUntilOperationsFinishedForced()

◆ canvasResourceChanged

◆ continueAlternateAction()

◆ continuePrimaryAction()

◆ convertDocumentToWidget()

◆ convertToImagePixelCoordFloored()

◆ convertToPixelCoord() [1/2]

◆ convertToPixelCoord() [2/2]

◆ convertToPixelCoordAndAlignOnWidget()

◆ convertToPixelCoordAndSnap() [1/2]

◆ convertToPixelCoordAndSnap() [2/2]

◆ convertToPt() [1/2]

◆ convertToPt() [2/2]

◆ createOptionWidget()

◆ currentBgColor()

◆ currentFgColor()

◆ currentGenerator()

◆ currentGradient()

◆ currentImage()

◆ currentNode()

◆ currentPaintOpPreset()

◆ currentPattern()

◆ cursor()

◆ deactivate

◆ deactivateAlternateAction()

◆ deactivatePrimaryAction()

◆ deleteSelection()

◆ endAlternateAction()

◆ endPrimaryAction()

◆ flags()

◆ image()

◆ isActive()

◆ isActiveChanged

◆ listeningToModifiers()

◆ listenToModifiers()

◆ mode()

◆ mouseDoubleClickEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ mouseTripleClickEvent()

◆ newActivationWithExternalSource()

◆ nodeEditable()

◆ nodePaintAbility()

◆ overrideCursorIfNotEditable()

◆ paintToolOutline()