KisToolKnife Class Reference

#include <KisToolKnife.h>

Inheritance diagram for KisToolKnife:

Classes
struct	Private

Public Slots
void	activate (const QSet< KoShape * > &shapes) override
KoInteractionStrategy *	createStrategy (KoPointerEvent *event) override
void	deactivate () override
bool	isValidForCurrentLayer () const
void	mouseMoveEvent (KoPointerEvent *event) override
void	mousePressEvent (KoPointerEvent *event)
void	mouseReleaseEvent (KoPointerEvent *event) override
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 ()

Public Member Functions
QWidget *	createOptionWidget () override
	KisToolKnife (KoCanvasBase *canvas)
void	paint (QPainter &painter, const KoViewConverter &converter) override
	~KisToolKnife () override
Public Member Functions inherited from KoInteractionTool
void	keyPressEvent (QKeyEvent *event) override
void	keyReleaseEvent (QKeyEvent *event) override
	KoInteractionTool (KoCanvasBase *canvas)
void	mouseMoveEvent (KoPointerEvent *event) override
void	mousePressEvent (KoPointerEvent *event) override
void	mouseReleaseEvent (KoPointerEvent *event) override
void	paint (QPainter &painter, const KoViewConverter &converter) override
	~KoInteractionTool () 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 ()
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	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
	KoToolBase (KoCanvasBase *canvas)
bool	maskSyntheticEvents () const
virtual void	mouseDoubleClickEvent (KoPointerEvent *event)
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 Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
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 KoInteractionTool
void	addInteractionFactory (KoInteractionStrategyFactory *factory)
void	cancelCurrentStrategy ()
	Cancels the current strategy and deletes it.
virtual KoInteractionStrategy *	createStrategy (KoPointerEvent *event)=0
KoInteractionStrategy *	createStrategyBase (KoPointerEvent *event)
KoInteractionStrategy *	currentStrategy ()
bool	hasInteractionFactory (const QString &id)
	KoInteractionTool (KoInteractionToolPrivate &dd)
void	removeInteractionFactory (const QString &id)
bool	tryUseCustomCursor ()
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)
Protected Attributes inherited from KoToolBase
KoToolBasePrivate *	d_ptr

Detailed Description

Definition at line 32 of file KisToolKnife.h.

Constructor & Destructor Documentation

KisToolKnife()

KisToolKnife::KisToolKnife

(

KoCanvasBase *

canvas

)

Definition at line 57 of file KisToolKnife.cpp.

    : KoInteractionTool(canvas),
      m_d(new Private)
{
    setObjectName("tool_knife");
    useCursor(Qt::ArrowCursor);
    repaintDecorations();
}

References KoToolBase::repaintDecorations(), and KoToolBase::useCursor().

~KisToolKnife()

KisToolKnife::~KisToolKnife ( )

override

Definition at line 66 of file KisToolKnife.cpp.

{
    m_d->optionsWidget = nullptr;
}

References m_d.

Member Function Documentation

activate

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

overrideslot

Definition at line 187 of file KisToolKnife.cpp.

{
    KoInteractionTool::activate(shapes);
    useCursor(KisCursor::arrowCursor());
 
}

References KoToolBase::activate(), KisCursor::arrowCursor(), and KoToolBase::useCursor().

createOptionWidget()

QWidget * KisToolKnife::createOptionWidget ( )

overridevirtual

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

Reimplemented from KoToolBase.

Definition at line 272 of file KisToolKnife.cpp.

{
    KisCanvas2 * kiscanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT(kiscanvas);
    qreal resolution = 1.0;
    if (kiscanvas->image()) {
        // we're going to assume isotropic image
        resolution = kiscanvas->image()->xRes();
    }
 
    m_d->optionsWidget = new KisToolKnifeOptionsWidget(kiscanvas->viewManager()->canvasResourceProvider(), 0, toolId(), resolution);
    m_d->optionsWidget->setObjectName(toolId() + "option widget");
 
 
    return m_d->optionsWidget;
}

References KoToolBase::canvas(), KisViewManager::canvasResourceProvider(), KisCanvas2::image(), KIS_ASSERT, m_d, KoToolBase::toolId(), KisCanvas2::viewManager(), and KisImage::xRes().

createStrategy

KoInteractionStrategy * KisToolKnife::createStrategy ( KoPointerEvent * event )

overrideslot

Definition at line 251 of file KisToolKnife.cpp.

{
    QList<KoShape*> shapes = canvas()->shapeManager()->shapes();
 
    if (m_d->optionsWidget->getToolMode() == KisToolKnifeOptionsWidget::ToolMode::AddGutter) {
        return new CutThroughShapeStrategy(this, canvas()->selectedShapesProxy()->selection(), shapes, event->point, m_d->optionsWidget->getCurrentWidthsConfig());
    } else {
        return new RemoveGutterStrategy(this, canvas()->selectedShapesProxy()->selection(), shapes, event->point);
    }
 
    //return NULL;
}

References KisToolKnifeOptionsWidget::AddGutter, KoToolBase::canvas(), m_d, KoPointerEvent::point, KoToolBase::selection(), KoCanvasBase::shapeManager(), and KoShapeManager::shapes.

deactivate

void KisToolKnife::deactivate ( )

overrideslot

Definition at line 194 of file KisToolKnife.cpp.

{
    KoInteractionTool::deactivate();
}

References KoToolBase::deactivate().

isValidForCurrentLayer

bool KisToolKnife::isValidForCurrentLayer ( ) const

slot

Definition at line 264 of file KisToolKnife.cpp.

{
    KisCanvas2 *kisCanvas = static_cast<KisCanvas2 *>(canvas());
    KisNodeSP node = kisCanvas->viewManager()->canvasResourceProvider()->currentNode();
    const KisShapeLayer *shapeLayer = qobject_cast<const KisShapeLayer*>(node.data());
    return (shapeLayer != nullptr);
}

References KoToolBase::canvas(), KisViewManager::canvasResourceProvider(), KisCanvasResourceProvider::currentNode(), KisSharedPtr< T >::data(), and KisCanvas2::viewManager().

mouseMoveEvent

void KisToolKnife::mouseMoveEvent ( KoPointerEvent * event )

overrideslot

Definition at line 213 of file KisToolKnife.cpp.

{
    KoInteractionTool::mouseMoveEvent(event);
 
    if (event->buttons().testFlag(Qt::MouseButton::LeftButton)) {
 
        m_d->endPoint = event->point;
        QRectF dirtyRect;
        KisAlgebra2D::accumulateBounds(m_d->startPoint, &dirtyRect);
        KisAlgebra2D::accumulateBounds(m_d->endPoint, &dirtyRect);
 
        QRectF accumulatedWithPrevious = m_d->previousLineDirtyRect;
        accumulatedWithPrevious |= dirtyRect;
 
        canvas()->updateCanvas(accumulatedWithPrevious);
        m_d->previousLineDirtyRect = dirtyRect;
 
    }
 
    repaintDecorations();
}

References KisAlgebra2D::accumulateBounds(), KoPointerEvent::buttons(), KoToolBase::canvas(), m_d, KoInteractionTool::mouseMoveEvent(), KoToolBase::repaintDecorations(), and KoCanvasBase::updateCanvas().

mousePressEvent

void KisToolKnife::mousePressEvent ( KoPointerEvent * event )

slot

Definition at line 199 of file KisToolKnife.cpp.

{
    // this tool only works on a vector layer right now, so give a warning if another layer type is trying to use it
    if (!isValidForCurrentLayer()) {
        KisCanvas2 *kiscanvas = static_cast<KisCanvas2 *>(canvas());
        kiscanvas->viewManager()->showFloatingMessage(
                i18n("This tool only works on vector layers. You probably want to create a vector layer and a starting shape first."),
                QIcon(), 2000, KisFloatingMessage::Medium, Qt::AlignCenter);
        return;
    }
 
    KoInteractionTool::mousePressEvent(event);
}

References KoToolBase::canvas(), isValidForCurrentLayer(), KisFloatingMessage::Medium, KoInteractionTool::mousePressEvent(), KisViewManager::showFloatingMessage(), and KisCanvas2::viewManager().

mouseReleaseEvent

void KisToolKnife::mouseReleaseEvent ( KoPointerEvent * event )

overrideslot

Definition at line 235 of file KisToolKnife.cpp.

{
    KoInteractionTool::mouseReleaseEvent(event);
 
    m_d->endPoint = event->point;
 
    QRectF dirtyRect;
    KisAlgebra2D::accumulateBounds(m_d->startPoint, &dirtyRect);
    KisAlgebra2D::accumulateBounds(m_d->endPoint, &dirtyRect);
 
    QRectF accumulatedWithPrevious = m_d->previousLineDirtyRect | dirtyRect;
 
    canvas()->updateCanvas(accumulatedWithPrevious);
    m_d->previousLineDirtyRect = dirtyRect;
}

References KisAlgebra2D::accumulateBounds(), KoToolBase::canvas(), m_d, KoInteractionTool::mouseReleaseEvent(), and KoCanvasBase::updateCanvas().

paint()

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

overridevirtual

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

Parameters

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

Implements KoToolBase.

Definition at line 139 of file KisToolKnife.cpp.

{
    Q_UNUSED(converter);
 
    painter.save();
    painter.restore();
 
    painter.save();
    painter.setBrush(Qt::darkGray);
    //painter.drawEllipse(converter.documentToView(m_d->mousePoint), 4, 4);
 
    painter.restore();
 
    KoInteractionTool::paint(painter, converter);
 
 
#ifdef KNIFE_DEBUG
    bool paintSelection = true;
    if (paintSelection) {
 
        KIS_SAFE_ASSERT_RECOVER_RETURN(canvas());
        KIS_SAFE_ASSERT_RECOVER_RETURN(canvas()->selectedShapesProxy());
 
        KIS_SAFE_ASSERT_RECOVER_RETURN(canvas()->selectedShapesProxy()->selection());
 
        KoSelection *selection = canvas()->selectedShapesProxy()->selection();
 
        QList<KoShape*> shapes = selection->selectedEditableShapes();
 
        Q_FOREACH(KoShape* shape, shapes) {
            KisAlgebra2D::VectorPath vector = KisAlgebra2D::VectorPath(shape->outline());
            painter.save();
            painter.setTransform(painter.transform());
            for (int i = 0; i < vector.segmentsCount(); i++) {
                paintSelectedEdge(painter, converter, shape->absoluteTransformation().map(vector.segmentAtAsLine(i)));
            }
            for (int i =  0; i < vector.pointsCount(); i++) {
                paintSelectedPoint(painter, converter, shape->absoluteTransformation().map(vector.pointAt(i).endPoint));
            }
            painter.restore();
 
        }
    }
#endif
 
 
}

References KoShape::absoluteTransformation(), KoToolBase::canvas(), KisAlgebra2D::VectorPath::VectorPathPoint::endPoint, KIS_SAFE_ASSERT_RECOVER_RETURN, KoShape::outline(), KoInteractionTool::paint(), paintSelectedEdge(), paintSelectedPoint(), KisAlgebra2D::VectorPath::pointAt(), KisAlgebra2D::VectorPath::pointsCount(), KisAlgebra2D::VectorPath::segmentAtAsLine(), KisAlgebra2D::VectorPath::segmentsCount(), KoCanvasBase::selectedShapesProxy(), KoToolBase::selection(), and KoSelectedShapesProxy::selection().

Member Data Documentation

m_d

const QScopedPointer<Private> KisToolKnife::m_d

private

Definition at line 59 of file KisToolKnife.h.

---

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

• plugins/tools/tool_knife/KisToolKnife.h
• plugins/tools/tool_knife/KisToolKnife.cpp