#include <kis_colorize_mask.h>

Inheritance diagram for KisColorizeMask:

Classes
struct	KeyStrokeColors

struct	Private

Signals
void	sigKeyStrokesListChanged ()

void	sigUpdateOnDirtyParent () const

Signals inherited from KisNode
void	sigNodeChangedInternal ()

Signals inherited from KisBaseNode
void	keyframeChannelAdded (KisKeyframeChannel *channel)

void	opacityChanged (quint8 value)

Public Member Functions
bool	accept (KisNodeVisitor &v) override

void	accept (KisProcessingVisitor &visitor, KisUndoAdapter *undoAdapter) override

QVector< KisPaintDeviceSP >	allPaintDevices () const

qreal	cleanUpAmount () const

KisNodeSP	clone () const override

KisPaintDeviceSP	coloringProjection () const

KisPaintDeviceSP	colorSampleSourceDevice () const override

const KoColorSpace *	colorSpace () const override

QRect	decorateRect (KisPaintDeviceSP &src, KisPaintDeviceSP &dst, const QRect &rc, PositionToFilthy maskPos, KisRenderPassFlags flags) const override

qreal	edgeDetectionSize () const

QRect	exactBounds () const override

QRect	extent () const override

QList< KisLazyFillTools::KeyStroke >	fetchKeyStrokesDirect () const

void	forceRegenerateMask ()

qreal	fuzzyRadius () const

KisPaintDeviceList	getLodCapableDevices () const override

QIcon	icon () const override

void	initializeCompositeOp ()

KeyStrokeColors	keyStrokesColors () const

	KisColorizeMask (const KisColorizeMask &rhs)

	KisColorizeMask (KisImageWSP image, const QString &name)

bool	limitToDeviceBounds () const

void	mergeToLayerThreaded (KisNodeSP layer, KUndo2Command parentCommand, const KUndo2MagicString &transactionText, int timedID, QVector< KisRunnableStrokeJobData > *jobs) override

QRect	nonDependentExtent () const override

KisPaintDeviceSP	paintDevice () const override

void	regeneratePrefilteredDeviceIfNeeded ()

void	removeKeyStroke (const KoColor &color)

void	resetCache ()

KisBaseNode::PropertyList	sectionModelProperties () const override

void	setCleanUpAmount (qreal value)

KUndo2Command *	setColorSpace (const KoColorSpace dstColorSpace, KoColorConversionTransformation::Intent renderingIntent=KoColorConversionTransformation::internalRenderingIntent(), KoColorConversionTransformation::ConversionFlags conversionFlags=KoColorConversionTransformation::internalConversionFlags(), KoUpdater progressUpdater=nullptr)

void	setCurrentColor (const KoColor &color) override

void	setEdgeDetectionSize (qreal value)

void	setFuzzyRadius (qreal value)

void	setImage (KisImageWSP image) override

void	setKeyStrokesColors (KeyStrokeColors colors)

void	setKeyStrokesDirect (const QList< KisLazyFillTools::KeyStroke > &strokes)

void	setLimitToDeviceBounds (bool value)

void	setProfile (const KoColorProfile profile, KUndo2Command parentCommand)

void	setSectionModelProperties (const KisBaseNode::PropertyList &properties) override

void	setUseEdgeDetection (bool value)

void	setX (qint32 x) override

void	setY (qint32 y) override

bool	supportsNonIndirectPainting () const override

void	testingAddKeyStroke (KisPaintDeviceSP dev, const KoColor &color, bool isTransparent=false)

KisPaintDeviceSP	testingFilteredSource () const

bool	useEdgeDetection () const

void	writeMergeData (KisPainter *painter, KisPaintDeviceSP src, const QRect &rc) override

qint32	x () const override

qint32	y () const override

	~KisColorizeMask () override

Public Member Functions inherited from KisEffectMask
void	apply (KisPaintDeviceSP projection, const QRect &applyRect, const QRect &needRect, PositionToFilthy maskPos, KisRenderPassFlags flags) const

QIcon	icon () const override

	KisEffectMask (const KisEffectMask &rhs)

	KisEffectMask (KisImageWSP image, const QString &name)

	~KisEffectMask () override

Public Member Functions inherited from KisMask
bool	allowAsChild (KisNodeSP node) const override

QRect	changeRect (const QRect &rect, PositionToFilthy pos=N_FILTHY) const override

const KoColorSpace *	colorSpace () const override

const KoCompositeOp *	compositeOp () const override

QImage	createThumbnail (qint32 w, qint32 h, Qt::AspectRatioMode aspectRatioMode=Qt::IgnoreAspectRatio) override

QRect	exactBounds () const override

QRect	extent () const override

void	initSelection (KisLayerSP parentLayer)
	initSelection initializes an empty selection

void	initSelection (KisPaintDeviceSP copyFromDevice, KisLayerSP parentLayer)
	initSelection initializes the selection for the mask from the given paint device.

void	initSelection (KisSelectionSP copyFrom, KisLayerSP parentLayer)
	initSelection initializes the selection for the mask from the given selection's projection.

void	initSelectionImpl (KisSelectionSP copyFrom, KisLayerSP parentLayer, KisPaintDeviceSP copyFromDevice, KisImageWSP image)

	KisMask (const KisMask &rhs)

	KisMask (KisImageWSP image, const QString &name)

QRect	needRect (const QRect &rect, PositionToFilthy pos=N_FILTHY) const override

KisPaintDeviceSP	original () const override

KisPaintDeviceSP	paintDevice () const override

	Private (KisMask *_q)

KisPaintDeviceSP	projection () const override

KisAbstractProjectionPlaneSP	projectionPlane () const override

void	select (const QRect &rc, quint8 selectedness=MAX_SELECTED)

KisSelectionSP	selection () const

void	setImage (KisImageWSP image) override

void	setSelection (KisSelectionSP selection)

void	setX (qint32 x) override

void	setY (qint32 y) override

bool	supportsLodPainting () const override

void	testingInitSelection (const QRect &rect, KisLayerSP parentLayer)

int	thumbnailSeqNo () const override

qint32	x () const override

qint32	y () const override

	~KisMask () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Member Functions inherited from KisNode
bool	accept (KisNodeVisitor &v) override

void	accept (KisProcessingVisitor &visitor, KisUndoAdapter *undoAdapter) override

KisNodeSP	at (quint32 index) const

KisBusyProgressIndicator *	busyProgressIndicator () const

quint32	childCount () const

QList< KisNodeSP >	childNodes (const QStringList &nodeTypes, const KoProperties &properties) const

const KisNode *	findSymmetricClone (const KisNode srcRoot, const KisNode dstRoot, const KisNode *srcTarget)

KisNodeSP	firstChild () const

KisNodeGraphListener *	graphListener () const

int	graphSequenceNumber () const

void	handleKeyframeChannelFrameAboutToBeRemoved (const KisKeyframeChannel *channel, int time)

virtual void	handleKeyframeChannelFrameAdded (const KisKeyframeChannel *channel, int time)

virtual void	handleKeyframeChannelFrameChange (const KisKeyframeChannel *channel, int time)

void	handleKeyframeChannelFrameHasBeenRemoved (const KisKeyframeChannel *channel, int time)

KisFrameChangeUpdateRecipe	handleKeyframeChannelUpdateImpl (const KisKeyframeChannel *channel, int time)

int	index (const KisNodeSP node) const

void	invalidateFrames (const KisTimeSpan &range, const QRect &rect)

	KisNode (const KisNode &rhs)

	KisNode (KisImageWSP image)

KisNodeSP	lastChild () const

KisNodeSP	nextSibling () const

KisNodeProgressProxy *	nodeProgressProxy () const

KisNodeSP	parent () const

KisNodeSP	prevSibling () const

	Private (KisNode *node)

void	processDuplicatedClones (const KisNode srcDuplicationRoot, const KisNode dstDuplicationRoot, KisNode *node)

virtual KisProjectionLeafSP	projectionLeaf () const

void	requestTimeSwitch (int time)

virtual void	setDirty ()

void	setDirty (const KisRegion &region)

void	setDirty (const QRect &rect)

virtual void	setDirty (const QVector< QRect > &rects)

void	setDirtyDontResetAnimationCache ()

void	setDirtyDontResetAnimationCache (const QRect &rect)

void	setDirtyDontResetAnimationCache (const QVector< QRect > &rects)
	setDirtyDontResetAnimationCache does almost the same thing as usual setDirty() call, but doesn't reset the animation cache (since onion skins are not used when rendering animation.

void	setGraphListener (KisNodeGraphListener *graphListener)

void	setImage (KisImageWSP newImage) override

virtual void	syncLodCache ()

	~KisNode () override

Public Member Functions inherited from KisBaseNode
bool	belongsToIsolatedGroup () const

bool	check (const KoProperties &properties) const

bool	collapsed () const

int	colorLabelIndex () const

const QString &	compositeOpId () const

virtual QImage	createThumbnailForFrame (qint32 w, qint32 h, int time, Qt::AspectRatioMode aspectRatioMode=Qt::IgnoreAspectRatio)

void	enableAnimation ()

KisKeyframeChannel *	getKeyframeChannel (const QString &id) const

KisKeyframeChannel *	getKeyframeChannel (const QString &id, bool create)

bool	hasEditablePaintDevice () const

KisImageWSP	image () const

bool	isAnimated () const

bool	isEditable (bool checkVisibility=true) const

virtual bool	isFakeNode () const

bool	isIsolatedRoot () const

bool	isPinnedToTimeline () const

QMap< QString, KisKeyframeChannel * >	keyframeChannels () const

	KisBaseNode (const KisBaseNode &rhs)

	KisBaseNode (KisImageWSP image)

void	mergeNodeProperties (const KoProperties &properties)

QString	name () const

const KoProperties &	nodeProperties () const

quint8	opacity () const

quint8	percentOpacity () const

	Private (const Private &rhs)

	Private (KisImageWSP p_image)

void	setCollapsed (bool collapsed)

void	setColorLabelIndex (int index)

void	setCompositeOpId (const QString &compositeOpId)

void	setName (const QString &name)

void	setNodeProperty (const QString &name, const QVariant &value)

void	setOpacity (quint8 val)

void	setPercentOpacity (quint8 val)

void	setPinnedToTimeline (bool pinned)

virtual void	setUserLocked (bool l)

void	setUuid (const QUuid &id)

virtual void	setVisible (bool visible, bool loading=false)

bool	supportsLodMoves () const

virtual void	updateSettings ()

bool	userLocked () const

QUuid	uuid () const

virtual bool	visible (bool recursive=false) const

	~KisBaseNode () override

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Public Member Functions inherited from KisIndirectPaintingSupport
bool	hasTemporaryTarget () const

	KisIndirectPaintingSupport ()

void	mergeToLayer (KisNodeSP layer, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID)

void	setTemporaryChannelFlags (const QBitArray &channelFlags)

void	setTemporaryCompositeOp (const QString &id)

void	setTemporaryOpacity (qreal o)

void	setTemporarySelection (KisSelectionSP selection)

void	setTemporaryTarget (KisPaintDeviceSP t)

void	setupTemporaryPainter (KisPainter *painter) const

KisPaintDeviceSP	temporaryTarget () const

FinalMergeSuspenderSP	trySuspendFinalMerge ()

virtual	~KisIndirectPaintingSupport ()

Private Slots
void	slotRecalculatePrefilteredImage ()

void	slotRegenerationCancelled ()

void	slotRegenerationFinished (bool prefilterOnly)

void	slotUpdateOnDirtyParent ()

void	slotUpdateRegenerateFilling (bool prefilterOnly=false)

Private Member Functions
template<class DeviceMetricPolicy >
QRect	calculateMaskBounds (DeviceMetricPolicy policy) const

void	mergeToLayerUnthreaded (KisNodeSP layer, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID)

void	moveAllInternalDevices (const QPoint &diff)

bool	needsUpdate () const

void	rerenderFakePaintDevice ()

void	setNeedsUpdate (bool value)

void	setShowColoring (bool value)

void	setShowKeyStrokes (bool value)

bool	showColoring () const

bool	showKeyStrokes () const

Private Attributes
const QScopedPointer< Private >	m_d

Friends
struct	KeyStrokeAddRemoveCommand

struct	SetKeyStrokeColorsCommand

struct	SetKeyStrokesColorSpaceCommand

Additional Inherited Members
Public Types inherited from KisNode
enum	PositionToFilthy { N_ABOVE_FILTHY = 0x08 , N_FILTHY_PROJECTION = 0x20 , N_FILTHY = 0x40 , N_BELOW_FILTHY = 0x80 }

Public Types inherited from KisBaseNode
typedef QList< Property >	PropertyList

Public Types inherited from KisIndirectPaintingSupport
using	FinalMergeSuspenderSP = QSharedPointer<FinalMergeSuspender>

Public Attributes inherited from KisMask
QScopedPointer< QPoint >	deferredSelectionOffset

KisCachedPaintDevice	paintDeviceCache

KisAbstractProjectionPlaneSP	projectionPlane

KisMask *	q

KisSafeSelectionNodeProjectionStoreSP	safeProjection

KisSelectionSP	selection

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KisNode
KisBusyProgressIndicator *	busyProgressIndicator

std::optional< KisFrameChangeUpdateRecipe >	frameRemovalUpdateRecipe

KisNodeGraphListener *	graphListener

KisNodeProgressProxy *	nodeProgressProxy

KisSafeReadNodeList	nodes

QReadWriteLock	nodeSubgraphLock

KisNodeWSP	parent

KisProjectionLeafSP	projectionLeaf

Public Attributes inherited from KisBaseNode
bool	animated {false}

bool	collapsed {false}

QString	compositeOp

KisBaseNode::Property	hack_visible

QUuid	id

KisImageWSP	image

QMap< QString, KisKeyframeChannel * >	keyframeChannels

KisAnimatedOpacityProperty	opacityProperty

bool	pinnedToTimeline {false}

KoProperties	properties

bool	supportsLodMoves {false}

Public Attributes inherited from KisIndirectPaintingSupport
QBitArray	channelFlags

QString	compositeOp

qreal	compositeOpacity

bool	finalMergeInProgress = true

QReadWriteLock	lock

KisSelectionSP	selection

KisPaintDeviceSP	temporaryTarget

Protected Types inherited from KisIndirectPaintingSupport
using	WriteLockerSP = QSharedPointer<WriteLocker>

Protected Member Functions inherited from KisMask
void	apply (KisPaintDeviceSP projection, const QRect &applyRect, const QRect &needRect, PositionToFilthy maskPos, KisRenderPassFlags flags) const

void	baseNodeChangedCallback () override

virtual void	flattenSelectionProjection (KisSelectionSP selection, const QRect &dirtyRect) const

virtual void	mergeInMaskInternal (KisPaintDeviceSP projection, KisSelectionSP effectiveSelection, const QRect &applyRect, const QRect &preparedNeedRect, PositionToFilthy maskPos, KisRenderPassFlags flags) const

virtual bool	paintsOutsideSelection () const

KisKeyframeChannel *	requestKeyframeChannel (const QString &id) override

bool	supportsKeyframeChannel (const QString &id) override

Protected Member Functions inherited from KisNode
virtual QRect	accessRect (const QRect &rect, PositionToFilthy pos=N_FILTHY) const

void	addKeyframeChannel (KisKeyframeChannel *channel) override

void	baseNodeChangedCallback () override

void	baseNodeCollapsedChangedCallback () override

void	baseNodeInvalidateAllFramesCallback () override

virtual void	childNodeChanged (KisNodeSP changedChildNode)

virtual KisFrameChangeUpdateRecipe	handleKeyframeChannelFrameAboutToBeRemovedImpl (const KisKeyframeChannel *channel, int time)

void	notifyParentVisibilityChanged (bool value) override

KisBaseNodeSP	parentCallback () const override

Protected Member Functions inherited from KisBaseNode
void	setSupportsLodMoves (bool value)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Protected Member Functions inherited from KisIndirectPaintingSupport
void	lockTemporaryTargetForWrite () const

void	mergeToLayerImpl (KisPaintDeviceSP dst, KUndo2Command parentCommand, const KUndo2MagicString &transactionText, int timedID, bool cleanResources, WriteLockerSP sharedWriteLock, QVector< KisRunnableStrokeJobData > *jobs)

void	releaseResources ()

QString	temporaryCompositeOp () const

Detailed Description

Definition at line 26 of file kis_colorize_mask.h.

Constructor & Destructor Documentation

◆ KisColorizeMask() [1/2]

KisColorizeMask::KisColorizeMask	(	KisImageWSP	image,
		const QString &	name )

Definition at line 138 of file kis_colorize_mask.cpp.

    : KisEffectMask(image, name)
    , m_d(new Private(this, image))
{
    connect(&m_d->updateCompressor,
            SIGNAL(timeout()),
            SLOT(slotUpdateRegenerateFilling()));
 
    connect(this, SIGNAL(sigUpdateOnDirtyParent()),
            &m_d->dirtyParentUpdateCompressor, SLOT(start()));
 
    connect(&m_d->dirtyParentUpdateCompressor,
            SIGNAL(timeout()),
            SLOT(slotUpdateOnDirtyParent()));
 
    connect(&m_d->prefilterRecalculationCompressor,
            SIGNAL(timeout()),
            SLOT(slotRecalculatePrefilteredImage()));
 
 
    m_d->updateCompressor.moveToThread(qApp->thread());
}

References connect(), m_d, sigUpdateOnDirtyParent(), slotRecalculatePrefilteredImage(), slotUpdateOnDirtyParent(), and slotUpdateRegenerateFilling().

◆ ~KisColorizeMask()

KisColorizeMask::~KisColorizeMask ( )

override

Definition at line 161 of file kis_colorize_mask.cpp.

162{

163}

◆ KisColorizeMask() [2/2]

KisColorizeMask::KisColorizeMask ( const KisColorizeMask & rhs )

Definition at line 165 of file kis_colorize_mask.cpp.

    : KisEffectMask(rhs),
      m_d(new Private(*rhs.m_d, this))
{
    connect(&m_d->updateCompressor,
            SIGNAL(timeout()),
            SLOT(slotUpdateRegenerateFilling()));
 
    connect(this, SIGNAL(sigUpdateOnDirtyParent()),
            &m_d->dirtyParentUpdateCompressor, SLOT(start()));
 
    connect(&m_d->dirtyParentUpdateCompressor,
            SIGNAL(timeout()),
            SLOT(slotUpdateOnDirtyParent()));
 
    m_d->updateCompressor.moveToThread(qApp->thread());
}

References connect(), m_d, sigUpdateOnDirtyParent(), slotUpdateOnDirtyParent(), and slotUpdateRegenerateFilling().

Member Function Documentation

◆ accept() [1/2]

bool KisColorizeMask::accept ( KisNodeVisitor & )

overridevirtual

Accept the KisNodeVisitor (for the Visitor design pattern), should call the correct function on the KisNodeVisitor for this node type, so you need to override it for all leaf classes in the node inheritance hierarchy.

return false if the visitor could not successfully act on this node instance.

Reimplemented from KisBaseNode.

Definition at line 487 of file kis_colorize_mask.cpp.

{
    return v.visit(this);
}

References v.

◆ accept() [2/2]

void KisColorizeMask::accept	(	KisProcessingVisitor &	visitor,
		KisUndoAdapter *	undoAdapter )

overridevirtual

Accept the KisNodeVisitor (for the Visitor design pattern), should call the correct function on the KisProcessingVisitor for this node type, so you need to override it for all leaf classes in the node inheritance hierarchy.

The processing visitor differs from node visitor in the way that it accepts undo adapter, that allows the processing to be multithreaded

Reimplemented from KisBaseNode.

Definition at line 492 of file kis_colorize_mask.cpp.

{
    return visitor.visit(this, undoAdapter);
}

References KisProcessingVisitor::visit().

◆ allPaintDevices()

QVector< KisPaintDeviceSP > KisColorizeMask::allPaintDevices ( ) const

Definition at line 979 of file kis_colorize_mask.cpp.

{
    QVector<KisPaintDeviceSP> devices;
 
    Q_FOREACH (const KeyStroke &stroke, m_d->keyStrokes) {
        devices << stroke.dev;
    }
 
    devices << m_d->coloringProjection;
    devices << m_d->fakePaintDevice;
 
    return devices;
}

References KisLazyFillTools::KeyStroke::dev, and m_d.

◆ calculateMaskBounds()

template<class DeviceMetricPolicy >

QRect KisColorizeMask::calculateMaskBounds ( DeviceMetricPolicy policy ) const

private

Definition at line 619 of file kis_colorize_mask.cpp.

{
    QRect rc;
 
    if (m_d->shouldShowFilteredSource()) {
        rc |= boundsPolicy(m_d->filteredSource);
    }
 
    if (m_d->shouldShowColoring()) {
        rc |= boundsPolicy(m_d->coloringProjection);
    }
 
    if (m_d->showKeyStrokes) {
        Q_FOREACH (const KeyStroke &stroke, m_d->keyStrokes) {
            rc |= boundsPolicy(stroke.dev);
        }
 
        KisIndirectPaintingSupport::ReadLocker locker(this);
 
        KisPaintDeviceSP temporaryTarget = this->temporaryTarget();
        if (temporaryTarget) {
            rc |= boundsPolicy(temporaryTarget);
        }
    }
 
    return rc;
}

References KisLazyFillTools::KeyStroke::dev, m_d, and KisIndirectPaintingSupport::temporaryTarget.

◆ cleanUpAmount()

qreal KisColorizeMask::cleanUpAmount ( ) const

Definition at line 1045 of file kis_colorize_mask.cpp.

{
    return m_d->filteringOptions.cleanUpAmount;
}

References m_d.

◆ clone()

KisNodeSP KisColorizeMask::clone ( ) const

inlineoverridevirtual

Implements KisNode.

Definition at line 57 of file kis_colorize_mask.h.

                                     {
        return KisNodeSP(new KisColorizeMask(*this));
    }

◆ coloringProjection()

KisPaintDeviceSP KisColorizeMask::coloringProjection ( ) const

Definition at line 469 of file kis_colorize_mask.cpp.

{
    return m_d->coloringProjection;
}

References m_d.

◆ colorSampleSourceDevice()

KisPaintDeviceSP KisColorizeMask::colorSampleSourceDevice ( ) const

overridevirtual

Returns: a special device from where the color sampler tool should sample color when in layer-only mode. For most of the nodes just shortcuts to projection() device. TODO: can it be null?

Reimplemented from KisBaseNode.

Definition at line 474 of file kis_colorize_mask.cpp.

{
    return
        m_d->shouldShowColoring() && !m_d->coloringProjection->extent().isEmpty() ?
            m_d->coloringProjection : projection();
}

References KisPaintDevice::extent(), m_d, and KisMask::projection().

◆ colorSpace()

const KoColorSpace * KisColorizeMask::colorSpace ( ) const

overridevirtual

Implements KisBaseNode.

Definition at line 200 of file kis_colorize_mask.cpp.

{
    return m_d->fakePaintDevice->colorSpace();
}

References m_d.

◆ decorateRect()

QRect KisColorizeMask::decorateRect	(	KisPaintDeviceSP &	src,
		KisPaintDeviceSP &	dst,
		const QRect &	rc,
		PositionToFilthy	maskPos,
		KisRenderPassFlags	flags ) const

overridevirtual

Reimplemented from KisMask.

Definition at line 513 of file kis_colorize_mask.cpp.

{
    Q_UNUSED(maskPos);
    Q_UNUSED(flags);
 
    if (maskPos == N_ABOVE_FILTHY) {
        // the source layer has changed, we should update the filtered cache!
 
        if (!m_d->filteringDirty) {
            Q_EMIT sigUpdateOnDirtyParent();
        }
    }
 
    KIS_ASSERT(dst != src);
 
    // Draw the filling and the original layer
    {
        KisPainter gc(dst);
 
        if (m_d->shouldShowFilteredSource()) {
            const QRect drawRect = m_d->limitToDeviceBounds ? rect & m_d->filteredDeviceBounds : rect;
 
            gc.setOpacityF(0.5);
            gc.bitBlt(drawRect.topLeft(), m_d->filteredSource, drawRect);
        } else {
            gc.setOpacityToUnit();
            gc.bitBlt(rect.topLeft(), src, rect);
        }
 
        if (m_d->shouldShowColoring()) {
 
            gc.setOpacityU8(opacity());
            gc.setCompositeOpId(compositeOpId());
            gc.bitBlt(rect.topLeft(), m_d->coloringProjection, rect);
        }
    }
 
    // Draw the key strokes
    if (m_d->showKeyStrokes) {
        KisIndirectPaintingSupport::ReadLocker locker(this);
 
        KisCachedSelection::Guard s1(m_d->cachedSelection);
        KisCachedSelection::Guard s2(m_d->cachedSelection);
 
        KisSelectionSP selection = s1.selection();
        KisPixelSelectionSP tempSelection = s2.selection()->pixelSelection();
 
        KisPaintDeviceSP temporaryTarget = this->temporaryTarget();
        const bool isTemporaryTargetErasing = temporaryCompositeOp() == COMPOSITE_ERASE;
        const QRect temporaryExtent = temporaryTarget ? temporaryTarget->extent() : QRect();
 
 
        KisFillPainter gc(dst);
 
        QList<KeyStroke> extendedStrokes = m_d->keyStrokes;
 
        if (m_d->currentKeyStrokeDevice &&
            m_d->needAddCurrentKeyStroke &&
            !isTemporaryTargetErasing) {
 
            extendedStrokes << KeyStroke(m_d->currentKeyStrokeDevice, m_d->currentColor);
        }
 
        Q_FOREACH (const KeyStroke &stroke, extendedStrokes) {
            selection->pixelSelection()->makeCloneFromRough(stroke.dev, rect);
            gc.setSelection(selection);
 
            if (stroke.color == m_d->currentColor ||
                (isTemporaryTargetErasing &&
                 temporaryExtent.intersects(selection->pixelSelection()->selectedRect()))) {
 
                if (temporaryTarget) {
                    tempSelection->copyAlphaFrom(temporaryTarget, rect);
 
                    KisPainter selectionPainter(selection->pixelSelection());
                    setupTemporaryPainter(&selectionPainter);
                    selectionPainter.bitBlt(rect.topLeft(), tempSelection, rect);
                }
            }
 
            gc.fillSelection(rect, stroke.color);
        }
    }
 
    return rect;
}

References KisPainter::bitBlt(), KisLazyFillTools::KeyStroke::color, COMPOSITE_ERASE, KisBaseNode::compositeOpId(), KisPixelSelection::copyAlphaFrom(), KisLazyFillTools::KeyStroke::dev, KisPaintDevice::extent(), KisFillPainter::fillSelection(), KIS_ASSERT, m_d, KisPaintDevice::makeCloneFromRough(), KisNode::N_ABOVE_FILTHY, KisBaseNode::opacity(), KisSelection::pixelSelection, s1, s2, KisPixelSelection::selectedRect(), KisMask::selection, KisPainter::setCompositeOpId(), KisPainter::setOpacityF(), KisPainter::setOpacityToUnit(), KisPainter::setOpacityU8(), KisPainter::setSelection(), KisIndirectPaintingSupport::setupTemporaryPainter(), sigUpdateOnDirtyParent(), KisIndirectPaintingSupport::temporaryCompositeOp(), and KisIndirectPaintingSupport::temporaryTarget.

◆ edgeDetectionSize()

qreal KisColorizeMask::edgeDetectionSize ( ) const

Definition at line 1022 of file kis_colorize_mask.cpp.

{
    return m_d->filteringOptions.edgeDetectionSize;
}

References m_d.

◆ exactBounds()

QRect KisColorizeMask::exactBounds ( ) const

overridevirtual

Returns the exact bounds of where the actual data resides in this node.

Reimplemented from KisBaseNode.

Definition at line 653 of file kis_colorize_mask.cpp.

{
    return calculateMaskBounds(DeviceExactBoundsPolicy());
}

References calculateMaskBounds().

◆ extent()

QRect KisColorizeMask::extent ( ) const

overridevirtual

Returns an approximation of where the bounds on actual data are in this node.

Reimplemented from KisBaseNode.

Definition at line 648 of file kis_colorize_mask.cpp.

{
    return calculateMaskBounds(DeviceExtentPolicy());
}

References calculateMaskBounds().

◆ fetchKeyStrokesDirect()

QList< KeyStroke > KisColorizeMask::fetchKeyStrokesDirect ( ) const

Definition at line 1095 of file kis_colorize_mask.cpp.

{
    return m_d->keyStrokes;
}

References m_d.

◆ forceRegenerateMask()

void KisColorizeMask::forceRegenerateMask ( )

Definition at line 1084 of file kis_colorize_mask.cpp.

{
    slotUpdateRegenerateFilling();
    m_d->updateIsRunning = false;
}

References m_d, and slotUpdateRegenerateFilling().

◆ fuzzyRadius()

qreal KisColorizeMask::fuzzyRadius ( ) const

Definition at line 1034 of file kis_colorize_mask.cpp.

{
    return m_d->filteringOptions.fuzzyRadius;
}

References m_d.

◆ getLodCapableDevices()

KisPaintDeviceList KisColorizeMask::getLodCapableDevices ( ) const

overridevirtual

Reimplemented from KisNode.

Definition at line 1136 of file kis_colorize_mask.cpp.

{
    KisPaintDeviceList list;
 
    auto it = m_d->keyStrokes.begin();
    for(; it != m_d->keyStrokes.end(); ++it) {
        list << it->dev;
    }
 
    list << m_d->coloringProjection;
    list << m_d->fakePaintDevice;
    list << m_d->filteredSource;
 
    return list;
}

References m_d.

◆ icon()

QIcon KisColorizeMask::icon ( ) const

overridevirtual

Returns: the icon used to represent the node type, for instance in the layerbox and in the menu.

Reimplemented from KisBaseNode.

Definition at line 481 of file kis_colorize_mask.cpp.

{
    return KisIconUtils::loadIcon("colorizeMask");
}

References KisIconUtils::loadIcon().

◆ initializeCompositeOp()

void KisColorizeMask::initializeCompositeOp ( )

Definition at line 183 of file kis_colorize_mask.cpp.

{
    KisLayerSP parentLayer(qobject_cast<KisLayer*>(parent().data()));
    if (!parentLayer || !parentLayer->original()) return;
 
    KisImageSP image = parentLayer->image();
    if (!image) return;
 
    const qreal samplePortion = 0.1;
    const qreal alphaPortion =
        KritaUtils::estimatePortionOfTransparentPixels(parentLayer->original(),
                                                       image->bounds(),
                                                       samplePortion);
 
    setCompositeOpId(alphaPortion > 0.3 ? COMPOSITE_BEHIND : COMPOSITE_MULT);
}

References KisImage::bounds(), COMPOSITE_BEHIND, COMPOSITE_MULT, KritaUtils::estimatePortionOfTransparentPixels(), KisBaseNode::image, KisLayer::original(), KisNode::parent, and KisBaseNode::setCompositeOpId().

◆ keyStrokesColors()

KisColorizeMask::KeyStrokeColors KisColorizeMask::keyStrokesColors ( ) const

Definition at line 884 of file kis_colorize_mask.cpp.

{
    KeyStrokeColors colors;
 
    // TODO: thread safety!
    for (int i = 0; i < m_d->keyStrokes.size(); i++) {
        colors.colors << m_d->keyStrokes[i].color;
 
        if (m_d->keyStrokes[i].isTransparent) {
            colors.transparentIndex = i;
        }
    }
 
    return colors;
}

References KisColorizeMask::KeyStrokeColors::colors, m_d, and KisColorizeMask::KeyStrokeColors::transparentIndex.

◆ limitToDeviceBounds()

bool KisColorizeMask::limitToDeviceBounds ( ) const

Definition at line 1057 of file kis_colorize_mask.cpp.

{
    return m_d->limitToDeviceBounds;
}

References m_d.

◆ mergeToLayerThreaded()

void KisColorizeMask::mergeToLayerThreaded	(	KisNodeSP	layer,
		KUndo2Command *	parentCommand,
		const KUndo2MagicString &	transactionText,
		int	timedID,
		QVector< KisRunnableStrokeJobData * > *	jobs )

overridevirtual

Reimplemented from KisIndirectPaintingSupport.

Definition at line 736 of file kis_colorize_mask.cpp.

{
    // Just fake threaded merging. It is not supported for the colorize mask.
 
    KritaUtils::addJobSequential(*jobs,
        [=] () {
            this->mergeToLayerUnthreaded(layer, parentCommand, transactionText, timedID);
        }
    );
}

References KritaUtils::addJobSequential(), and mergeToLayerUnthreaded().

◆ mergeToLayerUnthreaded()

void KisColorizeMask::mergeToLayerUnthreaded	(	KisNodeSP	layer,
		KUndo2Command *	parentCommand,
		const KUndo2MagicString &	transactionText,
		int	timedID )

private

Add a new key stroke plane

When erasing, the brush affects all the key strokes, not only the current one.

When merging, we use barrier jobs only for ensuring that the merge jobs are not split by the update jobs. Merge jobs hold the shared lock, so forcing them out of CPU will basically cause a deadlock. When running in the fake executor, the jobs cannot be split anyway, so there is no danger in that.

Try removing the key strokes that has been completely erased

Definition at line 747 of file kis_colorize_mask.cpp.

{
    Q_UNUSED(layer);
 
    auto executeAndAdd = [parentCommand] (KUndo2Command *cmd) {
        cmd->redo();
        new KisCommandUtils::SkipFirstRedoWrapper(cmd, parentCommand);
    };
 
    WriteLockerSP sharedWriteLock(new WriteLocker(this));
 
    KisPaintDeviceSP temporaryTarget = this->temporaryTarget();
    const bool isTemporaryTargetErasing = temporaryCompositeOp() == COMPOSITE_ERASE;
    const QRect temporaryExtent = temporaryTarget ? temporaryTarget->extent() : QRect();
 
    if (m_d->needAddCurrentKeyStroke && !isTemporaryTargetErasing) {
        KeyStroke key(m_d->currentKeyStrokeDevice, m_d->currentColor);
        executeAndAdd(new KeyStrokeAddRemoveCommand(
            true, m_d->keyStrokes.size(), key, &m_d->keyStrokes, KisColorizeMaskSP(this), nullptr));
    }
 
    QVector<KisRunnableStrokeJobData*> jobs;
 
    if (!isTemporaryTargetErasing) {
        mergeToLayerImpl(m_d->currentKeyStrokeDevice, parentCommand, transactionText, timedID, false, sharedWriteLock, &jobs);
    } else {
        Q_FOREACH (const KeyStroke &stroke, m_d->keyStrokes) {
            if (temporaryExtent.intersects(stroke.dev->extent())) {
                mergeToLayerImpl(stroke.dev, parentCommand, transactionText, timedID, false, sharedWriteLock, &jobs);
            }
        }
    }
 
    mergeToLayerImpl(m_d->fakePaintDevice, parentCommand, transactionText, timedID, false, sharedWriteLock, &jobs);
 
    KisFakeRunnableStrokeJobsExecutor fakeExecutor(KisFakeRunnableStrokeJobsExecutor::AllowBarrierJobs);
    fakeExecutor.addRunnableJobs(implicitCastList<KisRunnableStrokeJobDataBase*>(jobs));
 
    m_d->currentKeyStrokeDevice = 0;
    m_d->currentColor = KoColor();
    releaseResources();
 
    if (isTemporaryTargetErasing) {
        for (int index = 0; index < m_d->keyStrokes.size(); /*noop*/) {
            const KeyStroke &stroke = m_d->keyStrokes[index];
 
            if (stroke.dev->exactBounds().isEmpty()) {
                executeAndAdd(new KeyStrokeAddRemoveCommand(
                    false, index, stroke, &m_d->keyStrokes, KisColorizeMaskSP(this), nullptr));
            } else {
                index++;
            }
        }
    }
}

References KisFakeRunnableStrokeJobsExecutor::addRunnableJobs(), KisFakeRunnableStrokeJobsExecutor::AllowBarrierJobs, COMPOSITE_ERASE, KisLazyFillTools::KeyStroke::dev, KisPaintDevice::exactBounds(), KisPaintDevice::extent(), KisNode::index(), KeyStrokeAddRemoveCommand, m_d, KisIndirectPaintingSupport::mergeToLayerImpl(), KisIndirectPaintingSupport::releaseResources(), KisIndirectPaintingSupport::temporaryCompositeOp(), and KisIndirectPaintingSupport::temporaryTarget.

◆ moveAllInternalDevices()

void KisColorizeMask::moveAllInternalDevices ( const QPoint & diff )

private

Definition at line 1165 of file kis_colorize_mask.cpp.

{
    QVector<KisPaintDeviceSP> devices = allPaintDevices();
 
    Q_FOREACH (KisPaintDeviceSP dev, devices) {
        dev->moveTo(dev->offset() + diff);
    }
}

References allPaintDevices(), KisPaintDevice::moveTo(), and KisPaintDevice::offset().

◆ needsUpdate()

bool KisColorizeMask::needsUpdate ( ) const

private

Definition at line 292 of file kis_colorize_mask.cpp.

{
    return m_d->needsUpdate;
}

References m_d.

◆ nonDependentExtent()

QRect KisColorizeMask::nonDependentExtent ( ) const

overridevirtual

Colorize mask has its own "projection", so it should report it to the parent layer using non-dependent-extent property

Reimplemented from KisMask.

Definition at line 658 of file kis_colorize_mask.cpp.

{
    return extent();
}

References extent().

◆ paintDevice()

KisPaintDeviceSP KisColorizeMask::paintDevice ( ) const

overridevirtual

Return the paintdevice you can use to change pixels on. For a paint layer these will be paint pixels, for an adjustment layer or a mask the selection paint device.

Returns: the paint device to paint on. Can be 0 if the actual node type does not support painting.

Implements KisBaseNode.

Definition at line 464 of file kis_colorize_mask.cpp.

{
    return m_d->showKeyStrokes && !m_d->updateIsRunning ? m_d->fakePaintDevice : KisPaintDeviceSP();
}

References m_d.

◆ regeneratePrefilteredDeviceIfNeeded()

void KisColorizeMask::regeneratePrefilteredDeviceIfNeeded ( )

Definition at line 1152 of file kis_colorize_mask.cpp.

{
    if (!parent()) return;
 
    KisPaintDeviceSP src = parent()->original();
    KIS_ASSERT_RECOVER_RETURN(src);
 
    if (!m_d->filteredSourceValid(src)) {
        // update the prefiltered source if needed
        slotUpdateRegenerateFilling(true);
    }
}

References KIS_ASSERT_RECOVER_RETURN, m_d, KisBaseNode::original(), KisNode::parent, and slotUpdateRegenerateFilling().

◆ removeKeyStroke()

void KisColorizeMask::removeKeyStroke ( const KoColor & color )

Definition at line 953 of file kis_colorize_mask.cpp.

{
    KoColor color = _color;
    color.convertTo(colorSpace());
 
    QList<KeyStroke>::iterator it =
        std::find_if(m_d->keyStrokes.begin(),
                     m_d->keyStrokes.end(),
                     kismpl::mem_equal_to(&KeyStroke::color, color));
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(it != m_d->keyStrokes.end());
 
    const int index = it - m_d->keyStrokes.begin();
 
    KisProcessingApplicator applicator(image(), KisNodeSP(this),
                                       KisProcessingApplicator::NONE,
                                       KisImageSignalVector(),
                                       kundo2_i18n("Remove Key Stroke"));
    applicator.applyCommand(
        new KeyStrokeAddRemoveCommand(
            false, index, *it, &m_d->keyStrokes, KisColorizeMaskSP(this)));
 
    applicator.end();
}

References KisProcessingApplicator::applyCommand(), KisLazyFillTools::KeyStroke::color, colorSpace(), KoColor::convertTo(), KisProcessingApplicator::end(), KisBaseNode::image, KisNode::index(), KeyStrokeAddRemoveCommand, KIS_SAFE_ASSERT_RECOVER_RETURN, kundo2_i18n(), m_d, kismpl::mem_equal_to(), and KisProcessingApplicator::NONE.

◆ rerenderFakePaintDevice()

void KisColorizeMask::rerenderFakePaintDevice ( )

private

Definition at line 1062 of file kis_colorize_mask.cpp.

{
    m_d->fakePaintDevice->clear();
    KisFillPainter gc(m_d->fakePaintDevice);
 
    KisCachedSelection::Guard s1(m_d->cachedSelection);
    KisSelectionSP selection = s1.selection();
 
    Q_FOREACH (const KeyStroke &stroke, m_d->keyStrokes) {
        const QRect rect = stroke.dev->extent();
 
        selection->pixelSelection()->makeCloneFromRough(stroke.dev, rect);
        gc.setSelection(selection);
        gc.fillSelection(rect, stroke.color);
    }
}

References KisLazyFillTools::KeyStroke::color, KisLazyFillTools::KeyStroke::dev, KisPaintDevice::extent(), KisFillPainter::fillSelection(), m_d, KisPaintDevice::makeCloneFromRough(), KisSelection::pixelSelection, s1, KisMask::selection, and KisPainter::setSelection().

◆ resetCache()

void KisColorizeMask::resetCache ( )

Definition at line 993 of file kis_colorize_mask.cpp.

{
    m_d->filteredSource->clear();
    m_d->originalSequenceNumber = -1;
    m_d->filteringDirty = true;
 
    rerenderFakePaintDevice();
    slotUpdateRegenerateFilling(true);
}

References m_d, rerenderFakePaintDevice(), and slotUpdateRegenerateFilling().

◆ sectionModelProperties()

KisBaseNode::PropertyList KisColorizeMask::sectionModelProperties ( ) const

overridevirtual

Return a the properties of this base node (locked, visible etc, with the right icons for their representation and their state.

Subclasses can extend this list with new properties, like opacity for layers or visualized for masks.

The order of properties is, unfortunately, for now, important, so take care which properties superclasses of your class define.

KisBaseNode defines visible = 0, locked = 1 KisLayer defines opacity = 2, compositeOp = 3 KisMask defines active = 2 (KisMask does not inherit kislayer)

Reimplemented from KisBaseNode.

Definition at line 431 of file kis_colorize_mask.cpp.

{
    KisBaseNode::PropertyList l = KisMask::sectionModelProperties();
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::colorizeNeedsUpdate, needsUpdate());
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::colorizeEditKeyStrokes, showKeyStrokes());
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::colorizeShowColoring, showColoring());
 
    return l;
}

References KisLayerPropertiesIcons::colorizeEditKeyStrokes, KisLayerPropertiesIcons::colorizeNeedsUpdate, KisLayerPropertiesIcons::colorizeShowColoring, KisLayerPropertiesIcons::getProperty(), needsUpdate(), KisBaseNode::sectionModelProperties(), showColoring(), and showKeyStrokes().

◆ setCleanUpAmount()

void KisColorizeMask::setCleanUpAmount ( qreal value )

Definition at line 1039 of file kis_colorize_mask.cpp.

{
    m_d->filteringOptions.cleanUpAmount = value;
    setNeedsUpdate(true);
}

References m_d, setNeedsUpdate(), and value().

◆ setColorSpace()

KUndo2Command * KisColorizeMask::setColorSpace	(	const KoColorSpace *	dstColorSpace,
		KoColorConversionTransformation::Intent	renderingIntent = KoColorConversionTransformation::internalRenderingIntent(),
		KoColorConversionTransformation::ConversionFlags	conversionFlags = KoColorConversionTransformation::internalConversionFlags(),
		KoUpdater *	progressUpdater = nullptr )

Definition at line 269 of file kis_colorize_mask.cpp.

{
    using namespace KisCommandUtils;
 
    CompositeCommand *composite = new CompositeCommand();
 
    m_d->fakePaintDevice->convertTo(dstColorSpace, renderingIntent, conversionFlags, composite, progressUpdater);
    m_d->coloringProjection->convertTo(dstColorSpace, renderingIntent, conversionFlags, composite, progressUpdater);
 
    KUndo2Command *strokesConversionCommand =
        new SetKeyStrokesColorSpaceCommand(
            dstColorSpace, renderingIntent, conversionFlags,
            &m_d->keyStrokes, KisColorizeMaskSP(this));
    strokesConversionCommand->redo();
 
    composite->addCommand(new SkipFirstRedoWrapper(strokesConversionCommand));
 
    return composite;
}

References KisCommandUtils::CompositeCommand::addCommand(), m_d, KUndo2Command::redo(), and SetKeyStrokesColorSpaceCommand.

◆ setCurrentColor()

void KisColorizeMask::setCurrentColor ( const KoColor & color )

overridevirtual

Reimplemented from KisIndirectPaintingSupport.

Definition at line 677 of file kis_colorize_mask.cpp.

{
    KoColor color = _color;
    color.convertTo(colorSpace());
 
    WriteLocker locker(this);
 
    m_d->setNeedsUpdateImpl(true, false);
 
    QList<KeyStroke>::const_iterator it =
        std::find_if(m_d->keyStrokes.constBegin(),
                     m_d->keyStrokes.constEnd(),
                     kismpl::mem_equal_to(&KeyStroke::color, color));
 
    KisPaintDeviceSP activeDevice;
    bool newKeyStroke = false;
 
    if (it == m_d->keyStrokes.constEnd()) {
        activeDevice = new KisPaintDevice(KoColorSpaceRegistry::instance()->alpha8());
        activeDevice->setParentNode(this);
        activeDevice->setDefaultBounds(KisDefaultBoundsBaseSP(new KisDefaultBounds(image())));
        newKeyStroke = true;
    } else {
        activeDevice = it->dev;
    }
 
    m_d->currentColor = color;
    m_d->currentKeyStrokeDevice = activeDevice;
    m_d->needAddCurrentKeyStroke = newKeyStroke;
}

References KisLazyFillTools::KeyStroke::color, colorSpace(), KoColor::convertTo(), KisBaseNode::image, KoColorSpaceRegistry::instance(), m_d, kismpl::mem_equal_to(), KisPaintDevice::setDefaultBounds(), and KisPaintDevice::setParentNode().

◆ setEdgeDetectionSize()

void KisColorizeMask::setEdgeDetectionSize ( qreal value )

Definition at line 1015 of file kis_colorize_mask.cpp.

{
    m_d->filteringOptions.edgeDetectionSize = value;
    m_d->filteringDirty = true;
    setNeedsUpdate(true);
}

References m_d, setNeedsUpdate(), and value().

◆ setFuzzyRadius()

void KisColorizeMask::setFuzzyRadius ( qreal value )

Definition at line 1027 of file kis_colorize_mask.cpp.

{
    m_d->filteringOptions.fuzzyRadius = value;
    m_d->filteringDirty = true;
    setNeedsUpdate(true);
}

References m_d, setNeedsUpdate(), and value().

◆ setImage()

void KisColorizeMask::setImage ( KisImageWSP image )

overridevirtual

Reimplemented from KisBaseNode.

Definition at line 663 of file kis_colorize_mask.cpp.

{
    KisDefaultBoundsSP bounds(new KisDefaultBounds(image));
 
    auto it = m_d->keyStrokes.begin();
    for(; it != m_d->keyStrokes.end(); ++it) {
        it->dev->setDefaultBounds(bounds);
    }
 
    m_d->coloringProjection->setDefaultBounds(bounds);
    m_d->fakePaintDevice->setDefaultBounds(bounds);
    m_d->filteredSource->setDefaultBounds(bounds);
}

References bounds, KisBaseNode::image, and m_d.

◆ setKeyStrokesColors()

void KisColorizeMask::setKeyStrokesColors ( KeyStrokeColors colors )

Definition at line 930 of file kis_colorize_mask.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(colors.colors.size() == m_d->keyStrokes.size());
 
    QList<KeyStroke> newList = m_d->keyStrokes;
 
    for (int i = 0; i < newList.size(); i++) {
        newList[i].color = colors.colors[i];
        newList[i].color.convertTo(colorSpace());
        newList[i].isTransparent = colors.transparentIndex == i;
    }
 
    KisProcessingApplicator applicator(image(), KisNodeSP(this),
                                       KisProcessingApplicator::NONE,
                                       KisImageSignalVector(),
                                       kundo2_i18n("Change Key Stroke Color"));
    applicator.applyCommand(
        new SetKeyStrokeColorsCommand(
            newList, &m_d->keyStrokes, KisColorizeMaskSP(this)));
 
    applicator.end();
}

References KisProcessingApplicator::applyCommand(), KisColorizeMask::KeyStrokeColors::colors, colorSpace(), KisProcessingApplicator::end(), KisBaseNode::image, KIS_ASSERT_RECOVER_RETURN, kundo2_i18n(), m_d, KisProcessingApplicator::NONE, SetKeyStrokeColorsCommand, and KisColorizeMask::KeyStrokeColors::transparentIndex.

◆ setKeyStrokesDirect()

void KisColorizeMask::setKeyStrokesDirect ( const QList< KisLazyFillTools::KeyStroke > & strokes )

Definition at line 1100 of file kis_colorize_mask.cpp.

{
    m_d->keyStrokes = strokes;
 
    for (auto it = m_d->keyStrokes.begin(); it != m_d->keyStrokes.end(); ++it) {
        it->dev->setParentNode(this);
    }
 
    KIS_SAFE_ASSERT_RECOVER(image())
    {};
}

References KisBaseNode::image, KIS_SAFE_ASSERT_RECOVER, and m_d.

◆ setLimitToDeviceBounds()

void KisColorizeMask::setLimitToDeviceBounds ( bool value )

Definition at line 1050 of file kis_colorize_mask.cpp.

{
    m_d->limitToDeviceBounds = value;
    m_d->filteringDirty = true;
    setNeedsUpdate(true);
}

References m_d, setNeedsUpdate(), and value().

◆ setNeedsUpdate()

void KisColorizeMask::setNeedsUpdate ( bool value )

private

Definition at line 297 of file kis_colorize_mask.cpp.

{
    m_d->setNeedsUpdateImpl(value, true);
}

References m_d, and value().

◆ setProfile()

void KisColorizeMask::setProfile	(	const KoColorProfile *	profile,
		KUndo2Command *	parentCommand )

Definition at line 259 of file kis_colorize_mask.cpp.

{
    m_d->fakePaintDevice->setProfile(profile, parentCommand);
    m_d->coloringProjection->setProfile(profile, parentCommand);
 
    for (auto & stroke : m_d->keyStrokes) {
        stroke.color.setProfile(profile);
    }
}

References m_d, and setProfile().

◆ setSectionModelProperties()

void KisColorizeMask::setSectionModelProperties ( const KisBaseNode::PropertyList & properties )

overridevirtual

Change the section model properties.

Reimplemented from KisBaseNode.

Definition at line 441 of file kis_colorize_mask.cpp.

{
    KisMask::setSectionModelProperties(properties);
 
    Q_FOREACH (const KisBaseNode::Property &property, properties) {
        if (property.id == KisLayerPropertiesIcons::colorizeNeedsUpdate.id()) {
            if (m_d->needsUpdate && m_d->needsUpdate != property.state.toBool()) {
                setNeedsUpdate(property.state.toBool());
            }
        }
        if (property.id == KisLayerPropertiesIcons::colorizeEditKeyStrokes.id()) {
            if (m_d->showKeyStrokes != property.state.toBool()) {
                setShowKeyStrokes(property.state.toBool());
            }
        }
        if (property.id == KisLayerPropertiesIcons::colorizeShowColoring.id()) {
            if (m_d->showColoring != property.state.toBool()) {
                setShowColoring(property.state.toBool());
            }
        }
    }
}

References KisLayerPropertiesIcons::colorizeEditKeyStrokes, KisLayerPropertiesIcons::colorizeNeedsUpdate, KisLayerPropertiesIcons::colorizeShowColoring, KoID::id(), KisBaseNode::Property::id, m_d, KisBaseNode::properties, setNeedsUpdate(), KisBaseNode::setSectionModelProperties(), setShowColoring(), setShowKeyStrokes(), and KisBaseNode::Property::state.

◆ setShowColoring()

void KisColorizeMask::setShowColoring ( bool value )

private

Definition at line 847 of file kis_colorize_mask.cpp.

{
    QRect savedExtent;
    if (m_d->showColoring && !value) {
        savedExtent = extent();
    }
 
    m_d->showColoring = value;
    baseNodeChangedCallback();
 
    if (!savedExtent.isEmpty()) {
        setDirty(savedExtent);
    }
}

References KisMask::baseNodeChangedCallback(), extent(), m_d, KisNode::setDirty(), and value().

◆ setShowKeyStrokes()

void KisColorizeMask::setShowKeyStrokes ( bool value )

private

Definition at line 867 of file kis_colorize_mask.cpp.

{
    QRect savedExtent;
    if (m_d->showKeyStrokes && !value) {
        savedExtent = extent();
    }
 
    m_d->showKeyStrokes = value;
    baseNodeChangedCallback();
 
    if (!savedExtent.isEmpty()) {
        setDirty(savedExtent);
    }
 
    regeneratePrefilteredDeviceIfNeeded();
}

References KisMask::baseNodeChangedCallback(), extent(), m_d, regeneratePrefilteredDeviceIfNeeded(), KisNode::setDirty(), and value().

◆ setUseEdgeDetection()

void KisColorizeMask::setUseEdgeDetection ( bool value )

Definition at line 1003 of file kis_colorize_mask.cpp.

{
    m_d->filteringOptions.useEdgeDetection = value;
    m_d->filteringDirty = true;
    setNeedsUpdate(true);
}

References m_d, setNeedsUpdate(), and value().

◆ setX()

void KisColorizeMask::setX ( qint32 )

overridevirtual

Set the x offset of this layer in the image place. Re-implement this where it makes sense, by default it does nothing. It should not move child nodes.

Reimplemented from KisBaseNode.

Definition at line 1122 of file kis_colorize_mask.cpp.

{
    const QPoint oldOffset = m_d->offset;
    m_d->offset.rx() = x;
    moveAllInternalDevices(m_d->offset - oldOffset);
}

References m_d, moveAllInternalDevices(), and x().

◆ setY()

void KisColorizeMask::setY ( qint32 )

overridevirtual

Set the y offset of this layer in the image place. Re-implement this where it makes sense, by default it does nothing. It should not move child nodes.

Reimplemented from KisBaseNode.

Definition at line 1129 of file kis_colorize_mask.cpp.

{
    const QPoint oldOffset = m_d->offset;
    m_d->offset.ry() = y;
    moveAllInternalDevices(m_d->offset - oldOffset);
}

References m_d, moveAllInternalDevices(), and y().

◆ showColoring()

bool KisColorizeMask::showColoring ( ) const

private

Definition at line 842 of file kis_colorize_mask.cpp.

{
    return m_d->showColoring;
}

References m_d.

◆ showKeyStrokes()

bool KisColorizeMask::showKeyStrokes ( ) const

private

Definition at line 862 of file kis_colorize_mask.cpp.

{
    return m_d->showKeyStrokes;
}

References m_d.

◆ sigKeyStrokesListChanged

void KisColorizeMask::sigKeyStrokesListChanged ( )

signal

◆ sigUpdateOnDirtyParent

void KisColorizeMask::sigUpdateOnDirtyParent ( ) const

signal

◆ slotRecalculatePrefilteredImage

void KisColorizeMask::slotRecalculatePrefilteredImage ( )

privateslot

Definition at line 401 of file kis_colorize_mask.cpp.

{
    slotUpdateRegenerateFilling(true);
}

References slotUpdateRegenerateFilling().

◆ slotRegenerationCancelled

void KisColorizeMask::slotRegenerationCancelled ( )

privateslot

Definition at line 425 of file kis_colorize_mask.cpp.

{
    slotRegenerationFinished(true);
    m_d->setNeedsUpdateImpl(true, false);
}

References m_d, and slotRegenerationFinished().

◆ slotRegenerationFinished

void KisColorizeMask::slotRegenerationFinished ( bool prefilterOnly )

privateslot

Definition at line 406 of file kis_colorize_mask.cpp.

{
    m_d->updateIsRunning = false;
 
    if (!prefilterOnly) {
        m_d->setNeedsUpdateImpl(false, false);
    }
 
    QRect oldExtent;
 
    if (!m_d->extentBeforeUpdateStart.isEmpty()) {
        oldExtent = m_d->extentBeforeUpdateStart.pop();
    } else {
        KIS_SAFE_ASSERT_RECOVER_NOOP(!m_d->extentBeforeUpdateStart.isEmpty()); // always fail!
    }
 
    setDirty(oldExtent | extent());
}

References extent(), KIS_SAFE_ASSERT_RECOVER_NOOP, m_d, and KisNode::setDirty().

◆ slotUpdateOnDirtyParent

void KisColorizeMask::slotUpdateOnDirtyParent ( )

privateslot

Definition at line 377 of file kis_colorize_mask.cpp.

{
    if (!parent()) {
        // When the colorize mask is being merged,
        // the update is performed for all the layers,
        // so the invisible areas around the canvas are included in the merged layer.
        // Colorize Mask gets the info that its parent is "dirty" (needs updating),
        // but when it arrives, the parent doesn't exist anymore and is set to null.
        // Colorize Mask doesn't work outside of the canvas anyway (at least in time of writing).
        return;
    }
    KisPaintDeviceSP src = parent()->original();
    KIS_ASSERT_RECOVER_RETURN(src);
 
    if (!m_d->filteredSourceValid(src)) {
        const QRect &oldExtent = extent();
 
        m_d->setNeedsUpdateImpl(true, false);
        m_d->filteringDirty = true;
 
        setDirty(oldExtent | extent());
    }
}

References extent(), KIS_ASSERT_RECOVER_RETURN, m_d, KisBaseNode::original(), KisNode::parent, and KisNode::setDirty().

◆ slotUpdateRegenerateFilling

void KisColorizeMask::slotUpdateRegenerateFilling ( bool prefilterOnly = false )

privateslot

Definition at line 314 of file kis_colorize_mask.cpp.

{
    KisPaintDeviceSP src = parent()->original();
    KIS_ASSERT_RECOVER_RETURN(src);
 
    const bool filteredSourceValid = m_d->filteredSourceValid(src);
    m_d->originalSequenceNumber = src->sequenceNumber();
    m_d->filteringDirty = false;
 
    if (!prefilterOnly) {
        m_d->coloringProjection->clear();
    }
 
    KisLayerSP parentLayer(qobject_cast<KisLayer*>(parent().data()));
    if (!parentLayer) return;
 
    KisImageSP image = parentLayer->image();
    if (image) {
        m_d->updateIsRunning = true;
 
        QRect fillBounds;
 
        if (m_d->limitToDeviceBounds) {
            fillBounds |= src->exactBounds();
            Q_FOREACH (const KeyStroke &stroke, m_d->keyStrokes) {
                fillBounds |= stroke.dev->exactBounds();
            }
            fillBounds &= image->bounds();
        } else {
            fillBounds = image->bounds();
        }
 
        m_d->filteredDeviceBounds = fillBounds;
 
        KisColorizeStrokeStrategy *strategy =
            new KisColorizeStrokeStrategy(src,
                                          m_d->coloringProjection,
                                          m_d->filteredSource,
                                          filteredSourceValid,
                                          fillBounds,
                                          this,
                                          prefilterOnly);
 
        strategy->setFilteringOptions(m_d->filteringOptions);
 
        Q_FOREACH (const KeyStroke &stroke, m_d->keyStrokes) {
            const KoColor color =
                !stroke.isTransparent ?
                stroke.color :
                KoColor::createTransparent(stroke.color.colorSpace());
 
            strategy->addKeyStroke(stroke.dev, color);
        }
 
        m_d->extentBeforeUpdateStart.push(extent());
 
        connect(strategy, SIGNAL(sigFinished(bool)), SLOT(slotRegenerationFinished(bool)));
        connect(strategy, SIGNAL(sigCancelled()), SLOT(slotRegenerationCancelled()));
        KisStrokeId id = image->startStroke(strategy);
        image->endStroke(id);
    }
}

References KisColorizeStrokeStrategy::addKeyStroke(), KisImage::bounds(), KisLazyFillTools::KeyStroke::color, KoColor::colorSpace(), connect(), KoColor::createTransparent(), KisLazyFillTools::KeyStroke::dev, KisImage::endStroke(), KisPaintDevice::exactBounds(), extent(), KisBaseNode::image, KisLazyFillTools::KeyStroke::isTransparent, KIS_ASSERT_RECOVER_RETURN, m_d, KisBaseNode::original(), KisNode::parent, KisColorizeStrokeStrategy::setFilteringOptions(), slotRegenerationCancelled(), slotRegenerationFinished(), and KisImage::startStroke().

◆ supportsNonIndirectPainting()

bool KisColorizeMask::supportsNonIndirectPainting ( ) const

overridevirtual

Reimplemented from KisIndirectPaintingSupport.

Definition at line 837 of file kis_colorize_mask.cpp.

{
    return false;
}

◆ testingAddKeyStroke()

void KisColorizeMask::testingAddKeyStroke	(	KisPaintDeviceSP	dev,
		const KoColor &	color,
		bool	isTransparent = false )

Definition at line 1079 of file kis_colorize_mask.cpp.

{
    m_d->keyStrokes << KeyStroke(dev, color, isTransparent);
}

References m_d.

◆ testingFilteredSource()

KisPaintDeviceSP KisColorizeMask::testingFilteredSource ( ) const

Definition at line 1090 of file kis_colorize_mask.cpp.

{
    return m_d->filteredSource;
}

References m_d.

◆ useEdgeDetection()

bool KisColorizeMask::useEdgeDetection ( ) const

Definition at line 1010 of file kis_colorize_mask.cpp.

{
    return m_d->filteringOptions.useEdgeDetection;
}

References m_d.

◆ writeMergeData()

void KisColorizeMask::writeMergeData	(	KisPainter *	painter,
		KisPaintDeviceSP	src,
		const QRect &	rc )

overridevirtual

Reimplemented from KisIndirectPaintingSupport.

Definition at line 821 of file kis_colorize_mask.cpp.

{
    const KoColorSpace *alpha8 = KoColorSpaceRegistry::instance()->alpha8();
    const bool nonAlphaDst = !(*painter->device()->colorSpace() == *alpha8);
 
    if (nonAlphaDst) {
        painter->bitBlt(rc.topLeft(), src, rc);
    } else {
        KisCachedSelection::Guard s1(m_d->cachedSelection);
        KisPixelSelectionSP tempSelection = s1.selection()->pixelSelection();
 
        tempSelection->copyAlphaFrom(src, rc);
        painter->bitBlt(rc.topLeft(), tempSelection, rc);
    }
}

References KoColorSpaceRegistry::alpha8(), KisPainter::bitBlt(), KisPaintDevice::colorSpace(), KisPixelSelection::copyAlphaFrom(), KisPainter::device, KoColorSpaceRegistry::instance(), m_d, and s1.

◆ x()

qint32 KisColorizeMask::x ( ) const

overridevirtual

Returns: the x-offset of this layer in the image plane.

Reimplemented from KisBaseNode.

Definition at line 1112 of file kis_colorize_mask.cpp.

{
    return m_d->offset.x();
}

References m_d.

◆ y()

qint32 KisColorizeMask::y ( ) const

overridevirtual

Returns: the y-offset of this layer in the image plane.

Reimplemented from KisBaseNode.

Definition at line 1117 of file kis_colorize_mask.cpp.

{
    return m_d->offset.y();
}

References m_d.

Friends And Related Symbol Documentation

◆ KeyStrokeAddRemoveCommand

friend struct KeyStrokeAddRemoveCommand

friend

Definition at line 164 of file kis_colorize_mask.h.

◆ SetKeyStrokeColorsCommand

friend struct SetKeyStrokeColorsCommand

friend

Definition at line 165 of file kis_colorize_mask.h.

◆ SetKeyStrokesColorSpaceCommand

friend struct SetKeyStrokesColorSpaceCommand

friend

Definition at line 163 of file kis_colorize_mask.h.

Member Data Documentation

◆ m_d

const QScopedPointer<Private> KisColorizeMask::m_d

private

Definition at line 169 of file kis_colorize_mask.h.

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

libs/image/lazybrush/kis_colorize_mask.h
libs/image/lazybrush/kis_colorize_mask.cpp

Classes

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisColorizeMask() [1/2]

◆ ~KisColorizeMask()

◆ KisColorizeMask() [2/2]

Member Function Documentation

◆ accept() [1/2]

◆ accept() [2/2]

◆ allPaintDevices()

◆ calculateMaskBounds()

◆ cleanUpAmount()

◆ clone()

◆ coloringProjection()

◆ colorSampleSourceDevice()

◆ colorSpace()

◆ decorateRect()

◆ edgeDetectionSize()

◆ exactBounds()

◆ extent()

◆ fetchKeyStrokesDirect()

◆ forceRegenerateMask()

◆ fuzzyRadius()

◆ getLodCapableDevices()

◆ icon()

◆ initializeCompositeOp()

◆ keyStrokesColors()

◆ limitToDeviceBounds()

◆ mergeToLayerThreaded()

◆ mergeToLayerUnthreaded()

◆ moveAllInternalDevices()

◆ needsUpdate()

◆ nonDependentExtent()

◆ paintDevice()

◆ regeneratePrefilteredDeviceIfNeeded()

◆ removeKeyStroke()

◆ rerenderFakePaintDevice()

◆ resetCache()

◆ sectionModelProperties()

◆ setCleanUpAmount()

◆ setColorSpace()

◆ setCurrentColor()

◆ setEdgeDetectionSize()

◆ setFuzzyRadius()

◆ setImage()

◆ setKeyStrokesColors()

◆ setKeyStrokesDirect()

◆ setLimitToDeviceBounds()

◆ setNeedsUpdate()

◆ setProfile()

◆ setSectionModelProperties()

◆ setShowColoring()

◆ setShowKeyStrokes()

◆ setUseEdgeDetection()

◆ setX()

◆ setY()

◆ showColoring()

◆ showKeyStrokes()

◆ sigKeyStrokesListChanged

◆ sigUpdateOnDirtyParent

◆ slotRecalculatePrefilteredImage

◆ slotRegenerationCancelled

◆ slotRegenerationFinished

◆ slotUpdateOnDirtyParent

◆ slotUpdateRegenerateFilling

◆ supportsNonIndirectPainting()

◆ testingAddKeyStroke()

◆ testingFilteredSource()

◆ useEdgeDetection()

◆ writeMergeData()

◆ x()

◆ y()

Friends And Related Symbol Documentation