SvgUtil Class Reference

#include <SvgUtil.h>

Classes
struct	PreserveAspectRatioParser

Static Public Member Functions
static double	fromPercentage (QString s, bool *ok=nullptr)
static double	fromUserSpace (double value)
static QString	mapExtendedShapeTag (const QString &tagName, const QDomElement &element)
static QPointF	objectToUserSpace (const QPointF &position, const QRectF &objectBound)
static QSizeF	objectToUserSpace (const QSizeF &size, const QRectF &objectBound)
static void	parseAspectRatio (const PreserveAspectRatioParser &p, const QRectF &elementBounds, const QRectF &viewRect, QTransform *_viewTransform)
static const char *	parseNumber (const char *ptr, qreal &number)
	parses the number into parameter number
static qreal	parseNumber (const QString &string)
static KoSvgText::CssLengthPercentage	parseTextUnitStruct (SvgGraphicsContext *gc, QStringView unit)
	Unit structs for text do not need the percentage to be resolved to viewport in most cases.
static qreal	parseUnit (SvgGraphicsContext *gc, const KoSvgTextProperties &resolved, QStringView, bool horiz=false, bool vert=false, const QRectF &bbox=QRectF())
	Parses a length attribute.
static qreal	parseUnitAngular (SvgGraphicsContext *gc, const QString &unit)
	parses angle, result in radians!
static KoSvgText::CssLengthPercentage	parseUnitStruct (SvgGraphicsContext *gc, QStringView unit, bool horiz=false, bool vert=false, const QRectF &bbox=QRectF())
	Parse length attribute into a struct, always resolving the percentage to viewport.
static KoSvgText::CssLengthPercentage	parseUnitStructImpl (SvgGraphicsContext *gc, QStringView, bool horiz=false, bool vert=false, const QRectF &bbox=QRectF(), bool percentageViewBox=false)
	Parse length attribute into struct.
static qreal	parseUnitX (SvgGraphicsContext *gc, const KoSvgTextProperties &resolved, const QString &unit)
	parses a length attribute in x-direction
static qreal	parseUnitXY (SvgGraphicsContext *gc, const KoSvgTextProperties &resolved, const QString &unit)
	parses a length attribute in xy-direction
static qreal	parseUnitY (SvgGraphicsContext *gc, const KoSvgTextProperties &resolved, const QString &unit)
	parses a length attribute in y-direction
static bool	parseViewBox (const QDomElement &e, const QRectF &elementBounds, QRectF *_viewRect, QTransform *_viewTransform)
	Parses a viewbox attribute into an rectangle.
static double	ptToPx (SvgGraphicsContext *gc, double value)
static QStringList	simplifyList (const QString &str)
static QString	toPercentage (qreal value)
static QPointF	toUserSpace (const QPointF &point)
	Converts given point from points to userspace units.
static QRectF	toUserSpace (const QRectF &rect)
	Converts given rectangle from points to userspace units.
static QSizeF	toUserSpace (const QSizeF &size)
	Converts given rectangle from points to userspace units.
static double	toUserSpace (double value)
static QString	transformToString (const QTransform &transform)
	Converts specified transformation to a string.
static QPointF	userSpaceToObject (const QPointF &position, const QRectF &objectBound)
static QSizeF	userSpaceToObject (const QSizeF &size, const QRectF &objectBound)
static void	writeTransformAttributeLazy (const QString &name, const QTransform &transform, KoXmlWriter &shapeWriter)
	Writes a transform as an attribute name iff the transform is not empty.

Detailed Description

Definition at line 24 of file SvgUtil.h.

Member Function Documentation

fromPercentage()

double SvgUtil::fromPercentage ( QString s, bool * ok = nullptr )

static

Parses the given string containing a percentage.

Parameters

s	the input string containing the percentage, float (0..1) or integer (0%..100%)
ok	optional failure indicator

Returns

the float percentage (0..1), not normalized

Definition at line 64 of file SvgUtil.cpp.

{
    if (s.endsWith('%'))
        return KisDomUtils::toDouble(s.remove('%'), ok) / 100.0;
    else
        return KisDomUtils::toDouble(s, ok);
}

References KisDomUtils::toDouble().

fromUserSpace()

double SvgUtil::fromUserSpace ( double value )

static

Definition at line 29 of file SvgUtil.cpp.

{
    return value;
}

References value().

mapExtendedShapeTag()

QString SvgUtil::mapExtendedShapeTag ( const QString & tagName, const QDomElement & element )

static

Definition at line 432 of file SvgUtil.cpp.

{
    QString result = tagName;
 
    if (tagName == "path") {
        QString kritaType = element.attribute("krita:type", "");
        QString sodipodiType = element.attribute("sodipodi:type", "");
 
        if (kritaType == "arc") {
            result = "krita:arc";
        } else if (sodipodiType == "arc") {
            result = "sodipodi:arc";
        }
    }
 
    return result;
}

objectToUserSpace() [1/2]

QPointF SvgUtil::objectToUserSpace ( const QPointF & position, const QRectF & objectBound )

static

Converts position from objectBoundingBox units to userSpace units.

Definition at line 72 of file SvgUtil.cpp.

{
    qreal x = objectBound.left() + position.x() * objectBound.width();
    qreal y = objectBound.top() + position.y() * objectBound.height();
    return QPointF(x, y);
}

objectToUserSpace() [2/2]

QSizeF SvgUtil::objectToUserSpace ( const QSizeF & size, const QRectF & objectBound )

static

Converts size from objectBoundingBox units to userSpace units.

Definition at line 79 of file SvgUtil.cpp.

{
    qreal w = size.width() * objectBound.width();
    qreal h = size.height() * objectBound.height();
    return QSizeF(w, h);
}

parseAspectRatio()

void SvgUtil::parseAspectRatio ( const PreserveAspectRatioParser & p, const QRectF & elementBounds, const QRectF & viewRect, QTransform * _viewTransform )

static

Definition at line 190 of file SvgUtil.cpp.

{
    if (p.mode != Qt::IgnoreAspectRatio) {
        QTransform viewBoxTransform = *_viewTransform;
 
        const qreal tan1 = viewBoxRect.height() / viewBoxRect.width();
        const qreal tan2 = elementBounds.height() / elementBounds.width();
 
        const qreal uniformScale =
            (p.mode == Qt::KeepAspectRatioByExpanding) ^ (tan1 > tan2) ?
                elementBounds.height() / viewBoxRect.height() :
                elementBounds.width() / viewBoxRect.width();
 
        viewBoxTransform =
            QTransform::fromTranslate(-viewBoxRect.x(), -viewBoxRect.y()) *
            QTransform::fromScale(uniformScale, uniformScale) *
            QTransform::fromTranslate(elementBounds.x(), elementBounds.y());
 
        const QPointF viewBoxAnchor = viewBoxTransform.map(p.rectAnchorPoint(viewBoxRect));
        const QPointF elementAnchor = p.rectAnchorPoint(elementBounds);
        const QPointF offset = elementAnchor - viewBoxAnchor;
 
        viewBoxTransform = viewBoxTransform * QTransform::fromTranslate(offset.x(), offset.y());
 
        *_viewTransform = viewBoxTransform;
    }
}

References p.

parseNumber() [1/2]

const char * SvgUtil::parseNumber ( const char * ptr, qreal & number )

static

parses the number into parameter number

Definition at line 378 of file SvgUtil.cpp.

{
    int integer, exponent;
    qreal decimal, frac;
    int sign, expsign;
 
    exponent = 0;
    integer = 0;
    frac = 1.0;
    decimal = 0;
    sign = 1;
    expsign = 1;
 
    // read the sign
    if (*ptr == '+') {
        ptr++;
    } else if (*ptr == '-') {
        ptr++;
        sign = -1;
    }
 
    // read the integer part
    while (*ptr != '\0' && *ptr >= '0' && *ptr <= '9')
        integer = (integer * 10) + *(ptr++) - '0';
    if (*ptr == '.') { // read the decimals
        ptr++;
        while (*ptr != '\0' && *ptr >= '0' && *ptr <= '9')
            decimal += (*(ptr++) - '0') * (frac *= 0.1);
    }
 
    if (*ptr == 'e' || *ptr == 'E') { // read the exponent part
        ptr++;
 
        // read the sign of the exponent
        if (*ptr == '+') {
            ptr++;
        } else if (*ptr == '-') {
            ptr++;
            expsign = -1;
        }
 
        exponent = 0;
        while (*ptr != '\0' && *ptr >= '0' && *ptr <= '9') {
            exponent *= 10;
            exponent += *ptr - '0';
            ptr++;
        }
    }
    number = integer + decimal;
    number *= sign * pow((double)10, double(expsign * exponent));
 
    return ptr;
}

References sign().

parseNumber() [2/2]

qreal SvgUtil::parseNumber ( const QString & string )

static

Definition at line 363 of file SvgUtil.cpp.

{
    qreal value = 0.0;
 
    if (string.isEmpty()) return value;
    QByteArray unitLatin1 = string.toLatin1();
 
    const char *start = unitLatin1.data();
    if (!start) return value;
 
    const char *end = parseNumber(start, value);
    KIS_SAFE_ASSERT_RECOVER_NOOP(int(end - start) == string.length());
    return value;
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, length(), parseNumber(), and value().

parseTextUnitStruct()

KoSvgText::CssLengthPercentage SvgUtil::parseTextUnitStruct ( SvgGraphicsContext * gc, QStringView unit )

static

Unit structs for text do not need the percentage to be resolved to viewport in most cases.

Definition at line 239 of file SvgUtil.cpp.

{
    return parseUnitStructImpl(gc, unit, false, false, QRectF(), false);
}

References parseUnitStructImpl().

parseUnit()

qreal SvgUtil::parseUnit ( SvgGraphicsContext * gc, const KoSvgTextProperties & resolved, QStringView unit, bool horiz = false, bool vert = false, const QRectF & bbox = QRectF() )

static

Parses a length attribute.

Definition at line 218 of file SvgUtil.cpp.

{
    if (unit.isEmpty())
        return 0.0;
    QByteArray unitLatin1 = unit.toLatin1();
    // TODO : percentage?
    const char *start = unitLatin1.data();
    if (!start) {
        return 0.0;
    }
    KoSvgText::CssLengthPercentage length = parseUnitStruct(gc, unit, horiz, vert, bbox);
    length.convertToAbsolute(resolved.metrics(), resolved.fontSize().value);
 
    return length.value;
}

References KoSvgTextProperties::fontSize(), length(), KoSvgTextProperties::metrics(), parseUnitStruct(), and KoSvgText::CssLengthPercentage::value.

parseUnitAngular()

qreal SvgUtil::parseUnitAngular ( SvgGraphicsContext * gc, const QString & unit )

static

parses angle, result in radians!

Definition at line 332 of file SvgUtil.cpp.

{
    Q_UNUSED(gc);
 
    qreal value = 0.0;
 
    if (unit.isEmpty()) return value;
    QByteArray unitLatin1 = unit.toLower().toLatin1();
 
    const char *start = unitLatin1.data();
    if (!start) return value;
 
    const char *end = parseNumber(start, value);
 
    if (int(end - start) < unit.length()) {
        if (unit.right(3) == "deg") {
            value = kisDegreesToRadians(value);
        } else if (unit.right(4) == "grad") {
            value *= M_PI / 200;
        } else if (unit.right(3) == "rad") {
            // noop!
        } else {
            value = kisDegreesToRadians(value);
        }
    } else {
        value = kisDegreesToRadians(value);
    }
 
    return value;
}

References kisDegreesToRadians(), M_PI, parseNumber(), and value().

parseUnitStruct()

KoSvgText::CssLengthPercentage SvgUtil::parseUnitStruct ( SvgGraphicsContext * gc, QStringView unit, bool horiz = false, bool vert = false, const QRectF & bbox = QRectF() )

static

Parse length attribute into a struct, always resolving the percentage to viewport.

Definition at line 234 of file SvgUtil.cpp.

{
    return parseUnitStructImpl(gc, unit, horiz, vert, bbox, true);
}

References parseUnitStructImpl().

parseUnitStructImpl()

KoSvgText::CssLengthPercentage SvgUtil::parseUnitStructImpl ( SvgGraphicsContext * gc, QStringView unit, bool horiz = false, bool vert = false, const QRectF & bbox = QRectF(), bool percentageViewBox = false )

static

Parse length attribute into struct.

Definition at line 244 of file SvgUtil.cpp.

{
    KoSvgText::CssLengthPercentage length;
 
    if (unit.isEmpty())
        return length;
    QByteArray unitLatin1 = unit.trimmed().toLatin1();
    // TODO : percentage?
    const char *start = unitLatin1.data();
    if (!start) {
        return length;
    }
    const char *end = parseNumber(start, length.value);
 
    if (int(end - start) < unit.length()) {
        if (unit.right(2) == QLatin1String("px"))
            length.value = SvgUtil::fromUserSpace(length.value);
        else if (unit.right(2) == QLatin1String("pt"))
            length.value = ptToPx(gc, length.value);
        else if (unit.right(2) == QLatin1String("cm"))
            length.value = ptToPx(gc, CM_TO_POINT(length.value));
        else if (unit.right(2) == QLatin1String("pc"))
            length.value = ptToPx(gc, PI_TO_POINT(length.value));
        else if (unit.right(2) == QLatin1String("mm"))
            length.value = ptToPx(gc, MM_TO_POINT(length.value));
        else if (unit.right(2) == QLatin1String("in"))
            length.value = ptToPx(gc, INCH_TO_POINT(length.value));
        else if (unit.right(2) == QLatin1String("em")) {
            length.unit = KoSvgText::CssLengthPercentage::Em;
        } else if (unit.right(2) == QLatin1String("ex")) {
            length.unit = KoSvgText::CssLengthPercentage::Ex;
        } else if (unit.right(3) == QLatin1String("cap")) {
            length.unit = KoSvgText::CssLengthPercentage::Cap;
        } else if (unit.right(2) == QLatin1String("ch")) {
            length.unit = KoSvgText::CssLengthPercentage::Ch;
        } else if (unit.right(2) == QLatin1String("ic")) {
            length.unit = KoSvgText::CssLengthPercentage::Ic;
        } else if (unit.right(2) == QLatin1String("lh")) {
            length.unit = KoSvgText::CssLengthPercentage::Lh;
        } else if (unit.right(1) == QLatin1Char('%')) {
 
            if (percentageViewBox) {
                if (horiz && vert)
                    length.value = (length.value / 100.0) * (sqrt(pow(bbox.width(), 2) + pow(bbox.height(), 2)) / sqrt(2.0));
                else if (horiz)
                    length.value = (length.value / 100.0) * bbox.width();
                else if (vert)
                    length.value = (length.value / 100.0) * bbox.height();
            } else {
                length.value = (length.value / 100.0);
                length.unit = KoSvgText::CssLengthPercentage::Percentage;
            }
        }
    } else {
        length.value = SvgUtil::fromUserSpace(length.value);
    }
 
    return length;
}

References KoSvgText::CssLengthPercentage::Cap, KoSvgText::CssLengthPercentage::Ch, CM_TO_POINT(), KoSvgText::CssLengthPercentage::Em, KoSvgText::CssLengthPercentage::Ex, fromUserSpace(), KoSvgText::CssLengthPercentage::Ic, INCH_TO_POINT(), length(), KoSvgText::CssLengthPercentage::Lh, MM_TO_POINT(), parseNumber(), KoSvgText::CssLengthPercentage::Percentage, PI_TO_POINT(), and ptToPx().

parseUnitX()

qreal SvgUtil::parseUnitX ( SvgGraphicsContext * gc, const KoSvgTextProperties & resolved, const QString & unit )

static

parses a length attribute in x-direction

Definition at line 304 of file SvgUtil.cpp.

{
    if (gc->forcePercentage) {
        return SvgUtil::fromPercentage(unit) * gc->currentBoundingBox.width();
    } else {
        return SvgUtil::parseUnit(gc, resolved, unit, true, false, gc->currentBoundingBox);
    }
}

References SvgGraphicsContext::currentBoundingBox, SvgGraphicsContext::forcePercentage, fromPercentage(), and parseUnit().

parseUnitXY()

qreal SvgUtil::parseUnitXY ( SvgGraphicsContext * gc, const KoSvgTextProperties & resolved, const QString & unit )

static

parses a length attribute in xy-direction

Definition at line 322 of file SvgUtil.cpp.

{
    if (gc->forcePercentage) {
        const qreal value = SvgUtil::fromPercentage(unit);
        return value * sqrt(pow(gc->currentBoundingBox.width(), 2) + pow(gc->currentBoundingBox.height(), 2)) / sqrt(2.0);
    } else {
        return SvgUtil::parseUnit(gc, resolved, unit, true, true, gc->currentBoundingBox);
    }
}

References SvgGraphicsContext::currentBoundingBox, SvgGraphicsContext::forcePercentage, fromPercentage(), parseUnit(), and value().

parseUnitY()

qreal SvgUtil::parseUnitY ( SvgGraphicsContext * gc, const KoSvgTextProperties & resolved, const QString & unit )

static

parses a length attribute in y-direction

Definition at line 313 of file SvgUtil.cpp.

{
    if (gc->forcePercentage) {
        return SvgUtil::fromPercentage(unit) * gc->currentBoundingBox.height();
    } else {
        return SvgUtil::parseUnit(gc, resolved, unit, false, true, gc->currentBoundingBox);
    }
}

References SvgGraphicsContext::currentBoundingBox, SvgGraphicsContext::forcePercentage, fromPercentage(), and parseUnit().

parseViewBox()

bool SvgUtil::parseViewBox ( const QDomElement & e, const QRectF & elementBounds, QRectF * _viewRect, QTransform * _viewTransform )

static

Parses a viewbox attribute into an rectangle.

Definition at line 133 of file SvgUtil.cpp.

{
    KIS_ASSERT(_viewRect);
    KIS_ASSERT(_viewTransform);
 
    QString viewBoxStr = e.attribute("viewBox");
    if (viewBoxStr.isEmpty()) return false;
 
    bool result = false;
 
    QRectF viewBoxRect;
    // this is a workaround for bug 260429 for a file generated by blender
    // who has px in the viewbox which is wrong.
    // reported as bug https://developer.blender.org/T30971
    viewBoxStr.remove("px");
 
    QStringList points = viewBoxStr.replace(',', ' ').simplified().split(' ');
    if (points.count() == 4) {
        viewBoxRect.setX(SvgUtil::fromUserSpace(points[0].toDouble()));
        viewBoxRect.setY(SvgUtil::fromUserSpace(points[1].toDouble()));
        viewBoxRect.setWidth(SvgUtil::fromUserSpace(points[2].toDouble()));
        viewBoxRect.setHeight(SvgUtil::fromUserSpace(points[3].toDouble()));
 
        result = true;
    } else {
        // TODO: WARNING!
    }
 
    if (!result) return false;
 
    qreal scaleX = 1;
    if (!qFuzzyCompare(elementBounds.width(), viewBoxRect.width())) {
        scaleX = elementBounds.width() / viewBoxRect.width();
    }
    qreal scaleY = 1;
    if (!qFuzzyCompare(elementBounds.height(), viewBoxRect.height())) {
        scaleY = elementBounds.height() / viewBoxRect.height();
    }
 
    QTransform viewBoxTransform =
        QTransform::fromTranslate(-viewBoxRect.x(), -viewBoxRect.y()) *
        QTransform::fromScale(scaleX, scaleY) *
        QTransform::fromTranslate(elementBounds.x(), elementBounds.y());
 
    const QString aspectString = e.attribute("preserveAspectRatio");
    // give initial value if value not defined
    PreserveAspectRatioParser p( (!aspectString.isEmpty())? aspectString : QString("xMidYMid meet"));
    parseAspectRatio(p, elementBounds, viewBoxRect, &viewBoxTransform);
 
    *_viewRect = viewBoxRect;
    *_viewTransform = viewBoxTransform;
 
    return result;
}

References fromUserSpace(), KIS_ASSERT, p, parseAspectRatio(), qFuzzyCompare(), and toDouble().

ptToPx()

double SvgUtil::ptToPx ( SvgGraphicsContext * gc, double value )

static

Definition at line 39 of file SvgUtil.cpp.

{
    return value * gc->pixelsPerInch / DPI;
}

References DPI, SvgGraphicsContext::pixelsPerInch, and value().

simplifyList()

QStringList SvgUtil::simplifyList ( const QString & str )

static

Definition at line 450 of file SvgUtil.cpp.

{
    QString attribute = str;
    attribute.replace(',', ' ');
    attribute.remove('\r');
    attribute.remove('\n');
    return attribute.simplified().split(' ', Qt::SkipEmptyParts);
}

toPercentage()

QString SvgUtil::toPercentage ( qreal value )

static

Parses the given float percentage.

Parameters

value

the input number containing float percentage (0..1)

Returns

the percentage string (0%..100%), not normalized

Definition at line 59 of file SvgUtil.cpp.

{
    return KisDomUtils::toString(value * 100.0) + "%";
}

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

toUserSpace() [1/4]

QPointF SvgUtil::toUserSpace ( const QPointF & point )

static

Converts given point from points to userspace units.

Definition at line 44 of file SvgUtil.cpp.

{
    return QPointF(toUserSpace(point.x()), toUserSpace(point.y()));
}

References toUserSpace().

toUserSpace() [2/4]

QRectF SvgUtil::toUserSpace ( const QRectF & rect )

static

Converts given rectangle from points to userspace units.

Definition at line 49 of file SvgUtil.cpp.

{
    return QRectF(toUserSpace(rect.topLeft()), toUserSpace(rect.size()));
}

References toUserSpace().

toUserSpace() [3/4]

QSizeF SvgUtil::toUserSpace ( const QSizeF & size )

static

Converts given rectangle from points to userspace units.

Definition at line 54 of file SvgUtil.cpp.

{
    return QSizeF(toUserSpace(size.width()), toUserSpace(size.height()));
}

References toUserSpace().

toUserSpace() [4/4]

double SvgUtil::toUserSpace ( double value )

static

Definition at line 34 of file SvgUtil.cpp.

{
    return value;
}

References value().

transformToString()

QString SvgUtil::transformToString ( const QTransform & transform )

static

Converts specified transformation to a string.

Definition at line 104 of file SvgUtil.cpp.

{
    if (transform.isIdentity())
        return QString();
 
    if (transform.type() == QTransform::TxTranslate) {
        return QString("translate(%1, %2)")
                     .arg(KisDomUtils::toString(toUserSpace(transform.dx())))
                     .arg(KisDomUtils::toString(toUserSpace(transform.dy())));
    } else {
        return QString("matrix(%1 %2 %3 %4 %5 %6)")
                     .arg(KisDomUtils::toString(transform.m11()))
                     .arg(KisDomUtils::toString(transform.m12()))
                     .arg(KisDomUtils::toString(transform.m21()))
                     .arg(KisDomUtils::toString(transform.m22()))
                     .arg(KisDomUtils::toString(toUserSpace(transform.dx())))
                     .arg(KisDomUtils::toString(toUserSpace(transform.dy())));
    }
}

References KisDomUtils::toString(), and toUserSpace().

userSpaceToObject() [1/2]

QPointF SvgUtil::userSpaceToObject ( const QPointF & position, const QRectF & objectBound )

static

Converts position from userSpace units to objectBoundingBox units.

Definition at line 86 of file SvgUtil.cpp.

{
    qreal x = 0.0;
    if (objectBound.width() != 0)
        x = (position.x() - objectBound.x()) / objectBound.width();
    qreal y = 0.0;
    if (objectBound.height() != 0)
        y = (position.y() - objectBound.y()) / objectBound.height();
    return QPointF(x, y);
}

userSpaceToObject() [2/2]

QSizeF SvgUtil::userSpaceToObject ( const QSizeF & size, const QRectF & objectBound )

static

Converts size from userSpace units to objectBoundingBox units.

Definition at line 97 of file SvgUtil.cpp.

{
    qreal w = objectBound.width() != 0 ? size.width() / objectBound.width() : 0.0;
    qreal h = objectBound.height() != 0 ? size.height() / objectBound.height() : 0.0;
    return QSizeF(w, h);
}

writeTransformAttributeLazy()

void SvgUtil::writeTransformAttributeLazy ( const QString & name, const QTransform & transform, KoXmlWriter & shapeWriter )

static

Writes a transform as an attribute name iff the transform is not empty.

Definition at line 124 of file SvgUtil.cpp.

{
    const QString value = transformToString(transform);
 
    if (!value.isEmpty()) {
        shapeWriter.addAttribute(name.toLatin1().data(), value);
    }
}

References KoXmlWriter::addAttribute(), transformToString(), and value().

---

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

• libs/flake/svg/SvgUtil.h
• libs/flake/svg/SvgUtil.cpp