#include <kis_spriter_export.h>

Inheritance diagram for KisSpriterExport:

Public Member Functions
KisImportExportErrorCode	convert (KisDocument document, QIODevice io, KisPropertiesConfigurationSP configuration=0) override

void	initializeCapabilities () override

	KisSpriterExport (QObject *parent, const QVariantList &)

bool	supportsIO () const override
	Override and return false for the filters that use a library that cannot handle file handles, only file names.

	~KisSpriterExport () override

Public Member Functions inherited from KisImportExportFilter
virtual KisConfigWidget *	createConfigurationWidget (QWidget *parent, const QByteArray &from="", const QByteArray &to="") const
	createConfigurationWidget creates a widget that can be used to define the settings for a given import/export filter

virtual KisPropertiesConfigurationSP	defaultConfiguration (const QByteArray &from="", const QByteArray &to="") const
	defaultConfiguration defines the default settings for the given import export filter

virtual QMap< QString, KisExportCheckBase * >	exportChecks ()
	generate and return the list of capabilities of this export filter. The list

virtual bool	exportSupportsGuides () const
	exportSupportsGuides Because guides are in the document and not the image, checking for guides cannot be made an exportCheck.

KisPropertiesConfigurationSP	lastSavedConfiguration (const QByteArray &from="", const QByteArray &to="") const
	lastSavedConfiguration return the last saved configuration for this filter

	Private ()

void	setBatchMode (bool batchmode)

void	setFilename (const QString &filename)

void	setImportUserFeedBackInterface (KisImportUserFeedbackInterface *interface)

void	setMimeType (const QString &mime)

void	setRealFilename (const QString &filename)

void	setUpdater (QPointer< KoUpdater > updater)

QPointer< KoUpdater >	updater ()

virtual QString	verify (const QString &fileName) const
	Verify whether the given file is correct and readable.

	~KisImportExportFilter () override

	~Private ()

Private Member Functions
void	fillScml (QDomDocument &scml, const QString &entityName)

void	fixBone (Bone *bone)

Bone *	parseBone (const Bone *parent, KisGroupLayerSP groupLayer)

KisImportExportErrorCode	parseFolder (KisGroupLayerSP parentGroup, const QString &folderName, const QString &basePath, int *folderId=0)

KisImportExportErrorCode	savePaintDevice (KisPaintDeviceSP dev, const QString &fileName)

void	writeBone (const Bone *bone, QDomElement &timeline, QDomDocument &scml)

void	writeBoneRef (const Bone *bone, QDomElement &mainline, QDomDocument &scml)

Private Attributes
KisLayerSP	m_boneLayer

QList< Folder >	m_folders

KisImageSP	m_image

QList< SpriterObject >	m_objects

Bone *	m_rootBone {nullptr}

KisGroupLayerSP	m_rootLayer

qreal	m_timelineid {0.0}

Additional Inherited Members
Public Attributes inherited from KisImportExportFilter
bool	batchmode

QMap< QString, KisExportCheckBase * >	capabilities

QString	filename

KisImportUserFeedbackInterface *	importUserFeedBackInterface {nullptr}

QByteArray	mime

QString	realFilename

QPointer< KoUpdater >	updater

Static Public Attributes inherited from KisImportExportFilter
static const QString	CICPPrimariesTag = "CICPCompatiblePrimaries"

static const QString	CICPTransferCharacteristicsTag = "CICPCompatibleTransferFunction"

static const QString	ColorDepthIDTag = "ColorDepthID"

static const QString	ColorModelIDTag = "ColorModelID"

static const QString	HDRTag = "HDRSupported"

static const QString	ImageContainsTransparencyTag = "ImageContainsTransparency"

static const QString	sRGBTag = "sRGB"

Protected Member Functions inherited from KisImportExportFilter
void	addCapability (KisExportCheckBase *capability)

void	addSupportedColorModels (QList< QPair< KoID, KoID > > supportedColorModels, const QString &name, KisExportCheckBase::Level level=KisExportCheckBase::PARTIALLY)

bool	batchMode () const

QString	filename () const

KisImportUserFeedbackInterface *	importUserFeedBackInterface () const

	KisImportExportFilter (QObject *parent=0)

QByteArray	mimeType () const

QString	realFilename () const

void	setProgress (int value)

QString	verifyZiPBasedFiles (const QString &fileName, const QStringList &filesToCheck) const

Detailed Description

Definition at line 93 of file kis_spriter_export.h.

Constructor & Destructor Documentation

◆ KisSpriterExport()

KisSpriterExport::KisSpriterExport	(	QObject *	parent,
		const QVariantList &	)

Definition at line 47 of file kis_spriter_export.cpp.

                                                                        : KisImportExportFilter(parent)
{
}

◆ ~KisSpriterExport()

KisSpriterExport::~KisSpriterExport ( )

override

Definition at line 51 of file kis_spriter_export.cpp.

52{

53}

Member Function Documentation

◆ convert()

KisImportExportErrorCode KisSpriterExport::convert	(	KisDocument *	document,
		QIODevice *	io,
		KisPropertiesConfigurationSP	configuration = 0 )

overridevirtual

The filter chain calls this method to perform the actual conversion. The passed mimetypes should be a pair of those you specified in your .desktop file. You have to implement this method to make the filter work.

Returns: The error status, see the #ConversionStatus enum. KisImportExportFilter::OK means that everything is alright.

Implements KisImportExportFilter.

Definition at line 469 of file kis_spriter_export.cpp.

{
    QFileInfo fi(filename());
 
    m_image = document->savingImage();
 
    if (m_image->rootLayer()->childCount() == 0) {
        return ImportExportCodes::Failure;
    }
 
    KisGroupLayerSP root = m_image->rootLayer();
 
    m_boneLayer = qobject_cast<KisLayer*>(KisLayerUtils::findNodeByName(root,"bone").data());
    //qDebug() << "Found boneLayer" << m_boneLayer;
 
    m_rootLayer= qobject_cast<KisGroupLayer*>(KisLayerUtils::findNodeByName(root,"root").data());
    //qDebug() << "Fond rootLayer" << m_rootLayer;
 
    KisImportExportErrorCode result = parseFolder(m_image->rootLayer(), "", fi.absolutePath());
    if (!result.isOk()) {
        dbgFile << "There were errors encountered while using the spriter exporter.";
        return result;
    }
 
    m_rootBone = 0;
 
    if (m_rootLayer) {
        m_rootBone = parseBone(0, m_rootLayer);
    }
    // Generate objects
    int objectId = 0;
    for (int folderIndex = 0, folderCount = m_folders.size(); folderIndex < folderCount; ++folderIndex) {
        Folder folder = m_folders[folderCount - 1 - folderIndex];
        for (int fileIndex = 0, fileCount = folder.files.size(); fileIndex < fileCount; ++ fileIndex) {
            SpriterFile file = folder.files[fileCount - 1 - fileIndex];
            SpriterObject spriterObject;
            spriterObject.id = objectId++;
            spriterObject.folderId = folder.id;
            spriterObject.fileId = file.id;
            spriterObject.x = file.x;
            spriterObject.y = -file.y;
            Bone *bone = 0;
 
            //qDebug() << "file layername" << file.layerName;
            // layer.name format: "base_name bone(bone_name) slot(slot_name)"
            if (file.layerName.contains("bone(")) {
                int start = file.layerName.indexOf("bone(") + 5;
                int end = file.layerName.indexOf(')', start);
                QString boneName = file.layerName.mid(start, end - start);
                bone = findBoneByName(m_rootBone, boneName);
            }
 
 
            // layer.name format: "base_name"
            if (!bone && m_rootBone) {
                bone = findBoneByName(m_rootBone, file.layerName);
            }
            // group.name format: "base_name bone(bone_name)"
            if (!bone && m_rootBone) {
                if (folder.groupName.contains("bone(")) {
                    int start = folder.groupName.indexOf("bone(") + 5;
                    int end = folder.groupName.indexOf(')', start);
                    QString boneName = folder.groupName.mid(start, end - start);
                    bone = findBoneByName(m_rootBone, boneName);
                }
 
                // group.name format: "base_name"
                if (!bone) {
                    bone = findBoneByName(m_rootBone, folder.groupName);
                }
            }
 
            if (!bone) {
                bone = m_rootBone;
            }
 
            if (bone) {
                spriterObject.bone = bone;
                spriterObject.localX = spriterObject.x - bone->x;
                spriterObject.localY = spriterObject.y - bone->y;
            }
            else {
                spriterObject.bone = 0;
                spriterObject.localX = spriterObject.x;
                spriterObject.localY = spriterObject.y;
            }
 
            spriterObject.localAngle = 0;
            spriterObject.localScaleX = 1.0;
            spriterObject.localScaleY = 1.0;
 
            SpriterSlot *slot = 0;
 
            // layer.name format: "base_name bone(bone_name) slot(slot_name)"
            if (file.layerName.contains("slot(")) {
                int start = file.layerName.indexOf("slot(") + 5;
                int end = file.layerName.indexOf(')', start);
                slot = new SpriterSlot();
                slot->name = file.layerName.mid(start, end - start);
                slot->defaultAttachmentFlag = file.layerName.contains("*");
            }
 
            spriterObject.slot = slot;
 
//            qDebug() << "Created object" << spriterObject.id << spriterObject.folderId
//                     << spriterObject.fileId << spriterObject.x << spriterObject.y
//                     << spriterObject.localX << spriterObject.localY;
 
            m_objects.append(spriterObject);
        }
    }
 
    // Copy object transforms
    for (int i = 0; i < m_objects.size(); ++i) {
        m_objects[i].fixLocalX = m_objects[i].localX;
        m_objects[i].fixLocalY = m_objects[i].localY;
        m_objects[i].fixLocalAngle = m_objects[i].localAngle;
        m_objects[i].fixLocalScaleX = m_objects[i].localScaleX;
        m_objects[i].fixLocalScaleY = m_objects[i].localScaleY;
    }
 
    // Calculate bone angles
    if (m_rootBone) {
        copyBone(m_rootBone);
        fixBone(m_rootBone);
    }
 
    // Generate scml
    QDomDocument scml;
    fillScml(scml, fi.completeBaseName());
 
    bool openedHere = false;
    if (!io->isOpen()) {
        openedHere = io->open(QIODevice::WriteOnly);
        if (!openedHere) {
            // unsuccessful open
            return ImportExportCodes::NoAccessToWrite;
        }
    }
 
    QString towrite = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
    if (io->write(towrite.toUtf8()) != towrite.length()) {
        return ImportExportCodes::ErrorWhileWriting;
    }
    towrite = scml.toString(4).toUtf8();
    if (io->write(towrite.toUtf8()) != towrite.length()) {
        return ImportExportCodes::ErrorWhileWriting;
    }
 
    delete m_rootBone;
 
    if (openedHere) {
        // FIXME: causes crash...
        //io->close();
    }
 
    return ImportExportCodes::OK;
}

References SpriterObject::bone, KisNode::childCount(), copyBone(), dbgFile, SpriterSlot::defaultAttachmentFlag, ImportExportCodes::ErrorWhileWriting, ImportExportCodes::Failure, SpriterObject::fileId, KisImportExportFilter::filename, Folder::files, fillScml(), findBoneByName(), KisLayerUtils::findNodeByName(), fixBone(), SpriterObject::folderId, Folder::groupName, Folder::id, SpriterObject::id, KisImportExportErrorCode::isOk(), SpriterObject::localAngle, SpriterObject::localScaleX, SpriterObject::localScaleY, SpriterObject::localX, SpriterObject::localY, m_boneLayer, m_folders, m_image, m_objects, m_rootBone, m_rootLayer, SpriterSlot::name, ImportExportCodes::NoAccessToWrite, ImportExportCodes::OK, parseBone(), parseFolder(), KisImage::rootLayer(), SpriterObject::slot, Bone::x, SpriterObject::x, Bone::y, and SpriterObject::y.

◆ fillScml()

void KisSpriterExport::fillScml	(	QDomDocument &	scml,
		const QString &	entityName )

private

Definition at line 326 of file kis_spriter_export.cpp.

{
    //qDebug() << "Creating scml" << entityName;
 
    QDomElement root = scml.createElement("spriter_data");
    scml.appendChild(root);
    root.setAttribute("scml_version", 1);
    root.setAttribute("generator", "krita");
    root.setAttribute("generator_version", qApp->applicationVersion());
 
    Q_FOREACH(const Folder &folder, m_folders) {
        QDomElement fe = scml.createElement("folder");
        root.appendChild(fe);
        fe.setAttribute("id", folder.id);
        fe.setAttribute("name", folder.name);
        Q_FOREACH(const SpriterFile &file, folder.files) {
            QDomElement fileElement = scml.createElement("file");
            fe.appendChild(fileElement);
            fileElement.setAttribute("id", file.id);
            fileElement.setAttribute("name", file.name);
            fileElement.setAttribute("width", QString::number(file.width, 'f', 2));
            fileElement.setAttribute("height", QString::number(file.height, 'f', 2));
            // qreal pivotX=0;
            // qreal pivotY=1;
            // Q_FOREACH(const SpriterObject &object, m_objects) {
                // if(file.id == object.fileId)
                // {
                    // pivotX = (0.0 -(object.fixLocalX / file.width));
                    // pivotY = (1.0 -(object.fixLocalY / file.height));
                    // break;
                // }
            // }
            // fileElement.setAttribute("pivot_x", QString::number(pivotX, 'f', 2));
            // fileElement.setAttribute("pivot_y", QString::number(pivotY, 'f', 2));
        }
    }
 
    // entity
    QDomElement entity = scml.createElement("entity");
    root.appendChild(entity);
    entity.setAttribute("id", "0");
    entity.setAttribute("name", entityName);
 
    // entity/animation
    QDomElement animation = scml.createElement("animation");
    entity.appendChild(animation);
    animation.setAttribute("id", "0");
    animation.setAttribute("name", "default");
    animation.setAttribute("length", "1000");
    animation.setAttribute("looping", "false");
 
    // entity/animation/mainline
    QDomElement mainline = scml.createElement("mainline");
    animation.appendChild(mainline);
 
    QDomElement key = scml.createElement("key");
    mainline.appendChild(key);
    key.setAttribute("id", "0");
 
    m_timelineid = 0;
    writeBoneRef(m_rootBone, key, scml);
 
    Q_FOREACH(const SpriterObject &object, m_objects) {
        QDomElement oe = scml.createElement("object_ref");
        key.appendChild(oe);
        oe.setAttribute("id", object.id);
        if (object.bone) {
            oe.setAttribute("parent", object.bone->id);
        }
        oe.setAttribute("timeline", m_timelineid++);
        oe.setAttribute("key", "0");
        oe.setAttribute("z_index", object.id);
    }
 
    // entity/animation/timeline
    m_timelineid = 0;
    if (m_rootBone) {
        writeBone(m_rootBone, animation, scml);
    }
 
    Q_FOREACH(const SpriterObject &object, m_objects) {
        Folder folder;
        Q_FOREACH(const Folder & f, m_folders) {
            if (f.id == object.folderId) {
                folder = f;
                break;
            }
        }
        SpriterFile file;
        file.id = -1;
        Q_FOREACH(const SpriterFile &f, folder.files) {
            if (f.id == object.fileId) {
                file = f;
                break;
            }
        }
        Q_ASSERT(file.id >= 0);
 
        QString objectName = "object-" + file.baseName;
 
        QDomElement timeline = scml.createElement("timeline");
        animation.appendChild(timeline);
        timeline.setAttribute("id", m_timelineid++);
        timeline.setAttribute("name", objectName);
 
        QDomElement key = scml.createElement("key");
        timeline.appendChild(key);
        key.setAttribute("id", "0");
        key.setAttribute("spin", "0");
 
        QDomElement objectEl = scml.createElement("object");
        key.appendChild(objectEl);
        objectEl.setAttribute("folder", object.folderId);
        objectEl.setAttribute("file", object.fileId);
        objectEl.setAttribute("x", object.fixLocalX);
        objectEl.setAttribute("y", object.fixLocalY);
        objectEl.setAttribute("angle", QString::number(kisRadiansToDegrees(object.fixLocalAngle), 'f', 2));
        objectEl.setAttribute("scale_x", QString::number(object.fixLocalScaleX, 'f', 2));
        objectEl.setAttribute("scale_y", QString::number(object.fixLocalScaleY, 'f', 2));
    }
}

References Folder::files, Folder::id, kisRadiansToDegrees(), m_folders, m_objects, m_rootBone, m_timelineid, Folder::name, writeBone(), and writeBoneRef().

◆ fixBone()

void KisSpriterExport::fixBone ( Bone * bone )

private

Definition at line 224 of file kis_spriter_export.cpp.

{
    qreal boneLocalAngle = 0;
    qreal boneLocalScaleX = 1;
 
    if (bone->bones.length() >= 1) {
        // if a bone has one or more children, point at first child
        Bone *childBone = bone->bones[0];
        qreal dx = childBone->x - bone->x;
        qreal dy = childBone->y - bone->y;
        if (qAbs(dx) > 0 || qAbs(dy) > 0) {
            boneLocalAngle = KisFastMath::atan2(dy, dx);
            boneLocalScaleX = sqrt(dx * dx + dy * dy) / 200;
        }
    }
    else if (bone->parentBone) {
        // else, if bone has parent, point away from parent
        qreal dx = bone->x - bone->parentBone->x;
        qreal dy = bone->y - bone->parentBone->y;
        if (qAbs(dx) > 0 || qAbs(dy) > 0) {
            boneLocalAngle = KisFastMath::atan2(dy, dx);
            boneLocalScaleX = sqrt(dx * dx + dy * dy) / 200;
        }
    }
    // adjust bone angle
    bone->fixLocalAngle += boneLocalAngle;
    bone->fixLocalScaleX *= boneLocalScaleX;
 
    // rotate all the child bones back to world position
    for (int i = 0; i < bone->bones.length(); ++i) {
        Bone *childBone = bone->bones[i];
 
        qreal tx = childBone->fixLocalX;
        qreal ty = childBone->fixLocalY;
 
        childBone->fixLocalX = tx * cos(-boneLocalAngle) - ty * sin(-boneLocalAngle);
        childBone->fixLocalY = tx * sin(-boneLocalAngle) + ty * cos(-boneLocalAngle);
 
        childBone->fixLocalX /= boneLocalScaleX;
        childBone->fixLocalAngle -= boneLocalAngle;
        childBone->fixLocalScaleX /= boneLocalScaleX;
    }
 
    // rotate all the child objects back to world position
    for (int i = 0; i < m_objects.length(); ++i) {
        if (m_objects[i].bone == bone) {
            m_objects[i].fixLocalAngle -= boneLocalAngle;
            m_objects[i].fixLocalScaleX /= boneLocalScaleX;
        }
    }
 
    // process all child bones
    for (int i = 0; i < bone->bones.length(); ++i) {
        fixBone(bone->bones[i]);
    }
}

References KisFastMath::atan2(), Bone::bones, fixBone(), Bone::fixLocalAngle, Bone::fixLocalScaleX, Bone::fixLocalX, Bone::fixLocalY, m_objects, Bone::parentBone, Bone::x, and Bone::y.

◆ initializeCapabilities()

void KisSpriterExport::initializeCapabilities ( )

overridevirtual

Reimplemented from KisImportExportFilter.

Definition at line 628 of file kis_spriter_export.cpp.

{
    addCapability(KisExportCheckRegistry::instance()->get("MultiLayerCheck")->create(KisExportCheckBase::SUPPORTED));
    addCapability(KisExportCheckRegistry::instance()->get("LayerOpacityCheck")->create(KisExportCheckBase::PARTIALLY));
    QList<QPair<KoID, KoID> > supportedColorModels;
    supportedColorModels << QPair<KoID, KoID>()
            << QPair<KoID, KoID>(RGBAColorModelID, Integer8BitsColorDepthID);
    addSupportedColorModels(supportedColorModels, "Spriter");
}

References KisImportExportFilter::addCapability(), KisImportExportFilter::addSupportedColorModels(), get(), KisExportCheckRegistry::instance(), Integer8BitsColorDepthID, KisExportCheckBase::PARTIALLY, RGBAColorModelID, and KisExportCheckBase::SUPPORTED.

◆ parseBone()

Bone * KisSpriterExport::parseBone	(	const Bone *	parent,
		KisGroupLayerSP	groupLayer )

private

Definition at line 157 of file kis_spriter_export.cpp.

{
    static int boneId = 0;
    QString groupBaseName = groupLayer->name().split(" ").first();
    Bone *bone = new Bone;
    bone->id = boneId++;
    bone->parentBone = parent;
    bone->name = groupBaseName;
 
    if (m_boneLayer) {
        QRectF rc = m_image->bounds().intersected(m_boneLayer->exactBounds());
 
        qreal xmin = rc.left();
        qreal ymin = rc.top();
        qreal xmax = rc.right();
        qreal ymax = rc.bottom();
 
        bone->x = (xmin + xmax) / 2;
        bone->y = -(ymin + ymax) / 2;
        bone->width = xmax - xmin;
        bone->height = ymax - ymin;
    }
    else {
        bone->x = 0.0;
        bone->y = 0.0;
        bone->width = 0.0;
        bone->height = 0.0;
    }
 
    if (parent) {
        bone->localX = bone->x - parent->x;
        bone->localY = bone->y - parent->y;
    }
    else {
        bone->localX = bone->x;
        bone->localY = bone->y;
    }
 
    bone->localAngle = 0.0;
    bone->localScaleX = 1.0;
    bone->localScaleY = 1.0;
 
    KisNodeSP child = groupLayer->lastChild();
    while (child) {
        if (child->visible() && child->inherits("KisGroupLayer")) {
            bone->bones.append(parseBone(bone, qobject_cast<KisGroupLayer*>(child.data())));
        }
        child = child->prevSibling();
    }
 
    //qDebug() << "Created bone" << bone->id << "with" << bone->bones.size() << "bones";
    return bone;
}

References Bone::bones, KisImage::bounds(), KisSharedPtr< T >::data(), KisLayer::exactBounds(), Bone::height, Bone::id, KisNode::lastChild(), Bone::localAngle, Bone::localScaleX, Bone::localScaleY, Bone::localX, Bone::localY, m_boneLayer, m_image, KisBaseNode::name(), Bone::name, Bone::parentBone, parseBone(), KisNode::prevSibling(), KisBaseNode::visible(), Bone::width, Bone::x, and Bone::y.

◆ parseFolder()

KisImportExportErrorCode KisSpriterExport::parseFolder	(	KisGroupLayerSP	parentGroup,
		const QString &	folderName,
		const QString &	basePath,
		int *	folderId = 0 )

private

Definition at line 80 of file kis_spriter_export.cpp.

{
//    qDebug() << "parseFolder: parent" << parentGroup->name()
//                << "folderName" << folderName
//                << "basepath" << basePath;
 
    int currentFolder=0;
    if(folderId == 0)
    {
        folderId = &currentFolder;
    }
    QString pathName;
    if (!folderName.isEmpty()) {
        pathName = folderName + "/";
    }
 
 
    KisNodeSP child = parentGroup->lastChild();
    while (child) {
        if (child->visible() && child->inherits("KisGroupLayer")) {
            KisImportExportErrorCode res = parseFolder(qobject_cast<KisGroupLayer*>(child.data()), child->name().split(" ").first(), basePath + "/" + pathName, folderId);
            if (!res.isOk()) {
                return res;
            }
        }
        child = child->prevSibling();
    }
 
    Folder folder;
    folder.id = *folderId;
    folder.name = folderName;
    folder.groupName = parentGroup->name();
 
    int fileId = 0;
    child = parentGroup->lastChild();
 
    while (child) {
        if (child->visible() && !child->inherits("KisGroupLayer") && !child->inherits("KisMask")) {
            QRectF rc = m_image->bounds().intersected(child->exactBounds());
            QString layerBaseName = child->name().split(" ").first();
            SpriterFile file;
            file.id = fileId++;
            file.pathName = pathName;
            file.baseName = layerBaseName;
            file.layerName = child->name();
            file.name = folderName + "/" + layerBaseName + ".png";
 
            qreal xmin = rc.left();
            qreal ymin = rc.top();
            qreal xmax = rc.right();
            qreal ymax = rc.bottom();
 
            file.width = xmax - xmin;
            file.height = ymax - ymin;
            file.x = xmin;
            file.y = ymin;
            //qDebug() << "Created file" << file.id << file.name << file.pathName << file.baseName << file.width << file.height << file.layerName;
            KisImportExportErrorCode result = savePaintDevice(child->projection(), basePath + file.name);
            if (result.isOk()) {
                folder.files.append(file);
            } else {
                return result;
            }
        }
 
        child = child->prevSibling();
    }
 
    if (folder.files.size() > 0) {
        //qDebug() << "Adding folder" << folder.id << folder.name << folder.groupName << folder.files.length();
        m_folders.append(folder);
        (*folderId)++;
    }
 
    return ImportExportCodes::OK;
}

References KisImage::bounds(), KisSharedPtr< T >::data(), KisBaseNode::exactBounds(), Folder::files, Folder::groupName, Folder::id, KisImportExportErrorCode::isOk(), KisNode::lastChild(), m_folders, m_image, KisBaseNode::name(), Folder::name, ImportExportCodes::OK, parseFolder(), KisNode::prevSibling(), KisBaseNode::projection(), savePaintDevice(), and KisBaseNode::visible().

◆ savePaintDevice()

KisImportExportErrorCode KisSpriterExport::savePaintDevice	(	KisPaintDeviceSP	dev,
		const QString &	fileName )

private

Definition at line 55 of file kis_spriter_export.cpp.

{
    QFileInfo fi(fileName);
 
    QDir d = fi.absoluteDir();
    d.mkpath(d.path());
    QRect rc = m_image->bounds().intersected(dev->exactBounds());
 
    if (!KisPNGConverter::isColorSpaceSupported(dev->colorSpace())) {
        dev = new KisPaintDevice(*dev.data());
        dev->convertTo(KoColorSpaceRegistry::instance()->rgb8());
    }
 
    KisPNGOptions options;
    options.forceSRGB = true;
 
    vKisAnnotationSP_it beginIt = m_image->beginAnnotations();
    vKisAnnotationSP_it endIt = m_image->endAnnotations();
 
    KisPNGConverter converter(0);
    KisImportExportErrorCode res = converter.buildFile(fileName, rc, m_image->xRes(), m_image->yRes(), dev, beginIt, endIt, options, 0);
 
    return res;
}

References KisImage::beginAnnotations(), KisImage::bounds(), KisPNGConverter::buildFile(), KisPaintDevice::colorSpace(), KisPaintDevice::convertTo(), KisImportExportFilter::d, KisSharedPtr< T >::data(), KisImage::endAnnotations(), KisPaintDevice::exactBounds(), KisPNGOptions::forceSRGB, KoColorSpaceRegistry::instance(), KisPNGConverter::isColorSpaceSupported(), m_image, KisImage::xRes(), and KisImage::yRes().

◆ supportsIO()

bool KisSpriterExport::supportsIO ( ) const

inlineoverridevirtual

Override and return false for the filters that use a library that cannot handle file handles, only file names.

Reimplemented from KisImportExportFilter.

Definition at line 99 of file kis_spriter_export.h.

99{ return false; }

◆ writeBone()

void KisSpriterExport::writeBone	(	const Bone *	bone,
		QDomElement &	timeline,
		QDomDocument &	scml )

private

Definition at line 297 of file kis_spriter_export.cpp.

{
    if (!bone) return;
    QDomElement timeline = scml.createElement("timeline");
    animation.appendChild(timeline);
    timeline.setAttribute("id", m_timelineid);
    timeline.setAttribute("name", bone->name);
    timeline.setAttribute("object_type", "bone");
 
    QDomElement key = scml.createElement("key");
    timeline.appendChild(key);
    key.setAttribute("id", "0");
    key.setAttribute("spin", 0);
 
    QDomElement boneEl = scml.createElement("bone");
    key.appendChild(boneEl);
    boneEl.setAttribute("x", QString::number(bone->fixLocalX, 'f', 2));
    boneEl.setAttribute("y", QString::number(bone->fixLocalY, 'f', 2));
    boneEl.setAttribute("angle", QString::number(bone->fixLocalAngle, 'f', 2));
    boneEl.setAttribute("scale_x", QString::number(bone->fixLocalScaleX, 'f', 2));
    boneEl.setAttribute("scale_y", QString::number(bone->fixLocalScaleY, 'f', 2));
 
    m_timelineid++;
 
    Q_FOREACH(const Bone *childBone, bone->bones) {
        writeBone(childBone, animation, scml);
    }
}

References Bone::bones, Bone::fixLocalAngle, Bone::fixLocalScaleX, Bone::fixLocalScaleY, Bone::fixLocalX, Bone::fixLocalY, m_timelineid, Bone::name, and writeBone().

◆ writeBoneRef()

void KisSpriterExport::writeBoneRef	(	const Bone *	bone,
		QDomElement &	mainline,
		QDomDocument &	scml )

private

Definition at line 281 of file kis_spriter_export.cpp.

{
    if (!bone) return;
    QDomElement boneRef = scml.createElement("bone_ref");
    key.appendChild(boneRef);
    boneRef.setAttribute("id", bone->id);
    if (bone->parentBone) {
        boneRef.setAttribute("parent", bone->parentBone->id);
    }
    boneRef.setAttribute("timeline", m_timelineid++);
    boneRef.setAttribute("key", "0");
    Q_FOREACH(const Bone *childBone, bone->bones) {
        writeBoneRef(childBone, key, scml);
    }
}

References Bone::bones, Bone::id, m_timelineid, Bone::parentBone, and writeBoneRef().

Member Data Documentation

◆ m_boneLayer

KisLayerSP KisSpriterExport::m_boneLayer

private

Definition at line 118 of file kis_spriter_export.h.

◆ m_folders

QList<Folder> KisSpriterExport::m_folders

private

Definition at line 114 of file kis_spriter_export.h.

◆ m_image

KisImageSP KisSpriterExport::m_image

private

Definition at line 112 of file kis_spriter_export.h.

◆ m_objects

QList<SpriterObject> KisSpriterExport::m_objects

private

Definition at line 116 of file kis_spriter_export.h.

◆ m_rootBone

Bone* KisSpriterExport::m_rootBone {nullptr}

private

Definition at line 115 of file kis_spriter_export.h.

115{nullptr};

◆ m_rootLayer

KisGroupLayerSP KisSpriterExport::m_rootLayer

private

Definition at line 117 of file kis_spriter_export.h.

◆ m_timelineid

qreal KisSpriterExport::m_timelineid {0.0}

private

Definition at line 113 of file kis_spriter_export.h.

113{0.0};

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

plugins/impex/spriter/kis_spriter_export.h
plugins/impex/spriter/kis_spriter_export.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisSpriterExport()

◆ ~KisSpriterExport()

Member Function Documentation

◆ convert()

◆ fillScml()

◆ fixBone()

◆ initializeCapabilities()

◆ parseBone()

◆ parseFolder()

◆ savePaintDevice()

◆ supportsIO()

◆ writeBone()

◆ writeBoneRef()

Member Data Documentation

◆ m_boneLayer

◆ m_folders

◆ m_image

◆ m_objects

◆ m_rootBone

◆ m_rootLayer

◆ m_timelineid