KisBatchNodeUpdate Class Reference

#include <KisBatchNodeUpdate.h>

Inheritance diagram for KisBatchNodeUpdate:

Public Member Functions
void	addUpdate (KisNodeSP node, const QRect &rc)
void	compress ()
KisBatchNodeUpdate	compressed () const
	KisBatchNodeUpdate ()=default
	KisBatchNodeUpdate (const KisBatchNodeUpdate &rhs)=default
	KisBatchNodeUpdate (const std::vector< std::pair< KisNodeSP, QRect > > &rhs)
	KisBatchNodeUpdate (KisBatchNodeUpdate &&rhs)=default
KisBatchNodeUpdate &	operator= (const KisBatchNodeUpdate &rhs)=default
KisBatchNodeUpdate &	operator|= (const KisBatchNodeUpdate &rhs)

Detailed Description

A simple class for storing the updates of multiple nodes in a single place. These updates may later be "compressed", which means that only the topmost root layers will get updates. In such a case the update should be issued as refreshGraphAsync().

Definition at line 23 of file KisBatchNodeUpdate.h.

Constructor & Destructor Documentation

KisBatchNodeUpdate() [1/4]

KisBatchNodeUpdate::KisBatchNodeUpdate ( )

default

KisBatchNodeUpdate() [2/4]

KisBatchNodeUpdate::KisBatchNodeUpdate ( const KisBatchNodeUpdate & rhs )

default

KisBatchNodeUpdate() [3/4]

KisBatchNodeUpdate::KisBatchNodeUpdate ( KisBatchNodeUpdate && rhs )

default

KisBatchNodeUpdate() [4/4]

KisBatchNodeUpdate::KisBatchNodeUpdate

(

const std::vector< std::pair< KisNodeSP, QRect > > &

rhs

)

Definition at line 12 of file KisBatchNodeUpdate.cpp.

    : std::vector<std::pair<KisNodeSP, QRect>>(rhs)
{
 
}

Member Function Documentation

addUpdate()

void KisBatchNodeUpdate::addUpdate	(	KisNodeSP	node,
		const QRect &	rc )

Add an update designated for node with dirty rect rc

Please node that adding multiple updates for the same node, will result in multiple records added into the internal vector. These duplicated records may be resolved by calling compress() method.

See also

compress()

Definition at line 18 of file KisBatchNodeUpdate.cpp.

{
    push_back(std::make_pair(node, rc));
}

compress()

void KisBatchNodeUpdate::compress

(

)

Compress the stored updates:

1) All updates for the same node will be merged into one

2) If the list contains a child and its parent, the two updates will be merged into one. This new update record will be designated for the parent.

The idea is that the parent will be updated with refreshGraphAsync(), which would update the child anyway.

Definition at line 23 of file KisBatchNodeUpdate.cpp.

{
    *this = compressed();
}

References compressed().

compressed()

KisBatchNodeUpdate KisBatchNodeUpdate::compressed

(

)

const

See also

compress()

Definition at line 28 of file KisBatchNodeUpdate.cpp.

{
    KisBatchNodeUpdate newUpdateData;
 
    KisNodeList rootNodes;
 
    std::transform(begin(), end(), std::back_inserter(rootNodes),
              [] (const std::pair<KisNodeSP, QRect> &update) {return update.first; });
 
    rootNodes = KisLayerUtils::sortAndFilterMergeableInternalNodes(rootNodes, true);
 
    Q_FOREACH (KisNodeSP root, rootNodes) {
        QRect dirtyRect;
 
        for (auto it = begin(); it != end(); ++it) {
            if (it->first == root || KisLayerUtils::checkIsChildOf(it->first, {root})) {
                dirtyRect |= it->second;
            }
        }
 
        newUpdateData.push_back(std::make_pair(root, dirtyRect));
    }
 
    return newUpdateData;
}

References KisLayerUtils::checkIsChildOf(), and KisLayerUtils::sortAndFilterMergeableInternalNodes().

operator=()

KisBatchNodeUpdate & KisBatchNodeUpdate::operator= ( const KisBatchNodeUpdate & rhs )

default

operator|=()

KisBatchNodeUpdate & KisBatchNodeUpdate::operator|=

(

const KisBatchNodeUpdate &

rhs

)

Merge two update batches. The updates for the same nodes will be merged. This merge operation does not do parent-child compression though. You need to call compress() separately for that.

Definition at line 54 of file KisBatchNodeUpdate.cpp.

{
    if (this == &rhs)
        return *this;
 
    reserve(size() + rhs.size());
 
    std::copy(rhs.begin(), rhs.end(), std::back_inserter(*this));
    std::sort(begin(), end(), [](const std::pair<KisNodeSP, QRect> &lhs, const std::pair<KisNodeSP, QRect> &rhs) { return lhs.first.data() < rhs.first.data(); });
 
    if (size() <= 1)
        return *this;
 
    for (auto prevIt = begin(), it = next(prevIt); it != end();) {
        if (prevIt->first == it->first) {
            prevIt->second |= it->second;
            it = erase(it);
        } else {
            ++prevIt;
            ++it;
        }
    }
 
    return *this;
}

---

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

• libs/image/KisBatchNodeUpdate.h
• libs/image/KisBatchNodeUpdate.cpp