KisSaveGroupVisitor Class Reference

The KisSaveGroupVisitor class saves the groups in a Krita image to separate images. More...

#include <KisSaveGroupVisitor.h>

Inheritance diagram for KisSaveGroupVisitor:

Public Member Functions
	KisSaveGroupVisitor (KisImageWSP image, bool saveInvisible, bool saveTopLevelOnly, const QString &path, const QString &baseName, const QString &extension, const QString &mimeFilter)
bool	visit (KisAdjustmentLayer *) override
bool	visit (KisCloneLayer *) override
bool	visit (KisColorizeMask *) override
bool	visit (KisExternalLayer *) override
bool	visit (KisFilterMask *) override
bool	visit (KisGeneratorLayer *) override
bool	visit (KisGroupLayer *layer) override
bool	visit (KisNode *) override
bool	visit (KisPaintLayer *) override
bool	visit (KisSelectionMask *) override
bool	visit (KisTransformMask *) override
bool	visit (KisTransparencyMask *) override
	~KisSaveGroupVisitor () override
Public Member Functions inherited from KisNodeVisitor
	KisNodeVisitor ()
virtual	~KisNodeVisitor ()

Private Attributes
QString	m_baseName
QString	m_extension
KisImageWSP	m_image
QString	m_mimeFilter
QString	m_path
bool	m_saveInvisible
bool	m_saveTopLevelOnly

Additional Inherited Members
Protected Member Functions inherited from KisNodeVisitor
bool	visitAll (KisNode *node, bool breakOnFail=false)
bool	visitAllInverse (KisNode *node, bool breakOnFail=false)

Detailed Description

The KisSaveGroupVisitor class saves the groups in a Krita image to separate images.

Definition at line 26 of file KisSaveGroupVisitor.h.

Constructor & Destructor Documentation

KisSaveGroupVisitor()

KisSaveGroupVisitor::KisSaveGroupVisitor	(	KisImageWSP	image,
		bool	saveInvisible,
		bool	saveTopLevelOnly,
		const QString &	path,
		const QString &	baseName,
		const QString &	extension,
		const QString &	mimeFilter )

Create a KisSaveGroupVisitor

Parameters

image	the image to save
saveInvisible	also save invisible layers
saveTopLevelOnly	if true, only save the toplevel layers, otherwise descend into groups and save the bottom-most groups (groups that do not contain another group.
path	the base location where the images will be saved
baseName	the basename of the images
extension	the file format extension
mimeFilter	the export image type

Definition at line 13 of file KisSaveGroupVisitor.cpp.

    : m_image(image)
    , m_saveInvisible(saveInvisible)
    , m_saveTopLevelOnly(saveTopLevelOnly)
    , m_path(path)
    , m_baseName(baseName)
    , m_extension(extension)
    , m_mimeFilter(mimeFilter)
{
}

~KisSaveGroupVisitor()

KisSaveGroupVisitor::~KisSaveGroupVisitor ( )

override

Definition at line 30 of file KisSaveGroupVisitor.cpp.

{
}

Member Function Documentation

visit() [1/12]

bool KisSaveGroupVisitor::visit ( KisAdjustmentLayer * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 42 of file KisSaveGroupVisitor.cpp.

                                                    {
    return true;
}

visit() [2/12]

bool KisSaveGroupVisitor::visit ( KisCloneLayer * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 51 of file KisSaveGroupVisitor.cpp.

                                               {
    return true;
}

visit() [3/12]

bool KisSaveGroupVisitor::visit ( KisColorizeMask * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 76 of file KisSaveGroupVisitor.cpp.

                                                 {
    return true;
}

visit() [4/12]

bool KisSaveGroupVisitor::visit ( KisExternalLayer * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 46 of file KisSaveGroupVisitor.cpp.

                                                  {
    return true;
}

visit() [5/12]

bool KisSaveGroupVisitor::visit ( KisFilterMask * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 56 of file KisSaveGroupVisitor.cpp.

                                               {
    return true;
}

visit() [6/12]

bool KisSaveGroupVisitor::visit ( KisGeneratorLayer * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 68 of file KisSaveGroupVisitor.cpp.

                                                    {
    return true;
}

visit() [7/12]

bool KisSaveGroupVisitor::visit ( KisGroupLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 80 of file KisSaveGroupVisitor.cpp.

{
    if (layer == m_image->rootLayer()) {
        KisLayerSP child = qobject_cast<KisLayer*>(layer->firstChild().data());
        while (child) {
            child->accept(*this);
            child = qobject_cast<KisLayer*>(child->nextSibling().data());
        }
 
    }
    else if (layer->visible() || m_saveInvisible) {
 
        QRect r = m_image->bounds();
 
        KisDocument *exportDocument = KisPart::instance()->createDocument();
        { // make sure dst is deleted before calling 'delete exportDocument',
          // since KisDocument checks that its image is properly deref()'d.
          KisImageSP dst = new KisImage(exportDocument->createUndoStore(), r.width(), r.height(), m_image->colorSpace(), layer->name());
          dst->setResolution(m_image->xRes(), m_image->yRes());
          exportDocument->setCurrentImage(dst);
          KisPaintLayer* paintLayer = new KisPaintLayer(dst, "projection", layer->opacity());
          KisPainter gc(paintLayer->paintDevice());
          gc.bitBlt(QPoint(0, 0), layer->projection(), r);
          dst->addNode(paintLayer, dst->rootLayer(), KisLayerSP(0));
 
          dst->initialRefreshGraph();
        }
 
        QString path = m_path + "/" + m_baseName + "_" + layer->name().replace(' ', '_') + '.' + m_extension;
 
        exportDocument->setFileBatchMode(true);
        exportDocument->exportDocumentSync(path, m_mimeFilter.toLatin1());
 
        if (!m_saveTopLevelOnly) {
            KisGroupLayerSP child = dynamic_cast<KisGroupLayer*>(layer->firstChild().data());
            while (child) {
                child->accept(*this);
                child = dynamic_cast<KisGroupLayer*>(child->nextSibling().data());
            }
        }
        delete exportDocument;
    }
 
    return true;
}

References KisGroupLayer::accept(), KisNode::accept(), KisNodeFacade::addNode(), KisPainter::bitBlt(), KisImage::bounds(), KisImage::colorSpace(), KisPart::createDocument(), KisDocument::createUndoStore(), KisSharedPtr< T >::data(), KisDocument::exportDocumentSync(), KisNode::firstChild(), KisImage::initialRefreshGraph(), KisPart::instance(), m_baseName, m_extension, m_image, m_mimeFilter, m_path, m_saveInvisible, m_saveTopLevelOnly, KisBaseNode::name(), KisNode::nextSibling(), KisBaseNode::opacity(), KisPaintLayer::paintDevice, KisLayer::projection(), KisImage::rootLayer(), KisDocument::setCurrentImage(), KisDocument::setFileBatchMode(), KisImage::setResolution(), KisBaseNode::visible(), KisImage::xRes(), and KisImage::yRes().

visit() [8/12]

bool KisSaveGroupVisitor::visit ( KisNode * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 34 of file KisSaveGroupVisitor.cpp.

                                         {
    return true;
}

visit() [9/12]

bool KisSaveGroupVisitor::visit ( KisPaintLayer * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 38 of file KisSaveGroupVisitor.cpp.

                                               {
    return true;
}

visit() [10/12]

bool KisSaveGroupVisitor::visit ( KisSelectionMask * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 72 of file KisSaveGroupVisitor.cpp.

                                                  {
    return true;
}

visit() [11/12]

bool KisSaveGroupVisitor::visit ( KisTransformMask * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 60 of file KisSaveGroupVisitor.cpp.

                                                  {
    return true;
}

visit() [12/12]

bool KisSaveGroupVisitor::visit ( KisTransparencyMask * )

overridevirtual

Implements KisNodeVisitor.

Definition at line 64 of file KisSaveGroupVisitor.cpp.

                                                     {
    return true;
}

Member Data Documentation

m_baseName

QString KisSaveGroupVisitor::m_baseName

private

Definition at line 85 of file KisSaveGroupVisitor.h.

m_extension

QString KisSaveGroupVisitor::m_extension

private

Definition at line 86 of file KisSaveGroupVisitor.h.

m_image

KisImageWSP KisSaveGroupVisitor::m_image

private

Definition at line 81 of file KisSaveGroupVisitor.h.

m_mimeFilter

QString KisSaveGroupVisitor::m_mimeFilter

private

Definition at line 87 of file KisSaveGroupVisitor.h.

m_path

QString KisSaveGroupVisitor::m_path

private

Definition at line 84 of file KisSaveGroupVisitor.h.

m_saveInvisible

bool KisSaveGroupVisitor::m_saveInvisible

private

Definition at line 82 of file KisSaveGroupVisitor.h.

m_saveTopLevelOnly

bool KisSaveGroupVisitor::m_saveTopLevelOnly

private

Definition at line 83 of file KisSaveGroupVisitor.h.

---

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

• libs/ui/KisSaveGroupVisitor.h
• libs/ui/KisSaveGroupVisitor.cpp