Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Inkscape::Text::Layout::FontMetrics Class Reference

Keep track of font metrics. More...

#include <Layout-TNG.h>

Public Member Functions

 FontMetrics ()
 
void reset ()
 
void set (FontInstance const *font)
 
double emSize () const
 
double lineSize () const
 
void setZero ()
 
FontMetrics & operator*= (double x)
 
void max (FontMetrics const &other)
 Save the larger values of ascent and descent between this and other.
 
void computeEffective (const double &line_height)
 Calculate the effective ascent and descent including half "leading".
 
double getTypoAscent () const
 
double getTypoDescent () const
 
double getXHeight () const
 
double getMaxAscent () const
 
double getMaxDescent () const
 

Public Attributes

double ascent
 
double descent
 
double xheight
 
double ascent_max
 
double descent_max
 

Detailed Description

Keep track of font metrics.

Two use cases:

  1. Keep track of ascent, descent, and x-height of an individual font.
  2. Keep track of effective ascent and descent that includes half-leading.

Note: Leading refers to the "external" leading which is added (subtracted) due to a computed value of 'line-height' that differs from 'font-size'. "Internal" leading which is specified inside a font is not used in CSS. The 'font-size' is based on the font's em size which is 'ascent' + 'descent'.

This structure was renamed (and modified) from "LineHeight".

It's useful for this to be public so that ScanlineMaker can use it.

Definition at line 624 of file Layout-TNG.h.

Constructor & Destructor Documentation

◆ FontMetrics()

Inkscape::Text::Layout::FontMetrics::FontMetrics ( )
inline

Definition at line 627 of file Layout-TNG.h.

References reset().

Referenced by Inkscape::Text::Layout::_calculateCursorShapeForEmpty().

Member Function Documentation

◆ computeEffective()

void Inkscape::Text::Layout::FontMetrics::computeEffective ( const double &  line_height)

Calculate the effective ascent and descent including half "leading".

Definition at line 110 of file Layout-TNG-Output.cpp.

Referenced by SPText::_buildLayoutInit(), and SPFlowtext::_buildLayoutInput().

◆ emSize()

double Inkscape::Text::Layout::FontMetrics::emSize ( ) const
inline

Definition at line 640 of file Layout-TNG.h.

References ascent, and descent.

Referenced by Inkscape::Text::Layout::InfiniteScanlineMaker::completeLine(), Inkscape::Text::Layout::ShapeScanlineMaker::makeScanline(), operator<<(), operator<<(), Inkscape::Text::Layout::queryCursorShape(), and Inkscape::Text::Layout::ShapeScanlineMaker::setLineHeight().

◆ getMaxAscent()

double Inkscape::Text::Layout::FontMetrics::getMaxAscent ( ) const
inline

Definition at line 661 of file Layout-TNG.h.

References ascent_max.

◆ getMaxDescent()

double Inkscape::Text::Layout::FontMetrics::getMaxDescent ( ) const
inline

Definition at line 662 of file Layout-TNG.h.

References descent_max.

◆ getTypoAscent()

double Inkscape::Text::Layout::FontMetrics::getTypoAscent ( ) const
inline

Definition at line 658 of file Layout-TNG.h.

References ascent.

◆ getTypoDescent()

double Inkscape::Text::Layout::FontMetrics::getTypoDescent ( ) const
inline

Definition at line 659 of file Layout-TNG.h.

References descent.

◆ getXHeight()

double Inkscape::Text::Layout::FontMetrics::getXHeight ( ) const
inline

Definition at line 660 of file Layout-TNG.h.

References xheight.

◆ lineSize()

double Inkscape::Text::Layout::FontMetrics::lineSize ( ) const
inline

Definition at line 642 of file Layout-TNG.h.

References ascent, and descent.

◆ max()

void Inkscape::Text::Layout::FontMetrics::max ( FontMetrics const &  other)

Save the larger values of ascent and descent between this and other.

Needed for laying out a line with mixed font-sizes, fonts, or line spacings.

Definition at line 101 of file Layout-TNG-Output.cpp.

References ascent, ascent_max, descent, descent_max, and xheight.

Referenced by Inkscape::Text::Layout::getNearestCursorPositionTo().

◆ operator*=()

FontMetrics & Inkscape::Text::Layout::FontMetrics::operator*= ( double  x)
inline

Definition at line 646 of file Layout-TNG.h.

References ascent, ascent_max, descent, descent_max, and xheight.

◆ reset()

void Inkscape::Text::Layout::FontMetrics::reset ( )
inline

Definition at line 629 of file Layout-TNG.h.

References ascent, ascent_max, descent, descent_max, and xheight.

Referenced by SPText::_buildLayoutInit(), SPFlowtext::_buildLayoutInput(), and FontMetrics().

◆ set()

void Inkscape::Text::Layout::FontMetrics::set ( FontInstance const *  font)

Definition at line 90 of file Layout-TNG-Output.cpp.

References ascent, ascent_max, descent, descent_max, FontInstance::GetMaxAscent(), FontInstance::GetMaxDescent(), FontInstance::GetTypoAscent(), FontInstance::GetTypoDescent(), FontInstance::GetXHeight(), and xheight.

◆ setZero()

void Inkscape::Text::Layout::FontMetrics::setZero ( )
inline

Definition at line 643 of file Layout-TNG.h.

References ascent, ascent_max, descent, descent_max, and xheight.

Referenced by Inkscape::Text::Layout::InfiniteScanlineMaker::InfiniteScanlineMaker().

Member Data Documentation

◆ ascent

double Inkscape::Text::Layout::FontMetrics::ascent

Definition at line 665 of file Layout-TNG.h.

Referenced by SPText::_buildLayoutInit(), SPFlowtext::_buildLayoutInput(), Inkscape::Text::Layout::_calculateCursorShapeForEmpty(), Inkscape::Text::Layout::characterBoundingBox(), emSize(), Inkscape::Text::Layout::getNearestCursorPositionTo(), getTypoAscent(), lineSize(), max(), operator*=(), operator<<(), operator<<(), reset(), set(), and setZero().

◆ ascent_max

double Inkscape::Text::Layout::FontMetrics::ascent_max

Definition at line 668 of file Layout-TNG.h.

Referenced by getMaxAscent(), max(), operator*=(), reset(), set(), and setZero().

◆ descent

double Inkscape::Text::Layout::FontMetrics::descent

Definition at line 666 of file Layout-TNG.h.

Referenced by SPText::_buildLayoutInit(), SPFlowtext::_buildLayoutInput(), Inkscape::Text::Layout::_calculateCursorShapeForEmpty(), Inkscape::Text::Layout::characterBoundingBox(), emSize(), Inkscape::Text::Layout::getNearestCursorPositionTo(), getTypoDescent(), lineSize(), max(), operator*=(), operator<<(), operator<<(), Inkscape::Text::Layout::queryCursorShape(), reset(), set(), and setZero().

◆ descent_max

double Inkscape::Text::Layout::FontMetrics::descent_max

Definition at line 669 of file Layout-TNG.h.

Referenced by getMaxDescent(), max(), operator*=(), reset(), set(), and setZero().

◆ xheight

double Inkscape::Text::Layout::FontMetrics::xheight

Definition at line 667 of file Layout-TNG.h.

Referenced by SPText::_buildLayoutInit(), SPFlowtext::_buildLayoutInput(), Inkscape::Text::Layout::_calculateCursorShapeForEmpty(), getXHeight(), max(), operator*=(), operator<<(), operator<<(), reset(), set(), and setZero().

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