KisToolSelectBase< BaseClass > Class Template Reference

#include <kis_tool_select_base.h>

Inheritance diagram for KisToolSelectBase< BaseClass >:

Public Types
enum	SampleLayersMode { SampleAllLayers , SampleCurrentLayer , SampleColorLabeledLayers }

Public Member Functions
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
virtual bool	isPixelOnly () const
virtual bool	usesColorLabels () const

Protected Attributes
SelectionAction	m_selectionActionAlternate
KisSelectionToolConfigWidgetHelper	m_widgetHelper

Private Types
enum	Interaction { Interaction_None , Interaction_Select , Interaction_MoveSelection }

Private Attributes
Interaction	m_currentInteraction {Interaction_None}
Qt::KeyboardModifiers	m_currentModifiers
QPointF	m_currentPos
bool	m_didMove = false
QPointF	m_dragStartPos
KisSignalAutoConnectionsStore	m_modeConnections
KisStrokeId	m_moveStrokeId

Detailed Description

template<class BaseClass>
class KisToolSelectBase< BaseClass >

This is a basic template to create selection tools from basic path based drawing tools. The template overrides the ability to execute alternate actions correctly. The default behavior for the modifier keys is as follows:

Shift: add to selection Alt: subtract from selection Shift+Alt: intersect current selection Ctrl+Alt: symmetric difference Ctrl: replace selection

The mapping itself is done in KisSelectionModifierMapper.

Certain tools also use modifier keys to alter their behavior, e.g. forcing square proportions with the rectangle tool. The template enables the following rules for forwarding keys:

1) If the user is not selecting, then changing the modifier combination changes the selection method.

2) If the user is selecting then the modifier keys are forwarded to the specific tool, so that it can do with them whatever it wants. The selection method is not changed in this stage and it will be the same as just before the user started selecting.

3) Once the user finishes selecting, the selection method is updated to reflect the current modifier combination

4) If the user is moving the selection, then changing the modifiers

Definition at line 61 of file kis_tool_select_base.h.

Member Enumeration Documentation

Interaction

template<class BaseClass >

enum KisToolSelectBase::Interaction

private

Enumerator
Interaction_None
Interaction_Select
Interaction_MoveSelection

Definition at line 547 of file kis_tool_select_base.h.

    {
        Interaction_None,
        Interaction_Select,
        Interaction_MoveSelection
    };

SampleLayersMode

template<class BaseClass >

enum KisToolSelectBase::SampleLayersMode

Enumerator
SampleAllLayers
SampleCurrentLayer
SampleColorLabeledLayers

Definition at line 90 of file kis_tool_select_base.h.

    {
        SampleAllLayers,
        SampleCurrentLayer,
        SampleColorLabeledLayers,
    };

Constructor & Destructor Documentation

KisToolSelectBase() [1/3]

template<class BaseClass >

KisToolSelectBase< BaseClass >::KisToolSelectBase ( KoCanvasBase * canvas, const QString toolName )

inline

Definition at line 66 of file kis_tool_select_base.h.

        : BaseClass(canvas)
        , m_widgetHelper(toolName)
        , m_selectionActionAlternate(SELECTION_DEFAULT)
    {
        KisSelectionModifierMapper::instance();
    }

References KisSelectionModifierMapper::instance().

KisToolSelectBase() [2/3]

template<class BaseClass >

KisToolSelectBase< BaseClass >::KisToolSelectBase ( KoCanvasBase * canvas, const QCursor cursor, const QString toolName )

inline

Definition at line 74 of file kis_tool_select_base.h.

        : BaseClass(canvas, cursor)
        , m_widgetHelper(toolName)
        , m_selectionActionAlternate(SELECTION_DEFAULT)
    {
        KisSelectionModifierMapper::instance();
    }

References KisSelectionModifierMapper::instance().

KisToolSelectBase() [3/3]

template<class BaseClass >

KisToolSelectBase< BaseClass >::KisToolSelectBase ( KoCanvasBase * canvas, QCursor cursor, QString toolName, KoToolBase * delegateTool )

inline

Definition at line 82 of file kis_tool_select_base.h.

        : BaseClass(canvas, cursor, delegateTool)
        , m_widgetHelper(toolName)
        , m_selectionActionAlternate(SELECTION_DEFAULT)
    {
        KisSelectionModifierMapper::instance();
    }

References KisSelectionModifierMapper::instance().

Member Function Documentation

activate()

template<class BaseClass >

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

inlineoverride

Definition at line 115 of file kis_tool_select_base.h.

    {
        BaseClass::activate(shapes);
 
        m_modeConnections.addUniqueConnection(
            this->action("selection_tool_mode_replace"), SIGNAL(triggered()),
            &m_widgetHelper, SLOT(slotReplaceModeRequested()));
 
        m_modeConnections.addUniqueConnection(
            this->action("selection_tool_mode_add"), SIGNAL(triggered()),
            &m_widgetHelper, SLOT(slotAddModeRequested()));
 
        m_modeConnections.addUniqueConnection(
            this->action("selection_tool_mode_subtract"), SIGNAL(triggered()),
            &m_widgetHelper, SLOT(slotSubtractModeRequested()));
 
        m_modeConnections.addUniqueConnection(
            this->action("selection_tool_mode_intersect"), SIGNAL(triggered()),
            &m_widgetHelper, SLOT(slotIntersectModeRequested()));
 
        updateActionShortcutToolTips();
 
        if (m_widgetHelper.optionWidget()) {
            if (isPixelOnly()) {
                m_widgetHelper.optionWidget()->setModeSectionVisible(false);
                m_widgetHelper.optionWidget()->setAdjustmentsSectionVisible(
                    true);
            }
            m_widgetHelper.optionWidget()->setReferenceSectionVisible(
                usesColorLabels());
        }
    }

References KisSignalAutoConnectionsStore::addUniqueConnection(), KisToolSelectBase< BaseClass >::isPixelOnly(), KisToolSelectBase< BaseClass >::m_modeConnections, KisToolSelectBase< BaseClass >::m_widgetHelper, KisSelectionToolConfigWidgetHelper::optionWidget(), KisSelectionOptions::setAdjustmentsSectionVisible(), KisSelectionOptions::setModeSectionVisible(), KisSelectionOptions::setReferenceSectionVisible(), KisToolSelectBase< BaseClass >::updateActionShortcutToolTips(), and KisToolSelectBase< BaseClass >::usesColorLabels().

activateAlternateAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::activateAlternateAction ( KisTool::AlternateAction action )

inlineoverride

Definition at line 248 of file kis_tool_select_base.h.

    {
        Q_UNUSED(action);
        BaseClass::activatePrimaryAction();
    }

alternateSelectionAction()

template<class BaseClass >

SelectionAction KisToolSelectBase< BaseClass >::alternateSelectionAction ( ) const

inline

Definition at line 233 of file kis_tool_select_base.h.

    {
        return m_selectionActionAlternate;
    }

References KisToolSelectBase< BaseClass >::m_selectionActionAlternate.

antiAliasSelection()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::antiAliasSelection ( ) const

inline

Definition at line 193 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.antiAliasSelection();
    }

References KisSelectionToolConfigWidgetHelper::antiAliasSelection(), and KisToolSelectBase< BaseClass >::m_widgetHelper.

beginAlternateAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::beginAlternateAction ( KoPointerEvent * event, KisTool::AlternateAction action )

inlineoverride

Definition at line 260 of file kis_tool_select_base.h.

    {
        Q_UNUSED(action);
        beginPrimaryAction(event);
    }

References KisToolSelectBase< BaseClass >::beginPrimaryAction().

beginMoveSelectionInteraction()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::beginMoveSelectionInteraction ( )

inline

Definition at line 475 of file kis_tool_select_base.h.

                                         {
        if (m_currentInteraction != Interaction_None) {
            return false;
        }
        m_currentInteraction = Interaction_MoveSelection;
        return true;
    }

References KisToolSelectBase< BaseClass >::Interaction_MoveSelection, KisToolSelectBase< BaseClass >::Interaction_None, and KisToolSelectBase< BaseClass >::m_currentInteraction.

beginPrimaryAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::beginPrimaryAction ( KoPointerEvent * event )

inlineoverride

Definition at line 396 of file kis_tool_select_base.h.

    {
        if (isSelecting()) {
            BaseClass::beginPrimaryAction(event);
            return;
        }
        if (isMovingSelection()) {
            return;
        }
 
        const QPointF pos = this->convertToPixelCoord(event->point);
        KisCanvas2* canvas = dynamic_cast<KisCanvas2*>(this->canvas());
        KIS_SAFE_ASSERT_RECOVER_RETURN(canvas);
 
        KisNodeSP selectionMask = locateSelectionMaskUnderCursor(pos, event->modifiers());
        if (selectionMask) {
            if (this->beginMoveSelectionInteraction()) {
                KisStrokeStrategy *strategy = new MoveStrokeStrategy({selectionMask}, this->image().data(), this->image().data());
                m_moveStrokeId = this->image()->startStroke(strategy);
                m_dragStartPos = pos;
                m_didMove = true;
                return;
            }
        }
 
        m_didMove = false;
        BaseClass::beginPrimaryAction(event);
    }

References KisToolSelectBase< BaseClass >::beginMoveSelectionInteraction(), KisSharedPtr< T >::data(), KisToolSelectBase< BaseClass >::isMovingSelection(), KisToolSelectBase< BaseClass >::isSelecting(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisToolSelectBase< BaseClass >::locateSelectionMaskUnderCursor(), KisToolSelectBase< BaseClass >::m_didMove, KisToolSelectBase< BaseClass >::m_dragStartPos, KisToolSelectBase< BaseClass >::m_moveStrokeId, KoPointerEvent::modifiers(), and KoPointerEvent::point.

beginSelectInteraction()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::beginSelectInteraction ( )

inline

Definition at line 492 of file kis_tool_select_base.h.

                                  {
        if (m_currentInteraction != Interaction_None) {
            return false;
        }
        m_currentInteraction = Interaction_Select;
        return true;
    }

References KisToolSelectBase< BaseClass >::Interaction_None, KisToolSelectBase< BaseClass >::Interaction_Select, and KisToolSelectBase< BaseClass >::m_currentInteraction.

colorLabelsSelected()

template<class BaseClass >

QList< int > KisToolSelectBase< BaseClass >::colorLabelsSelected ( ) const

inline

Definition at line 213 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.selectedColorLabels();
    }

References KisToolSelectBase< BaseClass >::m_widgetHelper, and KisSelectionToolConfigWidgetHelper::selectedColorLabels().

continueAlternateAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::continueAlternateAction ( KoPointerEvent * event, KisTool::AlternateAction action )

inlineoverride

Definition at line 267 of file kis_tool_select_base.h.

    {
        Q_UNUSED(action);
        continuePrimaryAction(event);
    }

References KisToolSelectBase< BaseClass >::continuePrimaryAction().

continuePrimaryAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::continuePrimaryAction ( KoPointerEvent * event )

inlineoverride

Definition at line 425 of file kis_tool_select_base.h.

    {
        if (isMovingSelection()) {
            const QPointF pos = this->convertToPixelCoord(event->point);
            const QPoint offset((pos - m_dragStartPos).toPoint());
 
            this->image()->addJob(m_moveStrokeId, new MoveStrokeStrategy::Data(offset));
            return;
        }
 
        BaseClass::continuePrimaryAction(event);
    }

References KisToolSelectBase< BaseClass >::isMovingSelection(), KisToolSelectBase< BaseClass >::m_dragStartPos, KisToolSelectBase< BaseClass >::m_moveStrokeId, and KoPointerEvent::point.

createOptionWidget()

template<class BaseClass >

QWidget * KisToolSelectBase< BaseClass >::createOptionWidget ( )

inlineoverride

Definition at line 154 of file kis_tool_select_base.h.

    {
        m_widgetHelper.createOptionWidget(this->toolId());
        m_widgetHelper.setConfigGroupForExactTool(this->toolId());
 
        this->connect(this, SIGNAL(isActiveChanged(bool)), &m_widgetHelper, SLOT(slotToolActivatedChanged(bool)));
        this->connect(&m_widgetHelper,
                      SIGNAL(selectionActionChanged(SelectionAction)),
                      this,
                      SLOT(resetCursorStyle()));
 
        updateActionShortcutToolTips();
        if (m_widgetHelper.optionWidget()) {
            m_widgetHelper.optionWidget()->setContentsMargins(0, 10, 0, 10);
            if (isPixelOnly()) {
                m_widgetHelper.optionWidget()->setModeSectionVisible(false);
                m_widgetHelper.optionWidget()->setAdjustmentsSectionVisible(
                    true);
            }
            m_widgetHelper.optionWidget()->setReferenceSectionVisible(
                usesColorLabels());
        }
 
        return m_widgetHelper.optionWidget();
    }

References connect(), KisSelectionToolConfigWidgetHelper::createOptionWidget(), KisToolSelectBase< BaseClass >::isPixelOnly(), KisToolSelectBase< BaseClass >::m_widgetHelper, KisSelectionToolConfigWidgetHelper::optionWidget(), KisSelectionOptions::setAdjustmentsSectionVisible(), KisSelectionToolConfigWidgetHelper::setConfigGroupForExactTool(), KisSelectionOptions::setModeSectionVisible(), KisSelectionOptions::setReferenceSectionVisible(), KisToolSelectBase< BaseClass >::updateActionShortcutToolTips(), and KisToolSelectBase< BaseClass >::usesColorLabels().

deactivate()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::deactivate ( )

inlineoverride

Definition at line 148 of file kis_tool_select_base.h.

    {
        BaseClass::deactivate();
        m_modeConnections.clear();
    }

References KisSignalAutoConnectionsStore::clear(), and KisToolSelectBase< BaseClass >::m_modeConnections.

deactivateAlternateAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::deactivateAlternateAction ( KisTool::AlternateAction action )

inlineoverride

Definition at line 254 of file kis_tool_select_base.h.

    {
        Q_UNUSED(action);
        BaseClass::deactivatePrimaryAction();
    }

endAlternateAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::endAlternateAction ( KoPointerEvent * event, KisTool::AlternateAction action )

inlineoverride

Definition at line 274 of file kis_tool_select_base.h.

    {
        Q_UNUSED(action);
        endPrimaryAction(event);
    }

References KisToolSelectBase< BaseClass >::endPrimaryAction().

endMoveSelectionInteraction()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::endMoveSelectionInteraction ( )

inline

Definition at line 483 of file kis_tool_select_base.h.

                                       {
        if (!isMovingSelection()) {
            return false;
        }
        m_currentInteraction = Interaction_None;
        updateCursorDelayed();
        return true;
    }

References KisToolSelectBase< BaseClass >::Interaction_None, KisToolSelectBase< BaseClass >::isMovingSelection(), KisToolSelectBase< BaseClass >::m_currentInteraction, and KisToolSelectBase< BaseClass >::updateCursorDelayed().

endPrimaryAction()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::endPrimaryAction ( KoPointerEvent * event )

inlineoverride

Definition at line 438 of file kis_tool_select_base.h.

    {
        if (isMovingSelection()) {
            this->image()->endStroke(m_moveStrokeId);
            m_moveStrokeId.clear();
            this->endMoveSelectionInteraction();
            return;
        }
 
        BaseClass::endPrimaryAction(event);
    }

References KisToolSelectBase< BaseClass >::endMoveSelectionInteraction(), KisToolSelectBase< BaseClass >::isMovingSelection(), and KisToolSelectBase< BaseClass >::m_moveStrokeId.

endSelectInteraction()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::endSelectInteraction ( )

inline

Definition at line 500 of file kis_tool_select_base.h.

                                {
        if (!isSelecting()) {
            return false;
        }
        m_currentInteraction = Interaction_None;
        updateCursorDelayed();
        return true;
    }

References KisToolSelectBase< BaseClass >::Interaction_None, KisToolSelectBase< BaseClass >::isSelecting(), KisToolSelectBase< BaseClass >::m_currentInteraction, and KisToolSelectBase< BaseClass >::updateCursorDelayed().

featherSelection()

template<class BaseClass >

int KisToolSelectBase< BaseClass >::featherSelection ( ) const

inline

Definition at line 208 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.featherSelection();
    }

References KisSelectionToolConfigWidgetHelper::featherSelection(), and KisToolSelectBase< BaseClass >::m_widgetHelper.

growSelection()

template<class BaseClass >

int KisToolSelectBase< BaseClass >::growSelection ( ) const

inline

Definition at line 198 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.growSelection();
    }

References KisSelectionToolConfigWidgetHelper::growSelection(), and KisToolSelectBase< BaseClass >::m_widgetHelper.

isMovingSelection()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::isMovingSelection ( ) const

inline

Definition at line 509 of file kis_tool_select_base.h.

                                   {
        return m_currentInteraction == Interaction_MoveSelection;
    }

References KisToolSelectBase< BaseClass >::Interaction_MoveSelection, and KisToolSelectBase< BaseClass >::m_currentInteraction.

isPixelOnly()

template<class BaseClass >

virtual bool KisToolSelectBase< BaseClass >::isPixelOnly ( ) const

inlineprotectedvirtual

Reimplemented in KisToolSelectContiguous, and KisToolSelectSimilar.

Definition at line 538 of file kis_tool_select_base.h.

                                     {
        return false;
    }

isSelecting()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::isSelecting ( ) const

inline

Definition at line 513 of file kis_tool_select_base.h.

                             {
        return m_currentInteraction == Interaction_Select;
    }

References KisToolSelectBase< BaseClass >::Interaction_Select, and KisToolSelectBase< BaseClass >::m_currentInteraction.

keyPressEvent()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::keyPressEvent ( QKeyEvent * event )

inlineoverride

Definition at line 308 of file kis_tool_select_base.h.

    {
        const Qt::Key key = KisExtendedModifiersMapper::workaroundShiftAltMetaHell(event);
        // Assume all the modifiers were unpressed...
        m_currentModifiers = Qt::NoModifier;
        // ...and add those which are right now
        if (key == Qt::Key_Control || event->modifiers().testFlag(Qt::ControlModifier)) {
            m_currentModifiers.setFlag(Qt::ControlModifier);
        }
        if (key == Qt::Key_Shift || event->modifiers().testFlag(Qt::ShiftModifier)) {
            m_currentModifiers.setFlag(Qt::ShiftModifier);
        }
        if (key == Qt::Key_Alt || event->modifiers().testFlag(Qt::AltModifier)) {
            m_currentModifiers.setFlag(Qt::AltModifier);
        }
        
        // Avoid changing the selection mode and cursor if the user is interacting
        if (isSelecting()) {
            BaseClass::keyPressEvent(event);
            return;
        }
        if (isMovingSelection()) {
            return;
        }
 
        setAlternateSelectionAction(KisSelectionModifierMapper::map(m_currentModifiers));
        this->resetCursorStyle();
    }

References KisToolSelectBase< BaseClass >::isMovingSelection(), KisToolSelectBase< BaseClass >::isSelecting(), KisToolSelectBase< BaseClass >::m_currentModifiers, KisSelectionModifierMapper::map(), KisToolSelectBase< BaseClass >::setAlternateSelectionAction(), and KisExtendedModifiersMapper::workaroundShiftAltMetaHell().

keyReleaseEvent()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::keyReleaseEvent ( QKeyEvent * event )

inlineoverride

Definition at line 337 of file kis_tool_select_base.h.

    {
        const Qt::Key key = KisExtendedModifiersMapper::workaroundShiftAltMetaHell(event);
        // Assume all the modifiers were pressed...
        m_currentModifiers = Qt::ControlModifier | Qt::ShiftModifier | Qt::AltModifier;
        // ...and remove those which aren't right now
        if (key == Qt::Key_Control || !event->modifiers().testFlag(Qt::ControlModifier)) {
            m_currentModifiers.setFlag(Qt::ControlModifier, false);
        }
        if (key == Qt::Key_Shift || !event->modifiers().testFlag(Qt::ShiftModifier)) {
            m_currentModifiers.setFlag(Qt::ShiftModifier, false);
        }
        if (key == Qt::Key_Alt || !event->modifiers().testFlag(Qt::AltModifier)) {
            m_currentModifiers.setFlag(Qt::AltModifier, false);
        }
 
        // Avoid changing the selection mode and cursor if the user is interacting
        if (isSelecting()) {
            BaseClass::keyReleaseEvent(event);
            return;
        }
        if (isMovingSelection()) {
            return;
        }
 
        setAlternateSelectionAction(KisSelectionModifierMapper::map(m_currentModifiers));
        if (m_currentModifiers == Qt::NoModifier) {
            KisNodeSP selectionMask = locateSelectionMaskUnderCursor(m_currentPos, m_currentModifiers);
            if (selectionMask) {
                this->useCursor(KisCursor::moveSelectionCursor());
            } else {
                this->resetCursorStyle();
            }
        } else {
            this->resetCursorStyle();
        }
    }

References KisToolSelectBase< BaseClass >::isMovingSelection(), KisToolSelectBase< BaseClass >::isSelecting(), KisToolSelectBase< BaseClass >::locateSelectionMaskUnderCursor(), KisToolSelectBase< BaseClass >::m_currentModifiers, KisToolSelectBase< BaseClass >::m_currentPos, KisSelectionModifierMapper::map(), KisCursor::moveSelectionCursor(), KisToolSelectBase< BaseClass >::setAlternateSelectionAction(), and KisExtendedModifiersMapper::workaroundShiftAltMetaHell().

locateSelectionMaskUnderCursor()

template<class BaseClass >

KisNodeSP KisToolSelectBase< BaseClass >::locateSelectionMaskUnderCursor ( const QPointF & pos, Qt::KeyboardModifiers modifiers )

inline

Definition at line 281 of file kis_tool_select_base.h.

                                                                                                {
        if (modifiers != Qt::NoModifier) return 0;
 
        KisCanvas2* canvas = dynamic_cast<KisCanvas2*>(this->canvas());
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(canvas, 0);
 
        KisSelectionSP selection = canvas->viewManager()->selection();
        if (selection &&
            selection->outlineCacheValid()) {
 
            const qreal handleRadius = qreal(this->handleRadius()) / canvas->coordinatesConverter()->effectiveZoom();
            QPainterPath samplePath;
            samplePath.addEllipse(pos, handleRadius, handleRadius);
 
            const QPainterPath selectionPath = selection->outlineCache();
 
            if (selectionPath.intersects(samplePath) && !selectionPath.contains(samplePath)) {
                KisNodeSP parent = selection->parentNode();
                if (parent && parent->isEditable()) {
                    return parent;
                }
            }
        }
 
        return 0;
    }

References KisCanvas2::coordinatesConverter, KisCoordinatesConverter::effectiveZoom(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisSelection::outlineCache(), KisSelection::outlineCacheValid(), KisSelection::parentNode, KisViewManager::selection(), and KisCanvas2::viewManager().

mouseMoveEvent()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::mouseMoveEvent ( KoPointerEvent * event )

inlineoverride

Definition at line 375 of file kis_tool_select_base.h.

    {
        m_currentPos = this->convertToPixelCoord(event->point);
 
        if (isSelecting()) {
            BaseClass::mouseMoveEvent(event);
            return;
        }
        if (isMovingSelection()) {
            return;
        }
 
        KisNodeSP selectionMask = locateSelectionMaskUnderCursor(m_currentPos, event->modifiers());
        if (selectionMask) {
            this->useCursor(KisCursor::moveSelectionCursor());
        } else {
            setAlternateSelectionAction(KisSelectionModifierMapper::map(m_currentModifiers));
            this->resetCursorStyle();
        }
    }

References KisToolSelectBase< BaseClass >::isMovingSelection(), KisToolSelectBase< BaseClass >::isSelecting(), KisToolSelectBase< BaseClass >::locateSelectionMaskUnderCursor(), KisToolSelectBase< BaseClass >::m_currentModifiers, KisToolSelectBase< BaseClass >::m_currentPos, KisSelectionModifierMapper::map(), KoPointerEvent::modifiers(), KisCursor::moveSelectionCursor(), KoPointerEvent::point, and KisToolSelectBase< BaseClass >::setAlternateSelectionAction().

popupActionsMenu()

template<class BaseClass >

QMenu * KisToolSelectBase< BaseClass >::popupActionsMenu ( )

inlineoverride

Definition at line 455 of file kis_tool_select_base.h.

    {
        if (isSelecting()) {
            return BaseClass::popupActionsMenu();
        }
 
        KisCanvas2 * kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(kisCanvas, 0);
 
        return KisSelectionToolHelper::getSelectionContextMenu(kisCanvas);
    }

References KisSelectionToolHelper::getSelectionContextMenu(), KisToolSelectBase< BaseClass >::isSelecting(), and KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

popupWidget()

template<class BaseClass >

KisPopupWidgetInterface * KisToolSelectBase< BaseClass >::popupWidget ( )

inlineoverride

Definition at line 467 of file kis_tool_select_base.h.

    {
        if (isSelecting()) {
            return BaseClass::popupWidget();
        }
        return nullptr;
    }

References KisToolSelectBase< BaseClass >::isSelecting().

sampleLayersMode()

template<class BaseClass >

SampleLayersMode KisToolSelectBase< BaseClass >::sampleLayersMode ( ) const

inline

Definition at line 218 of file kis_tool_select_base.h.

    {
        KisSelectionOptions::ReferenceLayers referenceLayers =
            m_widgetHelper.referenceLayers();
        if (referenceLayers == KisSelectionOptions::AllLayers) {
            return SampleAllLayers;
        } else if (referenceLayers == KisSelectionOptions::CurrentLayer) {
            return SampleCurrentLayer;
        } else if (referenceLayers == KisSelectionOptions::ColorLabeledLayers) {
            return SampleColorLabeledLayers;
        }
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(true, SampleAllLayers);
        return SampleAllLayers;
    }

References KisSelectionOptions::AllLayers, KisSelectionOptions::ColorLabeledLayers, KisSelectionOptions::CurrentLayer, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, KisToolSelectBase< BaseClass >::m_widgetHelper, KisSelectionToolConfigWidgetHelper::referenceLayers(), KisToolSelectBase< BaseClass >::SampleAllLayers, KisToolSelectBase< BaseClass >::SampleColorLabeledLayers, and KisToolSelectBase< BaseClass >::SampleCurrentLayer.

selectionAction()

template<class BaseClass >

SelectionAction KisToolSelectBase< BaseClass >::selectionAction ( ) const

inline

Definition at line 185 of file kis_tool_select_base.h.

    {
        if (alternateSelectionAction() == SELECTION_DEFAULT) {
            return m_widgetHelper.selectionAction();
        }
        return alternateSelectionAction();
    }

References KisToolSelectBase< BaseClass >::alternateSelectionAction(), KisToolSelectBase< BaseClass >::m_widgetHelper, SELECTION_DEFAULT, and KisSelectionToolConfigWidgetHelper::selectionAction().

selectionDidMove()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::selectionDidMove ( ) const

inline

Definition at line 450 of file kis_tool_select_base.h.

    {
        return m_didMove;
    }

References KisToolSelectBase< BaseClass >::m_didMove.

selectionMode()

template<class BaseClass >

SelectionMode KisToolSelectBase< BaseClass >::selectionMode ( ) const

inline

Definition at line 180 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.selectionMode();
    }

References KisToolSelectBase< BaseClass >::m_widgetHelper, and KisSelectionToolConfigWidgetHelper::selectionMode().

selectionOptionWidget()

template<class BaseClass >

KisSelectionOptions * KisToolSelectBase< BaseClass >::selectionOptionWidget ( )

inline

Definition at line 238 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.optionWidget();
    }

References KisToolSelectBase< BaseClass >::m_widgetHelper, and KisSelectionToolConfigWidgetHelper::optionWidget().

setAlternateSelectionAction()

template<class BaseClass >

virtual void KisToolSelectBase< BaseClass >::setAlternateSelectionAction ( SelectionAction action )

inlinevirtual

Definition at line 243 of file kis_tool_select_base.h.

    {
        m_selectionActionAlternate = action;
    }

References KisToolSelectBase< BaseClass >::m_selectionActionAlternate.

stopGrowingAtDarkestPixel()

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::stopGrowingAtDarkestPixel ( ) const

inline

Definition at line 203 of file kis_tool_select_base.h.

    {
        return m_widgetHelper.stopGrowingAtDarkestPixel();
    }

References KisToolSelectBase< BaseClass >::m_widgetHelper, and KisSelectionToolConfigWidgetHelper::stopGrowingAtDarkestPixel().

updateActionShortcutToolTips()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::updateActionShortcutToolTips ( )

inline

Definition at line 97 of file kis_tool_select_base.h.

                                        {
        KisSelectionOptions *widget = m_widgetHelper.optionWidget();
        if (widget) {
            widget->updateActionButtonToolTip(
                SELECTION_REPLACE,
                this->action("selection_tool_mode_replace")->shortcut());
            widget->updateActionButtonToolTip(
                SELECTION_ADD,
                this->action("selection_tool_mode_add")->shortcut());
            widget->updateActionButtonToolTip(
                SELECTION_SUBTRACT,
                this->action("selection_tool_mode_subtract")->shortcut());
            widget->updateActionButtonToolTip(
                SELECTION_INTERSECT,
                this->action("selection_tool_mode_intersect")->shortcut());
        }
    }

References KisToolSelectBase< BaseClass >::m_widgetHelper, KisSelectionToolConfigWidgetHelper::optionWidget(), SELECTION_ADD, SELECTION_INTERSECT, SELECTION_REPLACE, SELECTION_SUBTRACT, and KisSelectionOptions::updateActionButtonToolTip().

updateCursorDelayed()

template<class BaseClass >

void KisToolSelectBase< BaseClass >::updateCursorDelayed ( )

inline

Definition at line 517 of file kis_tool_select_base.h.

                               {
        setAlternateSelectionAction(KisSelectionModifierMapper::map(m_currentModifiers));
        QTimer::singleShot(100, Qt::CoarseTimer,
            this,
            [this]()
            {
                KisNodeSP selectionMask = locateSelectionMaskUnderCursor(m_currentPos, m_currentModifiers);
                if (selectionMask) {
                    this->useCursor(KisCursor::moveSelectionCursor());
                } else {
                    this->resetCursorStyle();
                }
            }
        );
    }

References KisToolSelectBase< BaseClass >::locateSelectionMaskUnderCursor(), KisToolSelectBase< BaseClass >::m_currentModifiers, KisToolSelectBase< BaseClass >::m_currentPos, KisSelectionModifierMapper::map(), KisCursor::moveSelectionCursor(), and KisToolSelectBase< BaseClass >::setAlternateSelectionAction().

usesColorLabels()

template<class BaseClass >

virtual bool KisToolSelectBase< BaseClass >::usesColorLabels ( ) const

inlineprotectedvirtual

Reimplemented in KisToolSelectContiguous, and KisToolSelectSimilar.

Definition at line 542 of file kis_tool_select_base.h.

                                         {
        return false;
    }

Member Data Documentation

m_currentInteraction

template<class BaseClass >

Interaction KisToolSelectBase< BaseClass >::m_currentInteraction {Interaction_None}

private

Definition at line 554 of file kis_tool_select_base.h.

{Interaction_None};

m_currentModifiers

template<class BaseClass >

Qt::KeyboardModifiers KisToolSelectBase< BaseClass >::m_currentModifiers

private

Definition at line 556 of file kis_tool_select_base.h.

m_currentPos

template<class BaseClass >

QPointF KisToolSelectBase< BaseClass >::m_currentPos

private

Definition at line 559 of file kis_tool_select_base.h.

m_didMove

template<class BaseClass >

bool KisToolSelectBase< BaseClass >::m_didMove = false

private

Definition at line 561 of file kis_tool_select_base.h.

m_dragStartPos

template<class BaseClass >

QPointF KisToolSelectBase< BaseClass >::m_dragStartPos

private

Definition at line 558 of file kis_tool_select_base.h.

m_modeConnections

template<class BaseClass >

KisSignalAutoConnectionsStore KisToolSelectBase< BaseClass >::m_modeConnections

private

Definition at line 563 of file kis_tool_select_base.h.

m_moveStrokeId

template<class BaseClass >

KisStrokeId KisToolSelectBase< BaseClass >::m_moveStrokeId

private

Definition at line 560 of file kis_tool_select_base.h.

m_selectionActionAlternate

template<class BaseClass >

SelectionAction KisToolSelectBase< BaseClass >::m_selectionActionAlternate

protected

Definition at line 536 of file kis_tool_select_base.h.

m_widgetHelper

template<class BaseClass >

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 file:

• libs/ui/tool/kis_tool_select_base.h