KisLayerComposition Class Reference

#include <kis_layer_composition.h>

Public Member Functions
void	apply ()
bool	isExportEnabled ()
	KisLayerComposition (const KisLayerComposition &rhs, KisImageWSP otherImage=0)
	KisLayerComposition (KisImageWSP image, const QString &name)
QString	name ()
void	save (QDomDocument &doc, QDomElement &element)
void	setCollapsed (QUuid id, bool collapsed)
void	setExportEnabled (bool enabled)
void	setName (const QString &name)
void	setVisible (QUuid id, bool visible)
void	store ()
	~KisLayerComposition ()

Private Attributes
QMap< QUuid, bool >	m_collapsedMap
bool	m_exportEnabled
KisImageWSP	m_image
QString	m_name
QMap< QUuid, bool >	m_visibilityMap

Friends
class	KisCompositionVisitor

Detailed Description

Storage class for layer compositions. Layer compositions allow to have several states for visible layers e.g. used in storyboarding with one background and different foregrounds

Definition at line 23 of file kis_layer_composition.h.

Constructor & Destructor Documentation

KisLayerComposition() [1/2]

KisLayerComposition::KisLayerComposition	(	KisImageWSP	image,
		const QString &	name )

Definition at line 90 of file kis_layer_composition.cpp.

    : m_image(image)
    , m_name(name)
    , m_exportEnabled(true)
{
 
}

~KisLayerComposition()

KisLayerComposition::~KisLayerComposition

(

)

Definition at line 98 of file kis_layer_composition.cpp.

{
 
}

KisLayerComposition() [2/2]

KisLayerComposition::KisLayerComposition	(	const KisLayerComposition &	rhs,
		KisImageWSP	otherImage = 0 )

Definition at line 103 of file kis_layer_composition.cpp.

    : m_image(otherImage ? otherImage : rhs.m_image),
      m_name(rhs.m_name),
      m_exportEnabled(rhs.m_exportEnabled)
{
    {
        auto it = rhs.m_visibilityMap.constBegin();
        for (; it != rhs.m_visibilityMap.constEnd(); ++it) {
            QUuid nodeUuid = it.key();
            KisNodeSP node = KisLayerUtils::findNodeByUuid(rhs.m_image->root(), nodeUuid);
            if (node) {
                KisNodeQueryPath path = KisNodeQueryPath::absolutePath(node);
                KisNodeSP newNode = path.queryUniqueNode(m_image);
                KIS_ASSERT_RECOVER(newNode) { continue; }
 
                m_visibilityMap.insert(newNode->uuid(), it.value());
            }
        }
    }
 
    {
        auto it = rhs.m_collapsedMap.constBegin();
        for (; it != rhs.m_collapsedMap.constEnd(); ++it) {
            QUuid nodeUuid = it.key();
            KisNodeSP node = KisLayerUtils::findNodeByUuid(rhs.m_image->root(), nodeUuid);
            if (node) {
                KisNodeQueryPath path = KisNodeQueryPath::absolutePath(node);
                KisNodeSP newNode = path.queryUniqueNode(m_image);
                KIS_ASSERT_RECOVER(newNode) { continue; }
 
                m_collapsedMap.insert(newNode->uuid(), it.value());
            }
        }
    }
}

References KisNodeQueryPath::absolutePath(), KisLayerUtils::findNodeByUuid(), KIS_ASSERT_RECOVER, m_collapsedMap, m_image, m_visibilityMap, KisNodeFacade::root, and KisBaseNode::uuid().

Member Function Documentation

apply()

void KisLayerComposition::apply

(

)

Applies the stored visibility to all the nodes

Definition at line 158 of file kis_layer_composition.cpp.

{
    if (m_image.isNull()) {
        return;
    }
    KisCompositionVisitor visitor(this, KisCompositionVisitor::APPLY);
    m_image->rootLayer()->accept(visitor);
}

References KisGroupLayer::accept(), KisCompositionVisitor::APPLY, KisWeakSharedPtr< T >::isNull(), m_image, and KisImage::rootLayer().

isExportEnabled()

bool KisLayerComposition::isExportEnabled

(

)

Export enabled flag, if false the compositions will not be exported

Returns

name of the composition

Definition at line 172 of file kis_layer_composition.cpp.

{
    return m_exportEnabled;
}

References m_exportEnabled.

name()

QString KisLayerComposition::name

(

)

Name of the composition as show in the docker

Returns

name of the composition

Definition at line 144 of file kis_layer_composition.cpp.

{
    return m_name;
}

References m_name.

save()

void KisLayerComposition::save	(	QDomDocument &	doc,
		QDomElement &	element )

Definition at line 187 of file kis_layer_composition.cpp.

{
    QDomElement compositionElement = doc.createElement("composition");
    compositionElement.setAttribute("name", m_name);
    compositionElement.setAttribute("exportEnabled", m_exportEnabled);
    QMapIterator<QUuid, bool> iter(m_visibilityMap);
    while (iter.hasNext()) {
        iter.next();
        QDomElement valueElement = doc.createElement("value");
        dbgKrita << "uuid" << iter.key().toString() << "visible" <<  iter.value();
        valueElement.setAttribute("uuid", iter.key().toString());
        valueElement.setAttribute("visible", iter.value());
        dbgKrita << "contains" << m_collapsedMap.contains(iter.key());
        if (m_collapsedMap.contains(iter.key())) {
            dbgKrita << "collapsed :" << m_collapsedMap[iter.key()];
            valueElement.setAttribute("collapsed", m_collapsedMap[iter.key()]);
        }
        compositionElement.appendChild(valueElement);
    }
    element.appendChild(compositionElement);
}

References dbgKrita, m_collapsedMap, m_exportEnabled, m_name, and m_visibilityMap.

setCollapsed()

void KisLayerComposition::setCollapsed	(	QUuid	id,
		bool	collapsed )

Definition at line 182 of file kis_layer_composition.cpp.

{
    m_collapsedMap[id] = collapsed;
}

References m_collapsedMap.

setExportEnabled()

void KisLayerComposition::setExportEnabled

(

bool

enabled

)

Set the export enabled flag, if false the compositions will not be exported

Definition at line 167 of file kis_layer_composition.cpp.

{
    m_exportEnabled = enabled;
}

References m_exportEnabled.

setName()

void KisLayerComposition::setName

(

const QString &

name

)

Sets name of the composition

Definition at line 139 of file kis_layer_composition.cpp.

{
    m_name = name;
}

References m_name, and name().

setVisible()

void KisLayerComposition::setVisible	(	QUuid	id,
		bool	visible )

Definition at line 177 of file kis_layer_composition.cpp.

{
    m_visibilityMap[id] = visible;
}

References m_visibilityMap.

store()

void KisLayerComposition::store

(

)

Stores the current visibility of all layers in the composition

Definition at line 149 of file kis_layer_composition.cpp.

{
    if(m_image.isNull()) {
        return;
    }
    KisCompositionVisitor visitor(this, KisCompositionVisitor::STORE);
    m_image->rootLayer()->accept(visitor);
}

References KisGroupLayer::accept(), KisWeakSharedPtr< T >::isNull(), m_image, KisImage::rootLayer(), and KisCompositionVisitor::STORE.

Friends And Related Symbol Documentation

KisCompositionVisitor

friend class KisCompositionVisitor

friend

Definition at line 76 of file kis_layer_composition.h.

Member Data Documentation

m_collapsedMap

QMap<QUuid, bool> KisLayerComposition::m_collapsedMap

private

Definition at line 73 of file kis_layer_composition.h.

m_exportEnabled

bool KisLayerComposition::m_exportEnabled

private

Definition at line 74 of file kis_layer_composition.h.

m_image

KisImageWSP KisLayerComposition::m_image

private

Definition at line 70 of file kis_layer_composition.h.

m_name

QString KisLayerComposition::m_name

private

Definition at line 71 of file kis_layer_composition.h.

m_visibilityMap

QMap<QUuid, bool> KisLayerComposition::m_visibilityMap

private

Definition at line 72 of file kis_layer_composition.h.

---

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

• libs/image/kis_layer_composition.h
• libs/image/kis_layer_composition.cpp