KisAsyncColorSamplerHelper Class Reference

#include <KisAsyncColorSamplerHelper.h>

Inheritance diagram for KisAsyncColorSamplerHelper:

Classes
struct	Private

Signals
void	sigColorSelected (const KoColor &color)
void	sigFinalColorSelected (const KoColor &color)
void	sigRawColorSelected (const KoColor &color)
void	sigRequestCursor (const QCursor &cursor)
void	sigRequestCursorReset ()
void	sigRequestUpdateOutline ()

Public Member Functions
void	activate (bool sampleCurrentLayer, bool pickFgColor)
QRectF	colorPreviewDocRect (const QPointF &docPoint)
void	continueAction (const QPointF &docPoint)
void	deactivate ()
void	endAction ()
bool	isActive () const
	KisAsyncColorSamplerHelper (KisCanvas2 *canvas)
void	paint (QPainter &gc, const KoViewConverter &converter)
void	setUpdateGlobalColor (bool value)
void	startAction (const QPointF &docPoint, int radius, int blend)
void	updateCursor (bool sampleCurrentLayer, bool pickFgColor)
bool	updateGlobalColor () const
	~KisAsyncColorSamplerHelper () override

Private Slots
void	activateDelayedPreview ()
void	slotAddSamplingJob (const QPointF &docPoint)
void	slotColorSamplingFinished (const KoColor &rawColor)

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Definition at line 23 of file KisAsyncColorSamplerHelper.h.

Constructor & Destructor Documentation

KisAsyncColorSamplerHelper()

KisAsyncColorSamplerHelper::KisAsyncColorSamplerHelper

(

KisCanvas2 *

canvas

)

Definition at line 86 of file KisAsyncColorSamplerHelper.cpp.

    : m_d(new Private(canvas))
{
    using namespace std::placeholders; // For _1 placeholder
    std::function<void(QPointF)> callback =
        std::bind(&KisAsyncColorSamplerHelper::slotAddSamplingJob, this, _1);
    m_d->samplingCompressor.reset(
        new Private::SamplingCompressor(100, callback, KisSignalCompressor::FIRST_ACTIVE));
 
    m_d->activationDelayTimer.setInterval(100);
    m_d->activationDelayTimer.setSingleShot(true);
    connect(&m_d->activationDelayTimer, SIGNAL(timeout()), this, SLOT(activateDelayedPreview()));
}

References activateDelayedPreview(), connect(), KisSignalCompressor::FIRST_ACTIVE, m_d, slotAddSamplingJob(), and void().

~KisAsyncColorSamplerHelper()

KisAsyncColorSamplerHelper::~KisAsyncColorSamplerHelper ( )

override

Definition at line 100 of file KisAsyncColorSamplerHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(!m_d->strokeId);
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, and m_d.

Member Function Documentation

activate()

void KisAsyncColorSamplerHelper::activate	(	bool	sampleCurrentLayer,
		bool	pickFgColor )

Definition at line 110 of file KisAsyncColorSamplerHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(!m_d->isActive);
    m_d->isActive = true;
 
    m_d->sampleResourceId =
        pickFgColor ?
            KoCanvasResource::ForegroundColor :
            KoCanvasResource::BackgroundColor;
 
    m_d->sampleCurrentLayer = sampleCurrentLayer;
    m_d->showComparePlate = false;
 
    m_d->activationDelayTimer.start();
}

References KoCanvasResource::BackgroundColor, KoCanvasResource::ForegroundColor, KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

activateDelayedPreview

void KisAsyncColorSamplerHelper::activateDelayedPreview ( )

privateslot

Definition at line 126 of file KisAsyncColorSamplerHelper.cpp.

{
    // the event may come after we have finished color
    // picking if the user is quick
    if (!m_d->isActive) return;
 
    m_d->showPreview = true;
 
    const KoColor currentColor =
        m_d->canvas->resourceManager()->koColorResource(m_d->sampleResourceId);
    const QColor previewColor = m_d->canvas->displayColorConverter()->toQColor(currentColor);
 
    m_d->currentColor = previewColor;
    m_d->baseColor = previewColor;
 
    updateCursor(m_d->sampleCurrentLayer, m_d->sampleResourceId == KoCanvasResource::ForegroundColor);
 
    Q_EMIT sigRequestUpdateOutline();
}

References KoCanvasResource::ForegroundColor, m_d, sigRequestUpdateOutline(), KoColor::toQColor(), and updateCursor().

colorPreviewDocRect()

QRectF KisAsyncColorSamplerHelper::colorPreviewDocRect

(

const QPointF &

docPoint

)

Definition at line 233 of file KisAsyncColorSamplerHelper.cpp.

{
    if (!m_d->showPreview) return QRectF();
 
    std::tie(m_d->currentColorDocRect, m_d->baseColorDocRect) =
            colorPreviewDocRectImpl(docPoint, m_d->showComparePlate, &m_d->converter());
 
    return m_d->currentColorDocRect | m_d->baseColorDocRect;
}

References m_d.

continueAction()

void KisAsyncColorSamplerHelper::continueAction

(

const QPointF &

docPoint

)

Definition at line 216 of file KisAsyncColorSamplerHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_d->strokeId);
    m_d->samplingCompressor->start(docPoint);
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

deactivate()

void KisAsyncColorSamplerHelper::deactivate

(

)

Definition at line 182 of file KisAsyncColorSamplerHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER(!m_d->strokeId) {
        endAction();
    }
 
    m_d->activationDelayTimer.stop();
 
    m_d->showPreview = false;
    m_d->showComparePlate = false;
 
    m_d->currentColorDocRect = QRectF();
    m_d->currentColor = QColor();
    m_d->baseColor = QColor();
    m_d->baseColorDocRect = QRectF();
 
    m_d->isActive = false;
 
    Q_EMIT sigRequestCursorReset();
    Q_EMIT sigRequestUpdateOutline();
}

References endAction(), KIS_SAFE_ASSERT_RECOVER, m_d, sigRequestCursorReset(), and sigRequestUpdateOutline().

endAction()

void KisAsyncColorSamplerHelper::endAction

(

)

Definition at line 222 of file KisAsyncColorSamplerHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_d->strokeId);
 
    m_d->strokesFacade()->addJob(m_d->strokeId,
        new KisColorSamplerStrokeStrategy::FinalizeData());
 
    m_d->strokesFacade()->endStroke(m_d->strokeId);
    m_d->strokeId.clear();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

isActive()

bool KisAsyncColorSamplerHelper::isActive

(

)

const

Definition at line 105 of file KisAsyncColorSamplerHelper.cpp.

{
    return m_d->isActive;
}

References m_d.

paint()

void KisAsyncColorSamplerHelper::paint	(	QPainter &	gc,
		const KoViewConverter &	converter )

Definition at line 243 of file KisAsyncColorSamplerHelper.cpp.

{
    if (!m_d->showPreview) return;
 
    const QRectF viewRect = converter.documentToView(m_d->currentColorDocRect);
    gc.fillRect(viewRect, m_d->currentColor);
 
    if (m_d->showComparePlate) {
        const QRectF baseColorRect = converter.documentToView(m_d->baseColorDocRect);
        gc.fillRect(baseColorRect, m_d->baseColor);
    }
}

References KoViewConverter::documentToView(), and m_d.

setUpdateGlobalColor()

void KisAsyncColorSamplerHelper::setUpdateGlobalColor

(

bool

value

)

Definition at line 172 of file KisAsyncColorSamplerHelper.cpp.

{
    m_d->updateGlobalColor = value;
}

References m_d, and value().

sigColorSelected

void KisAsyncColorSamplerHelper::sigColorSelected ( const KoColor & color )

signal

Notifies about the "palette" color picked from the layer, that is, with the alpha channel set to OPACITY_OPAQUE.

sigFinalColorSelected

void KisAsyncColorSamplerHelper::sigFinalColorSelected ( const KoColor & color )

signal

Notifies about the "palette" color picked from the layer, that is, with the alpha channel set to OPACITY_OPAQUE.

This notification is emitted only once at the very end of the color picking stroke.

sigRawColorSelected

void KisAsyncColorSamplerHelper::sigRawColorSelected ( const KoColor & color )

signal

Notifies about the raw color picked from the layer, including its alpha channel.

sigRequestCursor

void KisAsyncColorSamplerHelper::sigRequestCursor ( const QCursor & cursor )

signal

sigRequestCursorReset

void KisAsyncColorSamplerHelper::sigRequestCursorReset ( )

signal

sigRequestUpdateOutline

void KisAsyncColorSamplerHelper::sigRequestUpdateOutline ( )

signal

slotAddSamplingJob

void KisAsyncColorSamplerHelper::slotAddSamplingJob ( const QPointF & docPoint )

privateslot

The actual sampling is delayed by a compressor, so we can get this event when the stroke is already closed

Definition at line 256 of file KisAsyncColorSamplerHelper.cpp.

{
    if (!m_d->strokeId) return;
 
    KisImageSP image = m_d->canvas->image();
 
    const QPoint imagePoint = image->documentToImagePixelFloored(docPoint);
 
    if (!m_d->sampleCurrentLayer) {
        KisSharedPtr<KisReferenceImagesLayer> referencesLayer = m_d->canvas->imageView()->document()->referenceImagesLayer();
        if (referencesLayer && m_d->canvas->referenceImagesDecoration()->visible()) {
            QColor color = referencesLayer->getPixel(imagePoint);
            if (color.isValid() && color.alpha() != 0) {
                slotColorSamplingFinished(KoColor(color, image->colorSpace()));
                return;
            }
        }
    }
 
    KisPaintDeviceSP device = m_d->sampleCurrentLayer ?
        m_d->canvas->imageView()->currentNode()->colorSampleSourceDevice() :
        image->projection();
 
    if (device) {
        // Used for color sampler blending.
        const KoColor currentColor =
            m_d->canvas->resourceManager()->koColorResource(m_d->sampleResourceId);
 
        m_d->strokesFacade()->addJob(m_d->strokeId,
            new KisColorSamplerStrokeStrategy::Data(device, imagePoint, currentColor));
    } else {
        QString message = i18n("Color sampler does not work on this layer.");
        m_d->canvas->viewManager()->showFloatingMessage(message, koIcon("object-locked"));
    }
}

References Private::canvas, KisImage::colorSpace(), KisImage::documentToImagePixelFloored(), KisCanvas2::image(), koIcon, m_d, KisImage::projection(), and slotColorSamplingFinished().

slotColorSamplingFinished

void KisAsyncColorSamplerHelper::slotColorSamplingFinished ( const KoColor & rawColor )

privateslot

Definition at line 296 of file KisAsyncColorSamplerHelper.cpp.

{
    KoColor color(rawColor);
 
    color.setOpacity(OPACITY_OPAQUE_U8);
 
    if (m_d->updateGlobalColor) {
        m_d->canvas->resourceManager()->setResource(m_d->sampleResourceId, color);
    }
 
    Q_EMIT sigRawColorSelected(rawColor);
    Q_EMIT sigColorSelected(color);
 
    if (!m_d->showPreview) return;
 
    const QColor previewColor = m_d->canvas->displayColorConverter()->toQColor(color);
 
    m_d->showComparePlate = true;
    m_d->currentColor = previewColor;
 
    Q_EMIT sigRequestUpdateOutline();
}

References m_d, OPACITY_OPAQUE_U8, KoColor::setOpacity(), sigColorSelected(), sigRawColorSelected(), and sigRequestUpdateOutline().

startAction()

void KisAsyncColorSamplerHelper::startAction	(	const QPointF &	docPoint,
		int	radius,
		int	blend )

Definition at line 204 of file KisAsyncColorSamplerHelper.cpp.

{
    KisColorSamplerStrokeStrategy *strategy = new KisColorSamplerStrokeStrategy(radius, blend);
    connect(strategy, &KisColorSamplerStrokeStrategy::sigColorUpdated,
            this, &KisAsyncColorSamplerHelper::slotColorSamplingFinished);
    connect(strategy, &KisColorSamplerStrokeStrategy::sigFinalColorSelected,
            this, &KisAsyncColorSamplerHelper::sigFinalColorSelected);
 
    m_d->strokeId = m_d->strokesFacade()->startStroke(strategy);
    m_d->samplingCompressor->start(docPoint);
}

References connect(), m_d, KisColorSamplerStrokeStrategy::sigColorUpdated(), sigFinalColorSelected(), KisColorSamplerStrokeStrategy::sigFinalColorSelected(), and slotColorSamplingFinished().

updateCursor()

void KisAsyncColorSamplerHelper::updateCursor	(	bool	sampleCurrentLayer,
		bool	pickFgColor )

Definition at line 146 of file KisAsyncColorSamplerHelper.cpp.

{
    const int sampleResourceId =
            pickFgColor ?
                KoCanvasResource::ForegroundColor :
                KoCanvasResource::BackgroundColor;
 
    QCursor cursor;
 
    if (sampleCurrentLayer) {
        if (sampleResourceId == KoCanvasResource::ForegroundColor) {
            cursor = KisCursor::samplerLayerForegroundCursor();
        } else {
            cursor = KisCursor::samplerLayerBackgroundCursor();
        }
    } else {
        if (sampleResourceId == KoCanvasResource::ForegroundColor) {
            cursor = KisCursor::samplerImageForegroundCursor();
        } else {
            cursor = KisCursor::samplerImageBackgroundCursor();
        }
    }
 
    Q_EMIT sigRequestCursor(cursor);
}

References KoCanvasResource::BackgroundColor, KoCanvasResource::ForegroundColor, KisCursor::samplerImageBackgroundCursor(), KisCursor::samplerImageForegroundCursor(), KisCursor::samplerLayerBackgroundCursor(), KisCursor::samplerLayerForegroundCursor(), and sigRequestCursor().

updateGlobalColor()

bool KisAsyncColorSamplerHelper::updateGlobalColor

(

)

const

Definition at line 177 of file KisAsyncColorSamplerHelper.cpp.

{
    return m_d->updateGlobalColor;
}

References m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisAsyncColorSamplerHelper::m_d

private

Definition at line 79 of file KisAsyncColorSamplerHelper.h.

---

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

• libs/ui/tool/KisAsyncColorSamplerHelper.h
• libs/ui/tool/KisAsyncColorSamplerHelper.cpp