KisAslXmlWriter Class Reference

#include <kis_asl_xml_writer.h>

Classes
struct	Private

Public Member Functions
QDomDocument	document () const
void	enterDescriptor (const QString &key, const QString &name, const QString &classId)
void	enterList (const QString &key)
	KisAslXmlWriter ()
void	leaveDescriptor ()
void	leaveList ()
void	writeBoolean (const QString &key, bool value)
void	writeColor (const QString &key, const KoColor &value)
void	writeCurve (const QString &key, const QString &name, const QVector< QPointF > &points)
void	writeDouble (const QString &key, double value)
void	writeEnum (const QString &key, const QString &typeId, const QString &value)
void	writeFloatRect (const QString &key, const QRectF &rect)
void	writeInteger (const QString &key, int value)
void	writeOffsetPoint (const QString &key, const QPointF &value)
QString	writePattern (const QString &key, const KoPatternSP pattern)
void	writePatternRef (const QString &key, const KoPatternSP pattern, const QString &uuid)
void	writePhasePoint (const QString &key, const QPointF &value)
void	writePoint (const QString &key, const QPointF &value)
void	writePointRect (const QString &key, const QPolygonF &transformedRect)
void	writeRawData (const QString key, const QByteArray *rawData)
void	writeSegmentGradient (const QString &key, const KoSegmentGradient &gradient)
void	writeStopGradient (const QString &key, const KoStopGradient &gradient)
void	writeText (const QString &key, const QString &value)
void	writeTransform (const QString &key, const QTransform &transform)
void	writeUnitFloat (const QString &key, const QString &unit, double value)
void	writeUnitRect (const QString &key, const QString &unit, const QRectF &rect)
	~KisAslXmlWriter ()

Private Member Functions
QString	getSegmentEndpointTypeString (KoGradientSegmentEndpointType segtype)
void	writeGradientImpl (const QString &key, const QString &name, QVector< KoColor > colors, QVector< qreal > transparencies, QVector< qreal > positions, QVector< QString > types, QVector< qreal > middleOffsets)

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 26 of file kis_asl_xml_writer.h.

Constructor & Destructor Documentation

KisAslXmlWriter()

KisAslXmlWriter::KisAslXmlWriter

(

)

Definition at line 29 of file kis_asl_xml_writer.cpp.

    : m_d(new Private)
{
    QDomElement el = m_d->document.createElement("asl");
    m_d->document.appendChild(el);
    m_d->currentElement = el;
}

References m_d.

~KisAslXmlWriter()

KisAslXmlWriter::~KisAslXmlWriter

(

)

Definition at line 37 of file kis_asl_xml_writer.cpp.

{
}

Member Function Documentation

document()

QDomDocument KisAslXmlWriter::document

(

)

const

Definition at line 41 of file kis_asl_xml_writer.cpp.

{
    if (m_d->document.documentElement() != m_d->currentElement) {
        warnKrita << "KisAslXmlWriter::document(): unbalanced enter/leave descriptor/array";
    }
 
    return m_d->document;
}

References m_d, and warnKrita.

enterDescriptor()

void KisAslXmlWriter::enterDescriptor	(	const QString &	key,
		const QString &	name,
		const QString &	classId )

Definition at line 50 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "Descriptor");
    el.setAttribute("name", name);
    el.setAttribute("classId", classId);
 
    m_d->currentElement.appendChild(el);
    m_d->currentElement = el;
}

References m_d.

enterList()

void KisAslXmlWriter::enterList

(

const QString &

key

)

Definition at line 75 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "List");
 
    m_d->currentElement.appendChild(el);
    m_d->currentElement = el;
}

References m_d.

getSegmentEndpointTypeString()

QString KisAslXmlWriter::getSegmentEndpointTypeString ( KoGradientSegmentEndpointType segtype )

private

Definition at line 381 of file kis_asl_xml_writer.cpp.

{
    switch (segtype) {
    case COLOR_ENDPOINT:
        return "UsrS";
        break;
    case FOREGROUND_ENDPOINT:
    case FOREGROUND_TRANSPARENT_ENDPOINT:
        return "FrgC";
        break;
    case BACKGROUND_ENDPOINT:
    case BACKGROUND_TRANSPARENT_ENDPOINT:
        return "BckC";
        break;
    default:
        return "UsrS";
    }
}

References BACKGROUND_ENDPOINT, BACKGROUND_TRANSPARENT_ENDPOINT, COLOR_ENDPOINT, FOREGROUND_ENDPOINT, and FOREGROUND_TRANSPARENT_ENDPOINT.

leaveDescriptor()

void KisAslXmlWriter::leaveDescriptor

(

)

Definition at line 66 of file kis_asl_xml_writer.cpp.

{
    if (!m_d->currentElement.parentNode().toElement().isNull()) {
        m_d->currentElement = m_d->currentElement.parentNode().toElement();
    } else {
        warnKrita << "KisAslXmlWriter::leaveDescriptor(): unbalanced enter/leave descriptor";
    }
}

References m_d, and warnKrita.

leaveList()

void KisAslXmlWriter::leaveList

(

)

Definition at line 89 of file kis_asl_xml_writer.cpp.

{
    if (!m_d->currentElement.parentNode().toElement().isNull()) {
        m_d->currentElement = m_d->currentElement.parentNode().toElement();
    } else {
        warnKrita << "KisAslXmlWriter::leaveList(): unbalanced enter/leave list";
    }
}

References m_d, and warnKrita.

writeBoolean()

void KisAslXmlWriter::writeBoolean	(	const QString &	key,
		bool	value )

Definition at line 170 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "Boolean");
    el.setAttribute("value", KisDomUtils::toString(value));
 
    m_d->currentElement.appendChild(el);
}

References m_d, KisDomUtils::toString(), and value().

writeColor()

void KisAslXmlWriter::writeColor	(	const QString &	key,
		const KoColor &	value )

Definition at line 184 of file kis_asl_xml_writer.cpp.

{
    QDomDocument doc;
    QDomElement el = doc.createElement("color");
    value.toXML(doc, el);
    QDomElement colorEl = el.firstChildElement();
    if (value.colorSpace()->colorModelId() == RGBAColorModelID) {
        enterDescriptor(key, "", "RGBC");
 
        double v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("r", "0.0")) * 255.0, 255.0);
        writeDouble("Rd  ", v);
        v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("g", "0.0")) * 255.0, 255.0);
        writeDouble("Grn ", v);
        v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("b", "0.0")) * 255.0, 255.0);
        writeDouble("Bl  ", v);
    } else if (value.colorSpace()->colorModelId() == CMYKAColorModelID) {
        enterDescriptor(key, "", "CMYC");
 
        double v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("c", "0.0")) * 100.0, 100.0);
        writeDouble("Cyn ", v);
        v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("m", "0.0")) * 100.0, 100.0);
        writeDouble("Mgnt", v);
        v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("y", "0.0")) * 100.0, 100.0);
        writeDouble("Ylw ", v);
        v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("k", "0.0")) * 100.0, 100.0);
        writeDouble("Blck", v);
    } else if (value.colorSpace()->colorModelId() == LABAColorModelID) {
        enterDescriptor(key, "", "LbCl");
 
        double v = KisDomUtils::toDouble(colorEl.attribute("L", "0.0"));
        writeDouble("Lmnc", v);
        v = KisDomUtils::toDouble(colorEl.attribute("a", "0.0"));
        writeDouble("A   ", v);
        v = KisDomUtils::toDouble(colorEl.attribute("b", "0.0"));
        writeDouble("B   ", v);
    } else if (value.colorSpace()->colorModelId() == GrayAColorModelID) {
        enterDescriptor(key, "", "Grsc");
 
        double v = qBound(0.0, KisDomUtils::toDouble(colorEl.attribute("g", "0.0")) * 100.0, 100.0);
        writeDouble("Gry ", v);
    } else { // default to sRGB
        enterDescriptor(key, "", "RGBC");
 
        writeDouble("Rd  ", value.toQColor().red());
        writeDouble("Grn ", value.toQColor().green());
        writeDouble("Bl  ", value.toQColor().blue());
    }
    if (value.metadata().keys().contains("psdSpotBook")) {
        QVariant v;
        v = value.metadata().value("spotName");
        if (v.isValid()) {
            writeText("Nm  ", v.toString());
        }
        v = value.metadata().value("psdSpotBook");
        if (v.isValid()) {
            writeText("Bk  ", v.toString());
        }
        bool ok;
        v = value.metadata().value("psdSpotBookId");
        int bookid = v.toInt(&ok);
        if (ok) {
            writeInteger("bookID", bookid);
        }
    }
 
    leaveDescriptor();
}

References CMYKAColorModelID, enterDescriptor(), GrayAColorModelID, LABAColorModelID, leaveDescriptor(), RGBAColorModelID, KisDomUtils::toDouble(), v, value(), writeDouble(), writeInteger(), and writeText().

writeCurve()

void KisAslXmlWriter::writeCurve	(	const QString &	key,
		const QString &	name,
		const QVector< QPointF > &	points )

Definition at line 282 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "ShpC");
 
    writeText("Nm  ", name);
 
    enterList("Crv ");
 
    Q_FOREACH (const QPointF &pt, points) {
        writePoint("", pt);
    }
 
    leaveList();
    leaveDescriptor();
}

References enterDescriptor(), enterList(), leaveDescriptor(), leaveList(), writePoint(), and writeText().

writeDouble()

void KisAslXmlWriter::writeDouble	(	const QString &	key,
		double	value )

Definition at line 98 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "Double");
    el.setAttribute("value", KisDomUtils::toString(value));
 
    m_d->currentElement.appendChild(el);
}

References m_d, KisDomUtils::toString(), and value().

writeEnum()

void KisAslXmlWriter::writeEnum	(	const QString &	key,
		const QString &	typeId,
		const QString &	value )

Definition at line 126 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "Enum");
    el.setAttribute("typeId", typeId);
    el.setAttribute("value", value);
 
    m_d->currentElement.appendChild(el);
}

References m_d, and value().

writeFloatRect()

void KisAslXmlWriter::writeFloatRect	(	const QString &	key,
		const QRectF &	rect )

Definition at line 522 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "classFloatRect");
 
    writeDouble("Top ", rect.top());
    writeDouble("Left", rect.left());
    writeDouble("Btom", rect.bottom());
    writeDouble("Rght", rect.right());
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), and writeDouble().

writeGradientImpl()

void KisAslXmlWriter::writeGradientImpl ( const QString & key, const QString & name, QVector< KoColor > colors, QVector< qreal > transparencies, QVector< qreal > positions, QVector< QString > types, QVector< qreal > middleOffsets )

private

Definition at line 337 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "Gradient", "Grdn");
 
    writeText("Nm  ", name);
    writeEnum("GrdF", "GrdF", "CstS");
    writeDouble("Intr", 4096);
 
    enterList("Clrs");
 
    for (int i = 0; i < colors.size(); i++) {
        enterDescriptor("", "", "Clrt");
 
        writeColor("Clr ", colors[i]);
        writeEnum("Type", "Clry", types[i]);
        writeInteger("Lctn", positions[i] * 4096.0);
        writeInteger("Mdpn", middleOffsets[i] * 100.0);
 
        leaveDescriptor();
    };
 
    leaveList();
 
    enterList("Trns");
 
    for (int i = 0; i < colors.size(); i++) {
        enterDescriptor("", "", "TrnS");
        writeUnitFloat("Opct", "#Prc", transparencies[i] * 100.0);
        writeInteger("Lctn", positions[i] * 4096.0);
        writeInteger("Mdpn", middleOffsets[i] * 100.0);
        leaveDescriptor();
    };
 
    leaveList();
 
    leaveDescriptor();
}

References enterDescriptor(), enterList(), leaveDescriptor(), leaveList(), writeColor(), writeDouble(), writeEnum(), writeInteger(), writeText(), and writeUnitFloat().

writeInteger()

void KisAslXmlWriter::writeInteger	(	const QString &	key,
		int	value )

Definition at line 112 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "Integer");
    el.setAttribute("value", KisDomUtils::toString(value));
 
    m_d->currentElement.appendChild(el);
}

References m_d, KisDomUtils::toString(), and value().

writeOffsetPoint()

void KisAslXmlWriter::writeOffsetPoint	(	const QString &	key,
		const QPointF &	value )

Definition at line 272 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "Pnt ");
 
    writeUnitFloat("Hrzn", "#Prc", value.x());
    writeUnitFloat("Vrtc", "#Prc", value.y());
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), value(), and writeUnitFloat().

writePattern()

QString KisAslXmlWriter::writePattern	(	const QString &	key,
		const KoPatternSP	pattern )

Definition at line 298 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "KisPattern");
 
    writeText("Nm  ", pattern->name());
 
    QString uuid = KisAslWriterUtils::getPatternUuidLazy(pattern);
    writeText("Idnt", uuid);
 
    // Write pattern data
 
    QBuffer buffer;
    buffer.open(QIODevice::WriteOnly);
    pattern->savePatToDevice(&buffer);
 
    QDomCDATASection dataSection = m_d->document.createCDATASection(qCompress(buffer.buffer()).toBase64());
 
    QDomElement dataElement = m_d->document.createElement("node");
    dataElement.setAttribute("type", "KisPatternData");
    dataElement.setAttribute("key", "Data");
    dataElement.appendChild(dataSection);
 
    m_d->currentElement.appendChild(dataElement);
 
    leaveDescriptor();
 
    return uuid;
}

References enterDescriptor(), KisAslWriterUtils::getPatternUuidLazy(), leaveDescriptor(), m_d, and writeText().

writePatternRef()

void KisAslXmlWriter::writePatternRef	(	const QString &	key,
		const KoPatternSP	pattern,
		const QString &	uuid )

Definition at line 327 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "Ptrn");
 
    writeText("Nm  ", pattern->name());
    writeText("Idnt", uuid);
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), and writeText().

writePhasePoint()

void KisAslXmlWriter::writePhasePoint	(	const QString &	key,
		const QPointF &	value )

Definition at line 262 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "Pnt ");
 
    writeDouble("Hrzn", value.x());
    writeDouble("Vrtc", value.y());
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), value(), and writeDouble().

writePoint()

void KisAslXmlWriter::writePoint	(	const QString &	key,
		const QPointF &	value )

Definition at line 252 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "CrPt");
 
    writeDouble("Hrzn", value.x());
    writeDouble("Vrtc", value.y());
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), value(), and writeDouble().

writePointRect()

void KisAslXmlWriter::writePointRect	(	const QString &	key,
		const QPolygonF &	transformedRect )

Definition at line 534 of file kis_asl_xml_writer.cpp.

{
    if (transformedRect.size() < 4) {
        warnKrita << "KisAslXmlWriter::writePointRect(): too few points to write descriptor.";
        return;
    }
    enterDescriptor(key, "", "null");
 
    writePoint("rectangleCornerA", transformedRect.at(0));
    writePoint("rectangleCornerB", transformedRect.at(1));
    writePoint("rectangleCornerC", transformedRect.at(2));
    writePoint("rectangleCornerD", transformedRect.at(3));
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), warnKrita, and writePoint().

writeRawData()

void KisAslXmlWriter::writeRawData	(	const QString	key,
		const QByteArray *	rawData )

Definition at line 485 of file kis_asl_xml_writer.cpp.

{
    QDomCDATASection dataSection = m_d->document.createCDATASection(rawData->toBase64());
    QDomElement dataElement = m_d->document.createElement("node");
    dataElement.setAttribute("type", "RawData");
    dataElement.setAttribute("key", key);
    dataElement.appendChild(dataSection);
    m_d->currentElement.appendChild(dataElement);
}

References m_d.

writeSegmentGradient()

void KisAslXmlWriter::writeSegmentGradient	(	const QString &	key,
		const KoSegmentGradient &	gradient )

Definition at line 400 of file kis_asl_xml_writer.cpp.

{
    const QList<KoGradientSegment *> &segments = gradient.segments();
    KIS_SAFE_ASSERT_RECOVER_RETURN(!segments.isEmpty());
 
    QVector<KoColor> colors;
    QVector<qreal> transparencies;
    QVector<qreal> positions;
    QVector<QString> types;
    QVector<qreal> middleOffsets;
 
    Q_FOREACH (const KoGradientSegment *seg, segments) {
        const qreal start = seg->startOffset();
        const qreal end = seg->endOffset();
        const qreal mid = (end - start) > DBL_EPSILON ? (seg->middleOffset() - start) / (end - start) : 0.5;
 
        KoColor color = seg->startColor();
        qreal transparency = color.opacityF();
        color.setOpacity(1.0);
 
        QString type = getSegmentEndpointTypeString(seg->startType());
 
        colors << color;
        transparencies << transparency;
        positions << start;
        types << type;
        middleOffsets << mid;
    }
 
    // last segment
 
    if (!segments.isEmpty()) {
        const KoGradientSegment *lastSeg = segments.last();
 
        KoColor color = lastSeg->endColor();
        qreal transparency = color.opacityF();
        color.setOpacity(1.0);
        QString type = getSegmentEndpointTypeString(lastSeg->endType());
 
        colors << color;
        transparencies << transparency;
        positions << lastSeg->endOffset();
        types << type;
        middleOffsets << 0.5;
    }
 
    writeGradientImpl(key, gradient.name(), colors, transparencies, positions, types, middleOffsets);
}

References KoGradientSegment::endColor(), KoGradientSegment::endOffset(), KoGradientSegment::endType(), getSegmentEndpointTypeString(), KIS_SAFE_ASSERT_RECOVER_RETURN, KoGradientSegment::middleOffset(), KoResource::name, KoColor::opacityF(), KoSegmentGradient::segments(), KoColor::setOpacity(), KoGradientSegment::startColor(), KoGradientSegment::startOffset(), KoGradientSegment::startType(), and writeGradientImpl().

writeStopGradient()

void KisAslXmlWriter::writeStopGradient	(	const QString &	key,
		const KoStopGradient &	gradient )

Definition at line 449 of file kis_asl_xml_writer.cpp.

{
    QVector<KoColor> colors;
    QVector<qreal> transparencies;
    QVector<qreal> positions;
    QVector<QString> types;
    QVector<qreal> middleOffsets;
 
    Q_FOREACH (const KoGradientStop &stop, gradient.stops()) {
        KoColor color = stop.color;
        qreal transparency = color.opacityF();
        color.setOpacity(1.0);
 
        QString type;
        switch (stop.type) {
        case COLORSTOP:
            type = "UsrS";
            break;
        case FOREGROUNDSTOP:
            type = "FrgC";
            break;
        case BACKGROUNDSTOP:
            type = "BckC";
            break;
        }
 
        colors << color;
        transparencies << transparency;
        positions << stop.position;
        types << type;
        middleOffsets << 0.5;
    }
 
    writeGradientImpl(key, gradient.name(), colors, transparencies, positions, types, middleOffsets);
}

References BACKGROUNDSTOP, KoGradientStop::color, COLORSTOP, FOREGROUNDSTOP, KoResource::name, KoColor::opacityF(), KoGradientStop::position, KoColor::setOpacity(), KoStopGradient::stops(), KoGradientStop::type, and writeGradientImpl().

writeText()

void KisAslXmlWriter::writeText	(	const QString &	key,
		const QString &	value )

Definition at line 156 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "Text");
    el.setAttribute("value", value);
 
    m_d->currentElement.appendChild(el);
}

References m_d, and value().

writeTransform()

void KisAslXmlWriter::writeTransform	(	const QString &	key,
		const QTransform &	transform )

Definition at line 495 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "Transform", "Trnf");
 
    writeDouble("xx", transform.m11());
    writeDouble("xy", transform.m12());
    writeDouble("yx", transform.m21());
    writeDouble("yy", transform.m22());
    writeDouble("tx", transform.dx());
    writeDouble("ty", transform.dy());
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), and writeDouble().

writeUnitFloat()

void KisAslXmlWriter::writeUnitFloat	(	const QString &	key,
		const QString &	unit,
		double	value )

Definition at line 141 of file kis_asl_xml_writer.cpp.

{
    QDomElement el = m_d->document.createElement("node");
 
    if (!key.isEmpty()) {
        el.setAttribute("key", key);
    }
 
    el.setAttribute("type", "UnitFloat");
    el.setAttribute("unit", unit);
    el.setAttribute("value", KisDomUtils::toString(value));
 
    m_d->currentElement.appendChild(el);
}

References m_d, KisDomUtils::toString(), and value().

writeUnitRect()

void KisAslXmlWriter::writeUnitRect	(	const QString &	key,
		const QString &	unit,
		const QRectF &	rect )

Definition at line 509 of file kis_asl_xml_writer.cpp.

{
    enterDescriptor(key, "", "unitRect");
 
    writeInteger("unitValueQuadVersion", 1);
    writeUnitFloat("Top ", unit, rect.top());
    writeUnitFloat("Left", unit, rect.left());
    writeUnitFloat("Btom", unit, rect.bottom());
    writeUnitFloat("Rght", unit, rect.right());
 
    leaveDescriptor();
}

References enterDescriptor(), leaveDescriptor(), writeInteger(), and writeUnitFloat().

Member Data Documentation

m_d

const QScopedPointer<Private> KisAslXmlWriter::m_d

private

Definition at line 73 of file kis_asl_xml_writer.h.

---

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

• libs/psdutils/asl/kis_asl_xml_writer.h
• libs/psdutils/asl/kis_asl_xml_writer.cpp