#include <kis_base_rects_walker.h>

Inheritance diagram for KisBaseRectsWalker:

Classes
struct	CloneNotification

struct	JobItem

Public Types
typedef QVector< CloneNotification >	CloneNotificationsVector

typedef QStack< JobItem >	LeafStack

typedef qint32	NodePosition

enum	NodePositionValues { N_NORMAL = 0x00 , N_TOPMOST = 0x01 , N_BOTTOMMOST = 0x02 , N_EXTRA = 0x04 , N_ABOVE_FILTHY = 0x08 , N_FILTHY_ORIGINAL = 0x10 , N_FILTHY_PROJECTION = 0x20 , N_FILTHY = 0x40 , N_BELOW_FILTHY = 0x80 }

enum	SubtreeVisitFlag { None = 0x0 , SkipNonRenderableNodes = 0x1 , NoFilthyMode = 0x2 , DontNotifyClones = 0x4 }

enum	UpdateType { UPDATE , UPDATE_NO_FILTHY , FULL_REFRESH , FULL_REFRESH_NO_FILTHY , UNSUPPORTED }

Public Member Functions
QRect	accessRect () const

QRect	changeRect () const

bool	changeRectVaries () const

bool	checksumValid ()

CloneNotificationsVector &	cloneNotifications ()

bool	clonesDontInvalidateFrames () const

void	collectRects (KisNodeSP node, const QRect &requestedRect)

QRect	cropRect () const

	KisBaseRectsWalker ()

LeafStack &	leafStack ()

int	levelOfDetail () const

bool	needRectVaries () const

	Q_DECLARE_FLAGS (SubtreeVisitFlags, SubtreeVisitFlag)

void	recalculate (const QRect &requestedRect)

QRect	requestedRect () const

void	setClonesDontInvalidateFrames (bool value)

void	setCropRect (QRect cropRect)

KisNodeSP	startNode () const

virtual UpdateType	type () const =0

QRect	uncroppedChangeRect () const

virtual	~KisBaseRectsWalker ()

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static KisNode::PositionToFilthy	convertPositionToFilthy (NodePosition position)

Protected Member Functions
void	addCloneSourceRegenerationJobs ()

virtual void	adjustMasksChangeRect (KisProjectionLeafSP firstMask)

void	clear ()

QRect	cropThisRect (const QRect &rect, const QRect &cropRect)

bool	isStartLeaf (KisProjectionLeafSP leaf) const

void	pushJob (KisProjectionLeafSP leaf, NodePosition position, QRect applyRect, KisRenderPassFlags flags)

virtual void	registerChangeRect (KisProjectionLeafSP leaf, NodePosition position)

void	registerCloneNotification (KisNodeSP node, NodePosition position)

void	registerNeedRect (KisProjectionLeafSP leaf, NodePosition position, KisRenderPassFlags flags)

virtual void	registerNeedRect (KisProjectionLeafSP leaf, NodePosition position, KisRenderPassFlags flags, const QRect &cropRect)

void	setExplicitChangeRect (const QRect &changeRect, bool changeRectVaries)

virtual void	startTrip (KisProjectionLeafSP startWith)=0

void	visitSubtreeTopToBottom (KisProjectionLeafSP startWith, SubtreeVisitFlags flags, KisRenderPassFlags renderFlags, const QRect &cropRect)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Static Protected Member Functions
static qint32	calculateChecksum (KisProjectionLeafSP leaf, const QRect &requestedRect)

static NodePosition	calculateNodePosition (KisProjectionLeafSP leaf)

static qint32	getGraphPosition (qint32 position)

static bool	hasClones (KisNodeSP node)

Private Member Functions
int	getNodeLevelOfDetail (KisProjectionLeafSP leaf)

Private Attributes
bool	m_changeRectVaries {false}

QRect	m_childNeedRect

CloneNotificationsVector	m_cloneNotifications

bool	m_clonesDontInvalidateFrames {false}

QRect	m_cropRect

qint32	m_graphChecksum {0}

QRect	m_lastNeedRect

int	m_levelOfDetail {0}

LeafStack	m_mergeTask

bool	m_needRectVaries {false}

qint32	m_nodeChecksum {0}

QRect	m_requestedRect

QRect	m_resultAccessRect

QRect	m_resultChangeRect

QRect	m_resultNeedRect

QRect	m_resultUncroppedChangeRect

KisNodeSP	m_startNode

Detailed Description

Definition at line 21 of file kis_base_rects_walker.h.

Member Typedef Documentation

◆ CloneNotificationsVector

typedef QVector<CloneNotification> KisBaseRectsWalker::CloneNotificationsVector

Definition at line 90 of file kis_base_rects_walker.h.

◆ LeafStack

typedef QStack<JobItem> KisBaseRectsWalker::LeafStack

Definition at line 107 of file kis_base_rects_walker.h.

◆ NodePosition

typedef qint32 KisBaseRectsWalker::NodePosition

Definition at line 33 of file kis_base_rects_walker.h.

Member Enumeration Documentation

◆ NodePositionValues

enum KisBaseRectsWalker::NodePositionValues

Enumerator
N_NORMAL	There are two different sets of values. The first describes the position of the node to the graph, the second shows the position to the filthy node
N_TOPMOST
N_BOTTOMMOST
N_EXTRA
N_ABOVE_FILTHY
N_FILTHY_ORIGINAL
N_FILTHY_PROJECTION
N_FILTHY
N_BELOW_FILTHY

Definition at line 34 of file kis_base_rects_walker.h.

                            {
        N_NORMAL     = 0x00,
        N_TOPMOST    = 0x01,
        N_BOTTOMMOST = 0x02,
        N_EXTRA      = 0x04,
 
        N_ABOVE_FILTHY = 0x08,
        N_FILTHY_ORIGINAL   = 0x10, // not used actually
        N_FILTHY_PROJECTION = 0x20,
        N_FILTHY = 0x40,
        N_BELOW_FILTHY = 0x80
    };

◆ SubtreeVisitFlag

enum KisBaseRectsWalker::SubtreeVisitFlag

Enumerator
None
SkipNonRenderableNodes
NoFilthyMode
DontNotifyClones

Definition at line 109 of file kis_base_rects_walker.h.

                          {
        None = 0x0,
        SkipNonRenderableNodes = 0x1,
        NoFilthyMode = 0x2,
        DontNotifyClones = 0x4
    };

◆ UpdateType

enum KisBaseRectsWalker::UpdateType

Enumerator
UPDATE
UPDATE_NO_FILTHY
FULL_REFRESH
FULL_REFRESH_NO_FILTHY
UNSUPPORTED

Definition at line 24 of file kis_base_rects_walker.h.

                    {
        UPDATE,
        UPDATE_NO_FILTHY,
        FULL_REFRESH,
        FULL_REFRESH_NO_FILTHY,
        UNSUPPORTED
    };

Constructor & Destructor Documentation

◆ KisBaseRectsWalker()

KisBaseRectsWalker::KisBaseRectsWalker ( )

inline

Definition at line 119 of file kis_base_rects_walker.h.

        : m_levelOfDetail(0)
    {
    }

◆ ~KisBaseRectsWalker()

virtual KisBaseRectsWalker::~KisBaseRectsWalker ( )

inlinevirtual

Definition at line 124 of file kis_base_rects_walker.h.

124 {

125 }

Member Function Documentation

◆ accessRect()

QRect KisBaseRectsWalker::accessRect ( ) const

inline

Definition at line 205 of file kis_base_rects_walker.h.

                                    {
        return m_resultAccessRect;
    }

◆ addCloneSourceRegenerationJobs()

void KisBaseRectsWalker::addCloneSourceRegenerationJobs ( )

protected

Copy all suitable clone layers' jobs into a separate vector to make sure we don't have hangling iterators caused by calling to visitSubtreeTopToBottom() in the loop

If a clone has complicated masks, we should prepare additional source area to ensure the rect is prepared.

Definition at line 10 of file kis_base_rects_walker.cpp.

{
    QVector<JobItem> cloneLayers;
    std::copy_if(m_mergeTask.begin(), m_mergeTask.end(),
                 std::back_inserter(cloneLayers),
                 [] (const JobItem &item) {
                     return item.m_leaf->node()->inherits("KisCloneLayer") &&
                         (item.m_position & (N_FILTHY | N_ABOVE_FILTHY | N_EXTRA));
                 });
 
    for (auto it = cloneLayers.begin(); it != cloneLayers.end(); ++it) {
        KisCloneLayer *clone = dynamic_cast<KisCloneLayer*>(it->m_leaf->node().data());
 
        KisNodeSP source = clone->copyFrom();
        if (!source) continue;
 
        QVector<QRect> preparedRects;
 
        if (!m_cropRect.isEmpty()) {
            preparedRects << m_cropRect;
        }
 
        Q_FOREACH (const JobItem &job, m_mergeTask) {
            if (job.m_leaf->node() == source &&
                ((job.m_position & (N_FILTHY | N_EXTRA)) ||
                 (job.m_leaf->dependsOnLowerNodes() && (job.m_position & N_ABOVE_FILTHY)))) {
                preparedRects << job.m_applyRect;
            }
        }
 
        const QRect srcRect = it->m_applyRect.translated(-clone->x(), -clone->y());
 
        QRegion prepareRegion(srcRect);
 
        const QRect needRectOnSource = clone->needRectOnSourceForMasks(srcRect);
        if (!needRectOnSource.isEmpty()) {
            prepareRegion += needRectOnSource;
        }
 
        Q_FOREACH (const QRect &rc, preparedRects) {
            prepareRegion -= rc;
        }
 
        for (auto it = prepareRegion.begin(); it != prepareRegion.end(); ++it) {
            pushJob(source->projectionLeaf(), N_EXTRA, *it, KisRenderPassFlag::NoTransformMaskUpdates);
            visitSubtreeTopToBottom(source->projectionLeaf(),
                                    SkipNonRenderableNodes | DontNotifyClones,
                                    KisRenderPassFlag::NoTransformMaskUpdates,
                                    QRect());
        }
    }
}

References KisCloneLayer::copyFrom, DontNotifyClones, KisBaseRectsWalker::JobItem::m_applyRect, m_cropRect, KisBaseRectsWalker::JobItem::m_leaf, m_mergeTask, KisBaseRectsWalker::JobItem::m_position, N_ABOVE_FILTHY, N_EXTRA, N_FILTHY, KisCloneLayer::needRectOnSourceForMasks(), NoTransformMaskUpdates, pushJob(), SkipNonRenderableNodes, source(), visitSubtreeTopToBottom(), KisCloneLayer::x(), and KisCloneLayer::y().

◆ adjustMasksChangeRect()

virtual void KisBaseRectsWalker::adjustMasksChangeRect ( KisProjectionLeafSP firstMask )

inlineprotectedvirtual

ATTENTION: we miss the first mask

Reimplemented in KisFullRefreshWalker.

Definition at line 426 of file kis_base_rects_walker.h.

                                                                      {
        KisProjectionLeafSP currentLeaf = firstMask;
 
        while (currentLeaf) {
            do {
                currentLeaf = currentLeaf->nextSibling();
            } while (currentLeaf &&
                     (!currentLeaf->isMask() || !currentLeaf->visible()));
 
            if(currentLeaf) {
                QRect changeRect = currentLeaf->projectionPlane()->changeRect(m_resultChangeRect);
                m_changeRectVaries |= changeRect != m_resultChangeRect;
                m_resultChangeRect = changeRect;
                m_resultUncroppedChangeRect = changeRect;
            }
        }
 
        KisProjectionLeafSP parentLayer = firstMask->parent();
        KIS_SAFE_ASSERT_RECOVER_RETURN(parentLayer);
 
        registerCloneNotification(parentLayer->node(), N_FILTHY_PROJECTION);
    }

References KIS_SAFE_ASSERT_RECOVER_RETURN.

◆ calculateChecksum()

static qint32 KisBaseRectsWalker::calculateChecksum	(	KisProjectionLeafSP	leaf,
		const QRect &	requestedRect )

inlinestaticprotected

Definition at line 453 of file kis_base_rects_walker.h.

                                                                                          {
        qint32 checksum = 0;
        qint32 x, y, w, h;
        QRect tempRect;
 
        tempRect = leaf->projectionPlane()->changeRect(requestedRect);
        tempRect.getRect(&x, &y, &w, &h);
        checksum += -x - y + w + h;
 
        tempRect = leaf->projectionPlane()->needRect(requestedRect);
        tempRect.getRect(&x, &y, &w, &h);
        checksum += -x - y + w + h;
 
//        errKrita << leaf << requestedRect << "-->" << checksum;
 
        return checksum;
    }

◆ calculateNodePosition()

static NodePosition KisBaseRectsWalker::calculateNodePosition ( KisProjectionLeafSP leaf )

inlinestaticprotected

Definition at line 258 of file kis_base_rects_walker.h.

                                                                               {
        KisProjectionLeafSP nextLeaf = leaf->nextSibling();
        while(nextLeaf && !nextLeaf->isLayer()) nextLeaf = nextLeaf->nextSibling();
        if (!nextLeaf) return N_TOPMOST;
 
        KisProjectionLeafSP prevLeaf = leaf->prevSibling();
        while(prevLeaf && !prevLeaf->isLayer()) prevLeaf = prevLeaf->prevSibling();
        if (!prevLeaf) return N_BOTTOMMOST;
 
        return N_NORMAL;
    }

◆ changeRect()

QRect KisBaseRectsWalker::changeRect ( ) const

inline

Definition at line 209 of file kis_base_rects_walker.h.

                                    {
        return m_resultChangeRect;
    }

◆ changeRectVaries()

bool KisBaseRectsWalker::changeRectVaries ( ) const

inline

Definition at line 221 of file kis_base_rects_walker.h.

                                         {
        return m_changeRectVaries;
    }

◆ checksumValid()

bool KisBaseRectsWalker::checksumValid ( )

inline

Definition at line 172 of file kis_base_rects_walker.h.

                         {
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(m_startNode, false);
        return
            m_nodeChecksum == calculateChecksum(m_startNode->projectionLeaf(), m_requestedRect) &&
            m_graphChecksum == m_startNode->graphSequenceNumber();
    }

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

◆ clear()

void KisBaseRectsWalker::clear ( )

inlineprotected

Definition at line 274 of file kis_base_rects_walker.h.

                        {
        m_resultAccessRect = m_resultNeedRect = /*m_resultChangeRect =*/
            m_childNeedRect = m_lastNeedRect = QRect();
 
        m_needRectVaries = m_changeRectVaries = false;
        m_mergeTask.clear();
        m_cloneNotifications.clear();
 
        // Not needed really. Think over removing.
        //m_startNode = 0;
        //m_requestedRect = QRect();
    }

◆ cloneNotifications()

CloneNotificationsVector & KisBaseRectsWalker::cloneNotifications ( )

inline

Definition at line 201 of file kis_base_rects_walker.h.

                                                          {
        return m_cloneNotifications;
    }

◆ clonesDontInvalidateFrames()

bool KisBaseRectsWalker::clonesDontInvalidateFrames ( ) const

inline

Definition at line 183 of file kis_base_rects_walker.h.

                                                   {
        return m_clonesDontInvalidateFrames;
    }

◆ collectRects()

void KisBaseRectsWalker::collectRects	(	KisNodeSP	node,
		const QRect &	requestedRect )

inline

Definition at line 127 of file kis_base_rects_walker.h.

                                                                  {
        clear();
 
        KisProjectionLeafSP startLeaf = node->projectionLeaf();
 
        m_nodeChecksum = calculateChecksum(startLeaf, requestedRect);
        m_graphChecksum = node->graphSequenceNumber();
        m_resultChangeRect = requestedRect;
        m_resultUncroppedChangeRect = requestedRect;
        m_requestedRect = requestedRect;
        m_startNode = node;
        m_levelOfDetail = getNodeLevelOfDetail(startLeaf);
        startTrip(startLeaf);
        addCloneSourceRegenerationJobs();
    }

References KisNode::graphSequenceNumber(), and KisNode::projectionLeaf.

◆ convertPositionToFilthy()

static KisNode::PositionToFilthy KisBaseRectsWalker::convertPositionToFilthy ( NodePosition position )

inlinestatic

Definition at line 55 of file kis_base_rects_walker.h.

                                                                                         {
        static const int positionToFilthyMask =
            N_ABOVE_FILTHY |
            N_FILTHY_PROJECTION |
            N_FILTHY |
            N_BELOW_FILTHY;
 
        qint32 positionToFilthy = position & N_EXTRA ? N_FILTHY : position & positionToFilthyMask;
        // We do not use N_FILTHY_ORIGINAL yet, so...
        Q_ASSERT(positionToFilthy);
 
        return static_cast<KisNode::PositionToFilthy>(positionToFilthy);
    }

◆ cropRect()

QRect KisBaseRectsWalker::cropRect ( ) const

inline

Definition at line 191 of file kis_base_rects_walker.h.

                                 {
        return m_cropRect;
    }

◆ cropThisRect()

QRect KisBaseRectsWalker::cropThisRect	(	const QRect &	rect,
		const QRect &	cropRect )

inlineprotected

Definition at line 292 of file kis_base_rects_walker.h.

                                                                        {
        return cropRect.isValid() ? rect & cropRect : rect;
    }

◆ getGraphPosition()

static qint32 KisBaseRectsWalker::getGraphPosition ( qint32 position )

inlinestaticprotected

Definition at line 249 of file kis_base_rects_walker.h.

                                                           {
        return position & GRAPH_POSITION_MASK;
    }

References GRAPH_POSITION_MASK.

◆ getNodeLevelOfDetail()

int KisBaseRectsWalker::getNodeLevelOfDetail ( KisProjectionLeafSP leaf )

inlineprivate

Such errors may happen during undo or too quick node removal, they shouldn't cause any real problems in Krita work.

Definition at line 475 of file kis_base_rects_walker.h.

                                                              {
        while (leaf && !leaf->projection()) {
            leaf = leaf->parent();
        }
 
        if (!leaf || !leaf->projection()) {
            qWarning() << "WARNING: KisBaseRectsWalker::getNodeLevelOfDetail() "
                          "failed to fetch currentLevelOfDetail() from the node. "
                          "Perhaps the node was removed from the image in the meantime.";
            return 0;
        }
 
        return leaf->projection()->defaultBounds()->currentLevelOfDetail();
    }

◆ hasClones()

static bool KisBaseRectsWalker::hasClones ( KisNodeSP node )

inlinestaticprotected

Definition at line 253 of file kis_base_rects_walker.h.

                                                 {
        KisLayer *layer = qobject_cast<KisLayer*>(node.data());
        return layer && layer->hasClones();
    }

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

◆ isStartLeaf()

bool KisBaseRectsWalker::isStartLeaf ( KisProjectionLeafSP leaf ) const

inlineprotected

Definition at line 270 of file kis_base_rects_walker.h.

                                                            {
        return leaf->node() == m_startNode;
    }

◆ leafStack()

LeafStack & KisBaseRectsWalker::leafStack ( )

inline

Definition at line 196 of file kis_base_rects_walker.h.

                                  {
        return m_mergeTask;
    }

◆ levelOfDetail()

int KisBaseRectsWalker::levelOfDetail ( ) const

inline

Definition at line 233 of file kis_base_rects_walker.h.

                                     {
        return m_levelOfDetail;
    }

◆ needRectVaries()

bool KisBaseRectsWalker::needRectVaries ( ) const

inline

Definition at line 217 of file kis_base_rects_walker.h.

                                       {
        return m_needRectVaries;
    }

◆ pushJob()

void KisBaseRectsWalker::pushJob	(	KisProjectionLeafSP	leaf,
		NodePosition	position,
		QRect	applyRect,
		KisRenderPassFlags	flags )

inlineprotected

Definition at line 287 of file kis_base_rects_walker.h.

                                                                                                                    {
        JobItem item = {leaf, position, applyRect, flags};
        m_mergeTask.push(item);
    }

◆ Q_DECLARE_FLAGS()

KisBaseRectsWalker::Q_DECLARE_FLAGS	(	SubtreeVisitFlags	,
		SubtreeVisitFlag	)

◆ recalculate()

void KisBaseRectsWalker::recalculate ( const QRect & requestedRect )

inline

Definition at line 143 of file kis_base_rects_walker.h.

                                                        {
        KIS_SAFE_ASSERT_RECOVER_RETURN(m_startNode);
 
        KisProjectionLeafSP startLeaf = m_startNode->projectionLeaf();
 
        int calculatedLevelOfDetail = getNodeLevelOfDetail(startLeaf);
 
        if (m_levelOfDetail != calculatedLevelOfDetail) {
            qWarning() << "WARNING: KisBaseRectsWalker::recalculate()"
                       << "The levelOfDetail has changes with time,"
                       << "which couldn't have happened!"
                       << ppVar(m_levelOfDetail)
                       << ppVar(calculatedLevelOfDetail);
 
            m_levelOfDetail = calculatedLevelOfDetail;
        }
 
        if(startLeaf->isStillInGraph()) {
            collectRects(m_startNode, requestedRect);
        }
        else {
            clear();
            m_nodeChecksum = calculateChecksum(startLeaf, requestedRect);
            m_graphChecksum = m_startNode->graphSequenceNumber();
            m_resultChangeRect = QRect();
            m_resultUncroppedChangeRect = QRect();
        }
    }

References collectRects(), KIS_SAFE_ASSERT_RECOVER_RETURN, and ppVar.

◆ registerChangeRect()

virtual void KisBaseRectsWalker::registerChangeRect	(	KisProjectionLeafSP	leaf,
		NodePosition	position )

inlineprotectedvirtual

Called for every node we meet on a forward way of the trip.

Reimplemented in KisFullRefreshWalker.

Definition at line 308 of file kis_base_rects_walker.h.

                                                                                     {
        // We do not work with masks here. It is KisLayer's job.
        if(!leaf->isLayer()) return;
        if(!(position & N_FILTHY) && !leaf->visible()) return;
 
        QRect currentChangeRect = leaf->projectionPlane()->changeRect(m_resultChangeRect,
                                                                      convertPositionToFilthy(position));
        currentChangeRect = cropThisRect(currentChangeRect, m_cropRect);
 
        if(!m_changeRectVaries)
            m_changeRectVaries = currentChangeRect != m_resultChangeRect;
 
        m_resultChangeRect = currentChangeRect;
 
        m_resultUncroppedChangeRect = leaf->projectionPlane()->changeRect(m_resultUncroppedChangeRect,
                                                                          convertPositionToFilthy(position));
        registerCloneNotification(leaf->node(), position);
    }

◆ registerCloneNotification()

void KisBaseRectsWalker::registerCloneNotification	(	KisNodeSP	node,
		NodePosition	position )

inlineprotected

Note, we do not check for (N_ABOVE_FILTHY && dependOnLowerNodes(node)) because it may lead to an infinite loop with filter layer. Activate it when it is guaranteed that it is not possible to create a filter layer above its own clone

Definition at line 327 of file kis_base_rects_walker.h.

                                                                          {
        if(hasClones(node) && position & (N_FILTHY | N_FILTHY_PROJECTION | N_EXTRA)) {
            m_cloneNotifications.append(
                CloneNotification(node, m_resultUncroppedChangeRect, m_clonesDontInvalidateFrames));
        }
    }

◆ registerNeedRect() [1/2]

void KisBaseRectsWalker::registerNeedRect	(	KisProjectionLeafSP	leaf,
		NodePosition	position,
		KisRenderPassFlags	flags )

inlineprotected

Definition at line 342 of file kis_base_rects_walker.h.

                                                                                                     {
        registerNeedRect(leaf, position, flags, m_cropRect);
    }

◆ registerNeedRect() [2/2]

virtual void KisBaseRectsWalker::registerNeedRect	(	KisProjectionLeafSP	leaf,
		NodePosition	position,
		KisRenderPassFlags	flags,
		const QRect &	cropRect )

inlineprotectedvirtual

Called for every node we meet on a backward way of the trip.

Reimplemented in KisFullRefreshWalker.

Definition at line 349 of file kis_base_rects_walker.h.

                                                                                   {
        // We do not work with masks here. It is KisLayer's job.
        if(!leaf->isLayer()) return;
 
        if(m_mergeTask.isEmpty())
            m_resultAccessRect = m_resultNeedRect = m_childNeedRect =
                m_lastNeedRect = m_resultChangeRect;
 
        if (leaf->parent() && position & N_TOPMOST) {
            bool parentNeedRectFound = false;
            QRect parentNeedRect;
 
            for (auto it = std::make_reverse_iterator(m_mergeTask.end());
                 it != std::make_reverse_iterator(m_mergeTask.begin());
                 ++it) {
 
                if (it->m_leaf == leaf->parent()) {
                    parentNeedRect =
                        it->m_leaf->projectionPlane()->needRectForOriginal(it->m_applyRect);
                    parentNeedRectFound = true;
                    break;
                }
            }
 
            // TODO: check if we can put this requirement
            // KIS_SAFE_ASSERT_RECOVER_NOOP(parentNeedRectFound);
 
            if (parentNeedRectFound) {
                m_lastNeedRect = parentNeedRect;
            } else {
                // legacy way of fetching parent need rect, just
                // takes need rect of the last visited filthy node
                m_lastNeedRect = m_childNeedRect;
            }
        }
 
        if (!leaf->shouldBeRendered()) {
            if (!m_lastNeedRect.isEmpty()) {
                // push a dumb job to fit state machine requirements
                pushJob(leaf, position, m_lastNeedRect, flags);
            }
        } else if(position & (N_FILTHY | N_ABOVE_FILTHY | N_EXTRA)) {
            if(!m_lastNeedRect.isEmpty())
                pushJob(leaf, position, m_lastNeedRect, flags);
            //else /* Why push empty rect? */;
 
            m_resultAccessRect |= leaf->projectionPlane()->accessRect(m_lastNeedRect,
                                                                      convertPositionToFilthy(position));
 
            m_lastNeedRect = leaf->projectionPlane()->needRect(m_lastNeedRect,
                                                               convertPositionToFilthy(position));
            m_lastNeedRect = cropThisRect(m_lastNeedRect, cropRect);
            m_childNeedRect = m_lastNeedRect;
        }
        else if(position & (N_BELOW_FILTHY | N_FILTHY_PROJECTION)) {
            if(!m_lastNeedRect.isEmpty()) {
                pushJob(leaf, position, m_lastNeedRect, flags);
 
                m_resultAccessRect |= leaf->projectionPlane()->accessRect(m_lastNeedRect,
                                                                          convertPositionToFilthy(position));
 
                m_lastNeedRect = leaf->projectionPlane()->needRect(m_lastNeedRect,
                                                                   convertPositionToFilthy(position));
                m_lastNeedRect = cropThisRect(m_lastNeedRect, cropRect);
            }
        }
        else {
            // N_FILTHY_ORIGINAL is not used so it goes there
            qFatal("KisBaseRectsWalker: node position(%d) is out of range", position);
        }
 
        if(!m_needRectVaries)
            m_needRectVaries = m_resultNeedRect != m_lastNeedRect;
        m_resultNeedRect |= m_lastNeedRect;
    }

◆ requestedRect()

QRect KisBaseRectsWalker::requestedRect ( ) const

inline

Definition at line 229 of file kis_base_rects_walker.h.

                                       {
        return m_requestedRect;
    }

◆ setClonesDontInvalidateFrames()

void KisBaseRectsWalker::setClonesDontInvalidateFrames ( bool value )

inline

Definition at line 179 of file kis_base_rects_walker.h.

                                                          {
        m_clonesDontInvalidateFrames = value;
    }

References value().

◆ setCropRect()

void KisBaseRectsWalker::setCropRect ( QRect cropRect )

inline

Definition at line 187 of file kis_base_rects_walker.h.

                                            {
        m_cropRect = cropRect;
    }

◆ setExplicitChangeRect()

void KisBaseRectsWalker::setExplicitChangeRect	(	const QRect &	changeRect,
		bool	changeRectVaries )

inlineprotected

Used by KisFullRefreshWalker as it has a special changeRect strategy

Definition at line 299 of file kis_base_rects_walker.h.

                                                                                      {
        m_resultChangeRect = changeRect;
        m_resultUncroppedChangeRect = changeRect;
        m_changeRectVaries = changeRectVaries;
    }

◆ startNode()

KisNodeSP KisBaseRectsWalker::startNode ( ) const

inline

Definition at line 225 of file kis_base_rects_walker.h.

                                       {
        return m_startNode;
    }

◆ startTrip()

virtual void KisBaseRectsWalker::startTrip ( KisProjectionLeafSP startWith )

protectedpure virtual

Initiates collecting of rects. Should be implemented in derived classes

Implemented in KisFullRefreshWalker, KisMergeWalker, KisRefreshSubtreeWalker, and KisMergeWalker.

◆ type()

virtual UpdateType KisBaseRectsWalker::type ( ) const

pure virtual

Implemented in KisFullRefreshWalker, KisMergeWalker, and KisRefreshSubtreeWalker.

◆ uncroppedChangeRect()

QRect KisBaseRectsWalker::uncroppedChangeRect ( ) const

inline

Definition at line 213 of file kis_base_rects_walker.h.

                                             {
        return m_resultUncroppedChangeRect;
    }

◆ visitSubtreeTopToBottom()

void KisBaseRectsWalker::visitSubtreeTopToBottom	(	KisProjectionLeafSP	startWith,
		SubtreeVisitFlags	flags,
		KisRenderPassFlags	renderFlags,
		const QRect &	cropRect )

protected

If the node is not renderable and we don't care about hidden groups, e.g. when generating animation frames, then just skip the entire group.

registerNeedRect() and registerCloneNotification() automatically skip non-layer leafs

we didn't have a change-rect pass, so we should add clone notifications manually

In no-filthy mode we just recompose the root layer without entering any subgroups

Definition at line 73 of file kis_base_rects_walker.cpp.

{
    if (flags & SkipNonRenderableNodes && !startWith->shouldBeRendered()) return;
 
    KisProjectionLeafSP currentLeaf = startWith->lastChild();
    while(currentLeaf) {
        NodePosition pos = (flags & NoFilthyMode ? N_ABOVE_FILTHY : N_FILTHY) |
            calculateNodePosition(currentLeaf);
        registerNeedRect(currentLeaf, pos, renderFlags, cropRect);
 
        if (!flags.testFlag(DontNotifyClones)) {
            registerCloneNotification(currentLeaf->node(), pos);
        }
 
        currentLeaf = currentLeaf->prevSibling();
    }
 
    if (flags & NoFilthyMode) return;
 
    currentLeaf = startWith->lastChild();
    while(currentLeaf) {
        if(currentLeaf->canHaveChildLayers()) {
            visitSubtreeTopToBottom(currentLeaf, flags, renderFlags, cropRect);
        }
        currentLeaf = currentLeaf->prevSibling();
    }
}

References calculateNodePosition(), cropRect(), DontNotifyClones, N_ABOVE_FILTHY, N_FILTHY, NoFilthyMode, registerCloneNotification(), registerNeedRect(), SkipNonRenderableNodes, and visitSubtreeTopToBottom().

Member Data Documentation

◆ m_changeRectVaries

bool KisBaseRectsWalker::m_changeRectVaries {false}

private

Definition at line 505 of file kis_base_rects_walker.h.

505{false};

◆ m_childNeedRect

QRect KisBaseRectsWalker::m_childNeedRect

private

Definition at line 534 of file kis_base_rects_walker.h.

◆ m_cloneNotifications

CloneNotificationsVector KisBaseRectsWalker::m_cloneNotifications

private

Definition at line 507 of file kis_base_rects_walker.h.

◆ m_clonesDontInvalidateFrames

bool KisBaseRectsWalker::m_clonesDontInvalidateFrames {false}

private

Definition at line 539 of file kis_base_rects_walker.h.

539{false};

◆ m_cropRect

QRect KisBaseRectsWalker::m_cropRect

private

Temporary variables

Definition at line 532 of file kis_base_rects_walker.h.

◆ m_graphChecksum

qint32 KisBaseRectsWalker::m_graphChecksum {0}

private

Used for getting know whether the structure of the graph has changed since the walker was calculated

Definition at line 527 of file kis_base_rects_walker.h.

527{0};

◆ m_lastNeedRect

QRect KisBaseRectsWalker::m_lastNeedRect

private

Definition at line 535 of file kis_base_rects_walker.h.

◆ m_levelOfDetail

int KisBaseRectsWalker::m_levelOfDetail {0}

private

Definition at line 537 of file kis_base_rects_walker.h.

537{0};

◆ m_mergeTask

LeafStack KisBaseRectsWalker::m_mergeTask

private

Definition at line 506 of file kis_base_rects_walker.h.

◆ m_needRectVaries

bool KisBaseRectsWalker::m_needRectVaries {false}

private

Definition at line 504 of file kis_base_rects_walker.h.

504{false};

◆ m_nodeChecksum

qint32 KisBaseRectsWalker::m_nodeChecksum {0}

private

Used for getting know whether the start node properties have changed since the walker was calculated

Definition at line 520 of file kis_base_rects_walker.h.

520{0};

◆ m_requestedRect

QRect KisBaseRectsWalker::m_requestedRect

private

Definition at line 513 of file kis_base_rects_walker.h.

◆ m_resultAccessRect

QRect KisBaseRectsWalker::m_resultAccessRect

private

The result variables. By the end of a recursion they will store a complete data for a successful merge operation.

Definition at line 500 of file kis_base_rects_walker.h.

◆ m_resultChangeRect

QRect KisBaseRectsWalker::m_resultChangeRect

private

Definition at line 502 of file kis_base_rects_walker.h.

◆ m_resultNeedRect

QRect KisBaseRectsWalker::m_resultNeedRect

private

Definition at line 501 of file kis_base_rects_walker.h.

◆ m_resultUncroppedChangeRect

QRect KisBaseRectsWalker::m_resultUncroppedChangeRect

private

Definition at line 503 of file kis_base_rects_walker.h.

◆ m_startNode

KisNodeSP KisBaseRectsWalker::m_startNode

private

Used by update optimization framework

Definition at line 512 of file kis_base_rects_walker.h.

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

libs/image/kis_base_rects_walker.h
libs/image/kis_base_rects_walker.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CloneNotificationsVector

◆ LeafStack

◆ NodePosition

Member Enumeration Documentation

◆ NodePositionValues

◆ SubtreeVisitFlag

◆ UpdateType

Constructor & Destructor Documentation

◆ KisBaseRectsWalker()

◆ ~KisBaseRectsWalker()

Member Function Documentation

◆ accessRect()

◆ addCloneSourceRegenerationJobs()

◆ adjustMasksChangeRect()

◆ calculateChecksum()

◆ calculateNodePosition()

◆ changeRect()

◆ changeRectVaries()

◆ checksumValid()

◆ clear()

◆ cloneNotifications()

◆ clonesDontInvalidateFrames()

◆ collectRects()

◆ convertPositionToFilthy()

◆ cropRect()

◆ cropThisRect()

◆ getGraphPosition()

◆ getNodeLevelOfDetail()

◆ hasClones()

◆ isStartLeaf()

◆ leafStack()

◆ levelOfDetail()

◆ needRectVaries()

◆ pushJob()

◆ Q_DECLARE_FLAGS()

◆ recalculate()

◆ registerChangeRect()

◆ registerCloneNotification()

◆ registerNeedRect() [1/2]

◆ registerNeedRect() [2/2]

◆ requestedRect()

◆ setClonesDontInvalidateFrames()

◆ setCropRect()

◆ setExplicitChangeRect()

◆ startNode()

◆ startTrip()

◆ type()

◆ uncroppedChangeRect()

◆ visitSubtreeTopToBottom()

Member Data Documentation

◆ m_changeRectVaries

◆ m_childNeedRect

◆ m_cloneNotifications

◆ m_clonesDontInvalidateFrames

◆ m_cropRect

◆ m_graphChecksum

◆ m_lastNeedRect

◆ m_levelOfDetail

◆ m_mergeTask

◆ m_needRectVaries

◆ m_nodeChecksum

◆ m_requestedRect

◆ m_resultAccessRect

◆ m_resultChangeRect

◆ m_resultNeedRect

◆ m_resultUncroppedChangeRect

◆ m_startNode