#include <kis_group_layer.h>

Inheritance diagram for KisGroupLayer:

Public Member Functions
bool	accept (KisNodeVisitor &v) override

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

bool	allowAsChild (KisNodeSP) const override

QRect	calculateChildrenLooseUserVisibleBounds () const

QRect	calculateChildrenTightUserVisibleBounds () const

KisNodeSP	clone () const override

const KoColorSpace *	colorSpace () const override

KisLayerSP	createMergedLayerTemplate (KisLayerSP prevLayer) override

KoColor	defaultProjectionColor () const

QRect	exactBounds () const override

QRect	extent () const override

void	fillMergedLayerTemplate (KisLayerSP dstLayer, KisLayerSP prevLayer, bool skipPaintingThisLayer) override

QIcon	icon () const override

	KisGroupLayer (const KisGroupLayer &rhs)

	KisGroupLayer (KisImageWSP image, const QString &name, quint8 opacity, const KoColorSpace *colorSpace=0)

KisPaintDeviceSP	lazyDestinationForSubtreeComposition () const

KisPaintDeviceSP	original () const override

std::tuple< KisPaintDeviceSP, bool >	originalImpl () const

KisPaintDeviceSP	paintDevice () const override
	Group layers don't have a paint device, so return 0.

bool	passThroughMode () const

	Private ()

bool	projectionIsValid () const

void	resetCache (const KoColorSpace *colorSpace)

KisBaseNode::PropertyList	sectionModelProperties () const override

void	setDefaultProjectionColor (KoColor color)

void	setImage (KisImageWSP image) override

void	setPassThroughMode (bool value)

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

void	setX (qint32 x) override

void	setY (qint32 y) override

qint32	x () const override

qint32	y () const override

	~KisGroupLayer () override

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

Public Member Functions inherited from KisLayer
bool	alphaChannelDisabled () const

void	buildProjectionUpToNode (KisPaintDeviceSP projection, KisNodeSP lastNode, const QRect &rect)

QBitArray &	channelFlags () const

KisFilterMaskSP	colorOverlayMask () const

const KoColorSpace *	colorSpace () const override
	returns the image's colorSpace or null, if there is no image

const KoCompositeOp *	compositeOp () const override
	returns the layer's composite op for the colorspace of the layer's parent.

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

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

void	disableAlphaChannel (bool disable)

QList< KisEffectMaskSP >	effectMasks () const

QList< KisEffectMaskSP >	effectMasks (KisNodeSP lastNode) const

QRect	exactBounds () const override

QRect	extent () const override

bool	hasClones () const

bool	hasEffectMasks () const

virtual KisLayerProjectionPlaneSP	internalProjectionPlane () const

	KisLayer (const KisLayer &rhs)

	KisLayer (KisImageWSP image, const QString &name, quint8 opacity)

KisPSDLayerStyleSP	layerStyle () const

QRect	looseUserVisibleBounds () const

KisMetaData::Store *	metaData ()

virtual bool	needProjection () const

void	notifyChildMaskChanged ()

KisLayerSP	parentLayer () const

QRect	partialChangeRect (KisNodeSP lastNode, const QRect &rect)

	Private (KisLayer *q)

KisPaintDeviceSP	projection () const override

KisAbstractProjectionPlaneSP	projectionPlane () const override

void	registerClone (KisCloneLayerWSP clone)

const QList< KisCloneLayerWSP >	registeredClones () const

KisBaseNode::PropertyList	sectionModelProperties () const override

virtual KisSelectionSP	selection () const

virtual KisSelectionMaskSP	selectionMask () const

virtual void	setChannelFlags (const QBitArray &channelFlags)

void	setImage (KisImageWSP image) override

void	setLayerStyle (KisPSDLayerStyleSP layerStyle)

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

void	setTemporary (bool t)

void	setX (qint32 x) override

void	setY (qint32 y) override

bool	temporary () const

int	thumbnailSeqNo () const override

QRect	tightUserVisibleBounds () const

void	unregisterClone (KisCloneLayerWSP clone)

void	updateClones (const QRect &rect, bool dontInvalidateFrames)

qint32	x () const override

qint32	y () const override

	~KisLayer () override

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

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)

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

virtual KisPaintDeviceSP	colorSampleSourceDevice () const

const QString &	compositeOpId () const

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)

virtual bool	supportsKeyframeChannel (const QString &id)

bool	supportsLodMoves () const

virtual bool	supportsLodPainting () 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 Attributes
KisPaintDeviceSP	paintDevice

bool	passThroughMode

qint32	x

qint32	y

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KisLayer
QBitArray	channelFlags

KisCloneLayersList	clonesList

KisPSDLayerStyleSP	layerStyle

KisLayerStyleProjectionPlaneSP	layerStyleProjectionPlane

KisLayerMasksCache	masksCache

KisMetaData::Store *	metaDataStore {nullptr}

KisLayerProjectionPlaneSP	projectionPlane

KisSafeNodeProjectionStoreSP	safeProjection

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}

Protected Member Functions
QRect	amortizedProjectionRectForCleanupInChangePass () const override

KisLayer *	onlyMeaningfulChild () const

std::tuple< KisPaintDeviceSP, bool >	originalImpl () const

KisPaintDeviceSP	tryObligeChild () const

Protected Member Functions inherited from KisLayer
QRect	applyMasks (const KisPaintDeviceSP source, KisPaintDeviceSP destination, const QRect &requestedRect, KisNodeSP filthyNode, KisNodeSP lastNode, KisRenderPassFlags flags) const

bool	canMergeAndKeepBlendOptions (KisLayerSP otherLayer)

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

void	childNodeChanged (KisNodeSP changedChildNode) override

virtual void	copyOriginalToProjection (const KisPaintDeviceSP original, KisPaintDeviceSP projection, const QRect &rect) const

virtual QRect	incomingChangeRect (const QRect &rect) const

QRect	masksChangeRect (const QList< KisEffectMaskSP > &masks, const QRect &requestedRect, bool &rectVariesFlag) const

QRect	masksNeedRect (const QList< KisEffectMaskSP > &masks, const QRect &changeRect, QStack< QRect > &applyRects, bool &rectVariesFlag) const

QRect	needRectForOriginal (const QRect &rect) const

virtual QRect	outgoingChangeRect (const QRect &rect) const

QList< KisEffectMaskSP >	searchEffectMasks (KisNodeSP lastNode) const

QRect	updateProjection (const QRect &rect, KisNodeSP filthyNode, KisRenderPassFlags flags)

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 KisFrameChangeUpdateRecipe	handleKeyframeChannelFrameAboutToBeRemovedImpl (const KisKeyframeChannel *channel, int time)

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

void	notifyParentVisibilityChanged (bool value) override

KisBaseNodeSP	parentCallback () const override

Protected Member Functions inherited from KisBaseNode
virtual KisKeyframeChannel *	requestKeyframeChannel (const QString &id)

void	setSupportsLodMoves (bool value)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Private Member Functions
bool	checkCloneLayer (KisCloneLayerSP clone) const

bool	checkNodeRecursively (KisNodeSP node) const

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

Signals inherited from KisNode
void	sigNodeChangedInternal ()

Signals inherited from KisBaseNode
void	keyframeChannelAdded (KisKeyframeChannel *channel)

void	opacityChanged (quint8 value)

Detailed Description

A KisLayer that bundles child layers into a single layer. The top layer is firstChild(), with index 0; the bottommost lastChild() with index childCount() - 1. KisLayer::nextSibling() moves towards higher indices, from the top to the bottom layer; prevSibling() the reverse. (Implementation detail: internally, the indices are reversed, for speed.)

Definition at line 32 of file kis_group_layer.cc.

Constructor & Destructor Documentation

◆ KisGroupLayer() [1/2]

KisGroupLayer::KisGroupLayer	(	KisImageWSP	image,
		const QString &	name,
		quint8	opacity,
		const KoColorSpace *	colorSpace = 0 )

Definition at line 51 of file kis_group_layer.cc.

                                                                                                                    :
    KisLayer(image, name, opacity),
    m_d(new Private())
{
    resetCache(colorSpace);
}

References colorSpace(), and resetCache().

◆ KisGroupLayer() [2/2]

KisGroupLayer::KisGroupLayer ( const KisGroupLayer & rhs )

Definition at line 58 of file kis_group_layer.cc.

                                                     :
    KisLayer(rhs),
    m_d(new Private())
{
    m_d->paintDevice = new KisPaintDevice(*rhs.m_d->paintDevice.data());
    m_d->x = rhs.m_d->x;
    m_d->y = rhs.m_d->y;
    m_d->paintDevice->setDefaultPixel(const_cast<KisGroupLayer*>(&rhs)->m_d->paintDevice->defaultPixel());
    m_d->paintDevice->setProjectionDevice(true);
    m_d->passThroughMode = rhs.passThroughMode();
}

References m_d, and passThroughMode.

◆ ~KisGroupLayer()

KisGroupLayer::~KisGroupLayer ( )

override

Definition at line 70 of file kis_group_layer.cc.

{
    delete m_d;
}

References m_d.

Member Function Documentation

◆ accept() [1/2]

bool KisGroupLayer::accept ( KisNodeVisitor & v )

overridevirtual

Accept the specified visitor.

Returns: true if the operation succeeded, false if it failed.

Reimplemented from KisBaseNode.

Definition at line 358 of file kis_group_layer.cc.

{
    return v.visit(this);
}

References v.

◆ accept() [2/2]

void KisGroupLayer::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 363 of file kis_group_layer.cc.

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

References KisProcessingVisitor::visit().

◆ allowAsChild()

bool KisGroupLayer::allowAsChild ( KisNodeSP ) const

overridevirtual

Re-implement this method to add constraints for the subclasses that can be added as children to this node

Returns: false if the given node is not allowed as a child to this node

Implements KisNode.

Definition at line 114 of file kis_group_layer.cc.

{
    if (!checkNodeRecursively(node)) return false;
 
    if (!parent()) {
        // We are the root layer, so we need to check
        // whether the node that's going to be added is
        // a selection mask; that is only allowed if
        // there isn't a global selection. See
        // BUG:294905
 
        if (node->inherits("KisSelectionMask")) {
            return !qobject_cast<KisSelectionMask*>(node.data())->active() || !selectionMask();
        }
 
        KisImageSP image = this->image();
 
        if (!image || !image->allowMasksOnRootNode()) {
            if (node->inherits("KisMask")) {
                return false;
            }
        }
    }
 
    return checkNodeRecursively(node);
 
}

References KisImage::allowMasksOnRootNode(), checkNodeRecursively(), KisSharedPtr< T >::data(), KisBaseNode::image, KisNode::parent, and KisLayer::selectionMask().

◆ amortizedProjectionRectForCleanupInChangePass()

QRect KisGroupLayer::amortizedProjectionRectForCleanupInChangePass ( ) const

overrideprotectedvirtual

Internal projection device that should be updated in the changeRect pass even when the change rect is cropped by masks or something like that

Reimplemented from KisLayer.

Definition at line 294 of file kis_group_layer.cc.

{
    return hasEffectMasks() ? projection()->exactBoundsAmortized() : m_d->paintDevice->exactBoundsAmortized();
}

References KisPaintDevice::exactBoundsAmortized(), KisLayer::hasEffectMasks(), m_d, and KisLayer::projection().

◆ calculateChildrenLooseUserVisibleBounds()

QRect KisGroupLayer::calculateChildrenLooseUserVisibleBounds ( ) const

Definition at line 445 of file kis_group_layer.cc.

{
    return collectRects(this, ExtentPolicy());
}

References collectRects().

◆ calculateChildrenTightUserVisibleBounds()

QRect KisGroupLayer::calculateChildrenTightUserVisibleBounds ( ) const

Definition at line 440 of file kis_group_layer.cc.

{
    return collectRects(this, ExactBoundsPolicy());
}

References collectRects().

◆ checkCloneLayer()

bool KisGroupLayer::checkCloneLayer ( KisCloneLayerSP clone ) const

private

Definition at line 75 of file kis_group_layer.cc.

{
    KisNodeSP source = clone->copyFrom();
    if (source) {
        if(!allowAsChild(source)) return false;
 
        if (source->inherits("KisGroupLayer")) {
            KisNodeSP newParent = const_cast<KisGroupLayer*>(this);
            while (newParent) {
                if (newParent == source) {
                    return false;
                }
                newParent = newParent->parent();
            }
        }
    }
 
    return true;
}

References allowAsChild(), clone(), KisNode::parent, and source().

◆ checkNodeRecursively()

bool KisGroupLayer::checkNodeRecursively ( KisNodeSP node ) const

private

Definition at line 95 of file kis_group_layer.cc.

{
    KisCloneLayerSP cloneLayer = dynamic_cast<KisCloneLayer*>(node.data());
    if(cloneLayer) {
        return checkCloneLayer(cloneLayer);
    }
    else if (node->inherits("KisGroupLayer")) {
        KisNodeSP child = node->firstChild();
        while (child) {
            if (!checkNodeRecursively(child)) {
                return false;
            }
            child = child->nextSibling();
        }
    }
 
    return true;
}

References checkCloneLayer(), checkNodeRecursively(), KisSharedPtr< T >::data(), KisNode::firstChild(), and KisNode::nextSibling().

◆ clone()

KisNodeSP KisGroupLayer::clone ( ) const

inlineoverridevirtual

Implements KisNode.

Definition at line 30 of file kis_group_layer.h.

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

◆ colorSpace()

const KoColorSpace * KisGroupLayer::colorSpace ( ) const

overridevirtual

XXX: make the colorspace of a layergroup user-settable: we want to be able to have, for instance, a group of grayscale layers resulting in a grayscale projection that is then merged with an rgb image stack.

Implements KisBaseNode.

Definition at line 142 of file kis_group_layer.cc.

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

References m_d.

◆ createMergedLayerTemplate()

KisLayerSP KisGroupLayer::createMergedLayerTemplate ( KisLayerSP prevLayer )

overridevirtual

Create and return a layer that is the result of merging this with layer.

This method is designed to be called only within KisImage::mergeLayerDown().

Descendants override this to create specific merged types when possible. The KisLayer one creates a KisPaintLayerSP via a bitBlt, and can work on all layer types.

Descendants that perform their own version do NOT call KisLayer::createMergedLayer

Reimplemented from KisLayer.

Definition at line 158 of file kis_group_layer.cc.

{
    KisGroupLayer *prevGroup = dynamic_cast<KisGroupLayer*>(prevLayer.data());
 
    if (prevGroup && canMergeAndKeepBlendOptions(prevLayer)) {
        KisSharedPtr<KisGroupLayer> merged(new KisGroupLayer(*prevGroup));
 
        KisNodeSP child, cloned;
 
        for (child = firstChild(); child; child = child->nextSibling()) {
            cloned = child->clone();
            image()->addNode(cloned, merged);
        }
 
        if (!merged->passThroughMode()) {
            image()->refreshGraphAsync(merged);
        }
 
        return merged;
    } else
        return KisLayer::createMergedLayerTemplate(prevLayer);
}

References KisNodeFacade::addNode(), KisLayer::canMergeAndKeepBlendOptions(), KisNode::clone(), KisLayer::createMergedLayerTemplate(), KisSharedPtr< T >::data(), KisNode::firstChild(), KisBaseNode::image, KisGroupLayer(), KisNode::nextSibling(), and KisImage::refreshGraphAsync().

◆ defaultProjectionColor()

KoColor KisGroupLayer::defaultProjectionColor ( ) const

See also: setDefaultProjectionColor()

Definition at line 314 of file kis_group_layer.cc.

{
    KoColor color(m_d->paintDevice->defaultPixel(), m_d->paintDevice->colorSpace());
    return color;
}

References m_d.

◆ exactBounds()

QRect KisGroupLayer::exactBounds ( ) const

overridevirtual

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

Reimplemented from KisBaseNode.

Definition at line 433 of file kis_group_layer.cc.

{
    return m_d->passThroughMode ?
        calculateChildrenTightUserVisibleBounds() :
        KisLayer::exactBounds();
}

References calculateChildrenTightUserVisibleBounds(), KisLayer::exactBounds(), and m_d.

◆ extent()

QRect KisGroupLayer::extent ( ) const

overridevirtual

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

Reimplemented from KisBaseNode.

Definition at line 426 of file kis_group_layer.cc.

{
    return m_d->passThroughMode ?
        calculateChildrenLooseUserVisibleBounds() :
        KisLayer::extent();
}

References calculateChildrenLooseUserVisibleBounds(), KisLayer::extent(), and m_d.

◆ fillMergedLayerTemplate()

void KisGroupLayer::fillMergedLayerTemplate	(	KisLayerSP	dstLayer,
		KisLayerSP	prevLayer,
		bool	skipPaintingThisLayer )

overridevirtual

Reimplemented from KisLayer.

Definition at line 181 of file kis_group_layer.cc.

{
    if (!dynamic_cast<KisGroupLayer*>(dstLayer.data())) {
        KisLayer::fillMergedLayerTemplate(dstLayer, prevLayer, skipPaintingThisLayer);
    }
}

References KisSharedPtr< T >::data(), and KisLayer::fillMergedLayerTemplate().

◆ icon()

QIcon KisGroupLayer::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 147 of file kis_group_layer.cc.

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

References KisIconUtils::loadIcon().

◆ lazyDestinationForSubtreeComposition()

KisPaintDeviceSP KisGroupLayer::lazyDestinationForSubtreeComposition ( ) const

Returns own original device when tryOblidgeChild() mechanism is not triggered. When tryOblidgeChild() mechanism is in action, returns null (therefor there is no need to do subtree composition).

Definition at line 285 of file kis_group_layer.cc.

{
    KisPaintDeviceSP originalDev;
    bool ownsOriginal = false;
    std::tie(originalDev, ownsOriginal) = originalImpl();
 
    return ownsOriginal ? originalDev : nullptr;
}

References originalImpl().

◆ onlyMeaningfulChild()

KisLayer * KisGroupLayer::onlyMeaningfulChild ( ) const

protected

Definition at line 214 of file kis_group_layer.cc.

{
    KisNode *child = firstChild().data();
    KisLayer *onlyLayer = 0;
 
    while (child) {
        KisLayer *layer = qobject_cast<KisLayer*>(child);
        if (layer && !layer->isFakeNode()) {
            if (onlyLayer) return 0;
            onlyLayer = layer;
        }
        child = child->nextSibling().data();
    }
 
    return onlyLayer;
}

References KisSharedPtr< T >::data(), KisNode::firstChild(), KisBaseNode::isFakeNode(), and KisNode::nextSibling().

◆ original()

KisPaintDeviceSP KisGroupLayer::original ( ) const

overridevirtual

Returns: the projection of the layers in the group before the masks are applied.

Implements KisLayer.

Definition at line 280 of file kis_group_layer.cc.

{
    return std::get<0>(originalImpl());
}

References originalImpl().

◆ originalImpl() [1/2]

std::tuple< KisPaintDeviceSP, bool > KisGroupLayer::originalImpl ( ) const

We are too lazy! Let's our children work for us. Try to use children's paintDevice if it's the only one in stack and meets some conditions

Definition at line 259 of file kis_group_layer.cc.

{
    KisPaintDeviceSP realOriginal = tryObligeChild();
    bool ownsOriginal = false;
 
    if (!realOriginal) {
        if (!childCount() && !m_d->paintDevice->extent().isEmpty()) {
            m_d->paintDevice->clear();
        }
        realOriginal = m_d->paintDevice;
        ownsOriginal = true;
    }
 
    return std::make_tuple(realOriginal, ownsOriginal);
}

References KisNode::childCount(), m_d, and tryObligeChild().

◆ originalImpl() [2/2]

std::tuple< KisPaintDeviceSP, bool > KisGroupLayer::originalImpl ( ) const

protected

◆ paintDevice()

KisPaintDeviceSP KisGroupLayer::paintDevice ( ) const

overridevirtual

Group layers don't have a paint device, so return 0.

Implements KisBaseNode.

◆ passThroughMode()

bool KisGroupLayer::passThroughMode ( ) const

◆ Private()

KisGroupLayer::Private ( )

inline

Definition at line 35 of file kis_group_layer.cc.

        : paintDevice(0)
        , x(0)
        , y(0)
        , passThroughMode(false)
    {
    }

◆ projectionIsValid()

bool KisGroupLayer::projectionIsValid ( ) const

Definition at line 304 of file kis_group_layer.cc.

{
    return !tryObligeChild();
}

References tryObligeChild().

◆ resetCache()

void KisGroupLayer::resetCache ( const KoColorSpace * colorSpace )

Clear the projection

Definition at line 188 of file kis_group_layer.cc.

{
    if (!colorSpace)
        colorSpace = image()->colorSpace();
 
    Q_ASSERT(colorSpace);
 
    if (!m_d->paintDevice) {
 
        KisPaintDeviceSP dev = new KisPaintDevice(this, colorSpace, new KisDefaultBounds(image()));
        dev->setX(this->x());
        dev->setY(this->y());
        m_d->paintDevice = dev;
        m_d->paintDevice->setProjectionDevice(true);
    }
    else if(*m_d->paintDevice->colorSpace() != *colorSpace) {
 
        m_d->paintDevice->clear();
        m_d->paintDevice->convertTo(colorSpace);
 
    } else {
 
        m_d->paintDevice->clear();
    }
}

References KisImage::colorSpace(), colorSpace(), KisBaseNode::image, m_d, KisPaintDevice::setX(), KisPaintDevice::setY(), x, and y.

◆ sectionModelProperties()

KisBaseNode::PropertyList KisGroupLayer::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 338 of file kis_group_layer.cc.

{
    KisBaseNode::PropertyList l = KisLayer::sectionModelProperties();
 
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::passThrough, passThroughMode());
 
    return l;
}

References KisLayerPropertiesIcons::getProperty(), KisLayerPropertiesIcons::passThrough, passThroughMode, and KisLayer::sectionModelProperties().

◆ setDefaultProjectionColor()

void KisGroupLayer::setDefaultProjectionColor ( KoColor color )

A special method that changes the default color of the projection merged onto this group layer. Please note, that you cannot use original()->setDefaultPixel(), because original() device can be switched by tryOblidgeChild() mechanism randomly.

Definition at line 309 of file kis_group_layer.cc.

{
    m_d->paintDevice->setDefaultPixel(color);
}

References m_d.

◆ setImage()

void KisGroupLayer::setImage ( KisImageWSP image )

overridevirtual

Reimplemented from KisBaseNode.

Definition at line 152 of file kis_group_layer.cc.

{
    m_d->paintDevice->setDefaultBounds(new KisDefaultBounds(image));
    KisLayer::setImage(image);
}

References KisBaseNode::image, m_d, and KisLayer::setImage().

◆ setPassThroughMode()

void KisGroupLayer::setPassThroughMode ( bool value )

Definition at line 325 of file kis_group_layer.cc.

{
    if (m_d->passThroughMode == value) return;
 
    m_d->passThroughMode = value;
    if (m_d->passThroughMode) {
        resetCache(colorSpace());
    }
    baseNodeChangedCallback();
    baseNodeInvalidateAllFramesCallback();
    notifyChildMaskChanged();
}

References KisNode::baseNodeChangedCallback(), KisNode::baseNodeInvalidateAllFramesCallback(), colorSpace(), m_d, KisLayer::notifyChildMaskChanged(), resetCache(), and value().

◆ setSectionModelProperties()

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

overridevirtual

Change the section model properties.

Reimplemented from KisBaseNode.

Definition at line 347 of file kis_group_layer.cc.

{
    Q_FOREACH (const KisBaseNode::Property &property, properties) {
        if (property.name == i18n("Pass Through")) {
            setPassThroughMode(property.state.toBool());
        }
    }
 
    KisLayer::setSectionModelProperties(properties);
}

References KisBaseNode::Property::name, KisBaseNode::properties, setPassThroughMode(), KisLayer::setSectionModelProperties(), and KisBaseNode::Property::state.

◆ setX()

void KisGroupLayer::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 378 of file kis_group_layer.cc.

{
    m_d->x = x;
    if(m_d->paintDevice) {
        m_d->paintDevice->setX(x);
    }
}

References m_d, and x.

◆ setY()

void KisGroupLayer::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 386 of file kis_group_layer.cc.

{
    m_d->y = y;
    if(m_d->paintDevice) {
        m_d->paintDevice->setY(y);
    }
}

References m_d, and y.

◆ tryObligeChild()

KisPaintDeviceSP KisGroupLayer::tryObligeChild ( ) const

protected

Definition at line 231 of file kis_group_layer.cc.

{
    KisLayer *child = onlyMeaningfulChild();
 
    if (child) {
        KisPaintDeviceSP projection = child->projection();
        if (child->channelFlags().isEmpty() &&
                projection &&
                child->visible() &&
                (child->compositeOpId() == COMPOSITE_OVER ||
                 child->compositeOpId() == COMPOSITE_ALPHA_DARKEN ||
                 child->compositeOpId() == COMPOSITE_COPY) &&
                child->opacity() == OPACITY_OPAQUE_U8 &&
                *projection->colorSpace() == *colorSpace() &&
                !child->layerStyle()) {
 
            quint8 defaultOpacity =
                    m_d->paintDevice->defaultPixel().opacityU8();
 
            if(defaultOpacity == OPACITY_TRANSPARENT_U8) {
                return projection;
            }
        }
    }
 
    return 0;
}

References KisLayer::channelFlags, KisPaintDevice::colorSpace(), colorSpace(), COMPOSITE_ALPHA_DARKEN, COMPOSITE_COPY, COMPOSITE_OVER, KisBaseNode::compositeOpId(), KisLayer::layerStyle, m_d, onlyMeaningfulChild(), KisBaseNode::opacity(), OPACITY_OPAQUE_U8, OPACITY_TRANSPARENT_U8, KisLayer::projection(), and KisBaseNode::visible().

◆ x()

qint32 KisGroupLayer::x ( ) const

overridevirtual

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

Reimplemented from KisBaseNode.

◆ y()

qint32 KisGroupLayer::y ( ) const

overridevirtual

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

Reimplemented from KisBaseNode.

Member Data Documentation

◆ m_d

Private* const KisGroupLayer::m_d

private

Definition at line 120 of file kis_group_layer.h.

◆ paintDevice

KisPaintDeviceSP KisGroupLayer::paintDevice

Definition at line 43 of file kis_group_layer.cc.

◆ passThroughMode

bool KisGroupLayer::passThroughMode

Definition at line 46 of file kis_group_layer.cc.

◆ x

qint32 KisGroupLayer::x

Definition at line 44 of file kis_group_layer.cc.

◆ y

qint32 KisGroupLayer::y

Definition at line 45 of file kis_group_layer.cc.

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

libs/image/kis_group_layer.cc
libs/image/kis_group_layer.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisGroupLayer() [1/2]

◆ KisGroupLayer() [2/2]

◆ ~KisGroupLayer()

Member Function Documentation

◆ accept() [1/2]

◆ accept() [2/2]

◆ allowAsChild()

◆ amortizedProjectionRectForCleanupInChangePass()

◆ calculateChildrenLooseUserVisibleBounds()

◆ calculateChildrenTightUserVisibleBounds()

◆ checkCloneLayer()

◆ checkNodeRecursively()

◆ clone()

◆ colorSpace()

◆ createMergedLayerTemplate()

◆ defaultProjectionColor()

◆ exactBounds()

◆ extent()

◆ fillMergedLayerTemplate()

◆ icon()

◆ lazyDestinationForSubtreeComposition()

◆ onlyMeaningfulChild()

◆ original()

◆ originalImpl() [1/2]

◆ originalImpl() [2/2]

◆ paintDevice()

◆ passThroughMode()

◆ Private()

◆ projectionIsValid()

◆ resetCache()

◆ sectionModelProperties()

◆ setDefaultProjectionColor()

◆ setImage()

◆ setPassThroughMode()

◆ setSectionModelProperties()

◆ setX()

◆ setY()

◆ tryObligeChild()

◆ x()

◆ y()

Member Data Documentation

◆ m_d

◆ paintDevice

◆ passThroughMode

◆ x

◆ y