#include <kis_tool_gradient.h>

Inheritance diagram for KisToolGradient:

Public Slots
void	activate (const QSet< KoShape * > &shapes) override

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

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

void	continuePrimaryAction (KoPointerEvent *event) override

QWidget *	createOptionWidget () override

void	endPrimaryAction (KoPointerEvent *event) override

	KisToolGradient (KoCanvasBase *canvas)

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

	~KisToolGradient () override

Public Member Functions inherited from KisToolPaint
int	flags () const override

	KisToolPaint (KoCanvasBase *canvas, const QCursor &cursor)

void	mouseMoveEvent (KoPointerEvent *event) override

void	mousePressEvent (KoPointerEvent *event) override

void	mouseReleaseEvent (KoPointerEvent *event) override

KisPopupWidgetInterface *	popupWidget () override

	~KisToolPaint () override

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

virtual void	beginAlternateDoubleClickAction (KoPointerEvent *event, AlternateAction action)

virtual void	beginPrimaryDoubleClickAction (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 Slots
void	resetCursorStyle () override

Protected Slots inherited from KisTool
virtual void	resetCursorStyle ()

Private Slots
void	areaDone (const QRect &rc)

void	slotSetAntiAliasThreshold (qreal)

void	slotSetDither (int)

void	slotSetDitherSteps (int)

void	slotSetRepeat (int)

void	slotSetReverse (bool)

void	slotSetShape (int)

Private Member Functions
void	paintLine (QPainter &gc)

QPointF	straightLine (QPointF point)

void	updateGuideline ()

Private Attributes
double	m_antiAliasThreshold {0.0}

QCheckBox *	m_ckReverse {nullptr}

KComboBox *	m_cmbDither {nullptr}

KComboBox *	m_cmbRepeat {nullptr}

KComboBox *	m_cmbShape {nullptr}

KConfigGroup	m_configGroup

KisGradientPainter::enumDither	m_dither {KisGradientPainter::DitherNone}

int	m_ditherSteps {KisGradientPainter::defaultDitherSteps}

QPointF	m_endPos

QLabel *	m_lbAntiAliasThreshold {nullptr}

QLabel *	m_lbDither {nullptr}

QLabel *	m_lbDitherSteps {nullptr}

QLabel *	m_lbRepeat {nullptr}

QLabel *	m_lbShape {nullptr}

KisGradientPainter::enumGradientRepeat	m_repeat

bool	m_reverse {false}

KisIntParseSpinBox *	m_sbDitherSteps {nullptr}

KisGradientPainter::enumGradientShape	m_shape

KisDoubleSliderSpinBox *	m_slAntiAliasThreshold {nullptr}

QPointF	m_startPos

Additional Inherited Members
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 }

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 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 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	beginAlternateAction (KoPointerEvent *event, AlternateAction action) override

void	canvasResourceChanged (int key, const QVariant &v) override

void	continueAlternateAction (KoPointerEvent *event, AlternateAction action) override

QWidget *	createOptionWidget () 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

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

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)

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 38 of file kis_tool_gradient.h.

Constructor & Destructor Documentation

◆ KisToolGradient()

KisToolGradient::KisToolGradient ( KoCanvasBase * canvas )

Definition at line 53 of file kis_tool_gradient.cc.

        : KisToolPaint(canvas, KisCursor::loadWithSize("tool_gradient_cursor.svg", 32, 32, 6, 6))
{
    setObjectName("tool_gradient");
 
    m_startPos = QPointF(0, 0);
    m_endPos = QPointF(0, 0);
 
    m_dither = KisGradientPainter::DitherNone;
    m_ditherSteps = KisGradientPainter::defaultDitherSteps;
    m_reverse = false;
    m_shape = KisGradientPainter::GradientShapeLinear;
    m_repeat = KisGradientPainter::GradientRepeatNone;
    m_antiAliasThreshold = 0.2;
 
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas);
 
    connect(kritaCanvas->viewManager()->canvasResourceProvider(), SIGNAL(sigEffectiveCompositeOpChanged()), SLOT(resetCursorStyle()));
}

References Private::canvas, KisViewManager::canvasResourceProvider(), KisGradientPainter::defaultDitherSteps, KisGradientPainter::DitherNone, KisGradientPainter::GradientRepeatNone, KisGradientPainter::GradientShapeLinear, m_antiAliasThreshold, m_dither, m_ditherSteps, m_endPos, m_repeat, m_reverse, m_shape, m_startPos, resetCursorStyle(), and KisCanvas2::viewManager().

◆ ~KisToolGradient()

KisToolGradient::~KisToolGradient ( )

override

Definition at line 73 of file kis_tool_gradient.cc.

74{

75}

Member Function Documentation

◆ activate

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

overrideslot

Definition at line 88 of file kis_tool_gradient.cc.

{
    KisToolPaint::activate(shapes);
    m_configGroup =  KSharedConfig::openConfig()->group(toolId());
}

References KisToolPaint::activate(), m_configGroup, and KoToolBase::toolId().

◆ areaDone

void KisToolGradient::areaDone ( const QRect & rc )

inlineprivateslot

Definition at line 69 of file kis_tool_gradient.h.

                                    {
        currentNode()->setDirty(rc); // Starts computing the projection for the area we've done.
 
    }

References KisTool::currentNode(), and KisNode::setDirty().

◆ beginPrimaryAction()

void KisToolGradient::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.

Definition at line 102 of file kis_tool_gradient.cc.

{
    if (!nodeEditable()) {
        event->ignore();
        return;
    }
 
    setMode(KisTool::PAINT_MODE);
 
    m_startPos = convertToPixelCoordAndSnap(event, QPointF(), false);
    m_endPos = m_startPos;
}

References KisTool::convertToPixelCoordAndSnap(), m_endPos, m_startPos, KisTool::nodeEditable(), KisTool::PAINT_MODE, and KisToolPaint::setMode().

◆ continuePrimaryAction()

void KisToolGradient::continuePrimaryAction ( KoPointerEvent * event )

overridevirtual

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.

TODO: The gradient tool is still not in strokes, so the end of its action can call processEvent(), which would result in nested event handler calls. Please uncomment this line when the tool is ported to strokes.

Reimplemented from KisTool.

Definition at line 115 of file kis_tool_gradient.cc.

{
    //CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
 
    // First ensure the old guideline is deleted
    updateGuideline();
 
    QPointF pos = convertToPixelCoordAndSnap(event, QPointF(), false);
 
    if (event->modifiers() == Qt::ShiftModifier) {
        m_endPos = straightLine(pos);
    } else {
        m_endPos = pos;
    }
 
    updateGuideline();
}

References KisTool::convertToPixelCoordAndSnap(), m_endPos, KoPointerEvent::modifiers(), straightLine(), and updateGuideline().

◆ createOptionWidget()

QWidget * KisToolGradient::createOptionWidget ( )

overridevirtual

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

Reimplemented from KisTool.

Definition at line 234 of file kis_tool_gradient.cc.

{
    QWidget *widget = KisToolPaint::createOptionWidget();
    Q_CHECK_PTR(widget);
    widget->setObjectName(toolId() + " option widget");
 
 
    // Make sure to create the connections last after everything is set up. The initialized values
    // won't be loaded from the configuration file if you add the widget before the connection
    m_lbShape = new QLabel(i18n("Shape:"), widget);
    m_cmbShape = new KComboBox(widget);
    m_cmbShape->setObjectName("shape_combo");
    m_cmbShape->addItem(i18nc("the gradient will be drawn linearly", "Linear"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn bilinearly", "Bi-Linear"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn radially", "Radial"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn in a square around a centre", "Square"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn as an asymmetric cone", "Conical"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn as a symmetric cone", "Conical Symmetric"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn as a spiral", "Spiral"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn as a reverse spiral", "Reverse Spiral"));
    m_cmbShape->addItem(i18nc("the gradient will be drawn in a selection outline", "Shaped"));
    addOptionWidgetOption(m_cmbShape, m_lbShape);
    connect(m_cmbShape, SIGNAL(currentIndexChanged(int)), this, SLOT(slotSetShape(int)));
 
    m_lbRepeat = new QLabel(i18n("Repeat:"), widget);
    m_cmbRepeat = new KComboBox(widget);
    m_cmbRepeat->setObjectName("repeat_combo");
    m_cmbRepeat->addItem(i18nc("The gradient will not repeat", "None"));
    m_cmbRepeat->addItem(i18nc("The gradient will repeat forwards", "Forwards"));
    m_cmbRepeat->addItem(i18nc("The gradient will repeat alternatingly", "Alternating"));
    addOptionWidgetOption(m_cmbRepeat, m_lbRepeat);
    connect(m_cmbRepeat, SIGNAL(currentIndexChanged(int)), this, SLOT(slotSetRepeat(int)));
 
    m_lbDither = new QLabel(i18n("Dither:"), widget);
    m_cmbDither = new KComboBox(widget);
    m_cmbDither->setObjectName("dither");
    m_cmbDither->addItem(i18nc("The gradient will not be dithered", "None"));
    m_cmbDither->addItem(i18nc("The gradient will be dithered with Blue Noise", "Blue Noise"));
    m_cmbDither->addItem(i18nc("The gradient will be dithered with Bayer Matrix 2x2", "Bayer Matrix 2x2"));
    m_cmbDither->addItem(i18nc("The gradient will be dithered with Bayer Matrix 4x4", "Bayer Matrix 4x4"));
    m_cmbDither->addItem(i18nc("The gradient will be dithered with Bayer Matrix 8x8", "Bayer Matrix 8x8"));
    addOptionWidgetOption(m_cmbDither, m_lbDither);
    connect(m_cmbDither, SIGNAL(currentIndexChanged(int)), this, SLOT(slotSetDither(int)));
 
    m_lbDitherSteps = new QLabel(i18n("Dither steps:"), widget);
    m_sbDitherSteps = new KisIntParseSpinBox(widget);
    m_sbDitherSteps->setObjectName("dither_steps");
    m_sbDitherSteps->setRange(2, 10000);
    addOptionWidgetOption(m_sbDitherSteps, m_lbDitherSteps);
    connect(m_sbDitherSteps, SIGNAL(valueChanged(int)), this, SLOT(slotSetDitherSteps(int)));
 
    m_lbAntiAliasThreshold = new QLabel(i18n("Anti-alias threshold:"), widget);
    m_slAntiAliasThreshold = new KisDoubleSliderSpinBox(widget);
    m_slAntiAliasThreshold->setObjectName("threshold_slider");
    m_slAntiAliasThreshold->setRange(0, 1, 3);
    m_slAntiAliasThreshold->setSingleStep(0.001);
    addOptionWidgetOption(m_slAntiAliasThreshold, m_lbAntiAliasThreshold);
    connect(m_slAntiAliasThreshold, SIGNAL(valueChanged(qreal)), this, SLOT(slotSetAntiAliasThreshold(qreal)));
 
    m_ckReverse = new QCheckBox(i18nc("the gradient will be drawn with the color order reversed", "Reverse"), widget);
    m_ckReverse->setObjectName("reverse_check");
    connect(m_ckReverse, SIGNAL(toggled(bool)), this, SLOT(slotSetReverse(bool)));
    addOptionWidgetOption(m_ckReverse);
 
 
    // load configuration settings into widget (updating UI will update internal variables from signals/slots)
    slotSetDither((int)m_configGroup.readEntry("dither", 0));
    m_sbDitherSteps->setValue((int)m_configGroup.readEntry("ditherSteps", KisGradientPainter::defaultDitherSteps));
    m_ckReverse->setChecked((bool)m_configGroup.readEntry("reverse", false));
    m_cmbShape->setCurrentIndex((int)m_configGroup.readEntry("shape", 0));
    m_cmbRepeat->setCurrentIndex((int)m_configGroup.readEntry("repeat", 0));
    m_slAntiAliasThreshold->setValue((qreal)m_configGroup.readEntry("antialiasThreshold", 0.0));
 
    return widget;
}

References KisToolPaint::addOptionWidgetOption(), KisToolPaint::createOptionWidget(), KisGradientPainter::defaultDitherSteps, m_ckReverse, m_cmbDither, m_cmbRepeat, m_cmbShape, m_configGroup, m_lbAntiAliasThreshold, m_lbDither, m_lbDitherSteps, m_lbRepeat, m_lbShape, m_sbDitherSteps, m_slAntiAliasThreshold, KisDoubleSliderSpinBox::setRange(), KisIntParseSpinBox::setValue(), KisDoubleSliderSpinBox::setValue(), slotSetAntiAliasThreshold(), slotSetDither(), slotSetDitherSteps(), slotSetRepeat(), slotSetReverse(), slotSetShape(), and KoToolBase::toolId().

◆ endPrimaryAction()

void KisToolGradient::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.

Definition at line 139 of file kis_tool_gradient.cc.

{
    Q_UNUSED(event);
    CHECK_MODE_SANITY_OR_RETURN(KisTool::PAINT_MODE);
    setMode(KisTool::HOVER_MODE);
 
    if (!currentNode())
        return;
 
    if (m_startPos == m_endPos) {
        return;
    }
 
    KisImageSP image = this->image();
 
    KisResourcesSnapshotSP resources =
        new KisResourcesSnapshot(image, currentNode(), this->canvas()->resourceManager());
 
    if (image && resources->currentNode()->paintDevice()) {
        KUndo2MagicString actionName = kundo2_i18n("Gradient");
        KisProcessingApplicator applicator(image, resources->currentNode(),
                                           KisProcessingApplicator::NONE,
                                           KisImageSignalVector(),
                                           actionName);
 
        applicator.applyCommand(
            new KisCommandUtils::LambdaCommand(
                [resources, startPos = m_startPos, endPos = m_endPos,
                 shape = m_shape, repeat = m_repeat, reverse = m_reverse,
                 antiAliasThreshold = m_antiAliasThreshold, dither = m_dither,
                 ditherSteps = m_ditherSteps] () mutable {
 
                    KisNodeSP node = resources->currentNode();
                    KisPaintDeviceSP device = node->paintDevice();
                    KisProcessingVisitor::ProgressHelper helper(node);
                    const QRect bounds = device->defaultBounds()->bounds();
 
                    KisGradientPainter painter(device, resources->activeSelection());
                    resources->setupPainter(&painter);
                    painter.setProgress(helper.updater());
 
                    painter.beginTransaction();
 
                    painter.setGradientShape(shape);
                    painter.paintGradient(startPos, endPos,
                                          repeat, antiAliasThreshold,
                                          reverse, 0, 0,
                                          bounds.width(), bounds.height(),
                                          dither, ditherSteps);
 
                    return painter.endAndTakeTransaction();
                }));
        applicator.end();
    }
 
    updateGuideline();
}

References KisResourcesSnapshot::activeSelection(), KisProcessingApplicator::applyCommand(), KisPainter::beginTransaction(), KisDefaultBoundsBase::bounds(), bounds, Private::canvas, CHECK_MODE_SANITY_OR_RETURN, KisResourcesSnapshot::currentNode(), KisTool::currentNode(), KisPaintDevice::defaultBounds(), KisProcessingApplicator::end(), KisPainter::endAndTakeTransaction(), KisTool::HOVER_MODE, KisTool::image(), kundo2_i18n(), m_antiAliasThreshold, m_dither, m_ditherSteps, m_endPos, m_repeat, m_reverse, m_shape, m_startPos, KisProcessingApplicator::NONE, KisTool::PAINT_MODE, KisBaseNode::paintDevice(), KisGradientPainter::paintGradient(), KisGradientPainter::setGradientShape(), KisToolPaint::setMode(), KisPainter::setProgress(), KisResourcesSnapshot::setupPainter(), updateGuideline(), and KisProcessingVisitor::ProgressHelper::updater().

◆ paint()

void KisToolGradient::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 94 of file kis_tool_gradient.cc.

{
    if (mode() == KisTool::PAINT_MODE && m_startPos != m_endPos) {
        paintLine(painter);
    }
    KisToolPaint::paint(painter, converter);
}

References m_endPos, m_startPos, KisTool::mode(), KisToolPaint::paint(), KisTool::PAINT_MODE, and paintLine().

◆ paintLine()

void KisToolGradient::paintLine ( QPainter & gc )

private

Definition at line 213 of file kis_tool_gradient.cc.

{
    QPointF viewStartPos = pixelToView(m_startPos);
    QPointF viewStartEnd = pixelToView(m_endPos);
 
    if (canvas()) {
        QPainterPath path;
        path.moveTo(viewStartPos);
        path.lineTo(viewStartEnd);
        paintToolOutline(&gc, path);
    }
}

References Private::canvas, m_endPos, m_startPos, KisTool::paintToolOutline(), and KisTool::pixelToView().

◆ resetCursorStyle

void KisToolGradient::resetCursorStyle ( )

overrideprotectedslot

Definition at line 77 of file kis_tool_gradient.cc.

{
    if (isEraser()) {
        useCursor(KisCursor::loadWithSize("tool_gradient_eraser_cursor.svg", 32, 32, 6, 6));
    } else {
        KisToolPaint::resetCursorStyle();
    }
 
    overrideCursorIfNotEditable();
}

References KisToolPaint::isEraser(), KisCursor::loadWithSize(), KisTool::overrideCursorIfNotEditable(), KisTool::resetCursorStyle(), and KoToolBase::useCursor().

◆ slotSetAntiAliasThreshold

void KisToolGradient::slotSetAntiAliasThreshold ( qreal value )

privateslot

Definition at line 346 of file kis_tool_gradient.cc.

{
    m_antiAliasThreshold = value;
    m_configGroup.writeEntry("antialiasThreshold", value);
}

References m_antiAliasThreshold, m_configGroup, and value().

◆ slotSetDither

void KisToolGradient::slotSetDither ( int dither )

privateslot

Definition at line 328 of file kis_tool_gradient.cc.

{
    if (m_cmbDither->currentIndex() != dither) {
        m_cmbDither->setCurrentIndex(dither);
    }
 
    m_dither = static_cast<KisGradientPainter::enumDither>(dither);
    m_configGroup.writeEntry("dither", dither);
 
    showControl(m_sbDitherSteps, KisGradientPainter::isBayerDither(m_dither));
}

References KisGradientPainter::isBayerDither(), m_cmbDither, m_configGroup, m_dither, m_sbDitherSteps, and KisToolPaint::showControl().

◆ slotSetDitherSteps

void KisToolGradient::slotSetDitherSteps ( int value )

privateslot

Definition at line 340 of file kis_tool_gradient.cc.

{
    m_ditherSteps = value;
    m_configGroup.writeEntry("ditherSteps", value);
}

References m_configGroup, m_ditherSteps, and value().

◆ slotSetRepeat

void KisToolGradient::slotSetRepeat ( int repeat )

privateslot

Definition at line 316 of file kis_tool_gradient.cc.

{
    m_repeat = static_cast<KisGradientPainter::enumGradientRepeat>(repeat);
    m_configGroup.writeEntry("repeat", repeat);
}

References m_configGroup, and m_repeat.

◆ slotSetReverse

void KisToolGradient::slotSetReverse ( bool state )

privateslot

Definition at line 322 of file kis_tool_gradient.cc.

{
    m_reverse = state;
    m_configGroup.writeEntry("reverse", state);
}

References m_configGroup, and m_reverse.

◆ slotSetShape

void KisToolGradient::slotSetShape ( int shape )

privateslot

Definition at line 310 of file kis_tool_gradient.cc.

{
    m_shape = static_cast<KisGradientPainter::enumGradientShape>(shape);
    m_configGroup.writeEntry("shape", shape);
}

References m_configGroup, and m_shape.

◆ straightLine()

QPointF KisToolGradient::straightLine ( QPointF point )

private

Definition at line 197 of file kis_tool_gradient.cc.

{
    QPointF comparison = point - m_startPos;
    QPointF result;
 
    if (fabs(comparison.x()) > fabs(comparison.y())) {
        result.setX(point.x());
        result.setY(m_startPos.y());
    } else {
        result.setX(m_startPos.x());
        result.setY(point.y());
    }
 
    return result;
}

References m_startPos.

◆ updateGuideline()

void KisToolGradient::updateGuideline ( )

private

Definition at line 226 of file kis_tool_gradient.cc.

{
    if (canvas()) {
        QRectF bound(m_startPos, m_endPos);
        canvas()->updateCanvas(convertToPt(bound.normalized().adjusted(-3, -3, 3, 3)));
    }
}

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

Member Data Documentation

◆ m_antiAliasThreshold

double KisToolGradient::m_antiAliasThreshold {0.0}

private

Definition at line 90 of file kis_tool_gradient.h.

90{0.0};

◆ m_ckReverse

QCheckBox* KisToolGradient::m_ckReverse {nullptr}

private

Definition at line 98 of file kis_tool_gradient.h.

98{nullptr};

◆ m_cmbDither

KComboBox* KisToolGradient::m_cmbDither {nullptr}

private

Definition at line 95 of file kis_tool_gradient.h.

95{nullptr};

◆ m_cmbRepeat

KComboBox* KisToolGradient::m_cmbRepeat {nullptr}

private

Definition at line 100 of file kis_tool_gradient.h.

100{nullptr};

◆ m_cmbShape

KComboBox* KisToolGradient::m_cmbShape {nullptr}

private

Definition at line 99 of file kis_tool_gradient.h.

99{nullptr};

◆ m_configGroup

KConfigGroup KisToolGradient::m_configGroup

private

Definition at line 103 of file kis_tool_gradient.h.

◆ m_dither

KisGradientPainter::enumDither KisToolGradient::m_dither {KisGradientPainter::DitherNone}

private

Definition at line 87 of file kis_tool_gradient.h.

87{KisGradientPainter::DitherNone};

◆ m_ditherSteps

int KisToolGradient::m_ditherSteps {KisGradientPainter::defaultDitherSteps}

private

Definition at line 88 of file kis_tool_gradient.h.

88{KisGradientPainter::defaultDitherSteps};

◆ m_endPos

QPointF KisToolGradient::m_endPos

private

Definition at line 82 of file kis_tool_gradient.h.

◆ m_lbAntiAliasThreshold

QLabel* KisToolGradient::m_lbAntiAliasThreshold {nullptr}

private

Definition at line 101 of file kis_tool_gradient.h.

101{nullptr};

◆ m_lbDither

QLabel* KisToolGradient::m_lbDither {nullptr}

private

Definition at line 94 of file kis_tool_gradient.h.

94{nullptr};

◆ m_lbDitherSteps

QLabel* KisToolGradient::m_lbDitherSteps {nullptr}

private

Definition at line 96 of file kis_tool_gradient.h.

96{nullptr};

◆ m_lbRepeat

QLabel* KisToolGradient::m_lbRepeat {nullptr}

private

Definition at line 93 of file kis_tool_gradient.h.

93{nullptr};

◆ m_lbShape

QLabel* KisToolGradient::m_lbShape {nullptr}

private

Definition at line 92 of file kis_tool_gradient.h.

92{nullptr};

◆ m_repeat

KisGradientPainter::enumGradientRepeat KisToolGradient::m_repeat

private

Definition at line 85 of file kis_tool_gradient.h.

◆ m_reverse

bool KisToolGradient::m_reverse {false}

private

Definition at line 89 of file kis_tool_gradient.h.

89{false};

◆ m_sbDitherSteps

KisIntParseSpinBox* KisToolGradient::m_sbDitherSteps {nullptr}

private

Definition at line 97 of file kis_tool_gradient.h.

97{nullptr};

◆ m_shape

KisGradientPainter::enumGradientShape KisToolGradient::m_shape

private

Definition at line 84 of file kis_tool_gradient.h.

◆ m_slAntiAliasThreshold

KisDoubleSliderSpinBox* KisToolGradient::m_slAntiAliasThreshold {nullptr}

private

Definition at line 102 of file kis_tool_gradient.h.

102{nullptr};

◆ m_startPos

QPointF KisToolGradient::m_startPos

private

Definition at line 81 of file kis_tool_gradient.h.

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

plugins/tools/basictools/kis_tool_gradient.h
plugins/tools/basictools/kis_tool_gradient.cc

Public Slots

Public Member Functions

Protected Slots

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisToolGradient()

◆ ~KisToolGradient()

Member Function Documentation

◆ activate

◆ areaDone

◆ beginPrimaryAction()

◆ continuePrimaryAction()

◆ createOptionWidget()

◆ endPrimaryAction()

◆ paint()

◆ paintLine()

◆ resetCursorStyle

◆ slotSetAntiAliasThreshold

◆ slotSetDither

◆ slotSetDitherSteps

◆ slotSetRepeat

◆ slotSetReverse

◆ slotSetShape

◆ straightLine()

◆ updateGuideline()

Member Data Documentation

◆ m_antiAliasThreshold

◆ m_ckReverse

◆ m_cmbDither

◆ m_cmbRepeat

◆ m_cmbShape

◆ m_configGroup

◆ m_dither

◆ m_ditherSteps

◆ m_endPos

◆ m_lbAntiAliasThreshold

◆ m_lbDither

◆ m_lbDitherSteps

◆ m_lbRepeat

◆ m_lbShape

◆ m_repeat

◆ m_reverse

◆ m_sbDitherSteps

◆ m_shape

◆ m_slAntiAliasThreshold

◆ m_startPos