#include <kis_tool_select_similar.h>

Inheritance diagram for KisToolSelectSimilar:

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

void	deactivate () override

void	slotSetOpacitySpread (int)

void	slotSetThreshold (int)

Public Member Functions
void	beginPrimaryAction (KoPointerEvent *event) override

QWidget *	createOptionWidget () override

void	endPrimaryAction (KoPointerEvent *event) override

	KisToolSelectSimilar (KoCanvasBase *canvas)

void	paint (QPainter &, const KoViewConverter &) override

void	resetCursorStyle () override

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

void	activateAlternateAction (KisTool::AlternateAction action) override

SelectionAction	alternateSelectionAction () const

bool	antiAliasSelection () const

void	beginAlternateAction (KoPointerEvent *event, KisTool::AlternateAction action) override

bool	beginMoveSelectionInteraction ()

void	beginPrimaryAction (KoPointerEvent *event) override

bool	beginSelectInteraction ()

QList< int >	colorLabelsSelected () const

void	continueAlternateAction (KoPointerEvent *event, KisTool::AlternateAction action) override

void	continuePrimaryAction (KoPointerEvent *event) override

QWidget *	createOptionWidget () override

void	deactivate () override

void	deactivateAlternateAction (KisTool::AlternateAction action) override

void	endAlternateAction (KoPointerEvent *event, KisTool::AlternateAction action) override

bool	endMoveSelectionInteraction ()

void	endPrimaryAction (KoPointerEvent *event) override

bool	endSelectInteraction ()

int	featherSelection () const

int	growSelection () const

bool	isMovingSelection () const

bool	isSelecting () const

void	keyPressEvent (QKeyEvent *event) override

void	keyReleaseEvent (QKeyEvent *event) override

	KisToolSelectBase (KoCanvasBase *canvas, const QCursor cursor, const QString toolName)

	KisToolSelectBase (KoCanvasBase *canvas, const QString toolName)

	KisToolSelectBase (KoCanvasBase canvas, QCursor cursor, QString toolName, KoToolBase delegateTool)

KisNodeSP	locateSelectionMaskUnderCursor (const QPointF &pos, Qt::KeyboardModifiers modifiers)

void	mouseMoveEvent (KoPointerEvent *event) override

QMenu *	popupActionsMenu () override

KisPopupWidgetInterface *	popupWidget () override

SampleLayersMode	sampleLayersMode () const

SelectionAction	selectionAction () const

bool	selectionDidMove () const

SelectionMode	selectionMode () const

KisSelectionOptions *	selectionOptionWidget ()

virtual void	setAlternateSelectionAction (SelectionAction action)

bool	stopGrowingAtDarkestPixel () const

void	updateActionShortcutToolTips ()

void	updateCursorDelayed ()

Protected Member Functions
bool	isPixelOnly () const override

bool	usesColorLabels () const override

Protected Attributes
KisSelectionToolConfigWidgetHelper	m_widgetHelper

Protected Attributes inherited from KisToolSelectBase< BaseClass >
SelectionAction	m_selectionActionAlternate

KisSelectionToolConfigWidgetHelper	m_widgetHelper

Private Attributes
KConfigGroup	m_configGroup

int	m_opacitySpread

int	m_previousTime

KisMergeLabeledLayersCommand::ReferenceNodeInfoListSP	m_referenceNodeList

KisPaintDeviceSP	m_referencePaintDevice

int	m_threshold

Additional Inherited Members
Public Types inherited from KisToolSelectBase< BaseClass >
enum	SampleLayersMode { SampleAllLayers , SampleCurrentLayer , SampleColorLabeledLayers }

Detailed Description

Definition at line 20 of file kis_tool_select_similar.h.

Constructor & Destructor Documentation

◆ KisToolSelectSimilar()

KisToolSelectSimilar::KisToolSelectSimilar ( KoCanvasBase * canvas )

Definition at line 39 of file kis_tool_select_similar.cc.

    : KisToolSelect(canvas,
                    KisCursor::load("tool_similar_selection_cursor.png", 6, 6),
                    i18n("Similar Color Selection"))
    , m_threshold(20)
    , m_opacitySpread(100)
    , m_previousTime(0)
{
}

Member Function Documentation

◆ activate

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

overrideslot

Definition at line 49 of file kis_tool_select_similar.cc.

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

References KisToolSelectBase< BaseClass >::activate(), and m_configGroup.

◆ beginPrimaryAction()

void KisToolSelectSimilar::beginPrimaryAction ( KoPointerEvent * event )

override

Definition at line 62 of file kis_tool_select_similar.cc.

{
    KisToolSelectBase::beginPrimaryAction(event);
    if (isMovingSelection()) {
        return;
    }
 
    KisPaintDeviceSP dev;
 
    if (!currentNode() ||
        !(currentNode()->projection()) ||
        !selectionEditable()) {
 
        event->ignore();
        return;
    }
 
    KisCanvas2 * kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_SAFE_ASSERT_RECOVER_RETURN(kisCanvas);
 
    beginSelectInteraction();
 
    KisCursorOverrideLock cursorLock(KisCursor::waitCursor());
 
    // Create the stroke
    KisStrokeStrategyUndoCommandBased *strategy =
            new KisStrokeStrategyUndoCommandBased(kundo2_i18n("Select Similar Color"), false, image().data());
    strategy->setSupportsWrapAroundMode(false);
    KisStrokeId strokeId = image()->startStroke(strategy);
 
    // Construct the reference device
    if (sampleLayersMode() == SampleCurrentLayer) {
        m_referencePaintDevice = currentNode()->projection();
    } else if (sampleLayersMode() == SampleAllLayers) {
        m_referencePaintDevice = currentImage()->projection();
    } else if (sampleLayersMode() == SampleColorLabeledLayers) {
        if (!m_referenceNodeList) {
            m_referencePaintDevice = KisMergeLabeledLayersCommand::createRefPaintDevice(image(), "Similar Colors Selection Tool Reference Result Paint Device");
            m_referenceNodeList.reset(new KisMergeLabeledLayersCommand::ReferenceNodeInfoList);
        }
        KisPaintDeviceSP newReferencePaintDevice = KisMergeLabeledLayersCommand::createRefPaintDevice(image(), "Similar Colors Selection Tool Reference Result Paint Device");
        KisMergeLabeledLayersCommand::ReferenceNodeInfoListSP newReferenceNodeList(new KisMergeLabeledLayersCommand::ReferenceNodeInfoList);
        const int currentTime = image()->animationInterface()->currentTime();
 
        image()->addJob(
            strokeId,
            new KisStrokeStrategyUndoCommandBased::Data(
                KUndo2CommandSP(new KisMergeLabeledLayersCommand(
                    image(),
                    m_referenceNodeList,
                    newReferenceNodeList,
                    m_referencePaintDevice,
                    newReferencePaintDevice,
                    colorLabelsSelected(),
                    KisMergeLabeledLayersCommand::GroupSelectionPolicy_SelectIfColorLabeled,
                    m_previousTime != currentTime
                )),
                false,
                KisStrokeJobData::SEQUENTIAL,
                KisStrokeJobData::EXCLUSIVE
            )
        );
 
        m_referencePaintDevice = newReferencePaintDevice;
        m_referenceNodeList = newReferenceNodeList;
        m_previousTime = currentTime;
    }
 
    // Get the color of the pixel where the user clicked
    KisPaintDeviceSP sourceDevice = m_referencePaintDevice;
    const QPoint pos = convertToImagePixelCoordFloored(event);
    QSharedPointer<KoColor> referenceColor = QSharedPointer<KoColor>(new KoColor(sourceDevice->colorSpace()));
    // We need to obtain the reference color from the reference paint
    // device, but it is produced in a stroke, so we must get the color
    // after the device is ready. So we get it in the stroke
    image()->addJob(
        strokeId,
        new KisStrokeStrategyUndoCommandBased::Data(
            KUndo2CommandSP(new KisCommandUtils::LambdaCommand(
                [sourceDevice, referenceColor, pos]() -> KUndo2Command*
                {
                    *referenceColor = sourceDevice->pixel(pos);
                    return 0;
                }
            )),
            false,
            KisStrokeJobData::SEQUENTIAL,
            KisStrokeJobData::EXCLUSIVE
        )
    );
 
    // Get the similar colors selection
    KisFillPainter painter;
    QRect bounds = currentImage()->bounds();
    QSharedPointer<KisProcessingVisitor::ProgressHelper>
        progressHelper(new KisProcessingVisitor::ProgressHelper(currentNode()));
    KisPixelSelectionSP tmpSel = new KisPixelSelection(new KisSelectionDefaultBounds(currentNode()->projection()));
 
    painter.setFillThreshold(m_threshold);
    painter.setOpacitySpread(m_opacitySpread);
    painter.setAntiAlias(antiAliasSelection());
    painter.setSizemod(growSelection());
    painter.setStopGrowingAtDarkestPixel(this->stopGrowingAtDarkestPixel());
    painter.setFeather(featherSelection());
 
    QVector<KisStrokeJobData*> jobs =
        painter.createSimilarColorsSelectionJobs(
            tmpSel, referenceColor, sourceDevice,
            bounds, nullptr, progressHelper
        );
 
    for (KisStrokeJobData *job : jobs) {
        image()->addJob(strokeId, job);
    }
 
    image()->addJob(
        strokeId,
        new KisStrokeStrategyUndoCommandBased::Data(
            KUndo2CommandSP(new KisCommandUtils::LambdaCommand(
                [tmpSel]() mutable -> KUndo2Command*
                {
                    tmpSel->invalidateOutlineCache();
                    return 0;
                }
            )),
            false,
            KisStrokeJobData::SEQUENTIAL,
            KisStrokeJobData::EXCLUSIVE
        )
    );
 
    image()->endStroke(strokeId);
 
    // Apply selection
    KisSelectionToolHelper helper(kisCanvas, kundo2_i18n("Select Similar Color"));
    helper.selectPixelSelection(tmpSel, selectionAction());
}

◆ createOptionWidget()

QWidget * KisToolSelectSimilar::createOptionWidget ( )

override

Definition at line 222 of file kis_tool_select_similar.cc.

{
    KisToolSelectBase::createOptionWidget();
    KisSelectionOptions *selectionWidget = selectionOptionWidget();
 
    selectionWidget->setStopGrowingAtDarkestPixelButtonVisible(true);
 
    // Create widgets
    KisSliderSpinBox *sliderThreshold = new KisSliderSpinBox;
    sliderThreshold->setPrefix(i18nc(
        "The 'threshold' spinbox prefix in similar selection tool options",
        "Threshold: "));
    sliderThreshold->setRange(1, 100);
    sliderThreshold->setSingleStep(1);
    sliderThreshold->setToolTip(
        i18n("Set the color similarity tolerance of the selection. "
             "Increasing threshold increases the range of similar colors to be selected."));
 
    KisSliderSpinBox *sliderSpread = new KisSliderSpinBox;
    sliderSpread->setRange(0, 100);
    KisSpinBoxI18nHelper::setText(sliderSpread,
                                  i18nc("The 'spread' spinbox in similar color selection tool options; {n} is the "
                                        "number value, % is the percent sign",
                                        "Spread: {n}%"));
 
    // Set the tooltips
    sliderThreshold->setToolTip(
        i18n("Set the color similarity tolerance of the selection. "
             "Increasing threshold increases the range of similar colors to be selected."));
    sliderSpread->setToolTip(
        i18n("Set the extent of the opaque portion of the selection. "
             "Decreasing spread decreases opacity of selection areas depending on color similarity."));
 
    // Construct the option widget
    KisOptionCollectionWidgetWithHeader *sectionSelectionExtent =
        new KisOptionCollectionWidgetWithHeader(
            i18nc("The 'selection extent' section label in similar selection "
                  "tool options",
                  "Selection extent"));
    sectionSelectionExtent->appendWidget("sliderThreshold", sliderThreshold);
    sectionSelectionExtent->appendWidget("sliderSpread", sliderSpread);
    selectionWidget->insertWidget(3, "sectionSelectionExtent", sectionSelectionExtent);
 
    // load setting from config
    if (m_configGroup.hasKey("threshold")) {
        m_threshold = m_configGroup.readEntry("threshold", 20);
    } else {
        m_threshold = m_configGroup.readEntry("fuzziness", 20);
    }
    sliderThreshold->setValue(m_threshold);
 
    m_opacitySpread = m_configGroup.readEntry("opacitySpread", 100);
    sliderSpread->setValue(m_opacitySpread);
 
    // Make connections
    connect(sliderThreshold,
            SIGNAL(valueChanged(int)),
            this,
            SLOT(slotSetThreshold(int)));
    connect(sliderSpread,
            SIGNAL(valueChanged(int)),
            this,
            SLOT(slotSetOpacitySpread(int)));
 
    return selectionWidget;
}

References KisOptionCollectionWidgetWithHeader::appendWidget(), connect(), KisToolSelectBase< BaseClass >::createOptionWidget(), KisOptionCollectionWidget::insertWidget(), m_configGroup, m_opacitySpread, m_threshold, KisToolSelectBase< BaseClass >::selectionOptionWidget(), KisSliderSpinBox::setRange(), KisSelectionOptions::setStopGrowingAtDarkestPixelButtonVisible(), KisSpinBoxI18nHelper::setText(), KisSliderSpinBox::setValue(), slotSetOpacitySpread(), and slotSetThreshold().

◆ deactivate

void KisToolSelectSimilar::deactivate ( )

overrideslot

Definition at line 55 of file kis_tool_select_similar.cc.

{
    m_referencePaintDevice = nullptr;
    m_referenceNodeList = nullptr;
    KisToolSelect::deactivate();
}

References KisToolSelectBase< BaseClass >::deactivate(), m_referenceNodeList, and m_referencePaintDevice.

◆ endPrimaryAction()

void KisToolSelectSimilar::endPrimaryAction ( KoPointerEvent * event )

override

Definition at line 200 of file kis_tool_select_similar.cc.

{
    if (isMovingSelection()) {
        KisToolSelectBase::endPrimaryAction(event);
        return;
    }
 
    endSelectInteraction();
}

References KisToolSelectBase< BaseClass >::endPrimaryAction(), KisToolSelectBase< BaseClass >::endSelectInteraction(), and KisToolSelectBase< BaseClass >::isMovingSelection().

◆ isPixelOnly()

bool KisToolSelectSimilar::isPixelOnly ( ) const

inlineoverrideprotectedvirtual

Reimplemented from KisToolSelectBase< BaseClass >.

Definition at line 40 of file kis_tool_select_similar.h.

40{ return true; }

◆ paint()

void KisToolSelectSimilar::paint	(	QPainter &	,
		const KoViewConverter &	)

inlineoverride

Definition at line 28 of file kis_tool_select_similar.h.

28{}

◆ resetCursorStyle()

void KisToolSelectSimilar::resetCursorStyle ( )

override

Definition at line 289 of file kis_tool_select_similar.cc.

{
    if (selectionAction() == SELECTION_ADD) {
        useCursor(KisCursor::load("tool_similar_selection_cursor_add.png", 6, 6));
    } else if (selectionAction() == SELECTION_SUBTRACT) {
        useCursor(KisCursor::load("tool_similar_selection_cursor_sub.png", 6, 6));
    } else if (selectionAction() == SELECTION_INTERSECT) {
        useCursor(KisCursor::load("tool_similar_selection_cursor_inter.png", 6, 6));
    } else if (selectionAction() == SELECTION_SYMMETRICDIFFERENCE) {
        useCursor(KisCursor::load("tool_similar_selection_cursor_symdiff.png", 6, 6));
    } else {
        KisToolSelect::resetCursorStyle();
    }
}

References KisCursor::load(), SELECTION_ADD, SELECTION_INTERSECT, SELECTION_SUBTRACT, SELECTION_SYMMETRICDIFFERENCE, and KisToolSelectBase< BaseClass >::selectionAction().

◆ slotSetOpacitySpread

void KisToolSelectSimilar::slotSetOpacitySpread ( int opacitySpread )

slot

Definition at line 216 of file kis_tool_select_similar.cc.

{
    m_opacitySpread = opacitySpread;
    m_configGroup.writeEntry("opacitySpread", opacitySpread);
}

References m_configGroup, and m_opacitySpread.

◆ slotSetThreshold

void KisToolSelectSimilar::slotSetThreshold ( int threshold )

slot

Definition at line 210 of file kis_tool_select_similar.cc.

{
    m_threshold = threshold;
    m_configGroup.writeEntry("threshold", threshold);
}

References m_configGroup, and m_threshold.

◆ usesColorLabels()

bool KisToolSelectSimilar::usesColorLabels ( ) const

inlineoverrideprotectedvirtual

Reimplemented from KisToolSelectBase< BaseClass >.

Definition at line 41 of file kis_tool_select_similar.h.

41{ return true; }

Member Data Documentation

◆ m_configGroup

KConfigGroup KisToolSelectSimilar::m_configGroup

private

Definition at line 46 of file kis_tool_select_similar.h.

◆ m_opacitySpread

int KisToolSelectSimilar::m_opacitySpread

private

Definition at line 45 of file kis_tool_select_similar.h.

◆ m_previousTime

int KisToolSelectSimilar::m_previousTime

private

Definition at line 49 of file kis_tool_select_similar.h.

◆ m_referenceNodeList

KisMergeLabeledLayersCommand::ReferenceNodeInfoListSP KisToolSelectSimilar::m_referenceNodeList

private

Definition at line 48 of file kis_tool_select_similar.h.

◆ m_referencePaintDevice

KisPaintDeviceSP KisToolSelectSimilar::m_referencePaintDevice

private

Definition at line 47 of file kis_tool_select_similar.h.

◆ m_threshold

int KisToolSelectSimilar::m_threshold

private

Definition at line 44 of file kis_tool_select_similar.h.

◆ m_widgetHelper

KisSelectionToolConfigWidgetHelper KisToolSelectBase< BaseClass >::m_widgetHelper

protected

Definition at line 535 of file kis_tool_select_base.h.

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

plugins/tools/selectiontools/kis_tool_select_similar.h
plugins/tools/selectiontools/kis_tool_select_similar.cc

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisToolSelectSimilar()

Member Function Documentation

◆ activate

◆ beginPrimaryAction()

◆ createOptionWidget()

◆ deactivate

◆ endPrimaryAction()

◆ isPixelOnly()

◆ paint()

◆ resetCursorStyle()

◆ slotSetOpacitySpread

◆ slotSetThreshold

◆ usesColorLabels()

Member Data Documentation

◆ m_configGroup

◆ m_opacitySpread

◆ m_previousTime

◆ m_referenceNodeList

◆ m_referencePaintDevice

◆ m_threshold

◆ m_widgetHelper