#include <KisColorSmudgeStrategyBase.h>

Inheritance diagram for KisColorSmudgeStrategyBase:

Classes
struct	DabColoringStrategy

struct	DabColoringStrategyMask

struct	DabColoringStrategyStamp

Public Member Functions
void	blendBrush (const QVector< KisPainter * > dstPainters, KisColorSmudgeSourceSP srcSampleDevice, KisFixedPaintDeviceSP maskDab, bool preserveMaskDab, const QRect &srcRect, const QRect &dstRect, const KoColor &currentPaintColor, qreal opacity, qreal smudgeRateValue, qreal maxPossibleSmudgeRateValue, qreal colorRateValue, qreal smudgeRadiusValue)

void	blendInBackgroundWithDulling (KisFixedPaintDeviceSP dst, KisColorSmudgeSourceSP src, const QRect &dstRect, const KoColor &preparedDullingColor, const qreal smudgeRateOpacity)

void	blendInBackgroundWithSmearing (KisFixedPaintDeviceSP dst, KisColorSmudgeSourceSP src, const QRect &srcRect, const QRect &dstRect, const qreal smudgeRateOpacity)

virtual DabColoringStrategy &	coloringStrategy ()=0

virtual qreal	colorRateOpacity (qreal opacity, qreal smudgeRateValue, qreal colorRateValue, qreal maxPossibleSmudgeRateValue)

virtual qreal	dullingRateOpacity (qreal opacity, qreal smudgeRateValue)

virtual QString	finalCompositeOp (bool smearAlpha) const

virtual qreal	finalPainterOpacity (qreal opacity, qreal smudgeRateValue)

void	initializePaintingImpl (const KoColorSpace *dstColorSpace, bool smearAlpha, const QString &colorRateCompositeOpId)

	KisColorSmudgeStrategyBase (bool useDullingMode)

const KoColorSpace *	preciseColorSpace () const override

virtual void	sampleDullingColor (const QRect &srcRect, qreal sampleRadiusValue, KisColorSmudgeSourceSP sourceDevice, KisFixedPaintDeviceSP tempFixedDevice, KisFixedPaintDeviceSP maskDab, KoColor *resultColor)

virtual QString	smearCompositeOp (bool smearAlpha) const

virtual qreal	smearRateOpacity (qreal opacity, qreal smudgeRateValue)

Public Member Functions inherited from KisColorSmudgeStrategy
virtual void	initializePainting ()=0

	KisColorSmudgeStrategy ()

virtual QVector< QRect >	paintDab (const QRect &srcRect, const QRect &dstRect, const KoColor &currentPaintColor, qreal opacity, qreal colorRateValue, qreal smudgeRateValue, qreal maxPossibleSmudgeRateValue, qreal lightnessStrengthValue, qreal smudgeRadiusValue)=0

virtual void	updateMask (KisDabCache dabCache, const KisPaintInformation &info, const KisDabShape &shape, const QPointF &cursorPoint, QRect dstDabRect, qreal lightnessStrength)=0

virtual	~KisColorSmudgeStrategy ()=default

Protected Attributes
const KoCompositeOp *	m_colorRateOp {nullptr}

KoColor	m_preparedDullingColor

const KoCompositeOp *	m_smearOp {nullptr}

Protected Attributes inherited from KisColorSmudgeStrategy
KisOptimizedByteArray::MemoryAllocatorSP	m_memoryAllocator

Private Attributes
KisFixedPaintDeviceSP	m_blendDevice

bool	m_useDullingMode {true}

Detailed Description

Definition at line 18 of file KisColorSmudgeStrategyBase.h.

Constructor & Destructor Documentation

◆ KisColorSmudgeStrategyBase()

KisColorSmudgeStrategyBase::KisColorSmudgeStrategyBase ( bool useDullingMode )

Definition at line 113 of file KisColorSmudgeStrategyBase.cpp.

        : m_useDullingMode(useDullingMode)
{
}

Member Function Documentation

◆ blendBrush()

void KisColorSmudgeStrategyBase::blendBrush	(	const QVector< KisPainter * >	dstPainters,
		KisColorSmudgeSourceSP	srcSampleDevice,
		KisFixedPaintDeviceSP	maskDab,
		bool	preserveMaskDab,
		const QRect &	srcRect,
		const QRect &	dstRect,
		const KoColor &	currentPaintColor,
		qreal	opacity,
		qreal	smudgeRateValue,
		qreal	maxPossibleSmudgeRateValue,
		qreal	colorRateValue,
		qreal	smudgeRadiusValue )

Definition at line 184 of file KisColorSmudgeStrategyBase.cpp.

{
    const qreal colorRateOpacity = this->colorRateOpacity(opacity, smudgeRateValue, colorRateValue, maxPossibleSmudgeRateValue);
 
    if (m_useDullingMode) {
        this->sampleDullingColor(srcRect,
                                 smudgeRadiusValue,
                                 srcSampleDevice, m_blendDevice,
                                 maskDab, &m_preparedDullingColor);
 
        KIS_SAFE_ASSERT_RECOVER(*m_preparedDullingColor.colorSpace() == *m_colorRateOp->colorSpace()) {
            m_preparedDullingColor.convertTo(m_colorRateOp->colorSpace());
        }
    }
 
    m_blendDevice->setRect(dstRect);
    m_blendDevice->lazyGrowBufferWithoutInitialization();
 
    DabColoringStrategy &coloringStrategy = this->coloringStrategy();
 
    const qreal dullingRateOpacity = this->dullingRateOpacity(opacity, smudgeRateValue);
 
    if (colorRateOpacity > 0 &&
        m_useDullingMode &&
        coloringStrategy.supportsFusedDullingBlending() &&
        ((m_smearOp->id() == COMPOSITE_OVER &&
          m_colorRateOp->id() == COMPOSITE_OVER) ||
         (m_smearOp->id() == COMPOSITE_COPY &&
          qFuzzyCompare(dullingRateOpacity, OPACITY_OPAQUE_F)))) {
 
        coloringStrategy.blendInFusedBackgroundAndColorRateWithDulling(m_blendDevice,
                                                                       srcSampleDevice,
                                                                       dstRect,
                                                                       m_preparedDullingColor,
                                                                       m_smearOp,
                                                                       dullingRateOpacity,
                                                                       currentPaintColor.convertedTo(
                                                                               m_preparedDullingColor.colorSpace()),
                                                                       m_colorRateOp,
                                                                       colorRateOpacity);
 
    } else {
        if (!m_useDullingMode) {
            const qreal smudgeRateOpacity = this->smearRateOpacity(opacity, smudgeRateValue);
            blendInBackgroundWithSmearing(m_blendDevice, srcSampleDevice,
                                          srcRect, dstRect, smudgeRateOpacity);
        } else {
            blendInBackgroundWithDulling(m_blendDevice, srcSampleDevice,
                                         dstRect,
                                         m_preparedDullingColor, dullingRateOpacity);
        }
 
        if (colorRateOpacity > 0) {
            coloringStrategy.blendInColorRate(
                    currentPaintColor.convertedTo(m_preparedDullingColor.colorSpace()),
                    m_colorRateOp,
                    colorRateOpacity,
                    m_blendDevice, dstRect);
        }
    }
 
    const bool preserveDab = preserveMaskDab && dstPainters.size() > 1;
 
    Q_FOREACH (KisPainter *dstPainter, dstPainters) {
        dstPainter->setOpacityF(finalPainterOpacity(opacity, smudgeRateValue));
 
        dstPainter->bltFixedWithFixedSelection(dstRect.x(), dstRect.y(),
                                               m_blendDevice, maskDab,
                                               maskDab->bounds().x(), maskDab->bounds().y(),
                                               m_blendDevice->bounds().x(), m_blendDevice->bounds().y(),
                                               dstRect.width(), dstRect.height());
        dstPainter->renderMirrorMaskSafe(dstRect, m_blendDevice, maskDab, preserveDab);
    }
 
}

References blendInBackgroundWithDulling(), blendInBackgroundWithSmearing(), KisColorSmudgeStrategyBase::DabColoringStrategy::blendInColorRate(), KisColorSmudgeStrategyBase::DabColoringStrategy::blendInFusedBackgroundAndColorRateWithDulling(), KisPainter::bltFixedWithFixedSelection(), KisFixedPaintDevice::bounds(), coloringStrategy(), colorRateOpacity(), KoColor::colorSpace(), KoCompositeOp::colorSpace, COMPOSITE_COPY, COMPOSITE_OVER, KoColor::convertedTo(), KoColor::convertTo(), dullingRateOpacity(), finalPainterOpacity(), KoCompositeOp::id, KIS_SAFE_ASSERT_RECOVER, KisFixedPaintDevice::lazyGrowBufferWithoutInitialization(), m_blendDevice, m_colorRateOp, m_preparedDullingColor, m_smearOp, m_useDullingMode, OPACITY_OPAQUE_F, KisPainter::renderMirrorMaskSafe(), sampleDullingColor(), KisPainter::setOpacityF(), KisFixedPaintDevice::setRect(), smearRateOpacity(), and KisColorSmudgeStrategyBase::DabColoringStrategy::supportsFusedDullingBlending().

◆ blendInBackgroundWithDulling()

void KisColorSmudgeStrategyBase::blendInBackgroundWithDulling	(	KisFixedPaintDeviceSP	dst,
		KisColorSmudgeSourceSP	src,
		const QRect &	dstRect,
		const KoColor &	preparedDullingColor,
		const qreal	smudgeRateOpacity )

Definition at line 286 of file KisColorSmudgeStrategyBase.cpp.

{
    Q_UNUSED(preparedDullingColor);
 
    if (m_smearOp->id() == COMPOSITE_COPY && qFuzzyCompare(smudgeRateOpacity, OPACITY_OPAQUE_F)) {
        dst->fill(dst->bounds(), m_preparedDullingColor);
    } else {
        src->readBytes(dst->data(), dstRect);
        m_smearOp->composite(dst->data(), dstRect.width() * dst->pixelSize(),
                             m_preparedDullingColor.data(), 0,
                             0, 0,
                             1, dstRect.width() * dstRect.height(),
                             smudgeRateOpacity);
    }
}

References KisFixedPaintDevice::bounds(), KoCompositeOp::composite(), COMPOSITE_COPY, KisFixedPaintDevice::data(), KoColor::data(), KisFixedPaintDevice::fill(), KoCompositeOp::id, m_preparedDullingColor, m_smearOp, OPACITY_OPAQUE_F, and KisFixedPaintDevice::pixelSize().

◆ blendInBackgroundWithSmearing()

void KisColorSmudgeStrategyBase::blendInBackgroundWithSmearing	(	KisFixedPaintDeviceSP	dst,
		KisColorSmudgeSourceSP	src,
		const QRect &	srcRect,
		const QRect &	dstRect,
		const qreal	smudgeRateOpacity )

Definition at line 264 of file KisColorSmudgeStrategyBase.cpp.

{
    if (m_smearOp->id() == COMPOSITE_COPY && qFuzzyCompare(smudgeRateOpacity, OPACITY_OPAQUE_F)) {
        src->readBytes(dst->data(), srcRect);
    } else {
        src->readBytes(dst->data(), dstRect);
 
        KisFixedPaintDevice tempDevice(src->colorSpace(), m_memoryAllocator);
        tempDevice.setRect(srcRect);
        tempDevice.lazyGrowBufferWithoutInitialization();
 
        src->readBytes(tempDevice.data(), srcRect);
        m_smearOp->composite(dst->data(), dstRect.width() * dst->pixelSize(),
                             tempDevice.data(), dstRect.width() * tempDevice.pixelSize(), // stride should be random non-zero
                             0, 0,
                             1, dstRect.width() * dstRect.height(),
                             smudgeRateOpacity);
    }
}

References KoCompositeOp::composite(), COMPOSITE_COPY, KisFixedPaintDevice::data(), KoCompositeOp::id, KisFixedPaintDevice::lazyGrowBufferWithoutInitialization(), KisColorSmudgeStrategy::m_memoryAllocator, m_smearOp, OPACITY_OPAQUE_F, KisFixedPaintDevice::pixelSize(), and KisFixedPaintDevice::setRect().

◆ coloringStrategy()

virtual DabColoringStrategy & KisColorSmudgeStrategyBase::coloringStrategy ( )

pure virtual

Implemented in KisColorSmudgeStrategyLightness, KisColorSmudgeStrategyMask, and KisColorSmudgeStrategyStamp.

◆ colorRateOpacity()

qreal KisColorSmudgeStrategyBase::colorRateOpacity	(	qreal	opacity,
		qreal	smudgeRateValue,
		qreal	colorRateValue,
		qreal	maxPossibleSmudgeRateValue )

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 154 of file KisColorSmudgeStrategyBase.cpp.

{
    Q_UNUSED(smudgeRateValue);
    Q_UNUSED(maxPossibleSmudgeRateValue);
    return colorRateValue * colorRateValue * opacity;
}

◆ dullingRateOpacity()

qreal KisColorSmudgeStrategyBase::dullingRateOpacity	(	qreal	opacity,
		qreal	smudgeRateValue )

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 162 of file KisColorSmudgeStrategyBase.cpp.

{
    return 0.8 * smudgeRateValue * opacity;
}

◆ finalCompositeOp()

QString KisColorSmudgeStrategyBase::finalCompositeOp ( bool smearAlpha ) const

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 140 of file KisColorSmudgeStrategyBase.cpp.

{
    Q_UNUSED(smearAlpha);
    return COMPOSITE_COPY;
}

References COMPOSITE_COPY.

◆ finalPainterOpacity()

qreal KisColorSmudgeStrategyBase::finalPainterOpacity	(	qreal	opacity,
		qreal	smudgeRateValue )

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 146 of file KisColorSmudgeStrategyBase.cpp.

{
    Q_UNUSED(opacity);
    Q_UNUSED(smudgeRateValue);
 
    return OPACITY_OPAQUE_F;
}

References OPACITY_OPAQUE_F.

◆ initializePaintingImpl()

void KisColorSmudgeStrategyBase::initializePaintingImpl	(	const KoColorSpace *	dstColorSpace,
		bool	smearAlpha,
		const QString &	colorRateCompositeOpId )

Definition at line 118 of file KisColorSmudgeStrategyBase.cpp.

{
    m_blendDevice = new KisFixedPaintDevice(dstColorSpace, m_memoryAllocator);
    m_smearOp = dstColorSpace->compositeOp(smearCompositeOp(smearAlpha));
    m_colorRateOp = dstColorSpace->compositeOp(colorRateCompositeOpId);
    m_preparedDullingColor.convertTo(dstColorSpace);
}

References KoColorSpace::compositeOp(), KoColor::convertTo(), m_blendDevice, m_colorRateOp, KisColorSmudgeStrategy::m_memoryAllocator, m_preparedDullingColor, m_smearOp, and smearCompositeOp().

◆ preciseColorSpace()

const KoColorSpace * KisColorSmudgeStrategyBase::preciseColorSpace ( ) const

overridevirtual

Implements KisColorSmudgeStrategy.

Definition at line 127 of file KisColorSmudgeStrategyBase.cpp.

{
    // verify that initialize() has already been called!
    KIS_ASSERT_RECOVER_RETURN_VALUE(m_smearOp, KoColorSpaceRegistry::instance()->rgb8());
 
    return m_smearOp->colorSpace();
}

References KoCompositeOp::colorSpace, KoColorSpaceRegistry::instance(), KIS_ASSERT_RECOVER_RETURN_VALUE, and m_smearOp.

◆ sampleDullingColor()

void KisColorSmudgeStrategyBase::sampleDullingColor	(	const QRect &	srcRect,
		qreal	sampleRadiusValue,
		KisColorSmudgeSourceSP	sourceDevice,
		KisFixedPaintDeviceSP	tempFixedDevice,
		KisFixedPaintDeviceSP	maskDab,
		KoColor *	resultColor )

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 172 of file KisColorSmudgeStrategyBase.cpp.

{
    using namespace KisColorSmudgeSampleUtils;
    sampleColor<WeightedSampleWrapper>(srcRect, sampleRadiusValue,
                                       sourceDevice, tempFixedDevice,
                                       maskDab, resultColor);
}

◆ smearCompositeOp()

QString KisColorSmudgeStrategyBase::smearCompositeOp ( bool smearAlpha ) const

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 135 of file KisColorSmudgeStrategyBase.cpp.

{
    return smearAlpha ? COMPOSITE_COPY : COMPOSITE_OVER;
}

References COMPOSITE_COPY, and COMPOSITE_OVER.

◆ smearRateOpacity()

qreal KisColorSmudgeStrategyBase::smearRateOpacity	(	qreal	opacity,
		qreal	smudgeRateValue )

virtual

Reimplemented in KisColorSmudgeStrategyMaskLegacy.

Definition at line 167 of file KisColorSmudgeStrategyBase.cpp.

{
    return smudgeRateValue * opacity;
}

Member Data Documentation

◆ m_blendDevice

KisFixedPaintDeviceSP KisColorSmudgeStrategyBase::m_blendDevice

private

Definition at line 122 of file KisColorSmudgeStrategyBase.h.

◆ m_colorRateOp

const KoCompositeOp* KisColorSmudgeStrategyBase::m_colorRateOp {nullptr}

protected

Definition at line 118 of file KisColorSmudgeStrategyBase.h.

118{nullptr};

◆ m_preparedDullingColor

KoColor KisColorSmudgeStrategyBase::m_preparedDullingColor

protected

Definition at line 119 of file KisColorSmudgeStrategyBase.h.

◆ m_smearOp

const KoCompositeOp* KisColorSmudgeStrategyBase::m_smearOp {nullptr}

protected

Definition at line 120 of file KisColorSmudgeStrategyBase.h.

120{nullptr};

◆ m_useDullingMode

bool KisColorSmudgeStrategyBase::m_useDullingMode {true}

private

Definition at line 123 of file KisColorSmudgeStrategyBase.h.

123{true};

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

plugins/paintops/colorsmudge/KisColorSmudgeStrategyBase.h
plugins/paintops/colorsmudge/KisColorSmudgeStrategyBase.cpp

Classes

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisColorSmudgeStrategyBase()

Member Function Documentation

◆ blendBrush()

◆ blendInBackgroundWithDulling()

◆ blendInBackgroundWithSmearing()

◆ coloringStrategy()

◆ colorRateOpacity()

◆ dullingRateOpacity()

◆ finalCompositeOp()

◆ finalPainterOpacity()

◆ initializePaintingImpl()

◆ preciseColorSpace()

◆ sampleDullingColor()

◆ smearCompositeOp()

◆ smearRateOpacity()

Member Data Documentation

◆ m_blendDevice

◆ m_colorRateOp

◆ m_preparedDullingColor

◆ m_smearOp

◆ m_useDullingMode