#include <kis_tool_polyline_base.h>

Inheritance diagram for KisToolPolylineBase:

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

void	beginAlternateAction (KoPointerEvent *event, AlternateAction action) override

void	beginPrimaryAction (KoPointerEvent *event) override

void	beginPrimaryDoubleClickAction (KoPointerEvent *event) override

void	deactivate () override

void	endPrimaryAction (KoPointerEvent *event) override

bool	eventFilter (QObject obj, QEvent event) override

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

void	mouseMoveEvent (KoPointerEvent *event) override

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

KisPopupWidgetInterface *	popupWidget () override

void	requestStrokeCancellation () override

void	requestStrokeEnd () 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	mousePressEvent (KoPointerEvent *event) override

void	mouseReleaseEvent (KoPointerEvent *event) override

	~KisToolPaint () override

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

virtual void	beginAlternateDoubleClickAction (KoPointerEvent *event, AlternateAction action)

virtual void	continuePrimaryAction (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

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

	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	finishPolyline (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	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
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 Slots
void	undoSelection ()

void	undoSelectionOrCancel ()

Private Member Functions
void	cancelStroke ()

QRectF	dragBoundingRect ()

void	endStroke ()

void	updateArea ()

Private Attributes
bool	m_closeSnappingActivated

QPointF	m_dragEnd

bool	m_dragging

QPointF	m_dragStart

vQPointF	m_points

ToolType	m_type

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

void	setStatusText (const QString &statusText)

void	updateOptionsWidgetIcons ()

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 13 of file kis_tool_polyline_base.h.

Member Enumeration Documentation

◆ ToolType

enum KisToolPolylineBase::ToolType

Enumerator
PAINT
SELECT

Definition at line 17 of file kis_tool_polyline_base.h.

                  {
        PAINT,
        SELECT
    };

Constructor & Destructor Documentation

◆ KisToolPolylineBase()

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

Definition at line 30 of file kis_tool_polyline_base.cpp.

    : KisToolShape(canvas, cursor),
      m_dragging(false),
      m_type(type),
      m_closeSnappingActivated(false)
{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas);
 
    connect(kritaCanvas->viewManager()->canvasResourceProvider(), SIGNAL(sigEffectiveCompositeOpChanged()), SLOT(resetCursorStyle()));
}

References Private::canvas, KisViewManager::canvasResourceProvider(), connect(), KisTool::resetCursorStyle(), and KisCanvas2::viewManager().

Member Function Documentation

◆ activate()

void KisToolPolylineBase::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< __KisToolSelectPolygonalLocal >.

Definition at line 42 of file kis_tool_polyline_base.cpp.

{
    KisToolShape::activate(shapes);
    connect(action("undo_polygon_selection"), SIGNAL(triggered()), SLOT(undoSelectionOrCancel()), 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 undoSelectionOrCancel().

◆ beginAlternateAction()

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

overridevirtual

Reimplemented from KisToolPaint.

Reimplemented in KisToolSelectBase< __KisToolSelectPolygonalLocal >.

Definition at line 161 of file kis_tool_polyline_base.cpp.

{
    if ((action != ChangeSize && action != ChangeSizeSnap) || !m_dragging) {
        KisToolPaint::beginAlternateAction(event, action);
    }
 
    if (m_closeSnappingActivated) {
        m_points.append(m_points.first());
    }
    endStroke();
}

References KoToolBase::action(), KisToolPaint::beginAlternateAction(), KisTool::ChangeSize, KisTool::ChangeSizeSnap, endStroke(), m_closeSnappingActivated, m_dragging, and m_points.

◆ beginPrimaryAction()

void KisToolPolylineBase::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< __KisToolSelectPolygonalLocal >.

Definition at line 107 of file kis_tool_polyline_base.cpp.

{
    Q_UNUSED(event);
    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_dragging && m_closeSnappingActivated) {
        m_points.append(m_points.first());
        endStroke();
    } else {
        beginShape();
        m_dragging = true;
    }
}

References KisToolShape::beginShape(), Private::canvas, KisTool::CLONE, endStroke(), koIcon, m_closeSnappingActivated, m_dragging, 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().

◆ beginPrimaryDoubleClickAction()

void KisToolPolylineBase::beginPrimaryDoubleClickAction ( KoPointerEvent * event )

overridevirtual

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

See also: beginPrimaryAction()

Reimplemented from KisTool.

Definition at line 153 of file kis_tool_polyline_base.cpp.

{
    endStroke();
 
    // this action will have no continuation
    event->ignore();
}

References endStroke().

◆ cancelStroke()

void KisToolPolylineBase::cancelStroke ( )

private

Definition at line 291 of file kis_tool_polyline_base.cpp.

{
    if (!m_dragging) return;
 
    m_dragging = false;
    m_points.clear();
    m_closeSnappingActivated = false;
    updateArea();
    endShape();
}

References KisToolShape::endShape(), m_closeSnappingActivated, m_dragging, m_points, and updateArea().

◆ deactivate()

void KisToolPolylineBase::deactivate ( )

overridevirtual

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

See also: activate()

Reimplemented from KoToolBase.

Reimplemented in KisToolSelectBase< __KisToolSelectPolygonalLocal >.

Definition at line 53 of file kis_tool_polyline_base.cpp.

{
    disconnect(action("undo_polygon_selection"), 0, this, 0);
    cancelStroke();
 
    KisInputManager *inputManager = (static_cast<KisCanvas2*>(canvas()))->globalInputManager();
    if (inputManager) {
        inputManager->detachPriorityEventFilter(this);
    }
 
    KisToolShape::deactivate();
}

References KoToolBase::action(), cancelStroke(), Private::canvas, KoToolBase::deactivate(), and KisInputManager::detachPriorityEventFilter().

◆ dragBoundingRect()

QRectF KisToolPolylineBase::dragBoundingRect ( )

private

Definition at line 302 of file kis_tool_polyline_base.cpp.

{
    QRectF rect = pixelToView(QRectF(m_dragStart, m_dragEnd).normalized());
    rect.adjust(-PREVIEW_LINE_WIDTH, -PREVIEW_LINE_WIDTH, PREVIEW_LINE_WIDTH, PREVIEW_LINE_WIDTH);
    return rect;
}

References m_dragEnd, m_dragStart, KisTool::pixelToView(), and PREVIEW_LINE_WIDTH.

◆ endPrimaryAction()

void KisToolPolylineBase::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< __KisToolSelectPolygonalLocal >.

Definition at line 141 of file kis_tool_polyline_base.cpp.

{
    CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
    setMode(KisTool::HOVER_MODE);
 
    if(m_dragging) {
        m_dragStart = convertToPixelCoordAndSnap(event);
        m_dragEnd = m_dragStart;
        m_points.append(m_dragStart);
    }
}

References CHECK_MODE_SANITY_OR_RETURN, KisTool::convertToPixelCoordAndSnap(), KisTool::HOVER_MODE, m_dragEnd, m_dragging, m_dragStart, m_points, KisTool::PAINT_MODE, and KisToolPaint::setMode().

◆ endStroke()

void KisToolPolylineBase::endStroke ( )

private

Definition at line 277 of file kis_tool_polyline_base.cpp.

{
    if (!m_dragging) return;
 
    m_dragging = false;
    if(m_points.count() > 1) {
        finishPolyline(m_points);
    }
    m_points.clear();
    m_closeSnappingActivated = false;
    updateArea();
    endShape();
}

References KisToolShape::endShape(), finishPolyline(), m_closeSnappingActivated, m_dragging, m_points, and updateArea().

◆ eventFilter()

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

override

Definition at line 83 of file kis_tool_polyline_base.cpp.

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

References m_dragging, and undoSelectionOrCancel().

◆ finishPolyline()

virtual void KisToolPolylineBase::finishPolyline ( const QVector< QPointF > & points )

protectedpure virtual

Implemented in KisToolSelectPolygonal, KisToolPolygon, and KisToolPolyline.

◆ mouseMoveEvent()

void KisToolPolylineBase::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 KisToolPaint.

Reimplemented in KisToolSelectBase< __KisToolSelectPolygonalLocal >.

Definition at line 173 of file kis_tool_polyline_base.cpp.

{
    if (m_dragging && !m_points.empty()) {
        // erase old lines on canvas
        QRectF updateRect = dragBoundingRect();
        // get current mouse position
        m_dragEnd = convertToPixelCoordAndSnap(event);
        // draw new lines on canvas
        updateRect |= dragBoundingRect();
        updateCanvasViewRect(updateRect);
 
 
        QPointF basePoint = pixelToView(m_points.first());
        m_closeSnappingActivated =
            m_points.size() > 1 &&
            (basePoint - pixelToView(m_dragEnd)).manhattanLength() < SNAPPING_THRESHOLD;
 
        updateCanvasViewRect(QRectF(basePoint, 2 * QSize(SNAPPING_HANDLE_RADIUS + PREVIEW_LINE_WIDTH, SNAPPING_HANDLE_RADIUS + PREVIEW_LINE_WIDTH)).translated(-SNAPPING_HANDLE_RADIUS + PREVIEW_LINE_WIDTH,-SNAPPING_HANDLE_RADIUS + PREVIEW_LINE_WIDTH));
        KisToolPaint::requestUpdateOutline(event->point, event);
    } else {
        KisToolPaint::mouseMoveEvent(event);
    }
}

References KisTool::convertToPixelCoordAndSnap(), dragBoundingRect(), m_closeSnappingActivated, m_dragEnd, m_dragging, m_points, KisToolPaint::mouseMoveEvent(), KisTool::pixelToView(), KoPointerEvent::point, PREVIEW_LINE_WIDTH, KisToolPaint::requestUpdateOutline(), SNAPPING_HANDLE_RADIUS, SNAPPING_THRESHOLD, and KisTool::updateCanvasViewRect().

◆ paint()

void KisToolPolylineBase::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 229 of file kis_tool_polyline_base.cpp.

{
    Q_UNUSED(converter);
 
    if (!canvas() || !currentImage())
        return;
 
    QPointF start, end;
    QPointF startPos;
    QPointF endPos;
 
    QPainterPath path;
    if (m_dragging && !m_points.empty()) {
        startPos = pixelToView(m_dragStart);
        endPos = pixelToView(m_dragEnd);
        path.moveTo(startPos);
        path.lineTo(endPos);
    }
 
    for (vQPointF::iterator it = m_points.begin(); it != m_points.end(); ++it) {
 
        if (it == m_points.begin()) {
            start = (*it);
        } else {
            end = (*it);
 
            startPos = pixelToView(start);
            endPos = pixelToView(end);
            path.moveTo(startPos);
            path.lineTo(endPos);
            start = end;
        }
    }
 
    if (m_closeSnappingActivated) {
        QPointF basePoint = pixelToView(m_points.first());
        path.addEllipse(basePoint, SNAPPING_HANDLE_RADIUS, SNAPPING_HANDLE_RADIUS);
    }
 
    paintToolOutline(&gc, path);
    KisToolPaint::paint(gc,converter);
}

References Private::canvas, KisTool::currentImage(), m_closeSnappingActivated, m_dragEnd, m_dragging, m_dragStart, m_points, KisToolPaint::paint(), KisTool::paintToolOutline(), KisTool::pixelToView(), and SNAPPING_HANDLE_RADIUS.

◆ popupWidget()

KisPopupWidgetInterface * KisToolPolylineBase::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 KisToolPaint.

Reimplemented in KisToolSelectBase< __KisToolSelectPolygonalLocal >.

Definition at line 76 of file kis_tool_polyline_base.cpp.

{
    return m_dragging || m_type == SELECT ? nullptr : KisToolShape::popupWidget();
}

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

◆ requestStrokeCancellation()

void KisToolPolylineBase::requestStrokeCancellation ( )

overridevirtual

Called when the user requested the cancellation of the current stroke. If you tool supports cancelling, override this method and do the needed work there

Reimplemented from KoToolBase.

Definition at line 71 of file kis_tool_polyline_base.cpp.

{
    cancelStroke();
}

References cancelStroke().

◆ requestStrokeEnd()

void KisToolPolylineBase::requestStrokeEnd ( )

overridevirtual

Called when the image decided that the stroke should better be ended. If you tool supports long strokes, override this method and do the needed work there

Reimplemented from KoToolBase.

Definition at line 66 of file kis_tool_polyline_base.cpp.

{
    endStroke();
}

References endStroke().

◆ undoSelection

void KisToolPolylineBase::undoSelection ( )

privateslot

Definition at line 197 of file kis_tool_polyline_base.cpp.

{
    if (m_dragging) {
        // 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(-PREVIEW_LINE_WIDTH, -PREVIEW_LINE_WIDTH, PREVIEW_LINE_WIDTH, PREVIEW_LINE_WIDTH);
            updateRect = updateRect.united(lastSegmentRect);
 
            m_points.pop_back();
        }
        m_dragStart = m_points.last();
 
        // Add the new dragging segment's rect
        updateRect = updateRect.united(dragBoundingRect());
        updateCanvasViewRect(updateRect);
    }
}

References dragBoundingRect(), m_dragging, m_dragStart, m_points, KisTool::pixelToView(), PREVIEW_LINE_WIDTH, and KisTool::updateCanvasViewRect().

◆ undoSelectionOrCancel

void KisToolPolylineBase::undoSelectionOrCancel ( )

privateslot

Definition at line 220 of file kis_tool_polyline_base.cpp.

{
    if (m_points.size() > 1) {
        undoSelection();
    } else {
        cancelStroke();
    }
}

References cancelStroke(), m_points, and undoSelection().

◆ updateArea()

void KisToolPolylineBase::updateArea ( )

private

Definition at line 272 of file kis_tool_polyline_base.cpp.

{
    updateCanvasPixelRect(image()->bounds());
}

References bounds, KisTool::image(), and KisTool::updateCanvasPixelRect().

Member Data Documentation

◆ m_closeSnappingActivated

bool KisToolPolylineBase::m_closeSnappingActivated

private

Definition at line 60 of file kis_tool_polyline_base.h.

◆ m_dragEnd

QPointF KisToolPolylineBase::m_dragEnd

private

Definition at line 56 of file kis_tool_polyline_base.h.

◆ m_dragging

bool KisToolPolylineBase::m_dragging

private

Definition at line 57 of file kis_tool_polyline_base.h.

◆ m_dragStart

QPointF KisToolPolylineBase::m_dragStart

private

Definition at line 55 of file kis_tool_polyline_base.h.

◆ m_points

vQPointF KisToolPolylineBase::m_points

private

Definition at line 58 of file kis_tool_polyline_base.h.

◆ m_type

ToolType KisToolPolylineBase::m_type

private

Definition at line 59 of file kis_tool_polyline_base.h.

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

libs/ui/tool/kis_tool_polyline_base.h
libs/ui/tool/kis_tool_polyline_base.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ToolType

Constructor & Destructor Documentation

◆ KisToolPolylineBase()

Member Function Documentation

◆ activate()

◆ beginAlternateAction()

◆ beginPrimaryAction()

◆ beginPrimaryDoubleClickAction()

◆ cancelStroke()

◆ deactivate()

◆ dragBoundingRect()

◆ endPrimaryAction()

◆ endStroke()

◆ eventFilter()

◆ finishPolyline()

◆ mouseMoveEvent()

◆ paint()

◆ popupWidget()

◆ requestStrokeCancellation()

◆ requestStrokeEnd()

◆ undoSelection

◆ undoSelectionOrCancel

◆ updateArea()

Member Data Documentation

◆ m_closeSnappingActivated

◆ m_dragEnd

◆ m_dragging

◆ m_dragStart

◆ m_points

◆ m_type