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	slotCanvasZoomPreviewUpdated (const QImage &canvasImage, QRect canvasRect)
void	slotColorSamplingFinished (const KoColor &rawColor)
void	slotUpdateBgColor ()

Private Member Functions
void	activatePreview ()
void	paintCircle (QPainter &gc, const QRectF &viewRectF, const QColor &currentColor, const QColor &baseColor)
void	paintCircleCanvasPreview (QPainter &gc, const QRectF &viewRectF, const QPainterPath &clip)
void	paintCircleCrosshair (QPainter &gc, const QRectF &viewRectF, const QColor &currentColor)
void	paintCircleReferenceImagePreview (QPainter &gc, const QRectF &viewRectF, const QPainterPath &clip)
void	paintRectangle (QPainter &gc, const QRectF &viewRectF, const QColor &currentColor, const QColor &baseColor)
void	prepareZoomPreview (const QRectF &docRect)

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Definition at line 24 of file KisAsyncColorSamplerHelper.h.

Constructor & Destructor Documentation

KisAsyncColorSamplerHelper()

KisAsyncColorSamplerHelper::KisAsyncColorSamplerHelper

(

KisCanvas2 *

canvas

)

Definition at line 278 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()));
    connect(m_d->canvas->displayColorConverter(), SIGNAL(displayConfigurationChanged()), this, SLOT(slotUpdateBgColor()));
    slotUpdateBgColor();
}

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

~KisAsyncColorSamplerHelper()

KisAsyncColorSamplerHelper::~KisAsyncColorSamplerHelper ( )

override

Definition at line 294 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 304 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->haveSample = false;
 
 
    KisConfig cfg(true);
    m_d->style = cfg.colorSamplerPreviewStyle();
 
    m_d->circlePreviewDiameter = cfg.colorSamplerPreviewCircleDiameter();
    m_d->circlePreviewThickness = cfg.colorSamplerPreviewCircleThickness()/100.0; // saved in percentages
    m_d->circlePreviewOutlineEnabled = cfg.colorSamplerPreviewCircleOutlineEnabled();
    m_d->circlePreviewExtraCircles = cfg.colorSamplerPreviewCircleExtraCirclesEnabled();
    m_d->circleZoomPreviewEnabled = cfg.colorSamplerZoomPreviewEnabled();
    m_d->circleZoomPreviewScale = cfg.colorSamplerZoomPreviewScale();
    m_d->circlePreviewPosition = cfg.colorSamplerPreviewCirclePosition();
 
    m_d->activationDelayTimer.start();
}

References KoCanvasResource::BackgroundColor, KisConfig::colorSamplerPreviewCircleDiameter(), KisConfig::colorSamplerPreviewCircleExtraCirclesEnabled(), KisConfig::colorSamplerPreviewCircleOutlineEnabled(), KisConfig::colorSamplerPreviewCirclePosition(), KisConfig::colorSamplerPreviewCircleThickness(), KisConfig::colorSamplerPreviewStyle(), KisConfig::colorSamplerZoomPreviewEnabled(), KisConfig::colorSamplerZoomPreviewScale(), KoCanvasResource::ForegroundColor, KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

activateDelayedPreview

void KisAsyncColorSamplerHelper::activateDelayedPreview ( )

privateslot

Definition at line 333 of file KisAsyncColorSamplerHelper.cpp.

{
    // the event may come after we have started or even
    // finished color picking if the user is quick
    if (!m_d->isActive || m_d->showPreview) {
        return;
    }
 
    activatePreview();
 
    Q_EMIT sigRequestUpdateOutline();
}

References activatePreview(), m_d, and sigRequestUpdateOutline().

activatePreview()

void KisAsyncColorSamplerHelper::activatePreview ( )

private

Definition at line 346 of file KisAsyncColorSamplerHelper.cpp.

{
    m_d->activationDelayTimer.stop();
    m_d->showPreview = true;
 
    const KoColor currentColor =
        m_d->canvas->resourceManager()->koColorResource(m_d->sampleResourceId);
    const QColor previewColor = m_d->canvas->displayColorConverter()->convertColorToDisplayColorSpace(currentColor, true);
 
    m_d->currentColor = previewColor;
    m_d->baseColor = previewColor;
    m_d->cache = QPixmap();
 
    updateCursor(m_d->sampleCurrentLayer, m_d->sampleResourceId == KoCanvasResource::ForegroundColor);
}

References KoCanvasResource::ForegroundColor, m_d, and updateCursor().

colorPreviewDocRect()

QRectF KisAsyncColorSamplerHelper::colorPreviewDocRect

(

const QPointF &

docPoint

)

Definition at line 459 of file KisAsyncColorSamplerHelper.cpp.

{
    if (!m_d->showPreview) return QRectF();
 
    m_d->sampleDocPoint = docPoint;
 
    KisConfig cfg(true);
    m_d->style = cfg.colorSamplerPreviewStyle();
    QRectF previewDocRect = m_d->colorPreviewDocRect(docPoint);
 
    if (previewDocRect != m_d->previewDocRect) prepareZoomPreview(previewDocRect);
 
    m_d->previewDocRect = previewDocRect;
 
    return m_d->previewDocRect;
}

References KisConfig::colorSamplerPreviewStyle(), m_d, and prepareZoomPreview().

continueAction()

void KisAsyncColorSamplerHelper::continueAction

(

const QPointF &

docPoint

)

Definition at line 442 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 398 of file KisAsyncColorSamplerHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER(!m_d->strokeId) {
        endAction();
    }
 
    m_d->activationDelayTimer.stop();
 
    m_d->showPreview = false;
    m_d->haveSample = false;
 
    m_d->previewDocRect = QRectF();
    m_d->currentColor = QColor();
    m_d->baseColor = QColor();
    m_d->cache = QPixmap();
 
    // Reset the cached zoom preview image and rect
    m_d->cacheCanvasPreviewImage = QImage();
    m_d->cacheCanvasPreviewRect = QRect();
    m_d->zoomPreviewHasPainted = false;
    m_d->zoomDocRectF = 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 448 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 299 of file KisAsyncColorSamplerHelper.cpp.

{
    return m_d->isActive;
}

References m_d.

paint()

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

Definition at line 517 of file KisAsyncColorSamplerHelper.cpp.

{
    if (!m_d->showPreview) {
        return;
    }
 
    QRectF viewRectF = converter.documentToView(m_d->previewDocRect);
    QColor currentColor = colorWithAlpha(m_d->currentColor, OPACITY_OPAQUE_U8);
    QColor baseColor = m_d->haveSample ? colorWithAlpha(m_d->baseColor, OPACITY_OPAQUE_U8) : currentColor;
 
    switch (m_d->style) {
    case KisConfig::ColorSamplerPreviewStyle::RectangleLeft:
    case KisConfig::ColorSamplerPreviewStyle::RectangleRight:
    case KisConfig::ColorSamplerPreviewStyle::RectangleAbove:
        paintRectangle(gc, viewRectF, currentColor, baseColor);
        break;
    default:
        // See comment in colorPreviewDocRect.
        if (m_d->haveSample) {
            paintCircle(gc, viewRectF, currentColor, baseColor);
        } else {
            paintRectangle(gc, viewRectF, currentColor, baseColor);
        }
        break;
    }
}

References KoViewConverter::documentToView(), m_d, OPACITY_OPAQUE_U8, paintCircle(), paintRectangle(), KisConfig::RectangleAbove, KisConfig::RectangleLeft, and KisConfig::RectangleRight.

paintCircle()

void KisAsyncColorSamplerHelper::paintCircle ( QPainter & gc, const QRectF & viewRectF, const QColor & currentColor, const QColor & baseColor )

private

Definition at line 594 of file KisAsyncColorSamplerHelper.cpp.

{
    if (!m_d->haveSample) {
        return;
    }
 
    gc.save();
 
    qreal dpr = gc.device()->devicePixelRatioF();
    QSizeF cacheSizeF = viewRectF.size() * dpr;
    QSize cacheSize(qCeil(cacheSizeF.width()), qCeil(cacheSizeF.height()));
    bool needsNewCache = m_d->cache.isNull() || m_d->cache.size() != cacheSize;
    if (needsNewCache) {
        m_d->cache = QPixmap(cacheSize);
        m_d->cache.fill(Qt::transparent);
    }
 
    qreal canvasRotationAngle = m_d->canvas->rotationAngle();
    if (m_d->canvas->xAxisMirrored()) {
        canvasRotationAngle = -canvasRotationAngle;
    }
 
    QPainter cachePainter(&m_d->cache);
    cachePainter.setRenderHint(QPainter::Antialiasing);
 
    QRectF cacheRect = m_d->cache.rect();
 
    // The color sampler preview is an outline and those rotate along
    // with the canvas. That's undesirable for the sampler preview
    // though, so we calculate the transformation to counter the rotation here
    QPointF cacheCenter = cacheRect.center();
    QTransform tf;
    tf.translate(cacheCenter.x(), cacheCenter.y());
    tf.rotate(-canvasRotationAngle);
    tf.translate(-cacheCenter.x(), -cacheCenter.y());
 
    bool needsDualColor = currentColor != baseColor;
    if (needsNewCache || (needsDualColor && !qFuzzyCompare(m_d->cacheRotation, canvasRotationAngle))) {
        m_d->cacheRotation = canvasRotationAngle;
 
        QColor backgroundColor = colorWithAlpha(m_d->backgroundColor, OPACITY_OPAQUE_U8 / 2 + 1);
        qreal penWidth = m_d->circlePreviewDiameter > 100 ? (2.0 * dpr) : (1.0 * dpr);
        QPen pen = QPen(backgroundColor, penWidth);
        if (m_d->circlePreviewOutlineEnabled) {
            cachePainter.setPen(pen);
        } else {
            cachePainter.setPen(Qt::NoPen);
        }
 
        QRectF outerRect = cacheRect.marginsRemoved(QMarginsF(penWidth, penWidth, penWidth, penWidth));
 
        if (needsDualColor) {
            // The color sampler preview is an outline and those rotate along
            // with the canvas. That's undesirable for the sampler preview
            // though, so we un-rotate its contents here accordingly.
 
            QPainterPath clipPath;
            clipPath.addPolygon(tf.map(QPolygonF(QRectF(0, 0, cacheRect.width(), cacheRect.height() / 2.0 + 1.0))));
            cachePainter.setClipPath(clipPath);
 
            bool flipped = m_d->canvas->yAxisMirrored();
            cachePainter.setBrush(flipped ? baseColor : currentColor);
            cachePainter.drawEllipse(outerRect);
 
            cachePainter.setBrush(baseColor);
            clipPath.clear();
            clipPath.addPolygon(
                tf.map(QRectF(0, cacheRect.height() / 2.0, cacheRect.width(), cacheRect.height() / 2.0)));
            cachePainter.setClipPath(clipPath);
 
            cachePainter.setBrush(flipped ? currentColor : baseColor);
            cachePainter.drawEllipse(outerRect);
 
            cachePainter.setClipPath(QPainterPath(), Qt::NoClip);
        } else {
            cachePainter.setBrush(currentColor);
            cachePainter.drawEllipse(outerRect);
        }
 
        qreal innerX = cacheRect.width() * (1.0 - m_d->circlePreviewThickness);
        qreal innerY = cacheRect.height() * (1.0 - m_d->circlePreviewThickness);
        QRectF innerRect = cacheRect.marginsRemoved(QMarginsF(innerX, innerY, innerX, innerY));
        QPainterPath innerEllipse;
        innerEllipse.addEllipse(innerRect);
 
        QPainterPath innerPath;
        innerPath.addPath(innerEllipse);
 
        if (m_d->circlePreviewThickness < 0.5 && m_d->circlePreviewExtraCircles) {
            qreal extraMargin = 0.1*m_d->circlePreviewThickness*innerRect.width(); // looks better
            QPointF leftCenter = QPointF(innerRect.left() - extraMargin, innerRect.top() + innerRect.height()/2.0);
            QPointF rightCenter = QPointF(innerRect.right() + extraMargin, innerRect.top() + innerRect.height()/2.0);
 
            innerPath.setFillRule(Qt::OddEvenFill);
            innerPath.addEllipse(leftCenter, m_d->circlePreviewThickness*cacheRect.width(), m_d->circlePreviewThickness*cacheRect.width());
            innerPath.addEllipse(rightCenter, m_d->circlePreviewThickness*cacheRect.width(), m_d->circlePreviewThickness*cacheRect.width());
 
            innerPath = innerPath.intersected(innerEllipse);
        }
 
        m_d->cacheCircleInnerClip = innerPath;
 
        // Draw inner circle outline if enabled
        if (m_d->circlePreviewOutlineEnabled) {
            cachePainter.setBrush(Qt::transparent);
            cachePainter.setPen(pen);
            cachePainter.setCompositionMode(QPainter::CompositionMode_SourceOver);
            cachePainter.drawPath(tf.map(m_d->cacheCircleInnerClip));
        }
    }
 
    cachePainter.setPen(Qt::NoPen);
    cachePainter.setBrush(m_d->backgroundColor);
 
    // Clear the center
    cachePainter.setCompositionMode(QPainter::CompositionMode_Clear);
    cachePainter.drawPath(tf.map(m_d->cacheCircleInnerClip));
 
    // If canvas preview image is null and it's being fetched (which means canvas preview is needed),
    // don't paint preview until it's done to avoid flickering
    bool shouldPaintPreview = !(m_d->cacheCanvasPreviewImage.isNull() && m_d->canvasPreviewFetchCookie);
 
    // But if zoom preview has already been painted, keeps painting to avoid flickering
    if (m_d->circleZoomPreviewEnabled && (shouldPaintPreview || m_d->zoomPreviewHasPainted)) {
        paintCircleCanvasPreview(cachePainter, cacheRect, tf.map(m_d->cacheCircleInnerClip));
        paintCircleReferenceImagePreview(cachePainter, cacheRect, tf.map(m_d->cacheCircleInnerClip));
 
        // Draw crosshair if preview is offseted
        if (m_d->circlePreviewPosition != KisConfig::ColorSamplerPreviewCirclePosition::Center) {
            paintCircleCrosshair(cachePainter, cacheRect, currentColor);
        }
 
        // Fill empty spaces to hide the underlying canvas
        cachePainter.setCompositionMode(QPainter::CompositionMode_DestinationOver);
        cachePainter.drawPath(tf.map(m_d->cacheCircleInnerClip));
 
        m_d->zoomPreviewHasPainted = true;
    }
 
    gc.drawPixmap(viewRectF.toRect(), m_d->cache);
 
    gc.restore();
}

References KisConfig::Center, m_d, OPACITY_OPAQUE_U8, paintCircleCanvasPreview(), paintCircleCrosshair(), paintCircleReferenceImagePreview(), and qFuzzyCompare().

paintCircleCanvasPreview()

void KisAsyncColorSamplerHelper::paintCircleCanvasPreview ( QPainter & gc, const QRectF & viewRectF, const QPainterPath & clip )

private

Definition at line 761 of file KisAsyncColorSamplerHelper.cpp.

                                                                                                                         {
    QRect canvasPixelRect = m_d->cacheCanvasPreviewRect;
    QImage cachedImage = m_d->cacheCanvasPreviewImage;
 
    if (cachedImage.isNull()) return;
 
    gc.save();
    gc.setCompositionMode(QPainter::CompositionMode_SourceOver);
 
    gc.setClipPath(clip);
 
    // QtDoc: The image is scaled to fit the rectangle, if both the image and rectangle size disagree.
    // Since the piece of canvas is (zoomPreviewScale) times smaller than cacheRect
    // drawImage will scale it up that many times, thus achieving the zoom effect
    gc.drawImage(viewRectF, cachedImage, canvasPixelRect);
 
    gc.restore();
}

References m_d.

paintCircleCrosshair()

void KisAsyncColorSamplerHelper::paintCircleCrosshair ( QPainter & gc, const QRectF & viewRectF, const QColor & currentColor )

private

Definition at line 741 of file KisAsyncColorSamplerHelper.cpp.

{
    QColor crosshairColor = Qt::black;
    qreal luminance = KisPaintingTweaks::luminosityCoarse(currentColor);
    if (luminance < 0.5) crosshairColor = Qt::white;
 
    gc.save();
 
    gc.setRenderHints(QPainter::Antialiasing | QPainter::SmoothPixmapTransform);
    gc.setCompositionMode(QPainter::CompositionMode_SourceOver);
    gc.setPen(crosshairColor);
 
    QTransform tf;
    tf.translate(viewRectF.center().x(), viewRectF.center().y());
    tf.rotate(-m_d->cacheRotation);
    gc.drawPath(tf.map(m_d->crosshairForOffsettedCircle()));
 
    gc.restore();
}

References KisPaintingTweaks::luminosityCoarse(), and m_d.

paintCircleReferenceImagePreview()

void KisAsyncColorSamplerHelper::paintCircleReferenceImagePreview ( QPainter & gc, const QRectF & viewRectF, const QPainterPath & clip )

private

Definition at line 782 of file KisAsyncColorSamplerHelper.cpp.

                                                                                                                                 {
    KisDocument *document = m_d->canvas->viewManager()->document();
    if (!document || !document->referenceImagesLayer()) return;
 
    gc.save();
 
    gc.setCompositionMode(QPainter::CompositionMode_SourceOver);
    gc.setClipPath(clip);
 
    QRectF zoomDocRectF = m_d->zoomDocRectF;
 
    QList<KoShape*> shapeList = document->referenceImagesLayer()->shapeManager()->shapesAt(zoomDocRectF);
    if (shapeList.size() > 1) std::sort(shapeList.begin(), shapeList.end(), KoShape::compareShapeZIndex);
 
    Q_FOREACH(KoShape *shape, shapeList) {
        KisReferenceImage *refImage = dynamic_cast<KisReferenceImage*>(shape);
        if (!refImage) continue;
 
        if (refImage->transparency() == 1.0) continue;
 
        gc.save();
 
        QImage image = refImage->getCachedImage();
 
        QPoint refPixelPoint = refImage->documentToPixelFloored(zoomDocRectF.center());
 
        // Avoid using KisReferenceImage::documentToPixel because it use absoluteTransformation.invert()
        // Which will take rotation into account and cause some quirks when ref image is rotated
        qreal xScale = refImage->size().width() / image.width();
        qreal yScale = refImage->size().height() / image.height();
 
        // This only happens when refImage size is 0, so painting it probably won't make senses
        if (xScale == 0 || yScale == 0) continue;
 
        QRect refPixelRect = QRect(refPixelPoint, QSize(zoomDocRectF.width() / xScale, zoomDocRectF.height() / yScale));
 
        refPixelRect = m_d->standardizeZoomPreviewPixelRect(refPixelRect);
 
        refPixelRect.moveCenter(refPixelPoint);
 
        // Rotate the painter, draw, rotate back is seemingly easier than
        // trying to rotate the image and the shenanighens that follow
        gc.translate(viewRectF.center());
        gc.rotate(refImage->rotation());
        gc.translate(-viewRectF.center());
 
        gc.drawImage(viewRectF, image, refPixelRect);
 
        gc.restore();
    }
 
    gc.restore();
}

References Private::canvas, KoShape::compareShapeZIndex(), KisViewManager::document(), KisReferenceImage::documentToPixelFloored(), KisReferenceImage::getCachedImage(), m_d, KoShape::rotation(), KoShape::size(), KoShape::transparency(), and KisCanvas2::viewManager().

paintRectangle()

void KisAsyncColorSamplerHelper::paintRectangle ( QPainter & gc, const QRectF & viewRectF, const QColor & currentColor, const QColor & baseColor )

private

Definition at line 544 of file KisAsyncColorSamplerHelper.cpp.

{
    qreal dpr = gc.device()->devicePixelRatioF();
    QSizeF cacheSizeF = viewRectF.size() * dpr;
    QSize cacheSize(qCeil(cacheSizeF.width()), qCeil(cacheSizeF.height()));
    bool needsNewCache = m_d->cache.isNull() || m_d->cache.size() != cacheSize;
    if (needsNewCache) {
        m_d->cache = QPixmap(cacheSize);
        m_d->cache.fill(Qt::transparent);
    }
 
    qreal canvasRotationAngle = m_d->canvas->rotationAngle();
    bool canvasMirror = m_d->canvas->xAxisMirrored();
    if (needsNewCache || !qFuzzyCompare(canvasRotationAngle, m_d->cacheRotation) || canvasMirror != m_d->cacheMirror) {
        m_d->cacheRotation = canvasRotationAngle;
        m_d->cacheMirror = canvasMirror;
 
        QPainter cachePainter(&m_d->cache);
        cachePainter.setRenderHint(QPainter::Antialiasing);
 
        qreal size = Private::PREVIEW_RECT_SIZE * dpr;
        QRectF rect(0.0, 0.0, m_d->haveSample ? size * 2.0 : size, size);
        rect.moveTopLeft(-rect.center());
 
        QTransform tf;
        QPointF offset = QRectF(m_d->cache.rect()).center();
        tf.translate(offset.x(), offset.y());
        tf.rotate(canvasMirror ? canvasRotationAngle : -canvasRotationAngle);
        cachePainter.setTransform(tf);
 
        if (m_d->haveSample) {
            qreal centerX = rect.center().x();
            QRectF currentRect(rect.topLeft(), QPointF(centerX + 1.0, rect.bottom()));
            QRectF baseRect(QPointF(centerX, rect.top()), rect.bottomRight());
            if (m_d->canvas->xAxisMirrored()) {
                std::swap(currentRect, baseRect);
            }
            cachePainter.fillRect(currentRect, currentColor);
            cachePainter.fillRect(baseRect, baseColor);
        } else {
            cachePainter.fillRect(rect, currentColor);
        }
    }
 
    gc.drawPixmap(viewRectF.toRect(), m_d->cache);
}

References m_d, KisAsyncColorSamplerHelper::Private::PREVIEW_RECT_SIZE, and qFuzzyCompare().

prepareZoomPreview()

void KisAsyncColorSamplerHelper::prepareZoomPreview ( const QRectF & docRect )

private

Definition at line 476 of file KisAsyncColorSamplerHelper.cpp.

                                                                         {
    // This can be called before startAction(), so there may not be a strokeId
    if (!m_d->circleZoomPreviewEnabled || !m_d->strokeId) return;
 
    KisImageSP image = m_d->canvas->image();
    if (!image) return;
 
    // Prepare zoomed doc rect
    QRectF zoomDocRectF = docRect;
 
    zoomDocRectF.setSize(zoomDocRectF.size() / m_d->circleZoomPreviewScale);
    zoomDocRectF.moveCenter(m_d->sampleDocPoint);
 
    m_d->zoomDocRectF = zoomDocRectF;
 
    // Prepare canvas preview because it takes time
    QRectF canvasPixelRectF = image->documentToPixel(zoomDocRectF);
    // Floor manually to avoid width != height when using toRect()
    QRect canvasPixelRect = QRect(canvasPixelRectF.topLeft().toPoint(), QSize(qFloor(canvasPixelRectF.width()), qFloor(canvasPixelRectF.height())));
 
    canvasPixelRect = m_d->standardizeZoomPreviewPixelRect(canvasPixelRect);
    // Make sure the center is the pixel currently sampled because standardizing may change the shape
    canvasPixelRect.moveCenter(image->documentToImagePixelFloored(zoomDocRectF.center()));
 
    if (!image->bounds().intersects(canvasPixelRect) && !image->wrapAroundModeActive()) {
        m_d->cacheCanvasPreviewRect = QRect();
        m_d->cacheCanvasPreviewImage = QImage();
        return;
    }
 
    // If not already have a job fetching canvas image, then do it
    if (!m_d->canvasPreviewFetchCookie && m_d->cacheCanvasPreviewRect != canvasPixelRect) {
        KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData *data =
            new KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData(image->projection(), canvasPixelRect, m_d->canvas->displayColorConverter());
 
        m_d->canvasPreviewFetchCookie = data->cookie();
 
        m_d->strokesFacade()->addJob(m_d->strokeId, data);
    }
}

References KisImage::bounds(), Private::canvas, KisColorSamplerStrokeStrategy::GenerateCanvasZoomPreviewData::cookie(), KisImage::documentToImagePixelFloored(), KisImage::documentToPixel(), KisCanvas2::image(), m_d, KisImage::projection(), and KisImage::wrapAroundModeActive().

setUpdateGlobalColor()

void KisAsyncColorSamplerHelper::setUpdateGlobalColor

(

bool

value

)

Definition at line 388 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 843 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()) {
            KoColor color = referencesLayer->getPixelForDocPoint(docPoint);
            if (color.opacityU8() > 0) {
                slotColorSamplingFinished(color);
                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::documentToImagePixelFloored(), KisCanvas2::image(), koIcon, m_d, KoColor::opacityU8(), KisImage::projection(), and slotColorSamplingFinished().

slotCanvasZoomPreviewUpdated

void KisAsyncColorSamplerHelper::slotCanvasZoomPreviewUpdated ( const QImage & canvasImage, QRect canvasRect )

privateslot

Definition at line 836 of file KisAsyncColorSamplerHelper.cpp.

                                                                                                         {
    m_d->cacheCanvasPreviewRect = canvasRect;
    m_d->cacheCanvasPreviewImage = canvasImage;
 
    Q_EMIT sigRequestUpdateOutline();
}

References m_d, and sigRequestUpdateOutline().

slotColorSamplingFinished

void KisAsyncColorSamplerHelper::slotColorSamplingFinished ( const KoColor & rawColor )

privateslot

Definition at line 882 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()->convertColorToDisplayColorSpace(color, true);
 
    if (!m_d->haveSample || m_d->currentColor != previewColor) {
        m_d->haveSample = true;
        m_d->currentColor = previewColor;
        m_d->cache = QPixmap();
    }
 
    Q_EMIT sigRequestUpdateOutline();
}

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

slotUpdateBgColor

void KisAsyncColorSamplerHelper::slotUpdateBgColor ( )

privateslot

Definition at line 908 of file KisAsyncColorSamplerHelper.cpp.

{
    KoColor bgColor;
    bgColor.fromQColor(qApp->palette().color(QPalette::Base));
    m_d->backgroundColor = m_d->canvas->displayColorConverter()->convertColorToDisplayColorSpace(bgColor);
}

References KoColor::fromQColor(), and m_d.

startAction()

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

Definition at line 426 of file KisAsyncColorSamplerHelper.cpp.

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

References activatePreview(), m_d, KisColorSamplerStrokeStrategy::sigCanvasZoomPreviewUpdated(), KisColorSamplerStrokeStrategy::sigColorUpdated(), sigFinalColorSelected(), KisColorSamplerStrokeStrategy::sigFinalColorSelected(), slotCanvasZoomPreviewUpdated(), and slotColorSamplingFinished().

updateCursor()

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

Definition at line 362 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 393 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 92 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