__KisToolSelectPathLocalTool Class Reference

#include <kis_tool_select_path.h>

Inheritance diagram for __KisToolSelectPathLocalTool:

Public Member Functions
	__KisToolSelectPathLocalTool (KoCanvasBase *canvas, KisToolSelectPath *parentTool)
void	addPathShape (KoPathShape *pathShape) override
void	cancelPath ()
QList< QPointer< QWidget > >	createOptionWidgets () override
	reimplemented
void	endPath ()
void	endPathWithoutLastPoint ()
void	paintPath (KoPathShape &path, QPainter &painter, const KoViewConverter &converter) override
void	removeLastPoint ()
Public Member Functions inherited from KoCreatePathTool
QRectF	decorationsRect () const override
	KoCreatePathTool (KoCanvasBase *canvas)
void	mouseDoubleClickEvent (KoPointerEvent *event) override
	reimplemented
void	mouseMoveEvent (KoPointerEvent *event) override
	reimplemented
void	mousePressEvent (KoPointerEvent *event) override
	reimplemented
void	mouseReleaseEvent (KoPointerEvent *event) override
	reimplemented
void	paint (QPainter &painter, const KoViewConverter &converter) override
	reimplemented
bool	pathStarted () const
void	setEnableClosePathShortcut (bool value)
bool	tryMergeInPathShape (KoPathShape *pathShape)
	~KoCreatePathTool () override
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 ()
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	deleteSelection ()
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
virtual void	mouseTripleClickEvent (KoPointerEvent *event)
QList< QPointer< QWidget > >	optionWidgets ()
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

Private Member Functions
void	beginShape () override
void	endShape () override

Private Attributes
KisToolSelectPath *const	m_selectionTool

Additional Inherited Members
Public Slots inherited from KoCreatePathTool
void	activate (const QSet< KoShape * > &shapes) override
	reimplemented
void	canvasResourceChanged (int key, const QVariant &res) override
	reimplemented
void	deactivate () override
	reimplemented
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 inherited from KoCreatePathTool
void	sigUpdateAutoSmoothCurvesGUI (bool value)
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)
Protected Member Functions inherited from KoCreatePathTool
bool	addPathShapeImpl (KoPathShape *pathShape, bool tryMergeOnly)
void	cancelPath ()
QList< QPointer< QWidget > >	createOptionWidgets () override
	reimplemented
void	endPath ()
void	endPathWithoutLastPoint ()
void	handleMouseMove (const KoPointerEvent *event, bool considerDrag)
void	removeLastPoint ()
Protected Member Functions inherited from KoToolBase
virtual QWidget *	createOptionWidget ()
int	grabSensitivity () const
	Convenience function to get the current grab sensitivity.
qreal	handleDocRadius () const
QRectF	handleGrabRect (const QPointF &position) const
QRectF	handlePaintRect (const QPointF &position) const
int	handleRadius () const
	Convenience function to get the current handle radius.
bool	isActivated () const
	KoToolBase (KoToolBasePrivate &dd)
KoPointerEvent *	lastDeliveredPointerEvent () const
void	setAbstractResource (KoAbstractCanvasResourceInterfaceSP abstractResource)
void	setConverter (KoDerivedResourceConverterSP converter)
void	setIsOpacityPresetMode (bool value)
void	setMaskSyntheticEvents (bool value)
void	setTextMode (bool value)
QHash< int, KoAbstractCanvasResourceInterfaceSP >	toolAbstractResources ()
QHash< int, KoDerivedResourceConverterSP >	toolConverters ()
void	useCursor (const QCursor &cursor)
Protected Attributes inherited from KoToolBase
KoToolBasePrivate *	d_ptr

Detailed Description

Definition at line 22 of file kis_tool_select_path.h.

Constructor & Destructor Documentation

__KisToolSelectPathLocalTool()

__KisToolSelectPathLocalTool::__KisToolSelectPathLocalTool	(	KoCanvasBase *	canvas,
		KisToolSelectPath *	parentTool )

Definition at line 127 of file kis_tool_select_path.cc.

    : KoCreatePathTool(canvas), m_selectionTool(parentTool)
{
    setEnableClosePathShortcut(false);
}

References KoCreatePathTool::setEnableClosePathShortcut().

Member Function Documentation

addPathShape()

void __KisToolSelectPathLocalTool::addPathShape ( KoPathShape * pathShape )

overridevirtual

Add path shape to document. This method can be overridden and change the behaviour of the tool. In that case the subclass takes ownership of pathShape. It gets only called if there are two or more points in the path.

Reimplemented from KoCreatePathTool.

Definition at line 146 of file kis_tool_select_path.cc.

{
    pathShape->normalize();
    pathShape->close();
 
    KisCanvas2 * kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    if (!kisCanvas)
        return;
 
    KisImageWSP image = kisCanvas->image();
 
    KisSelectionToolHelper helper(kisCanvas, kundo2_i18n("Select by Bezier Curve"));
 
    const SelectionMode mode =
        helper.tryOverrideSelectionMode(kisCanvas->viewManager()->selection(),
                                        m_selectionTool->selectionMode(),
                                        m_selectionTool->selectionAction());
 
    if (mode == PIXEL_SELECTION) {
        KisProcessingApplicator applicator(
            m_selectionTool->currentImage(),
            m_selectionTool->currentNode(),
            KisProcessingApplicator::NONE,
            KisImageSignalVector(),
            kundo2_i18n("Select by Bezier Curve"));
 
        KisPixelSelectionSP tmpSel = new KisPixelSelection(
            new KisDefaultBounds(m_selectionTool->currentImage()));
 
        const bool antiAlias = m_selectionTool->antiAliasSelection();
        const int grow = m_selectionTool->growSelection();
        const int feather = m_selectionTool->featherSelection();
 
        QTransform matrix;
        matrix.scale(image->xRes(), image->yRes());
        matrix.translate(pathShape->position().x(), pathShape->position().y());
 
        QPainterPath path = matrix.map(pathShape->outline());
 
        KUndo2Command *cmd = new KisCommandUtils::LambdaCommand(
            [tmpSel, antiAlias, grow, feather, path]() mutable
            -> KUndo2Command * {
                KisPainter painter(tmpSel);
                painter.setPaintColor(KoColor(Qt::black, tmpSel->colorSpace()));
                // Since the feathering already smooths the selection, the
                // antiAlias is not applied if we must feather
                painter.setAntiAliasPolygonFill(antiAlias && feather == 0);
                painter.setFillStyle(KisPainter::FillStyleForegroundColor);
                painter.setStrokeStyle(KisPainter::StrokeStyleNone);
 
                painter.fillPainterPath(path);
 
                if (grow > 0) {
                    KisGrowSelectionFilter biggy(grow, grow);
                    biggy.process(tmpSel,
                                  tmpSel->selectedRect().adjusted(-grow,
                                                                  -grow,
                                                                  grow,
                                                                  grow));
                } else if (grow < 0) {
                    KisShrinkSelectionFilter tiny(-grow, -grow, false);
                    tiny.process(tmpSel, tmpSel->selectedRect());
                }
                if (feather > 0) {
                    KisFeatherSelectionFilter feathery(feather);
                    feathery.process(tmpSel,
                                     tmpSel->selectedRect().adjusted(-feather,
                                                                     -feather,
                                                                     feather,
                                                                     feather));
                }
 
                if (grow == 0 && feather == 0) {
                    tmpSel->setOutlineCache(path);
                } else {
                    tmpSel->invalidateOutlineCache();
                }
 
                return 0;
            });
 
        applicator.applyCommand(cmd, KisStrokeJobData::SEQUENTIAL);
        helper.selectPixelSelection(applicator,
                                    tmpSel,
                                    m_selectionTool->selectionAction());
        applicator.end();
 
        delete pathShape;
 
    } else {
        helper.addSelectionShape(pathShape, m_selectionTool->selectionAction());
    }
}

References KisSelectionToolHelper::addSelectionShape(), KisToolSelectBase< BaseClass >::antiAliasSelection(), KisProcessingApplicator::applyCommand(), KoToolBase::canvas(), KoPathShape::close(), KisPaintDevice::colorSpace(), KisProcessingApplicator::end(), KisToolSelectBase< BaseClass >::featherSelection(), KisPainter::fillPainterPath(), KisPainter::FillStyleForegroundColor, KisToolSelectBase< BaseClass >::growSelection(), KisCanvas2::image(), KisPixelSelection::invalidateOutlineCache(), kundo2_i18n(), m_selectionTool, KisProcessingApplicator::NONE, KoPathShape::normalize(), KoPathShape::outline(), PIXEL_SELECTION, KoShape::position(), KisFeatherSelectionFilter::process(), KisGrowSelectionFilter::process(), KisShrinkSelectionFilter::process(), KisPixelSelection::selectedRect(), KisViewManager::selection(), KisToolSelectBase< BaseClass >::selectionAction(), KisToolSelectBase< BaseClass >::selectionMode(), KisSelectionToolHelper::selectPixelSelection(), KisStrokeJobData::SEQUENTIAL, KisPainter::setAntiAliasPolygonFill(), KisPainter::setFillStyle(), KisPixelSelection::setOutlineCache(), KisPainter::setPaintColor(), KisPainter::setStrokeStyle(), KisPainter::StrokeStyleNone, KisSelectionToolHelper::tryOverrideSelectionMode(), KisCanvas2::viewManager(), KisImage::xRes(), and KisImage::yRes().

beginShape()

void __KisToolSelectPathLocalTool::beginShape ( )

overrideprivatevirtual

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

Reimplemented from KoCreatePathTool.

Definition at line 240 of file kis_tool_select_path.cc.

{
    KisToolSelectPath* selectPathTool = dynamic_cast<KisToolSelectPath*>(m_selectionTool);
    KIS_ASSERT(selectPathTool);
    selectPathTool->beginSelectInteraction();
}

References KisToolSelectBase< BaseClass >::beginSelectInteraction(), KIS_ASSERT, and m_selectionTool.

cancelPath()

void KoCreatePathTool::cancelPath

(

)

Definition at line 97 of file KoCreatePathTool.cpp.

{
    Q_D(KoCreatePathTool);
 
    if (!d->shape) {
        return;
    }
    d->firstPoint = 0;
    d->activePoint = 0;
    d->cleanUp();
    repaintDecorations();
    endShape();
}

createOptionWidgets()

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

overridevirtual

reimplemented

Reimplemented from KoToolBase.

Definition at line 103 of file KoCreatePathTool.cpp.

{
    Q_D(KoCreatePathTool);
 
    QList<QPointer<QWidget> > list;
 
    QWidget *widget = new QWidget();
    widget->setObjectName("bezier-curve-tool-widget");
    widget->setWindowTitle(i18n("Path options"));
 
    QCheckBox *smoothCurves = new QCheckBox(i18n("Autosmooth curve"), widget);
    smoothCurves->setObjectName("smooth-curves-widget");
    smoothCurves->setChecked(d->autoSmoothCurves);
 
    QCheckBox *angleSnap = new QCheckBox(i18n("Activate angle snap"), widget);
    angleSnap->setObjectName("angle-snap-widget");
    angleSnap->setChecked(false);
    angleSnap->setCheckable(true);
 
    KisAngleSelector *angleEdit = new KisAngleSelector(widget);
    angleEdit->setObjectName("angle-edit-widget");
    angleEdit->setAngle(d->angleSnappingDelta);
    angleEdit->setRange(1, 360);
    angleEdit->setDecimals(0);
    angleEdit->setFlipOptionsMode(KisAngleSelector::FlipOptionsMode_MenuButton);
    angleEdit->setEnabled(angleSnap->isChecked());
 
    QHBoxLayout *angleEditLayout = new QHBoxLayout;
    angleEditLayout->setContentsMargins(10, 0, 0, 0);
    angleEditLayout->setSpacing(0);
    angleEditLayout->addWidget(angleEdit);
 
    QVBoxLayout *mainLayout = new QVBoxLayout;
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->setSpacing(5);
 
    mainLayout->addWidget(smoothCurves);
    mainLayout->addWidget(angleSnap);
    mainLayout->addLayout(angleEditLayout);
 
    widget->setLayout(mainLayout);
 
    list.append(widget);
 
    connect(smoothCurves,
            SIGNAL(toggled(bool)),
            this,
            SLOT(autoSmoothCurvesChanged(bool)));
    connect(this,
            SIGNAL(sigUpdateAutoSmoothCurvesGUI(bool)),
            smoothCurves,
            SLOT(setChecked(bool)));
    connect(angleEdit, SIGNAL(angleChanged(qreal)), this, SLOT(angleDeltaChanged(qreal)));
    connect(angleSnap, SIGNAL(stateChanged(int)), this, SLOT(angleSnapChanged(int)));
    connect(angleSnap,
            SIGNAL(toggled(bool)),
            angleEdit,
            SLOT(setEnabled(bool)));
 
    return list;
}

endPath()

void KoCreatePathTool::endPath

(

)

Definition at line 95 of file KoCreatePathTool.cpp.

{
    Q_D(KoCreatePathTool);
 
    if (!d->shape) {
        return;
    }
    d->addPathShape();
    repaintDecorations();
    endShape();
}

endPathWithoutLastPoint()

void KoCreatePathTool::endPathWithoutLastPoint

(

)

Definition at line 96 of file KoCreatePathTool.cpp.

{
    Q_D(KoCreatePathTool);
 
    if (!d->shape) {
        return;
    }
    delete d->shape->removePoint(d->shape->pathPointIndex(d->activePoint));
    d->addPathShape();
 
    repaintDecorations();
    endShape();
}

endShape()

void __KisToolSelectPathLocalTool::endShape ( )

overrideprivatevirtual

Reimplemented from KoCreatePathTool.

Definition at line 247 of file kis_tool_select_path.cc.

{
    KisToolSelectPath* selectPathTool = dynamic_cast<KisToolSelectPath*>(m_selectionTool);
    KIS_ASSERT(selectPathTool);
    selectPathTool->endSelectInteraction();
}

References KisToolSelectBase< BaseClass >::endSelectInteraction(), KIS_ASSERT, and m_selectionTool.

paintPath()

void __KisToolSelectPathLocalTool::paintPath ( KoPathShape & pathShape, QPainter & painter, const KoViewConverter & converter )

overridevirtual

This method is called to paint the path. Decorations are drawn by KoCreatePathTool afterwards.

Reimplemented from KoCreatePathTool.

Definition at line 133 of file kis_tool_select_path.cc.

{
    Q_UNUSED(converter);
    KisCanvas2 * kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    if (!kisCanvas)
        return;
 
    QTransform matrix;
    matrix.scale(kisCanvas->image()->xRes(), kisCanvas->image()->yRes());
    matrix.translate(pathShape.position().x(), pathShape.position().y());
    m_selectionTool->paintToolOutline(&painter, m_selectionTool->pixelToView(matrix.map(pathShape.outline())));
}

References KoToolBase::canvas(), KisCanvas2::image(), m_selectionTool, KoPathShape::outline(), KoShape::position(), KisImage::xRes(), and KisImage::yRes().

removeLastPoint()

void KoCreatePathTool::removeLastPoint

(

)

Definition at line 98 of file KoCreatePathTool.cpp.

{
    Q_D(KoCreatePathTool);
 
    if ((d->shape)) {
        KoPathPointIndex lastPointIndex = d->shape->pathPointIndex(d->activePoint);
 
        if (lastPointIndex.second > 1) {
            lastPointIndex.second--;
            delete d->shape->removePoint(lastPointIndex);
 
            d->hoveredPoint = 0;
 
            repaintDecorations();
        }
    }
}

Member Data Documentation

m_selectionTool

KisToolSelectPath* const __KisToolSelectPathLocalTool::m_selectionTool

private

Definition at line 35 of file kis_tool_select_path.h.

---

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

• plugins/tools/selectiontools/kis_tool_select_path.h
• plugins/tools/selectiontools/kis_tool_select_path.cc