KoSvgText::FontMetrics Struct Reference

The FontMetrics class A class to keep track of a variety of font metrics. Note that values are in Freetype pixels and coordinates! (that is 64 times bigger than a regular pixel, and Y is swapped.) More...

#include <KoSvgText.h>

Inheritance diagram for KoSvgText::FontMetrics:

Public Member Functions
	FontMetrics ()
	FontMetrics (qreal fontSizeInPt, bool isHorizontal)
void	offsetMetricsToNewOrigin (const Baseline baseline)
bool	operator== (const FontMetrics &other) const
void	scaleBaselines (const qreal multiplier)
void	setBaselineValueByTag (const QString &tag, int32_t value)
void	setMetricsValueByTag (const QLatin1String &tag, int32_t value)
int	valueForBaselineValue (Baseline baseline) const

Public Attributes
qint32	alphabeticBaseline = 0
	location of alphabetic baseline from origin.
qint32	ascender = 0
	distance from origin to top.
qint32	capHeight = 0
	Height of capital letters, defaults to ascender.
qint32	caretOffset = 0
qint32	caretRise = 0
qint32	caretRun = 0
	These are only used to determine the caret slant proportion.
qint32	descender = 0
	distance for origin to bottom.
qint32	fontSize = 0
	Currently set size, CSS unit 'em'.
qint32	hangingBaseline = 0
	location of the hanging baseline used in north brahmic scripts.
qint32	ideographicAdvance = 0
	Advance of the character '水' (U+6C34), CSS Unit ic, defaults to 1 em.
qint32	ideographicCenterBaseline = 0
	default baseline for vertical, centered between over and under.
qint32	ideographicFaceOverBaseline = 0
	location of ideographic face over baseline, that is, the top of the glyphs.
qint32	ideographicFaceUnderBaseline = 0
	location of ideographic face under baseline, that is, the bottom of the glyphs.
qint32	ideographicOverBaseline = 0
	location of ideographic over baseline from origin.
qint32	ideographicUnderBaseline = 0
	location of ideographic under baseline from origin, may fall back to descender.
bool	isVertical = false
	Different fontMetrics count between vertical and horizontal.
qint32	lineGap = 0
	additional linegap between consecutive lines.
qint32	lineThroughOffset = 0
	offset of strike-through from alphabetic baseline.
qint32	lineThroughThickness = 0
	strikethrough thickness, from font.
qint32	mathematicalBaseline = 0
	location of mathematical baseline from origin.
qint32	spaceAdvance = 0
	Advance of the character ' ', used by tabs.
QPair< qint32, qint32 >	subScriptOffset = qMakePair(0, 0)
	subscript baseline height, defaults to 1/5th em below alphabetic.
QPair< qint32, qint32 >	superScriptOffset = qMakePair(0, 0)
	superscript baseline height, defaults to 2/3rd above alphabetic.
qint32	underlineOffset = 0
	underline offset from alphabetic, positive.
qint32	underlineThickness = 0
	underline thickness from font.
qint32	xHeight = 0
	height of X, defaults to 0.5 fontsize.
qint32	zeroAdvance = 0
	Advance of the character '0', CSS Unit 'ch', defaults to 0.5 em in horizontal and 1.0 em in vertical.

Detailed Description

The FontMetrics class A class to keep track of a variety of font metrics. Note that values are in Freetype pixels and coordinates! (that is 64 times bigger than a regular pixel, and Y is swapped.)

Definition at line 327 of file KoSvgText.h.

Constructor & Destructor Documentation

FontMetrics() [1/2]

KoSvgText::FontMetrics::FontMetrics ( )

inline

Definition at line 366 of file KoSvgText.h.

                   {
 
    }

FontMetrics() [2/2]

KoSvgText::FontMetrics::FontMetrics	(	qreal	fontSizeInPt,
		bool	isHorizontal )

Definition at line 1405 of file KoSvgText.cpp.

    : isVertical(!isHorizontal)
    , fontSize(fontSizeInPt * 64.0)
{
    ideographicAdvance = fontSize;
    xHeight = fontSize/2;
    capHeight = (fontSize / 5) * 4;
 
    subScriptOffset.second = -(fontSize / 5);
    superScriptOffset.second = (fontSize / 3);
    if (isHorizontal) {
        zeroAdvance = fontSize/2;
        spaceAdvance = fontSize/2;
 
        ascender = (fontSize / 5) * 4;
        descender = ascender - fontSize;
 
        mathematicalBaseline = xHeight/2;
 
        ideographicUnderBaseline = descender;
        ideographicOverBaseline = ascender;
        ideographicCenterBaseline = (ascender+descender)/2;
 
        hangingBaseline = (fontSize / 5) * 3;
 
        caretRun = 0;
        caretRise = 1;
        caretOffset = 0;
 
    } else {
        zeroAdvance = fontSize;
        spaceAdvance = fontSize;
 
        ascender = fontSize /2;
        descender = ascender - fontSize;
 
        ideographicUnderBaseline = descender;
        ideographicOverBaseline = ascender;
        ideographicCenterBaseline = (ascender+descender)/2;
 
        mathematicalBaseline = ideographicCenterBaseline;
 
        alphabeticBaseline = ascender - (fontSize / 5) * 4;
 
        hangingBaseline = alphabeticBaseline + ((fontSize / 5) * 3);
 
        caretRun = 1;
        caretRise = 0;
        caretOffset = 0;
    }
 
    ideographicFaceUnderBaseline = descender;
    ideographicFaceOverBaseline = ascender;
    lineThroughOffset = mathematicalBaseline;
}

References alphabeticBaseline, ascender, capHeight, caretOffset, caretRise, caretRun, descender, fontSize, hangingBaseline, ideographicAdvance, ideographicCenterBaseline, ideographicFaceOverBaseline, ideographicFaceUnderBaseline, ideographicOverBaseline, ideographicUnderBaseline, lineThroughOffset, mathematicalBaseline, spaceAdvance, subScriptOffset, superScriptOffset, xHeight, and zeroAdvance.

Member Function Documentation

offsetMetricsToNewOrigin()

void KoSvgText::FontMetrics::offsetMetricsToNewOrigin

(

const Baseline

baseline

)

Definition at line 1611 of file KoSvgText.cpp.

{
    qint32 offset = valueForBaselineValue(baseline);
    if (offset == 0) return;
 
    alphabeticBaseline -= offset;
    hangingBaseline -= offset;
    mathematicalBaseline -= offset;
    ideographicFaceUnderBaseline -= offset;
    ideographicFaceOverBaseline -= offset;
    ideographicOverBaseline -= offset;
    ideographicCenterBaseline -= offset;
    ideographicUnderBaseline -= offset;
 
    ascender -= offset;
    descender -= offset;
}

References alphabeticBaseline, ascender, descender, hangingBaseline, ideographicCenterBaseline, ideographicFaceOverBaseline, ideographicFaceUnderBaseline, ideographicOverBaseline, ideographicUnderBaseline, mathematicalBaseline, and valueForBaselineValue().

operator==()

bool KoSvgText::FontMetrics::operator==

(

const FontMetrics &

other

)

const

Definition at line 1461 of file KoSvgText.cpp.

                                                           {
    return isVertical == other.isVertical
            && fontSize == other.fontSize
            && zeroAdvance == other.zeroAdvance
            && spaceAdvance == other.spaceAdvance
            && ideographicAdvance == other.ideographicAdvance
            && xHeight == other.xHeight
            && capHeight == other.capHeight
            && subScriptOffset == other.subScriptOffset
            && superScriptOffset == other.superScriptOffset
            && ascender == other.ascender
            && descender == other.descender
            && lineGap == other.lineGap
            && alphabeticBaseline == other.alphabeticBaseline
            && mathematicalBaseline == other.mathematicalBaseline
            && ideographicUnderBaseline == other.ideographicUnderBaseline
            && ideographicCenterBaseline == other.ideographicCenterBaseline
            && ideographicOverBaseline == other.ideographicOverBaseline
            && ideographicFaceUnderBaseline == other.ideographicFaceUnderBaseline
            && ideographicFaceOverBaseline == other.ideographicFaceOverBaseline
            && hangingBaseline == other.hangingBaseline
            && lineThroughOffset == other.lineThroughOffset
            && lineThroughThickness == other.lineThroughThickness
            && underlineOffset == other.underlineOffset
            && underlineThickness == other.underlineThickness
            && caretRun == other.caretRun
            && caretRise == other.caretRise
            && caretOffset == other.caretOffset;
}

References alphabeticBaseline, ascender, capHeight, caretOffset, caretRise, caretRun, descender, fontSize, hangingBaseline, ideographicAdvance, ideographicCenterBaseline, ideographicFaceOverBaseline, ideographicFaceUnderBaseline, ideographicOverBaseline, ideographicUnderBaseline, isVertical, lineGap, lineThroughOffset, lineThroughThickness, mathematicalBaseline, spaceAdvance, subScriptOffset, superScriptOffset, underlineOffset, underlineThickness, xHeight, and zeroAdvance.

scaleBaselines()

void KoSvgText::FontMetrics::scaleBaselines

(

const qreal

multiplier

)

Definition at line 1580 of file KoSvgText.cpp.

{
    alphabeticBaseline *= multiplier;
    hangingBaseline *= multiplier;
    mathematicalBaseline *= multiplier;
    ideographicFaceUnderBaseline *= multiplier;
    ideographicFaceOverBaseline *= multiplier;
    ideographicOverBaseline *= multiplier;
    ideographicCenterBaseline *= multiplier;
    ideographicUnderBaseline *= multiplier;
    xHeight *= multiplier;
    capHeight *= multiplier;
    subScriptOffset.first *= multiplier;
    subScriptOffset.second *= multiplier;
    superScriptOffset.first *= multiplier;
    superScriptOffset.second *= multiplier;
    fontSize *= multiplier;
    ascender *= multiplier;
    descender *= multiplier;
    lineGap *= multiplier;
 
    zeroAdvance *= multiplier;
    spaceAdvance *= multiplier;
    ideographicAdvance *= multiplier;
 
    underlineOffset *= multiplier;
    underlineThickness *= multiplier;
    lineThroughOffset *= multiplier;
    lineThroughThickness *= multiplier;
}

References alphabeticBaseline, ascender, capHeight, descender, fontSize, hangingBaseline, ideographicAdvance, ideographicCenterBaseline, ideographicFaceOverBaseline, ideographicFaceUnderBaseline, ideographicOverBaseline, ideographicUnderBaseline, lineGap, lineThroughOffset, lineThroughThickness, mathematicalBaseline, spaceAdvance, subScriptOffset, superScriptOffset, underlineOffset, underlineThickness, xHeight, and zeroAdvance.

setBaselineValueByTag()

void KoSvgText::FontMetrics::setBaselineValueByTag	(	const QString &	tag,
		int32_t	value )

Definition at line 1524 of file KoSvgText.cpp.

                                                                         {
    if (tag == "romn") {
        alphabeticBaseline = value;
    } else if (tag == "hang") {
        hangingBaseline = value;
    } else if (tag == "icfb") {
        ideographicFaceUnderBaseline = value;
    } else if (tag == "icft") {
        ideographicFaceOverBaseline = value;
    } else if (tag == "ideo") {
        ideographicUnderBaseline = value;
    } else if (tag == "idtp") {
        ideographicOverBaseline = value;
    } else if (tag == "Idce") {
        ideographicCenterBaseline = value;
    } else if (tag == "math") {
        mathematicalBaseline = value;
    }
}

References alphabeticBaseline, hangingBaseline, ideographicCenterBaseline, ideographicFaceOverBaseline, ideographicFaceUnderBaseline, ideographicOverBaseline, ideographicUnderBaseline, mathematicalBaseline, and value().

setMetricsValueByTag()

void KoSvgText::FontMetrics::setMetricsValueByTag	(	const QLatin1String &	tag,
		int32_t	value )

Definition at line 1544 of file KoSvgText.cpp.

                                                                              {
    if (tag == "xhgt") {
        xHeight = value;
    } else if (tag == "cpht") {
        capHeight = value;
    } else if (tag == "sbxo") {
        subScriptOffset.first = value;
    } else if (tag == "sbyo") {
        subScriptOffset.second = value;
    } else if (tag == "spxo") {
        superScriptOffset.first = value;
    } else if (tag == "spyo") {
        superScriptOffset.second = value;
    } else if (tag == "strs") {
        lineThroughThickness = value;
    } else if (tag == "stro") {
        lineThroughOffset = value;
    } else if (tag == "unds") {
        underlineThickness = value;
    } else if (tag == "undo") {
        underlineOffset = value;
    } else if (tag == "hcrs") {
        caretRise = value;
    } else if (tag == "hcrn") {
        caretRun = value;
    } else if (tag == "hcof") {
        caretOffset = value;
    } else if (tag == "vcrs") {
        caretRise = value;
    } else if (tag == "vcrn") {
        caretRun = value;
    } else if (tag == "vcof") {
        caretOffset = value;
    }
}

References capHeight, caretOffset, caretRise, caretRun, lineThroughOffset, lineThroughThickness, subScriptOffset, superScriptOffset, underlineOffset, underlineThickness, value(), and xHeight.

valueForBaselineValue()

int KoSvgText::FontMetrics::valueForBaselineValue

(

Baseline

baseline

)

const

Definition at line 1491 of file KoSvgText.cpp.

                                                              {
    qint32 baselineVal = 0;
    switch(baseline) {
    case BaselineIdeographic:
        baselineVal =  ideographicUnderBaseline;
        break;
    case BaselineAlphabetic:
        baselineVal = alphabeticBaseline;
        break;
    case BaselineHanging:
        baselineVal = hangingBaseline;
        break;
    case BaselineMathematical:
        baselineVal = mathematicalBaseline;
        break;
    case BaselineCentral:
        baselineVal = ideographicCenterBaseline;
        break;
    case BaselineMiddle:
        baselineVal = isVertical? ideographicCenterBaseline: xHeight/2;
        break;
    case BaselineTextBottom:
        baselineVal = descender;
        break;
    case BaselineTextTop:
        baselineVal = ascender;
        break;
    default:
        break;
    }
    return baselineVal;
}

References alphabeticBaseline, ascender, KoSvgText::BaselineAlphabetic, KoSvgText::BaselineCentral, KoSvgText::BaselineHanging, KoSvgText::BaselineIdeographic, KoSvgText::BaselineMathematical, KoSvgText::BaselineMiddle, KoSvgText::BaselineTextBottom, KoSvgText::BaselineTextTop, descender, hangingBaseline, ideographicCenterBaseline, ideographicUnderBaseline, isVertical, mathematicalBaseline, and xHeight.

Member Data Documentation

alphabeticBaseline

qint32 KoSvgText::FontMetrics::alphabeticBaseline = 0

location of alphabetic baseline from origin.

Definition at line 343 of file KoSvgText.h.

ascender

qint32 KoSvgText::FontMetrics::ascender = 0

distance from origin to top.

Definition at line 339 of file KoSvgText.h.

capHeight

qint32 KoSvgText::FontMetrics::capHeight = 0

Height of capital letters, defaults to ascender.

Definition at line 335 of file KoSvgText.h.

caretOffset

qint32 KoSvgText::FontMetrics::caretOffset = 0

Definition at line 364 of file KoSvgText.h.

caretRise

qint32 KoSvgText::FontMetrics::caretRise = 0

Definition at line 363 of file KoSvgText.h.

caretRun

qint32 KoSvgText::FontMetrics::caretRun = 0

These are only used to determine the caret slant proportion.

Definition at line 362 of file KoSvgText.h.

descender

qint32 KoSvgText::FontMetrics::descender = 0

distance for origin to bottom.

Definition at line 340 of file KoSvgText.h.

fontSize

qint32 KoSvgText::FontMetrics::fontSize = 0

Currently set size, CSS unit 'em'.

Definition at line 329 of file KoSvgText.h.

hangingBaseline

qint32 KoSvgText::FontMetrics::hangingBaseline = 0

location of the hanging baseline used in north brahmic scripts.

Definition at line 354 of file KoSvgText.h.

ideographicAdvance

qint32 KoSvgText::FontMetrics::ideographicAdvance = 0

Advance of the character '水' (U+6C34), CSS Unit ic, defaults to 1 em.

Definition at line 332 of file KoSvgText.h.

ideographicCenterBaseline

qint32 KoSvgText::FontMetrics::ideographicCenterBaseline = 0

default baseline for vertical, centered between over and under.

location of ideographic center baseline from origin,

Definition at line 347 of file KoSvgText.h.

ideographicFaceOverBaseline

qint32 KoSvgText::FontMetrics::ideographicFaceOverBaseline = 0

location of ideographic face over baseline, that is, the top of the glyphs.

Definition at line 352 of file KoSvgText.h.

ideographicFaceUnderBaseline

qint32 KoSvgText::FontMetrics::ideographicFaceUnderBaseline = 0

location of ideographic face under baseline, that is, the bottom of the glyphs.

Definition at line 351 of file KoSvgText.h.

ideographicOverBaseline

qint32 KoSvgText::FontMetrics::ideographicOverBaseline = 0

location of ideographic over baseline from origin.

Definition at line 349 of file KoSvgText.h.

ideographicUnderBaseline

qint32 KoSvgText::FontMetrics::ideographicUnderBaseline = 0

location of ideographic under baseline from origin, may fall back to descender.

Definition at line 346 of file KoSvgText.h.

isVertical

bool KoSvgText::FontMetrics::isVertical = false

Different fontMetrics count between vertical and horizontal.

Definition at line 328 of file KoSvgText.h.

lineGap

qint32 KoSvgText::FontMetrics::lineGap = 0

additional linegap between consecutive lines.

Definition at line 341 of file KoSvgText.h.

lineThroughOffset

qint32 KoSvgText::FontMetrics::lineThroughOffset = 0

offset of strike-through from alphabetic baseline.

Definition at line 358 of file KoSvgText.h.

lineThroughThickness

qint32 KoSvgText::FontMetrics::lineThroughThickness = 0

strikethrough thickness, from font.

Definition at line 359 of file KoSvgText.h.

mathematicalBaseline

qint32 KoSvgText::FontMetrics::mathematicalBaseline = 0

location of mathematical baseline from origin.

Definition at line 344 of file KoSvgText.h.

spaceAdvance

qint32 KoSvgText::FontMetrics::spaceAdvance = 0

Advance of the character ' ', used by tabs.

Definition at line 331 of file KoSvgText.h.

subScriptOffset

QPair<qint32, qint32> KoSvgText::FontMetrics::subScriptOffset = qMakePair(0, 0)

subscript baseline height, defaults to 1/5th em below alphabetic.

Definition at line 336 of file KoSvgText.h.

superScriptOffset

QPair<qint32, qint32> KoSvgText::FontMetrics::superScriptOffset = qMakePair(0, 0)

superscript baseline height, defaults to 2/3rd above alphabetic.

Definition at line 337 of file KoSvgText.h.

underlineOffset

qint32 KoSvgText::FontMetrics::underlineOffset = 0

underline offset from alphabetic, positive.

Definition at line 356 of file KoSvgText.h.

underlineThickness

qint32 KoSvgText::FontMetrics::underlineThickness = 0

underline thickness from font.

Definition at line 357 of file KoSvgText.h.

xHeight

qint32 KoSvgText::FontMetrics::xHeight = 0

height of X, defaults to 0.5 fontsize.

Definition at line 334 of file KoSvgText.h.

zeroAdvance

qint32 KoSvgText::FontMetrics::zeroAdvance = 0

Advance of the character '0', CSS Unit 'ch', defaults to 0.5 em in horizontal and 1.0 em in vertical.

Definition at line 330 of file KoSvgText.h.

---

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

• libs/flake/text/KoSvgText.h
• libs/flake/text/KoSvgText.cpp