#include <kis_selection_mask.h>

Inheritance diagram for KisSelectionMask:

Public Member Functions
bool	accept (KisNodeVisitor &v) override

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

bool	active () const

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

KisNodeSP	clone () const override

bool	decorationsVisible () const override

QRect	exactBounds () const override

QRect	extent () const override

QIcon	icon () const override

	KisSelectionMask (const KisSelectionMask &rhs)

	KisSelectionMask (KisImageWSP image, const QString &name=QString())

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

void	notifySelectionChangedCompressed ()

	Private (KisSelectionMask *_q)

KisBaseNode::PropertyList	sectionModelProperties () const override

void	setActive (bool active)

void	setDecorationsVisible (bool value)

void	setDecorationsVisible (bool value, bool update) override

virtual void	setDecorationsVisible (bool value, bool update)=0

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

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

void	setSelection (KisSelectionSP selection)
	Set the selection of this adjustment layer to a copy of selection.

void	setVisible (bool visible, bool isLoading=false) override

void	slotConfigChanged ()

void	slotConfigChangedImpl (bool blockUpdates)

void	slotSelectionChangedCompressed ()

	~KisSelectionMask () override

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

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

	KisEffectMask (const KisEffectMask &rhs)

	KisEffectMask (KisImageWSP image, const QString &name)

	~KisEffectMask () override

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

const KoColorSpace *	colorSpace () const override

const KoCompositeOp *	compositeOp () const override

QImage	createThumbnail (qint32 w, qint32 h, Qt::AspectRatioMode aspectRatioMode, KisThumbnailBoundsMode boundsMode) 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)

virtual QRect	nonDependentExtent () const

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 KisNode
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

virtual KisPaintDeviceList	getLodCapableDevices () 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)

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

virtual KisPaintDeviceSP	colorSampleSourceDevice () const

const QString &	compositeOpId () const

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

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

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

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

KisThumbnailBoundsMode	preferredThumbnailBoundsMode () 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)

void	setPreferredThumbnailBoundsMode (KisThumbnailBoundsMode value) const

virtual void	setUserLocked (bool l)

void	setUuid (const QUuid &id)

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)

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

virtual void	setCurrentColor (const KoColor &color)

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

virtual bool	supportsNonIndirectPainting () const

KisPaintDeviceSP	temporaryTarget () const

FinalMergeSuspenderSP	trySuspendFinalMerge ()

virtual	~KisIndirectPaintingSupport ()

Public Member Functions inherited from KisDecoratedNodeInterface
void	setDecorationsVisible (bool value)

virtual	~KisDecoratedNodeInterface ()

Public Attributes
KisCachedSelection	cachedSelection

KoColor	maskColor

KisCachedPaintDevice	paintDeviceCache

KisSelectionMask *	q

KisThreadSafeSignalCompressor *	updatesCompressor

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KisMask
QScopedPointer< QPoint >	deferredSelectionOffset

KisCachedPaintDevice	paintDeviceCache

KisAbstractProjectionPlaneSP	projectionPlane

KisMask *	q

KisSafeSelectionNodeProjectionStoreSP	safeProjection

KisSelectionSP	selection

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}

KisThumbnailBoundsMode	thumbnailBoundsMode { KisThumbnailBoundsMode::Precise }

Public Attributes inherited from KisIndirectPaintingSupport
QBitArray	channelFlags

QString	compositeOp

qreal	compositeOpacity

bool	finalMergeInProgress = true

QReadWriteLock	lock

KisSelectionSP	selection

KisPaintDeviceSP	temporaryTarget

Protected Member Functions
void	flattenSelectionProjection (KisSelectionSP selection, const QRect &dirtyRect) const override

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

bool	paintsOutsideSelection () const override

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 QRect	decorateRect (KisPaintDeviceSP &src, KisPaintDeviceSP &dst, const QRect &rc, PositionToFilthy maskPos, KisRenderPassFlags flags) 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

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

Private Attributes
Private *const	m_d

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>

Signals inherited from KisNode
void	sigNodeChangedInternal ()

Signals inherited from KisBaseNode
void	keyframeChannelAdded (KisKeyframeChannel *channel)

void	opacityChanged (quint8 value)

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

Detailed Description

An selection mask is a single channel mask that applies a particular selection to the layer the mask belongs to. A selection can contain both vector and pixel selection components.

Definition at line 32 of file kis_selection_mask.cpp.

Constructor & Destructor Documentation

◆ KisSelectionMask() [1/2]

KisSelectionMask::KisSelectionMask	(	KisImageWSP	image,
		const QString &	name = QString() )

Create an empty selection mask. There is filter and no layer associated with this mask.

Definition at line 51 of file kis_selection_mask.cpp.

    : KisEffectMask(image, name)
    , m_d(new Private(this))
{
    setActive(false);
    setSupportsLodMoves(false);
 
    m_d->updatesCompressor =
            new KisThreadSafeSignalCompressor(50, KisSignalCompressor::FIRST_ACTIVE);
 
    connect(m_d->updatesCompressor, SIGNAL(timeout()), SLOT(slotSelectionChangedCompressed()));
 
    connect(KisImageConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(slotConfigChanged()));
    m_d->slotConfigChangedImpl(false);
}

References KisSignalCompressor::FIRST_ACTIVE, KisImageConfigNotifier::instance(), m_d, setActive(), KisBaseNode::setSupportsLodMoves(), slotConfigChanged(), and slotSelectionChangedCompressed().

◆ ~KisSelectionMask()

KisSelectionMask::~KisSelectionMask ( )

override

Definition at line 80 of file kis_selection_mask.cpp.

{
    m_d->updatesCompressor->deleteLater();
    delete m_d;
}

References m_d.

◆ KisSelectionMask() [2/2]

KisSelectionMask::KisSelectionMask ( const KisSelectionMask & rhs )

Definition at line 67 of file kis_selection_mask.cpp.

    : KisEffectMask(rhs)
    , m_d(new Private(this))
{
    m_d->updatesCompressor =
            new KisThreadSafeSignalCompressor(300, KisSignalCompressor::POSTPONE);
 
    connect(m_d->updatesCompressor, SIGNAL(timeout()), SLOT(slotSelectionChangedCompressed()));
 
    connect(KisImageConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(slotConfigChanged()));
    m_d->slotConfigChangedImpl(false);
}

References KisImageConfigNotifier::instance(), m_d, KisSignalCompressor::POSTPONE, slotConfigChanged(), and slotSelectionChangedCompressed().

Member Function Documentation

◆ accept() [1/2]

bool KisSelectionMask::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 KisNode.

Definition at line 156 of file kis_selection_mask.cpp.

{
    return v.visit(this);
}

References v.

◆ accept() [2/2]

void KisSelectionMask::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 KisNode.

Definition at line 161 of file kis_selection_mask.cpp.

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

References KisProcessingVisitor::visit().

◆ active()

bool KisSelectionMask::active ( ) const

Definition at line 190 of file kis_selection_mask.cpp.

{
    return nodeProperties().boolProperty("active", true);
}

References KoProperties::boolProperty(), and KisBaseNode::nodeProperties().

◆ changeRect()

QRect KisSelectionMask::changeRect	(	const QRect &	rect,
		KisNode::PositionToFilthy	pos = N_FILTHY ) const

overridevirtual

Returns: internal changeRect() of the node. Do not mix with

See also: projectionPlane()

Some filters will cause a change of pixels those are outside a requested rect. E.g. we change a rect of 2x2, then we want to apply a convolution filter with kernel 4x4 (changeRect is (2+2*3)x(2+2*3)=8x8) to that area. The rect that should be updated on the layer will be exactly 8x8. More than that the needRect for that update will be 14x14. See needRect.

Reimplemented from KisMask.

Definition at line 233 of file kis_selection_mask.cpp.

{
    Q_UNUSED(pos);
 
    // selection masks just add an overlay, so the changed rect is simply passed through
    return rect;
}

◆ clone()

KisNodeSP KisSelectionMask::clone ( ) const

inlineoverridevirtual

Implements KisNode.

Definition at line 38 of file kis_selection_mask.h.

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

◆ decorationsVisible()

bool KisSelectionMask::decorationsVisible ( ) const

overridevirtual

Returns: true is the layer is allowed to write its decorative information into the stack. The value should be "true" by default.

Implements KisDecoratedNodeInterface.

Definition at line 275 of file kis_selection_mask.cpp.

{
    return selection()->isVisible();
}

References KisSelection::isVisible, and KisMask::selection.

◆ exactBounds()

QRect KisSelectionMask::exactBounds ( ) const

overridevirtual

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

Reimplemented from KisMask.

Definition at line 265 of file kis_selection_mask.cpp.

{
    return extent();
}

References extent().

◆ extent()

QRect KisSelectionMask::extent ( ) const

overridevirtual

The extent and bounds of the mask are those of the selection inside

Reimplemented from KisMask.

Definition at line 241 of file kis_selection_mask.cpp.

{
    // since mask overlay is inverted, the mask paints over
    // the entire image bounds
    QRect resultRect;
    KisSelectionSP selection = this->selection();
    
    if (selection) {
        resultRect = selection->pixelSelection()->defaultBounds()->bounds();
        
        if (KisNodeSP parent = this->parent()) {
            resultRect |= parent->extent();
        }
        
    } else if (KisNodeSP parent = this->parent()) {
        KisPaintDeviceSP dev = parent->projection();
        if (dev) {
            resultRect = dev->defaultBounds()->bounds();
        }
    }
 
    return resultRect;
}

References KisDefaultBoundsBase::bounds(), KisPaintDevice::defaultBounds(), KisBaseNode::extent(), KisNode::parent, KisSelection::pixelSelection, KisBaseNode::projection(), and KisMask::selection.

◆ flattenSelectionProjection()

void KisSelectionMask::flattenSelectionProjection	(	KisSelectionSP	selection,
		const QRect &	dirtyRect ) const

overrideprotectedvirtual

A special callback for calling selection->updateProjection() during the projection calculation process. Some masks (e.g. selection masks) don't need it, because they do it separately.

Reimplemented from KisMask.

Definition at line 302 of file kis_selection_mask.cpp.

{
    Q_UNUSED(selection);
    Q_UNUSED(dirtyRect);
}

References KisMask::selection.

◆ icon()

QIcon KisSelectionMask::icon ( ) const

overridevirtual

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

Reimplemented from KisEffectMask.

Definition at line 86 of file kis_selection_mask.cpp.

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

References KisIconUtils::loadIcon().

◆ mergeInMaskInternal()

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

overrideprotectedvirtual

Reimplemented from KisMask.

Definition at line 90 of file kis_selection_mask.cpp.

{
    Q_UNUSED(maskPos);
    Q_UNUSED(preparedNeedRect);
    Q_UNUSED(flags);
 
    if (!effectiveSelection) return;
 
    {
        KisSelectionSP mainMaskSelection = this->selection();
        if (mainMaskSelection &&
            (!mainMaskSelection->isVisible() ||
             mainMaskSelection->pixelSelection()->defaultBounds()->externalFrameActive())) {
 
            return;
        }
    }
 
    KisCachedPaintDevice::Guard d1(projection, m_d->paintDeviceCache);
    KisPaintDeviceSP fillDevice = d1.device();
    fillDevice->setDefaultPixel(m_d->maskColor);
 
    const QRect selectionExtent = effectiveSelection->selectedRect();
 
    if (selectionExtent.contains(applyRect) || selectionExtent.intersects(applyRect)) {
        KisCachedSelection::Guard s1(m_d->cachedSelection);
        KisSelectionSP invertedSelection = s1.selection();
 
        invertedSelection->pixelSelection()->makeCloneFromRough(effectiveSelection->pixelSelection(), applyRect);
        invertedSelection->pixelSelection()->invert();
 
        KisPainter gc(projection);
        gc.setSelection(invertedSelection);
        gc.bitBlt(applyRect.topLeft(), fillDevice, applyRect);
 
    } else {
        KisPainter gc(projection);
        gc.bitBlt(applyRect.topLeft(), fillDevice, applyRect);
    }
}

References KisPainter::bitBlt(), KisPaintDevice::defaultBounds(), KisCachedPaintDevice::Guard::device(), KisDefaultBoundsBase::externalFrameActive(), KisPixelSelection::invert(), KisSelection::isVisible, m_d, KisPaintDevice::makeCloneFromRough(), KisSelection::pixelSelection, KisMask::projection(), s1, KisSelection::selectedRect(), KisMask::selection, KisPaintDevice::setDefaultPixel(), and KisPainter::setSelection().

◆ needRect()

QRect KisSelectionMask::needRect	(	const QRect &	rect,
		KisNode::PositionToFilthy	pos = N_FILTHY ) const

overridevirtual

Returns: internal needRect() of the node. Do not mix with

See also: projectionPlane()

Some filters need pixels outside the current processing rect to compute the new value (for instance, convolution filters) See changeRect See accessRect

Reimplemented from KisMask.

Definition at line 225 of file kis_selection_mask.cpp.

{
    Q_UNUSED(pos);
    
    // selection masks just add an overlay, so the needed rect is simply passed through
    return rect;
}

◆ notifySelectionChangedCompressed()

void KisSelectionMask::notifySelectionChangedCompressed ( )

This method works like the one in KisSelection, but it compressed the incoming events instead of processing each of them separately.

Definition at line 270 of file kis_selection_mask.cpp.

{
    m_d->updatesCompressor->start();
}

References m_d.

◆ paintsOutsideSelection()

bool KisSelectionMask::paintsOutsideSelection ( ) const

overrideprotectedvirtual

Reimplemented from KisMask.

Definition at line 136 of file kis_selection_mask.cpp.

{
    return true;
}

◆ Private()

KisSelectionMask::Private ( KisSelectionMask * _q )

inline

Definition at line 35 of file kis_selection_mask.cpp.

        : q(_q)
        , updatesCompressor(0)
        , maskColor(Qt::green, KoColorSpaceRegistry::instance()->rgb8())
    {}

◆ sectionModelProperties()

KisBaseNode::PropertyList KisSelectionMask::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 166 of file kis_selection_mask.cpp.

{
    KisBaseNode::PropertyList l = KisBaseNode::sectionModelProperties();
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::selectionActive, active());
    return l;
}

References active(), KisLayerPropertiesIcons::getProperty(), KisBaseNode::sectionModelProperties(), and KisLayerPropertiesIcons::selectionActive.

◆ setActive()

void KisSelectionMask::setActive ( bool active )

WARNING: we have a direct link to the image here, but we must not use it for notification until we are a part of the node graph! Notifications should be emitted iff we have graph listener link set up.

Definition at line 195 of file kis_selection_mask.cpp.

{
    KisImageSP image = this->image();
    KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent().data());
 
    if (active && parentLayer) {
        KisSelectionMaskSP activeMask = parentLayer->selectionMask();
        if (activeMask && activeMask != this) {
            activeMask->setActive(false);
        }
    }
 
    const bool oldActive = this->active();
    setNodeProperty("active", active);
 
 
    if (graphListener() &&
        image && oldActive != active) {
 
        baseNodeChangedCallback();
        image->undoAdapter()->emitSelectionChanged();
    }
}

References active(), KisMask::baseNodeChangedCallback(), KisUndoAdapter::emitSelectionChanged(), KisNode::graphListener, KisBaseNode::image, KisNode::parent, KisLayer::selectionMask(), setActive(), KisBaseNode::setNodeProperty(), and KisImage::undoAdapter().

◆ setDecorationsVisible() [1/3]

void KisDecoratedNodeInterface::setDecorationsVisible ( bool value )

Convenience override for setDecorationsVisible()

Definition at line 38 of file KisDecoratedNodeInterface.cpp.

{
    setDecorationsVisible(value, true);
}

◆ setDecorationsVisible() [2/3]

void KisSelectionMask::setDecorationsVisible	(	bool	value,
		bool	update )

overridevirtual

Enable or disable writing decorative information into layer stack.

Implements KisDecoratedNodeInterface.

Definition at line 280 of file kis_selection_mask.cpp.

{
    if (value == decorationsVisible()) return;
 
    const QRect oldExtent = extent();
 
    selection()->setVisible(value);
 
    if (update) {
        setDirty(oldExtent | extent());
    }
}

References decorationsVisible(), extent(), KisMask::selection, KisNode::setDirty(), KisSelection::setVisible(), and value().

◆ setDecorationsVisible() [3/3]

virtual void KisDecoratedNodeInterface::setDecorationsVisible	(	bool	value,
		bool	update )

virtual

Enable or disable writing decorative information into layer stack.

Implements KisDecoratedNodeInterface.

◆ setDirty()

void KisSelectionMask::setDirty ( const QVector< QRect > & rects )

overridevirtual

Add the given rects to the set of dirty rects for this node; this percolates up to parent nodes all the way to the root node.

Reimplemented from KisNode.

Definition at line 293 of file kis_selection_mask.cpp.

{
    KisImageSP image = this->image();
 
    if (image && image->overlaySelectionMask() == this) {
        KisEffectMask::setDirty(rects);
    }
}

References KisBaseNode::image, KisImage::overlaySelectionMask(), and KisNode::setDirty().

◆ setSectionModelProperties()

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

overridevirtual

Change the section model properties.

Reimplemented from KisBaseNode.

Definition at line 173 of file kis_selection_mask.cpp.

{
    KisEffectMask::setSectionModelProperties(properties);
    setActive(properties.at(2).state.toBool());
}

References KisBaseNode::properties, setActive(), and KisBaseNode::setSectionModelProperties().

◆ setSelection()

void KisSelectionMask::setSelection ( KisSelectionSP selection )

Set the selection of this adjustment layer to a copy of selection.

Definition at line 141 of file kis_selection_mask.cpp.

{
    if (selection) {
        KisEffectMask::setSelection(selection);
    } else {
        KisEffectMask::setSelection(new KisSelection());
 
        const KoColorSpace * cs = KoColorSpaceRegistry::instance()->alpha8();
        KisFillPainter gc(KisPaintDeviceSP(this->selection()->pixelSelection().data()));
        gc.fillRect(image()->bounds(), KoColor(Qt::white, cs), MAX_SELECTED);
        gc.end();
    }
    setDirty();
}

References KoColorSpaceRegistry::alpha8(), bounds, KisPainter::end(), KisFillPainter::fillRect(), KisBaseNode::image, KoColorSpaceRegistry::instance(), MAX_SELECTED, KisMask::selection, KisNode::setDirty(), and KisMask::setSelection().

◆ setVisible()

void KisSelectionMask::setVisible	(	bool	visible,
		bool	loading = false )

overridevirtual

Set the visible status of this node. Visible nodes are active in the graph (except for selections masks which can be active while hidden), that is to say, they are taken into account when merging. Invisible nodes play no role in the final image , but will be modified when modifying all layers, for instance when cropping.

Toggling the visibility of a node will not automatically lead to recomposition.

Parameters

visible	the new visibility state
isLoading	if true, the property is set during loading.

Reimplemented from KisBaseNode.

Definition at line 179 of file kis_selection_mask.cpp.

{
    const bool oldVisible = this->visible(false);
    setNodeProperty("visible", visible);
 
    if (!isLoading && visible != oldVisible) {
        if (selection())
            selection()->setVisible(visible);
    }
}

References KisMask::selection, KisBaseNode::setNodeProperty(), KisSelection::setVisible(), and KisBaseNode::visible().

◆ slotConfigChanged()

void KisSelectionMask::slotConfigChanged ( )

◆ slotConfigChangedImpl()

void KisSelectionMask::slotConfigChangedImpl ( bool blockUpdates )

◆ slotSelectionChangedCompressed()

void KisSelectionMask::slotSelectionChangedCompressed ( )

Member Data Documentation

◆ cachedSelection

KisCachedSelection KisSelectionMask::cachedSelection

Definition at line 42 of file kis_selection_mask.cpp.

◆ m_d

Private* const KisSelectionMask::m_d

private

Definition at line 91 of file kis_selection_mask.h.

◆ maskColor

KoColor KisSelectionMask::maskColor

Definition at line 44 of file kis_selection_mask.cpp.

◆ paintDeviceCache

KisCachedPaintDevice KisSelectionMask::paintDeviceCache

Definition at line 41 of file kis_selection_mask.cpp.

◆ q

KisSelectionMask* KisSelectionMask::q

Definition at line 40 of file kis_selection_mask.cpp.

◆ updatesCompressor

KisThreadSafeSignalCompressor* KisSelectionMask::updatesCompressor

Definition at line 43 of file kis_selection_mask.cpp.

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

libs/image/kis_selection_mask.cpp
libs/image/kis_selection_mask.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisSelectionMask() [1/2]

◆ ~KisSelectionMask()

◆ KisSelectionMask() [2/2]

Member Function Documentation

◆ accept() [1/2]

◆ accept() [2/2]

◆ active()

◆ changeRect()

◆ clone()

◆ decorationsVisible()

◆ exactBounds()

◆ extent()

◆ flattenSelectionProjection()

◆ icon()

◆ mergeInMaskInternal()

◆ needRect()

◆ notifySelectionChangedCompressed()

◆ paintsOutsideSelection()

◆ Private()

◆ sectionModelProperties()

◆ setActive()

◆ setDecorationsVisible() [1/3]

◆ setDecorationsVisible() [2/3]

◆ setDecorationsVisible() [3/3]

◆ setDirty()

◆ setSectionModelProperties()

◆ setSelection()

◆ setVisible()

◆ slotConfigChanged()

◆ slotConfigChangedImpl()

◆ slotSelectionChangedCompressed()

Member Data Documentation

◆ cachedSelection

◆ m_d

◆ maskColor

◆ paintDeviceCache

◆ q

◆ updatesCompressor