KisSelectionDecoration Class Reference

#include <kis_selection_decoration.h>

Inheritance diagram for KisSelectionDecoration:

Public Types
enum	Mode { Ants , Mask }

Public Slots
void	antsAttackEvent ()
void	selectionChanged ()
Public Slots inherited from KisCanvasDecoration
void	toggleVisibility ()

Public Member Functions
	KisSelectionDecoration (QPointer< KisView > view)
Mode	mode () const
void	notifyWindowMinimized (bool minimized) override
void	setCanvasWidget (KisCanvasWidgetBase *canvas) override
void	setMode (Mode mode)
void	setVisible (bool v) override
void	toggleSlectionVisibility ()
	~KisSelectionDecoration () override
Public Member Functions inherited from KisCanvasDecoration
const QString &	id () const
	KisCanvasDecoration (const QString &id, QPointer< KisView >parent)
void	paint (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas)
int	priority () const
void	setView (QPointer< KisView > imageView)
bool	visible () const
	~KisCanvasDecoration () override
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Protected Member Functions
void	drawDecoration (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas) override
Protected Member Functions inherited from KisCanvasDecoration
int	decorationThickness () const
void	setPriority (int value)
QPointer< KisView >	view () const
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Private Slots
void	initializePens ()
void	slotCanvasResourcesChanged (int key, const QVariant &v)
void	slotConfigChanged ()
void	slotStartUpdateSelection ()

Private Member Functions
bool	selectionIsActive ()

Private Attributes
bool	m_antialiasSelectionOutline
QPen	m_antsPen
QTimer *	m_antsTimer
QColor	m_maskColor
Mode	m_mode
int	m_offset
qreal	m_opacity
QPainterPath	m_outlinePath
QPen	m_outlinePen
KisSelectionActionsPanel *	m_selectionActionsPanel
bool	m_selectionVisibility
KisSignalCompressor	m_signalCompressor
QImage	m_thumbnailImage
QTransform	m_thumbnailImageTransform

Additional Inherited Members
Static Public Member Functions inherited from KisCanvasDecoration
static bool	comparePriority (KisCanvasDecorationSP decoration1, KisCanvasDecorationSP decoration2)

Detailed Description

Definition at line 23 of file kis_selection_decoration.h.

Member Enumeration Documentation

Mode

enum KisSelectionDecoration::Mode

Enumerator
Ants
Mask

Definition at line 30 of file kis_selection_decoration.h.

              {
        Ants,
        Mask
    };

Constructor & Destructor Documentation

KisSelectionDecoration()

KisSelectionDecoration::KisSelectionDecoration

(

QPointer< KisView >

view

)

Definition at line 47 of file kis_selection_decoration.cc.

    : KisCanvasDecoration("selection", _view),
      m_signalCompressor(50 /*ms*/, KisSignalCompressor::FIRST_ACTIVE),
      m_offset(0),
      m_mode(Ants)
{
    initializePens();
    connect(this->view()->canvasBase()->resourceManager(), SIGNAL(canvasResourceChanged(int, const QVariant&)), this, SLOT(slotCanvasResourcesChanged(int, const QVariant&)));
 
    connect(KisConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(slotConfigChanged()));
    connect(KisImageConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(slotConfigChanged()));
 
    m_antsTimer = new QTimer(this);
    m_antsTimer->setInterval(150);
    m_antsTimer->setSingleShot(false);
    connect(m_antsTimer, SIGNAL(timeout()), SLOT(antsAttackEvent()));
 
    connect(&m_signalCompressor, SIGNAL(timeout()), SLOT(slotStartUpdateSelection()));
 
    // selections should be at the top of the stack
    setPriority(100);
 
    m_selectionActionsPanel = new KisSelectionActionsPanel(this->view()->viewManager());
 
    slotConfigChanged();
}

References antsAttackEvent(), initializePens(), KisConfigNotifier::instance(), KisImageConfigNotifier::instance(), m_antsTimer, m_selectionActionsPanel, m_signalCompressor, KisCanvasDecoration::setPriority(), slotCanvasResourcesChanged(), slotConfigChanged(), slotStartUpdateSelection(), and KisCanvasDecoration::view().

~KisSelectionDecoration()

KisSelectionDecoration::~KisSelectionDecoration ( )

override

Definition at line 74 of file kis_selection_decoration.cc.

{
}

Member Function Documentation

antsAttackEvent

void KisSelectionDecoration::antsAttackEvent ( )

slot

Definition at line 190 of file kis_selection_decoration.cc.

{
    KisSelectionSP selection = view()->selection();
    if (!selection) return;
 
    if (selectionIsActive()) {
        m_offset = (m_offset + 1) % (ANT_ADVANCE_WIDTH);
        m_antsPen.setDashOffset(m_offset);
        view()->canvasBase()->updateCanvas();
    }
}

References ANT_ADVANCE_WIDTH, m_antsPen, m_offset, selectionIsActive(), and KisCanvasDecoration::view().

drawDecoration()

void KisSelectionDecoration::drawDecoration ( QPainter & gc, const QRectF & updateRect, const KisCoordinatesConverter * converter, KisCanvas2 * canvas )

overrideprotectedvirtual

Implements KisCanvasDecoration.

Definition at line 206 of file kis_selection_decoration.cc.

{
    Q_UNUSED(updateRect);
    Q_UNUSED(canvas);
 
    // render Selection Action Bar first, so that it doesn't blink when making a new selection
 
    if ((m_mode == Ants && m_outlinePath.isEmpty()) || (m_mode == Mask && m_thumbnailImage.isNull())
        || !m_selectionVisibility) {
        //The SAP needs to be drawn on top of the decoration, but to avoid the panel flashing when making a new selection, we also need to call draw here
        m_selectionActionsPanel->draw(gc, canvas->displayRendererInterface());
 
        return;
    }
 
    if (!m_selectionVisibility) {
        return;
    }
 
    QTransform transform = converter->imageToWidgetTransform();
 
    gc.save();
    gc.setTransform(transform, false);
 
    if (m_mode == Mask) {
        gc.setRenderHints(QPainter::SmoothPixmapTransform |
                          QPainter::Antialiasing, false);
 
        gc.setTransform(m_thumbnailImageTransform, true);
        gc.drawImage(QPoint(), m_thumbnailImage);
 
        QRect r1 = m_thumbnailImageTransform.inverted().mapRect(view()->image()->bounds());
        QRect r2 = m_thumbnailImage.rect();
 
        QPainterPath p1;
        p1.addRect(r1);
 
        QPainterPath p2;
        p2.addRect(r2);
 
        KoColor c;
        c.fromQColor(m_maskColor);
        gc.setBrush(canvas->displayColorConverter()->convertColorToDisplayColorSpace(c));
        gc.setPen(Qt::NoPen);
        gc.drawPath(p1 - p2);
 
    } else /* if (m_mode == Ants) */ {
 
        KoColor c;
        c.fromQColor(Qt::white);
        m_outlinePen.setColor(canvas->displayColorConverter()->convertColorToDisplayColorSpace(c));
        c.fromQColor(Qt::black);
        m_antsPen.setColor(canvas->displayColorConverter()->convertColorToDisplayColorSpace(c));
 
        gc.setRenderHints(QPainter::Antialiasing | QPainter::Antialiasing, m_antialiasSelectionOutline);
 
        gc.setOpacity(m_opacity);
 
        // render selection outline in white
        gc.setPen(m_outlinePen);
        gc.drawPath(m_outlinePath);
 
        // render marching ants in black (above the white outline)
        gc.setPen(m_antsPen);
        gc.drawPath(m_outlinePath);
    }
 
    gc.restore();
    m_selectionActionsPanel->draw(gc, canvas->displayRendererInterface());
}

References Ants, bounds, KisDisplayColorConverter::convertColorToDisplayColorSpace(), KisCanvas2::displayColorConverter, KisCanvas2::displayRendererInterface(), KisSelectionActionsPanel::draw(), KoColor::fromQColor(), KisCoordinatesConverter::imageToWidgetTransform(), m_antialiasSelectionOutline, m_antsPen, m_maskColor, m_mode, m_opacity, m_outlinePath, m_outlinePen, m_selectionActionsPanel, m_selectionVisibility, m_thumbnailImage, m_thumbnailImageTransform, Mask, p1, p2, r1, r2, and KisCanvasDecoration::view().

initializePens

void KisSelectionDecoration::initializePens ( )

privateslot

Definition at line 97 of file kis_selection_decoration.cc.

{
    QColor white(Qt::white);
    QColor black(Qt::black);
 
    KisPaintingTweaks::initAntsPen(&m_antsPen, &m_outlinePen,
                                   ANT_LENGTH, ANT_SPACE,
                                   black, white);
 
    m_antsPen.setWidth(decorationThickness());
    m_outlinePen.setWidth(decorationThickness());
}

References ANT_LENGTH, ANT_SPACE, KisCanvasDecoration::decorationThickness(), KisPaintingTweaks::initAntsPen(), m_antsPen, and m_outlinePen.

mode()

KisSelectionDecoration::Mode KisSelectionDecoration::mode

(

)

const

Definition at line 78 of file kis_selection_decoration.cc.

{
    return m_mode;
}

References m_mode.

notifyWindowMinimized()

void KisSelectionDecoration::notifyWindowMinimized ( bool minimized )

overridevirtual

Reimplemented from KisCanvasDecoration.

Definition at line 290 of file kis_selection_decoration.cc.

{
    if(minimized) {
        m_antsTimer->stop();
    } else {
        selectionChanged();
    }
}

References m_antsTimer, and selectionChanged().

selectionChanged

void KisSelectionDecoration::selectionChanged ( )

slot

Definition at line 110 of file kis_selection_decoration.cc.

{
    KisSelectionMaskSP mask = qobject_cast<KisSelectionMask*>(view()->currentNode().data());
    if (!mask || !mask->active() || !mask->visible(true)) {
        mask = 0;
    }
 
    if (!view()->isCurrent() ||
        view()->viewManager()->mainWindow() == KisPart::instance()->currentMainwindow()) {
 
        view()->image()->setOverlaySelectionMask(mask);
    }
 
    KisSelectionSP selection = view()->selection();
 
    if (!mask && selectionIsActive()) {
        if ((m_mode == Ants && selection->outlineCacheValid()) ||
            (m_mode == Mask && selection->thumbnailImageValid())) {
 
            m_signalCompressor.stop();
 
            if (m_mode == Ants) {
                m_outlinePath = selection->outlineCache();
                m_antsTimer->start();
            } else {
                m_thumbnailImage = selection->thumbnailImage();
                m_thumbnailImageTransform = selection->thumbnailImageTransform();
                m_antsTimer->stop();
            }
 
            if (view() && view()->canvasBase()) {
                view()->canvasBase()->updateCanvas();
            }
 
 
            m_selectionActionsPanel->setVisible(true);
        } else {
            m_signalCompressor.start();
        }
    } else {
        m_signalCompressor.stop();
        m_outlinePath = QPainterPath();
        m_thumbnailImage = QImage();
        m_thumbnailImageTransform = QTransform();
        view()->canvasBase()->updateCanvas();
        m_antsTimer->stop();
    }
 
    if (!selection && !selectionIsActive()) {
        m_selectionActionsPanel->setVisible(false);
    }
}

References KisSelectionMask::active(), Ants, KisPart::instance(), m_antsTimer, m_mode, m_outlinePath, m_selectionActionsPanel, m_signalCompressor, m_thumbnailImage, m_thumbnailImageTransform, Mask, KisSelection::outlineCache(), KisSelection::outlineCacheValid(), selectionIsActive(), KisSelectionActionsPanel::setVisible(), KisSignalCompressor::start(), KisSignalCompressor::stop(), KisSelection::thumbnailImage(), KisSelection::thumbnailImageTransform(), KisSelection::thumbnailImageValid(), KisCanvasDecoration::view(), and KisBaseNode::visible().

selectionIsActive()

bool KisSelectionDecoration::selectionIsActive ( )

private

Definition at line 89 of file kis_selection_decoration.cc.

{
    KisSelectionSP selection = view()->selection();
    return visible() && selection &&
        (selection->hasNonEmptyPixelSelection() || selection->hasNonEmptyShapeSelection()) &&
            selection->isVisible();
}

References KisSelection::hasNonEmptyPixelSelection(), KisSelection::hasNonEmptyShapeSelection(), KisSelection::isVisible, KisCanvasDecoration::view(), and KisCanvasDecoration::visible().

setCanvasWidget()

void KisSelectionDecoration::setCanvasWidget ( KisCanvasWidgetBase * canvas )

overridevirtual

Reimplemented from KisCanvasDecoration.

Definition at line 277 of file kis_selection_decoration.cc.

{
    m_selectionActionsPanel->canvasWidgetChanged(canvas);
}

References KisSelectionActionsPanel::canvasWidgetChanged(), and m_selectionActionsPanel.

setMode()

void KisSelectionDecoration::setMode

(

Mode

mode

)

Definition at line 83 of file kis_selection_decoration.cc.

{
    m_mode = mode;
    selectionChanged();
}

References m_mode, mode(), and selectionChanged().

setVisible()

void KisSelectionDecoration::setVisible ( bool v )

overridevirtual

Set if the decoration is visible or not.

Reimplemented from KisCanvasDecoration.

Definition at line 282 of file kis_selection_decoration.cc.

{
    m_selectionVisibility = v;
    KisCanvasDecoration::setVisible(v);
    selectionChanged();
    m_selectionActionsPanel->setVisible(v);
}

References m_selectionActionsPanel, m_selectionVisibility, selectionChanged(), KisCanvasDecoration::setVisible(), KisSelectionActionsPanel::setVisible(), and v.

slotCanvasResourcesChanged

void KisSelectionDecoration::slotCanvasResourcesChanged ( int key, const QVariant & v )

privateslot

Definition at line 182 of file kis_selection_decoration.cc.

{
    Q_UNUSED(v);
    if (key == KoCanvasResource::DecorationThickness) {
        initializePens();
    }
}

References KoCanvasResource::DecorationThickness, initializePens(), and v.

slotConfigChanged

void KisSelectionDecoration::slotConfigChanged ( )

privateslot

Definition at line 171 of file kis_selection_decoration.cc.

{
    KisImageConfig imageConfig(true);
    KisConfig cfg(true);
 
    m_opacity = imageConfig.selectionOutlineOpacity();
    m_maskColor = imageConfig.selectionOverlayMaskColor();
    m_antialiasSelectionOutline = cfg.antialiasSelectionOutline();
    m_selectionActionsPanel->setEnabled(cfg.selectionActionBar());
}

References KisConfig::antialiasSelectionOutline(), m_antialiasSelectionOutline, m_maskColor, m_opacity, m_selectionActionsPanel, KisConfig::selectionActionBar(), KisImageConfig::selectionOutlineOpacity(), KisImageConfig::selectionOverlayMaskColor(), and KisSelectionActionsPanel::setEnabled().

slotStartUpdateSelection

void KisSelectionDecoration::slotStartUpdateSelection ( )

privateslot

Definition at line 163 of file kis_selection_decoration.cc.

{
    KisSelectionSP selection = view()->selection();
    if (!selection) return;
 
    view()->image()->addSpontaneousJob(new KisUpdateOutlineJob(selection, m_mode == Mask, m_maskColor));
}

References m_maskColor, m_mode, Mask, and KisCanvasDecoration::view().

toggleSlectionVisibility()

void KisSelectionDecoration::toggleSlectionVisibility

(

)

Definition at line 202 of file kis_selection_decoration.cc.

                                                      {
    m_selectionVisibility = !m_selectionVisibility;
}

References m_selectionVisibility.

Member Data Documentation

m_antialiasSelectionOutline

bool KisSelectionDecoration::m_antialiasSelectionOutline

private

Definition at line 75 of file kis_selection_decoration.h.

m_antsPen

QPen KisSelectionDecoration::m_antsPen

private

Definition at line 68 of file kis_selection_decoration.h.

m_antsTimer

QTimer* KisSelectionDecoration::m_antsTimer

private

Definition at line 65 of file kis_selection_decoration.h.

m_maskColor

QColor KisSelectionDecoration::m_maskColor

private

Definition at line 74 of file kis_selection_decoration.h.

m_mode

Mode KisSelectionDecoration::m_mode

private

Definition at line 70 of file kis_selection_decoration.h.

m_offset

int KisSelectionDecoration::m_offset

private

Definition at line 66 of file kis_selection_decoration.h.

m_opacity

qreal KisSelectionDecoration::m_opacity

private

Definition at line 72 of file kis_selection_decoration.h.

m_outlinePath

QPainterPath KisSelectionDecoration::m_outlinePath

private

Definition at line 62 of file kis_selection_decoration.h.

m_outlinePen

QPen KisSelectionDecoration::m_outlinePen

private

Definition at line 69 of file kis_selection_decoration.h.

m_selectionActionsPanel

KisSelectionActionsPanel* KisSelectionDecoration::m_selectionActionsPanel

private

Definition at line 76 of file kis_selection_decoration.h.

m_selectionVisibility

bool KisSelectionDecoration::m_selectionVisibility

private

Definition at line 78 of file kis_selection_decoration.h.

m_signalCompressor

KisSignalCompressor KisSelectionDecoration::m_signalCompressor

private

Definition at line 61 of file kis_selection_decoration.h.

m_thumbnailImage

QImage KisSelectionDecoration::m_thumbnailImage

private

Definition at line 63 of file kis_selection_decoration.h.

m_thumbnailImageTransform

QTransform KisSelectionDecoration::m_thumbnailImageTransform

private

Definition at line 64 of file kis_selection_decoration.h.

---

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

• libs/ui/kis_selection_decoration.h
• libs/ui/kis_selection_decoration.cc