#include <kis_tool_pencil.h>

Inheritance diagram for __KisToolPencilLocalTool:

Public Member Functions
	__KisToolPencilLocalTool (KoCanvasBase canvas, KisToolPencil parentTool)

void	addPathShape (KoPathShape *pathShape, bool closePath) override

QList< QPointer< QWidget > >	createOptionWidgets () override

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

virtual void	paintPath (KoPathShape *path, QPainter &painter, const KoViewConverter &converter)

Public Member Functions inherited from KoPencilTool
void	activate (const QSet< KoShape * > &shapes) override

void	deactivate () override

void	keyPressEvent (QKeyEvent *event) override

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

	~KoPencilTool () 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 the Enter key or any equivalent key. 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	keyReleaseEvent (QKeyEvent *event)

	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

Protected Member Functions
void	slotUpdatePencilCursor () override

Protected Member Functions inherited from KoPencilTool
QList< QPointer< QWidget > >	createOptionWidgets () override

KoShapeStrokeSP	createStroke ()

qreal	getFittingError ()

KoPathShape *	path ()

void	setFittingError (qreal fittingError)

void	setStrokeColor (QColor color)

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)

Private Attributes
KisToolPencil *const	m_parentTool

Additional Inherited Members
Public Slots inherited from KoToolBase
virtual void	canvasResourceChanged (int key, const QVariant &res)

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 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 Slots inherited from KoPencilTool
Protected Attributes inherited from KoToolBase
KoToolBasePrivate *	d_ptr

Detailed Description

Definition at line 23 of file kis_tool_pencil.h.

Constructor & Destructor Documentation

◆ __KisToolPencilLocalTool()

__KisToolPencilLocalTool::__KisToolPencilLocalTool	(	KoCanvasBase *	canvas,
		KisToolPencil *	parentTool )

Definition at line 97 of file kis_tool_pencil.cc.

    : KoPencilTool(canvas), m_parentTool(parentTool) {
    setIsOpacityPresetMode(true);
}

References KoToolBase::setIsOpacityPresetMode().

Member Function Documentation

◆ addPathShape()

void __KisToolPencilLocalTool::addPathShape	(	KoPathShape *	path,
		bool	closePath )

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 KoPencilTool.

Definition at line 126 of file kis_tool_pencil.cc.

{
    if (closePath) {
        pathShape->close();
        pathShape->normalize();
    }
 
    m_parentTool->addPathShape(pathShape, kundo2_i18n("Draw Freehand Path"));
}

References KoPathShape::close(), kundo2_i18n(), m_parentTool, and KoPathShape::normalize().

◆ createOptionWidgets()

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

overridevirtual

Reimplemented from KoToolBase.

Definition at line 40 of file KoPencilTool.cpp.

{
    m_mode = static_cast<PencilMode>(m_configGroup.readEntry<int>("pencilMode", m_mode));
    m_optimizeRaw = m_configGroup.readEntry<bool>("optimizeRaw", m_optimizeRaw);
    m_optimizeCurve = m_configGroup.readEntry<bool>("optimizeCurve", m_optimizeCurve);
    m_combineAngle = m_configGroup.readEntry<qreal>("combineAngle", m_combineAngle);
    m_fittingError = m_configGroup.readEntry<qreal>("fittingError", m_fittingError);
 
    QList<QPointer<QWidget> > widgets;
    QWidget *optionWidget = new QWidget();
    QVBoxLayout * layout = new QVBoxLayout(optionWidget);
 
    QHBoxLayout *modeLayout = new QHBoxLayout;
    modeLayout->setSpacing(3);
    QLabel *modeLabel = new QLabel(i18n("Precision:"), optionWidget);
    QComboBox * modeBox = new QComboBox(optionWidget);
    modeBox->addItem(i18nc("The raw line data", "Raw"));
    modeBox->addItem(i18n("Curve"));
    modeBox->addItem(i18n("Straight"));
    modeLayout->addWidget(modeLabel);
    modeLayout->addWidget(modeBox, 1);
    layout->addLayout(modeLayout);
 
    QStackedWidget * stackedWidget = new QStackedWidget(optionWidget);
 
    QWidget * rawBox = new QWidget(stackedWidget);
    QVBoxLayout * rawLayout = new QVBoxLayout(rawBox);
    QCheckBox * optimizeRaw = new QCheckBox(i18n("Optimize"), rawBox);
    optimizeRaw->setChecked(m_optimizeRaw);
    rawLayout->addWidget(optimizeRaw);
    rawLayout->setContentsMargins(0, 0, 0, 0);
 
    QWidget * curveBox = new QWidget(stackedWidget);
    QHBoxLayout * curveLayout = new QHBoxLayout(curveBox);
    QCheckBox * optimizeCurve = new QCheckBox(i18n("Optimize"), curveBox);
    optimizeCurve->setChecked(m_optimizeCurve);
    QDoubleSpinBox * fittingError = new KisDoubleParseSpinBox(curveBox);
    fittingError->setSingleStep(0.50);
    fittingError->setMaximum(400.0);
    fittingError->setMinimum(0.0);
    fittingError->setValue(m_fittingError);
    fittingError->setToolTip(i18n("Exactness:"));
    curveLayout->addWidget(optimizeCurve);
    curveLayout->addWidget(fittingError);
    curveLayout->setContentsMargins(0, 0, 0, 0);
 
    QWidget *straightBox = new QWidget(stackedWidget);
    QVBoxLayout *straightLayout = new QVBoxLayout(straightBox);
    QDoubleSpinBox *combineAngle = new KisDoubleParseSpinBox(straightBox);
    combineAngle->setSingleStep(0.50);
    combineAngle->setMaximum(360.0);
    combineAngle->setMinimum(0.0);
    combineAngle->setValue(m_combineAngle);
    combineAngle->setSuffix(" deg");
    // QT5TODO
    //combineAngle->setLabel(i18n("Combine angle:"), Qt::AlignLeft | Qt::AlignVCenter);
    straightLayout->addWidget(combineAngle);
    straightLayout->setContentsMargins(0, 0, 0, 0);
 
    stackedWidget->addWidget(rawBox);
    stackedWidget->addWidget(curveBox);
    stackedWidget->addWidget(straightBox);
    layout->addWidget(stackedWidget);
    layout->addStretch(1);
 
    connect(modeBox, SIGNAL(activated(int)), stackedWidget, SLOT(setCurrentIndex(int)));
    connect(modeBox, SIGNAL(activated(int)), this, SLOT(selectMode(int)));
    connect(optimizeRaw, SIGNAL(stateChanged(int)), this, SLOT(setOptimize(int)));
    connect(optimizeCurve, SIGNAL(stateChanged(int)), this, SLOT(setOptimize(int)));
    connect(fittingError, SIGNAL(valueChanged(double)), this, SLOT(setDelta(double)));
    connect(combineAngle, SIGNAL(valueChanged(double)), this, SLOT(setDelta(double)));
 
    modeBox->setCurrentIndex(m_mode);
    stackedWidget->setCurrentIndex(m_mode);
    optionWidget->setObjectName(i18n("Pencil"));
    optionWidget->setWindowTitle(i18n("Pencil"));
    widgets.append(optionWidget);
 
    m_strokeWidget = new KoStrokeConfigWidget(canvas(), 0);
    m_strokeWidget->setNoSelectionTrackingMode(true);
    m_strokeWidget->setWindowTitle(i18n("Line"));
    connect(m_strokeWidget, SIGNAL(sigStrokeChanged()), SLOT(slotUpdatePencilCursor()));
    if (isActivated()) {
        m_strokeWidget->activate();
    }
    widgets.append(m_strokeWidget);
    return widgets;
}

◆ paint()

void __KisToolPencilLocalTool::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 102 of file kis_tool_pencil.cc.

{
    if (m_parentTool->strokeStyle() == KisToolShapeUtils::StrokeStyleNone) {
        paintPath(path(), painter, converter);
    } else {
        KoPencilTool::paint(painter, converter);
    }
}

References m_parentTool, KoPencilTool::paint(), paintPath(), KoPencilTool::path(), and KisToolShapeUtils::StrokeStyleNone.

◆ paintPath()

void __KisToolPencilLocalTool::paintPath	(	KoPathShape *	path,
		QPainter &	painter,
		const KoViewConverter &	converter )

virtual

Definition at line 113 of file kis_tool_pencil.cc.

{
    Q_UNUSED(converter);
    if (!pathShape) {
        return;
    }
 
    QTransform matrix;
    matrix.scale(m_parentTool->image()->xRes(), m_parentTool->image()->yRes());
    matrix.translate(pathShape->position().x(), pathShape->position().y());
    m_parentTool->paintToolOutline(&painter, m_parentTool->pixelToView(matrix.map(pathShape->outline())));
}

References m_parentTool, KoPathShape::outline(), and KoShape::position().

◆ slotUpdatePencilCursor()

void __KisToolPencilLocalTool::slotUpdatePencilCursor ( )

overrideprotectedvirtual

Reimplemented from KoPencilTool.

Definition at line 136 of file kis_tool_pencil.cc.

{
    KoShapeStrokeSP stroke = this->createStroke();
    m_parentTool->updatePencilCursor(stroke && stroke->isVisible());
 
    auto style = m_parentTool->strokeStyle();
    if (style ==  KisToolShapeUtils::StrokeStyleForeground )
    {
        KoPencilTool::setStrokeColor(canvas()->resourceManager()->foregroundColor().toQColor());
    }
    else if ( style == KisToolShapeUtils::StrokeStyleBackground)
    {
        KoPencilTool::setStrokeColor(canvas()->resourceManager()->backgroundColor().toQColor());
    }
}

References KoToolBase::canvas(), KoPencilTool::createStroke(), m_parentTool, KoPencilTool::setStrokeColor(), KisToolShapeUtils::StrokeStyleBackground, KisToolShapeUtils::StrokeStyleForeground, and KisToolPencil::updatePencilCursor().

Member Data Documentation

◆ m_parentTool

KisToolPencil* const __KisToolPencilLocalTool::m_parentTool

private

Definition at line 36 of file kis_tool_pencil.h.

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

plugins/tools/basictools/kis_tool_pencil.h
plugins/tools/basictools/kis_tool_pencil.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __KisToolPencilLocalTool()

Member Function Documentation

◆ addPathShape()

◆ createOptionWidgets()

◆ paint()

◆ paintPath()

◆ slotUpdatePencilCursor()

Member Data Documentation

◆ m_parentTool