#include <kis_full_refresh_walker.h>

Inheritance diagram for KisFullRefreshWalker:

Public Types
enum	Flag

Public Types inherited from KisRefreshSubtreeWalker
enum	Flag { None = 0x0 , SkipNonRenderableNodes = 0x1 , NoFilthyMode = 0x2 , DontAdjustChangeRect = 0x4 , ClonesDontInvalidateFrames = 0x8 }

Public Types inherited from KisBaseRectsWalker
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 Types inherited from KisMergeWalker
enum	Flag { DEFAULT = 0 , NO_FILTHY = 0x1 , CLONES_DONT_INVALIDATE_FRAMES = 0x2 }

Public Member Functions
void	adjustMasksChangeRect (KisProjectionLeafSP firstMask) override

	KisFullRefreshWalker (QRect cropRect, Flags flags=None)

void	registerChangeRect (KisProjectionLeafSP leaf, NodePosition position) override

void	registerNeedRect (KisProjectionLeafSP leaf, NodePosition position, KisRenderPassFlags renderFlags, const QRect &cropRect) override

void	startTrip (KisProjectionLeafSP startWith) override

UpdateType	type () const override

Public Member Functions inherited from KisRefreshSubtreeWalker
Flags	flags () const

	KisRefreshSubtreeWalker (QRect cropRect, Flags flags=None)

	Q_DECLARE_FLAGS (Flags, Flag)

UpdateType	type () const override

	~KisRefreshSubtreeWalker () override

Public Member Functions inherited from KisBaseRectsWalker
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

QRect	uncroppedChangeRect () const

virtual	~KisBaseRectsWalker ()

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Public Member Functions inherited from KisMergeWalker
	KisMergeWalker (QRect cropRect, Flags flags=DEFAULT)

UpdateType	type () const override

	~KisMergeWalker () override

Private Attributes
UpdateType	m_currentUpdateType { UPDATE }

bool	m_firstRun { true }

Additional Inherited Members
Static Public Member Functions inherited from KisBaseRectsWalker
static KisNode::PositionToFilthy	convertPositionToFilthy (NodePosition position)

Protected Member Functions inherited from KisRefreshSubtreeWalker
	KisRefreshSubtreeWalker ()

void	startTrip (KisProjectionLeafSP startWith) override

Protected Member Functions inherited from KisBaseRectsWalker
void	addCloneSourceRegenerationJobs ()

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)

void	registerCloneNotification (KisNodeSP node, NodePosition position)

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

void	setExplicitChangeRect (const QRect &changeRect, bool changeRectVaries)

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

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Protected Member Functions inherited from KisMergeWalker
	KisMergeWalker ()

	KisMergeWalker (Flags flags)

void	startTrip (KisProjectionLeafSP startWith) override

virtual void	startTrip (KisProjectionLeafSP startWith)=0

void	startTripWithMask (KisProjectionLeafSP filthyMask, KisMergeWalker::Flags flags)

Static Protected Member Functions inherited from KisRefreshSubtreeWalker
static std::pair< QRect, bool >	calculateChangeRect (KisProjectionLeafSP startWith, const QRect &requestedRect)

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

static NodePosition	calculateNodePosition (KisProjectionLeafSP leaf)

static qint32	getGraphPosition (qint32 position)

static bool	hasClones (KisNodeSP node)

Detailed Description

Definition at line 14 of file kis_full_refresh_walker.h.

Member Enumeration Documentation

◆ Flag

enum KisRefreshSubtreeWalker::Flag

Definition at line 17 of file kis_refresh_subtree_walker.h.

              {
        None = 0x0,
        SkipNonRenderableNodes = 0x1,
        NoFilthyMode = 0x2,
        DontAdjustChangeRect = 0x4,
        ClonesDontInvalidateFrames = 0x8
    };

Constructor & Destructor Documentation

◆ KisFullRefreshWalker()

KisFullRefreshWalker::KisFullRefreshWalker	(	QRect	cropRect,
		Flags	flags = None )

inline

Definition at line 21 of file kis_full_refresh_walker.h.

        : KisRefreshSubtreeWalker(cropRect, flags | DontAdjustChangeRect),
          KisMergeWalker(cropRect, NO_FILTHY | (flags.testFlag(ClonesDontInvalidateFrames) ? CLONES_DONT_INVALIDATE_FRAMES : DEFAULT))
    {
    }

Member Function Documentation

◆ adjustMasksChangeRect()

void KisFullRefreshWalker::adjustMasksChangeRect ( KisProjectionLeafSP firstMask )

inlineoverridevirtual

Reimplemented from KisBaseRectsWalker.

Definition at line 94 of file kis_full_refresh_walker.h.

                                                                       {
        if(m_currentUpdateType == FULL_REFRESH) {
            KisRefreshSubtreeWalker::adjustMasksChangeRect(firstMask);
        }
        else {
            KisMergeWalker::adjustMasksChangeRect(firstMask);
        }
    }

References KisBaseRectsWalker::adjustMasksChangeRect(), KisBaseRectsWalker::FULL_REFRESH, and m_currentUpdateType.

◆ registerChangeRect()

void KisFullRefreshWalker::registerChangeRect	(	KisProjectionLeafSP	leaf,
		NodePosition	position )

inlineoverridevirtual

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

Merge walker thinks that we changed the original of the dirty node (dirtyNode == startNode()), but that is not true in case of full refresh walker, because all the children of the dirty node are dirty as well, that is why we shouldn't rely on usual registerChangeRect() mechanism for this node. That is why we just unite the changeRects of all its children here.

Reimplemented from KisBaseRectsWalker.

Definition at line 59 of file kis_full_refresh_walker.h.

                                                                                      {
        if(m_currentUpdateType == FULL_REFRESH) {
            KisRefreshSubtreeWalker::registerChangeRect(leaf, position);
        }
        else {
            if(isStartLeaf(leaf)&& !leaf->isRoot()) {
                QRect changeRect;
                bool changeRectVaries = false;
                std::tie(changeRect, changeRectVaries) =
                    KisRefreshSubtreeWalker::calculateChangeRect(leaf, requestedRect());
                setExplicitChangeRect(changeRect, changeRectVaries);
            }
            else {
                KisMergeWalker::registerChangeRect(leaf, position);
            }
        }
    }

References KisRefreshSubtreeWalker::calculateChangeRect(), KisBaseRectsWalker::changeRect(), KisBaseRectsWalker::changeRectVaries(), KisBaseRectsWalker::FULL_REFRESH, KisBaseRectsWalker::isStartLeaf(), m_currentUpdateType, KisBaseRectsWalker::registerChangeRect(), KisBaseRectsWalker::requestedRect(), and KisBaseRectsWalker::setExplicitChangeRect().

◆ registerNeedRect()

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

inlineoverridevirtual

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

Reimplemented from KisBaseRectsWalker.

Definition at line 86 of file kis_full_refresh_walker.h.

                                                                                                                                           {
        if(m_currentUpdateType == FULL_REFRESH) {
            KisRefreshSubtreeWalker::registerNeedRect(leaf, position, renderFlags, cropRect);
        }
        else {
            KisMergeWalker::registerNeedRect(leaf, position, renderFlags, cropRect);
        }
    }

References KisBaseRectsWalker::cropRect(), KisBaseRectsWalker::FULL_REFRESH, m_currentUpdateType, and KisBaseRectsWalker::registerNeedRect().

◆ startTrip()

void KisFullRefreshWalker::startTrip ( KisProjectionLeafSP startWith )

inlineoverridevirtual

Initiates collecting of rects. Should be implemented in derived classes

Implements KisBaseRectsWalker.

Definition at line 32 of file kis_full_refresh_walker.h.

                                                           {
        if(m_firstRun) {
            m_firstRun = false;
 
            m_currentUpdateType = UPDATE;
            KisMergeWalker::startTrip(startWith);
 
            m_currentUpdateType = FULL_REFRESH;
 
            if (!startWith->dependsOnLowerNodes()) {
                KisRefreshSubtreeWalker::startTrip(startWith);
            } else {
                KIS_SAFE_ASSERT_RECOVER_NOOP(!startWith->canHaveChildLayers());
            }
 
            m_firstRun = true;
        }
        else {
            if(m_currentUpdateType == FULL_REFRESH) {
                KisRefreshSubtreeWalker::startTrip(startWith);
            }
            else {
                KisMergeWalker::startTrip(startWith);
            }
        }
    }

References KisBaseRectsWalker::FULL_REFRESH, KIS_SAFE_ASSERT_RECOVER_NOOP, m_currentUpdateType, m_firstRun, KisMergeWalker::startTrip(), KisRefreshSubtreeWalker::startTrip(), and KisBaseRectsWalker::UPDATE.

◆ type()

UpdateType KisFullRefreshWalker::type ( ) const

inlineoverridevirtual

Implements KisBaseRectsWalker.

Definition at line 27 of file kis_full_refresh_walker.h.

                                     {
        return KisRefreshSubtreeWalker::flags() & NoFilthyMode ?
            FULL_REFRESH_NO_FILTHY : FULL_REFRESH;
    }

References KisRefreshSubtreeWalker::flags(), KisBaseRectsWalker::FULL_REFRESH, KisBaseRectsWalker::FULL_REFRESH_NO_FILTHY, and KisRefreshSubtreeWalker::NoFilthyMode.

Member Data Documentation

◆ m_currentUpdateType

UpdateType KisFullRefreshWalker::m_currentUpdateType { UPDATE }

private

Definition at line 104 of file kis_full_refresh_walker.h.

104{ UPDATE };

◆ m_firstRun

bool KisFullRefreshWalker::m_firstRun { true }

private

Definition at line 105 of file kis_full_refresh_walker.h.

105{ true };

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

libs/image/kis_full_refresh_walker.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Flag

Constructor & Destructor Documentation

◆ KisFullRefreshWalker()

Member Function Documentation

◆ adjustMasksChangeRect()

◆ registerChangeRect()

◆ registerNeedRect()

◆ startTrip()

◆ type()

Member Data Documentation

◆ m_currentUpdateType

◆ m_firstRun