KisProjectionLeaf Class Reference

#include <kis_projection_leaf.h>

Inheritance diagram for KisProjectionLeaf:

Public Types
enum	NodeDropReason { NodeAvailable , DropPassThroughMask , DropPassThroughClone }

Public Member Functions
bool	accept (KisNodeVisitor &visitor)
bool	canHaveChildLayers () const
QBitArray	channelFlags () const
bool	checkParentPassThrough ()
bool	checkThisPassThrough ()
bool	dependsOnLowerNodes () const
NodeDropReason	dropReason () const
void	explicitlyRegeneratePassThroughProjection ()
KisNodeSP	findRoot () const
KisProjectionLeafSP	firstChild () const
bool	hasClones () const
bool	isDroppedNode () const
bool	isLayer () const
bool	isMask () const
bool	isOverlayProjectionLeaf () const
bool	isRoot () const
bool	isStillInGraph () const
bool	isTemporaryHiddenFromRendering () const
bool	isTopmostNode () const
	KisProjectionLeaf (KisNode *node)
KisProjectionLeafSP	lastChild () const
KisPaintDeviceSP	lazyDestinationForSubtreeComposition ()
KisProjectionLeafSP	nextSibling () const
KisNodeSP	node () const
quint8	opacity () const
KisPaintDeviceSP	original ()
KisProjectionLeafSP	overlayProjectionLeaf () const
KisProjectionLeafSP	parent () const
KisProjectionLeafSP	prevSibling () const
	Private (KisNode *_node)
KisPaintDeviceSP	projection ()
KisAbstractProjectionPlaneSP	projectionPlane () const
void	setTemporaryHiddenFromRendering (bool value)
bool	shouldBeRendered () const
void	temporarySetPassThrough (bool value)
bool	visible () const
virtual	~KisProjectionLeaf ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Static Public Member Functions
static bool	checkPassThrough (const KisNode *node)
static bool	isSelectionMask (const KisNode *node)
static KisNodeSP	skipSelectionMasksBackward (KisNodeSP node)
static KisNodeSP	skipSelectionMasksForward (KisNodeSP node)

Public Attributes
bool	isTemporaryHidden = false
KisNodeWSP	node
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 26 of file kis_projection_leaf.cpp.

Member Enumeration Documentation

NodeDropReason

enum KisProjectionLeaf::NodeDropReason

Enumerator
NodeAvailable
DropPassThroughMask
DropPassThroughClone

Definition at line 59 of file kis_projection_leaf.h.

                        {
        NodeAvailable,
        DropPassThroughMask,
        DropPassThroughClone
    };

Constructor & Destructor Documentation

KisProjectionLeaf()

KisProjectionLeaf::KisProjectionLeaf

(

KisNode *

node

)

Definition at line 93 of file kis_projection_leaf.cpp.

    : m_d(new Private(node))
{
}

~KisProjectionLeaf()

KisProjectionLeaf::~KisProjectionLeaf ( )

virtual

Definition at line 98 of file kis_projection_leaf.cpp.

{
}

Member Function Documentation

accept()

bool KisProjectionLeaf::accept

(

KisNodeVisitor &

visitor

)

Definition at line 233 of file kis_projection_leaf.cpp.

{
    return m_d->node->accept(visitor);
}

References m_d.

canHaveChildLayers()

bool KisProjectionLeaf::canHaveChildLayers

(

)

const

Definition at line 271 of file kis_projection_leaf.cpp.

{
    return (bool)qobject_cast<const KisGroupLayer*>(m_d->node.data());
}

References m_d.

channelFlags()

QBitArray KisProjectionLeaf::channelFlags

(

)

const

Definition at line 313 of file kis_projection_leaf.cpp.

{
    QBitArray channelFlags;
 
    KisLayer *layer = qobject_cast<KisLayer*>(m_d->node.data());
    if (!layer) return channelFlags;
 
    channelFlags = layer->channelFlags();
 
    if (m_d->checkParentPassThrough()) {
        QBitArray parentChannelFlags;
 
        if (*m_d->node->colorSpace() ==
            *m_d->node->parent()->colorSpace()) {
 
            KisLayer *parentLayer = qobject_cast<KisLayer*>(m_d->node->parent().data());
            parentChannelFlags = parentLayer->channelFlags();
        }
 
        channelFlags = KritaUtils::mergeChannelFlags(channelFlags, parentChannelFlags);
    }
 
    return channelFlags;
}

References KisLayer::channelFlags, channelFlags(), m_d, and KritaUtils::mergeChannelFlags().

checkParentPassThrough()

bool KisProjectionLeaf::checkParentPassThrough ( )

inline

Definition at line 56 of file kis_projection_leaf.cpp.

                                  {
        return node->parent() && checkPassThrough(node->parent());
    }

References KisNode::parent.

checkPassThrough()

static bool KisProjectionLeaf::checkPassThrough ( const KisNode * node )

inlinestatic

Definition at line 33 of file kis_projection_leaf.cpp.

                                                      {
        const KisGroupLayer *group = qobject_cast<const KisGroupLayer*>(node);
        return group && group->passThroughMode();
    }

References KisGroupLayer::passThroughMode.

checkThisPassThrough()

bool KisProjectionLeaf::checkThisPassThrough ( )

inline

Definition at line 60 of file kis_projection_leaf.cpp.

                                {
        return checkPassThrough(node);
    }

dependsOnLowerNodes()

bool KisProjectionLeaf::dependsOnLowerNodes

(

)

const

Definition at line 276 of file kis_projection_leaf.cpp.

{
    return (bool)qobject_cast<const KisAdjustmentLayer*>(m_d->node.data());
}

References m_d.

dropReason()

KisProjectionLeaf::NodeDropReason KisProjectionLeaf::dropReason

(

)

const

Definition at line 359 of file kis_projection_leaf.cpp.

{
    if (qobject_cast<KisMask*>(m_d->node.data()) &&
            m_d->checkParentPassThrough()) {
 
        return DropPassThroughMask;
    }
 
    KisCloneLayer *cloneLayer = qobject_cast<KisCloneLayer*>(m_d->node.data());
    if (cloneLayer && cloneLayer->copyFrom()) {
        KisProjectionLeafSP leaf = cloneLayer->copyFrom()->projectionLeaf();
 
        if (leaf->m_d->checkThisPassThrough()) {
            return DropPassThroughClone;
        }
    }
 
    return NodeAvailable;
}

References KisCloneLayer::copyFrom, DropPassThroughClone, DropPassThroughMask, m_d, NodeAvailable, and KisNode::projectionLeaf.

explicitlyRegeneratePassThroughProjection()

void KisProjectionLeaf::explicitlyRegeneratePassThroughProjection

(

)

Regenerate projection of the current group layer iff it is pass-through mode.

WARNING: must be called either under the image lock held or in the context of an exclusive stroke job.

This method is rather slow and dangerous. It should be executes in exclusive environment only.

Definition at line 398 of file kis_projection_leaf.cpp.

{
    if (!m_d->checkThisPassThrough()) return;
 
    m_d->temporarySetPassThrough(false);
 
    const QRect updateRect = projection()->defaultBounds()->bounds();
 
    KisRefreshSubtreeWalker walker(updateRect);
    walker.collectRects(m_d->node, updateRect);
 
    KisAsyncMerger merger;
    merger.startMerge(walker);
 
    m_d->temporarySetPassThrough(true);
}

References KisDefaultBoundsBase::bounds(), KisBaseRectsWalker::collectRects(), KisPaintDevice::defaultBounds(), m_d, projection(), and KisAsyncMerger::startMerge().

findRoot()

KisNodeSP KisProjectionLeaf::findRoot ( ) const

inline

Definition at line 75 of file kis_projection_leaf.cpp.

                               {
        KisNodeSP root = node;
 
        while (root->parent()) {
            root = root->parent();
        }
 
        return root;
    }

References KisNode::parent.

firstChild()

KisProjectionLeafSP KisProjectionLeaf::firstChild

(

)

const

Definition at line 122 of file kis_projection_leaf.cpp.

{
    KisNodeSP node;
 
    if (!m_d->checkThisPassThrough()) {
        node = m_d->node->firstChild();
        node = Private::skipSelectionMasksForward(node);
    }
 
    if (!node && isRoot()) {
        KisProjectionLeafSP overlayLeaf = m_d->overlayProjectionLeaf();
        if (overlayLeaf) {
            return overlayLeaf;
        }
    }
 
    return node ? node->projectionLeaf() : KisProjectionLeafSP();
}

References KisNode::firstChild(), isRoot(), m_d, node, and KisNode::projectionLeaf.

hasClones()

bool KisProjectionLeaf::hasClones

(

)

const

Definition at line 343 of file kis_projection_leaf.cpp.

{
    KisLayer *layer = qobject_cast<KisLayer*>(m_d->node.data());
    return layer ? layer->hasClones() : false;
}

References KisLayer::hasClones(), and m_d.

isDroppedNode()

bool KisProjectionLeaf::isDroppedNode

(

)

const

Definition at line 349 of file kis_projection_leaf.cpp.

{
    return dropReason() != NodeAvailable;
}

References dropReason(), and NodeAvailable.

isLayer()

bool KisProjectionLeaf::isLayer

(

)

const

Definition at line 259 of file kis_projection_leaf.cpp.

{
    return (bool)qobject_cast<const KisLayer*>(m_d->node.data()) &&
        !m_d->node->isFakeNode();
}

References m_d.

isMask()

bool KisProjectionLeaf::isMask

(

)

const

Definition at line 265 of file kis_projection_leaf.cpp.

{
    return (bool)qobject_cast<const KisMask*>(m_d->node.data()) &&
        !m_d->node->isFakeNode();
}

References m_d.

isOverlayProjectionLeaf()

bool KisProjectionLeaf::isOverlayProjectionLeaf

(

)

const

Definition at line 379 of file kis_projection_leaf.cpp.

{
    return this == m_d->overlayProjectionLeaf();
}

References m_d.

isRoot()

bool KisProjectionLeaf::isRoot

(

)

const

Definition at line 254 of file kis_projection_leaf.cpp.

{
    return (bool)!m_d->node->parent();
}

References m_d.

isSelectionMask()

static bool KisProjectionLeaf::isSelectionMask ( const KisNode * node )

inlinestatic

Definition at line 38 of file kis_projection_leaf.cpp.

                                                     {
        return qobject_cast<const KisSelectionMask*>(node);
    }

isStillInGraph()

bool KisProjectionLeaf::isStillInGraph

(

)

const

Definition at line 338 of file kis_projection_leaf.cpp.

{
    return (bool)m_d->node->graphListener();
}

References m_d.

isTemporaryHiddenFromRendering()

bool KisProjectionLeaf::isTemporaryHiddenFromRendering

(

)

const

See also

setTemporaryHiddenFromRendering

Definition at line 389 of file kis_projection_leaf.cpp.

{
    return m_d->isTemporaryHidden;
}

References m_d.

isTopmostNode()

bool KisProjectionLeaf::isTopmostNode ( ) const

inline

Definition at line 69 of file kis_projection_leaf.cpp.

                               {
        return !skipSelectionMasksForward(node->nextSibling()) &&
            node->parent() &&
            !node->parent()->parent();
    }

References KisNode::nextSibling(), and KisNode::parent.

lastChild()

KisProjectionLeafSP KisProjectionLeaf::lastChild

(

)

const

Definition at line 141 of file kis_projection_leaf.cpp.

{
    KisNodeSP node;
 
    if (isRoot()) {
        KisProjectionLeafSP overlayLeaf = m_d->overlayProjectionLeaf();
        if (overlayLeaf) {
            return overlayLeaf;
        }
    }
 
    if (!m_d->checkThisPassThrough()) {
        node = m_d->node->lastChild();
        node = Private::skipSelectionMasksBackward(node);
    }
 
    return node ? node->projectionLeaf() : KisProjectionLeafSP();
}

References isRoot(), KisNode::lastChild(), m_d, node, and KisNode::projectionLeaf.

lazyDestinationForSubtreeComposition()

KisPaintDeviceSP KisProjectionLeaf::lazyDestinationForSubtreeComposition

(

)

Definition at line 248 of file kis_projection_leaf.cpp.

{
    const KisGroupLayer *group = qobject_cast<const KisGroupLayer*>(m_d->node.data());
    return group ? group->lazyDestinationForSubtreeComposition() : nullptr;
}

References KisGroupLayer::lazyDestinationForSubtreeComposition(), and m_d.

nextSibling()

KisProjectionLeafSP KisProjectionLeaf::nextSibling

(

)

const

Definition at line 196 of file kis_projection_leaf.cpp.

{
    if (Private::isSelectionMask(m_d->node)) {
        return KisProjectionLeafSP();
    }
 
    KisProjectionLeafSP overlayLeaf = m_d->overlayProjectionLeaf();
    if (overlayLeaf && m_d->isTopmostNode()) {
        return overlayLeaf;
    }
 
    KisNodeSP node = m_d->node->nextSibling();
    node = Private::skipSelectionMasksForward(node);
 
    while (node && Private::checkPassThrough(node) && node->firstChild()) {
        node = node->firstChild();
        node = Private::skipSelectionMasksForward(node);
    }
 
    if (!node && m_d->checkParentPassThrough()) {
        node = m_d->node->parent();
        node = Private::skipSelectionMasksForward(node);
    }
 
    return node ? node->projectionLeaf() : KisProjectionLeafSP();
}

References KisNode::firstChild(), m_d, KisNode::nextSibling(), node, KisNode::parent, and KisNode::projectionLeaf.

node()

KisNodeSP KisProjectionLeaf::node

(

)

const

opacity()

quint8 KisProjectionLeaf::opacity

(

)

const

Definition at line 300 of file kis_projection_leaf.cpp.

{
    quint8 resultOpacity = m_d->node->opacity();
 
    if (m_d->checkParentPassThrough()) {
        quint8 parentOpacity = m_d->node->parent()->projectionLeaf()->opacity();
 
        resultOpacity = KritaUtils::mergeOpacityU8(resultOpacity, parentOpacity);
    }
 
    return resultOpacity;
}

References m_d, KritaUtils::mergeOpacityU8(), and KisBaseNode::opacity().

original()

KisPaintDeviceSP KisProjectionLeaf::original

(

)

Definition at line 238 of file kis_projection_leaf.cpp.

{
    return m_d->node->original();
}

References m_d.

overlayProjectionLeaf()

KisProjectionLeafSP KisProjectionLeaf::overlayProjectionLeaf ( ) const

inline

Definition at line 64 of file kis_projection_leaf.cpp.

                                                      {
        return node && node->graphListener() && node->graphListener()->graphOverlayNode() ?
            node->graphListener()->graphOverlayNode()->projectionLeaf() : 0;
    }

References KisNode::graphListener, KisNodeGraphListener::graphOverlayNode(), and KisNode::projectionLeaf.

parent()

KisProjectionLeafSP KisProjectionLeaf::parent

(

)

const

Definition at line 102 of file kis_projection_leaf.cpp.

{
    KisNodeSP node;
 
    if (Private::isSelectionMask(m_d->node)) {
        if (m_d->overlayProjectionLeaf() == this) {
            node = m_d->findRoot();
        }
    } else {
        node = m_d->node->parent();
    }
 
    while (node && Private::checkPassThrough(node)) {
        node = node->parent();
    }
 
    return node ? node->projectionLeaf() : KisProjectionLeafSP();
}

References m_d, node, KisNode::parent, and KisNode::projectionLeaf.

prevSibling()

KisProjectionLeafSP KisProjectionLeaf::prevSibling

(

)

const

Definition at line 160 of file kis_projection_leaf.cpp.

{
    if (Private::isSelectionMask(m_d->node)) {
        KisProjectionLeafSP leaf;
 
        if (m_d->overlayProjectionLeaf() == this) {
            KisNodeSP node = m_d->findRoot()->lastChild();
            node = Private::skipSelectionMasksBackward(node);
            leaf = node->projectionLeaf();
        }
 
        return leaf;
    }
 
    KisNodeSP node;
 
    if (m_d->checkThisPassThrough()) {
        node = m_d->node->lastChild();
        node = Private::skipSelectionMasksBackward(node);
    }
 
    if (!node) {
        node = m_d->node->prevSibling();
        node = Private::skipSelectionMasksBackward(node);
    }
 
    const KisProjectionLeaf *leaf = this;
    while (!node && leaf->m_d->checkParentPassThrough()) {
        leaf = leaf->node()->parent()->projectionLeaf().data();
        node = leaf->node()->prevSibling();
        node = Private::skipSelectionMasksBackward(node);
    }
 
    return node ? node->projectionLeaf() : KisProjectionLeafSP();
}

References KisNode::lastChild(), m_d, node, KisNode::parent, KisNode::prevSibling(), and KisNode::projectionLeaf.

Private()

KisProjectionLeaf::Private ( KisNode * _node )

inline

Definition at line 28 of file kis_projection_leaf.cpp.

: node(_node) {}

projection()

KisPaintDeviceSP KisProjectionLeaf::projection

(

)

Definition at line 243 of file kis_projection_leaf.cpp.

{
    return m_d->node->projection();
}

References m_d.

projectionPlane()

KisAbstractProjectionPlaneSP KisProjectionLeaf::projectionPlane

(

)

const

Definition at line 228 of file kis_projection_leaf.cpp.

{
    return m_d->node->projectionPlane();
}

References m_d.

setTemporaryHiddenFromRendering()

void KisProjectionLeaf::setTemporaryHiddenFromRendering

(

bool

value

)

Temporarily exclude the projection leaf from rendering by making it invisible (KisProjectionLeaf::visible() == false).

This method is used by the tools that want to hide the original layer's content temporarily.

NOTE: the method is not thread-safe! The caller must guarantee exclusive access to the projection leaf himself.

Definition at line 384 of file kis_projection_leaf.cpp.

{
    m_d->isTemporaryHidden = value;
}

References m_d, and value().

shouldBeRendered()

bool KisProjectionLeaf::shouldBeRendered

(

)

const

A leaf can be renderable even when it is invisible, e.g. when it has clones (it should update data for clones)

Definition at line 354 of file kis_projection_leaf.cpp.

{
    return visible() || hasClones();
}

References hasClones(), and visible().

skipSelectionMasksBackward()

static KisNodeSP KisProjectionLeaf::skipSelectionMasksBackward ( KisNodeSP node )

inlinestatic

Definition at line 49 of file kis_projection_leaf.cpp.

                                                                {
        while (node && isSelectionMask(node)) {
            node = node->prevSibling();
        }
        return node;
    }

References isSelectionMask(), and KisNode::prevSibling().

skipSelectionMasksForward()

static KisNodeSP KisProjectionLeaf::skipSelectionMasksForward ( KisNodeSP node )

inlinestatic

Definition at line 42 of file kis_projection_leaf.cpp.

                                                               {
        while (node && isSelectionMask(node)) {
            node = node->nextSibling();
        }
        return node;
    }

References isSelectionMask(), and KisNode::nextSibling().

temporarySetPassThrough()

void KisProjectionLeaf::temporarySetPassThrough ( bool value )

inline

Definition at line 85 of file kis_projection_leaf.cpp.

                                             {
        KisGroupLayer *group = qobject_cast<KisGroupLayer*>(node.data());
        if (!group) return;
 
        group->setPassThroughMode(value);
    }

References KisWeakSharedPtr< T >::data(), KisGroupLayer::setPassThroughMode(), and value().

visible()

bool KisProjectionLeaf::visible

(

)

const

Definition at line 281 of file kis_projection_leaf.cpp.

{
    if (m_d->isTemporaryHidden || isDroppedNode()) return false;
 
    // TODO: check opacity as well!
 
    bool hiddenByParentPassThrough = false;
 
    KisNodeSP node = m_d->node->parent();
    while (node && node->projectionLeaf()->m_d->checkThisPassThrough()) {
        hiddenByParentPassThrough |= !node->visible();
        node = node->parent();
    }
 
    return (m_d->node->visible(false) || m_d->node->isIsolatedRoot()) &&
        !m_d->checkThisPassThrough() &&
        !hiddenByParentPassThrough;
}

References isDroppedNode(), m_d, node, KisNode::parent, KisNode::projectionLeaf, and KisBaseNode::visible().

Member Data Documentation

isTemporaryHidden

bool KisProjectionLeaf::isTemporaryHidden = false

Definition at line 31 of file kis_projection_leaf.cpp.

m_d

const QScopedPointer<Private> KisProjectionLeaf::m_d

private

Definition at line 96 of file kis_projection_leaf.h.

node

KisNodeSP KisProjectionLeaf::node

Definition at line 30 of file kis_projection_leaf.cpp.

---

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

• libs/image/kis_projection_leaf.cpp
• libs/image/kis_projection_leaf.h