Class OUTLINE_FONT implements outline font drawing. More...

#include <outline_font.h>

Inheritance diagram for KIFONT::OUTLINE_FONT:

Public Member Functions
	OUTLINE_FONT ()

bool	IsOutline () const override

bool	IsBold () const override

bool	IsItalic () const override

void	SetFakeBold ()

void	SetFakeItal ()

double	ComputeOverbarVerticalPosition (double aGlyphHeight) const override
	Compute the vertical position of an overbar. More...

double	ComputeUnderlineVerticalPosition (double aGlyphHeight) const override
	Compute the vertical position of an underline. More...

double	GetInterline (double aGlyphHeight=0.0, double aLineSpacing=1.0) const override
	Compute the distance (interline) between 2 lines of text (for multiline texts). More...

VECTOR2I	GetTextAsGlyphs (BOX2I aBoundingBox, std::vector< std::unique_ptr< GLYPH > > aGlyphs, const wxString &aText, const VECTOR2I &aSize, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, TEXT_STYLE_FLAGS aTextStyle) const override
	Convert text string to an array of GLYPHs. More...

void	GetLinesAsGlyphs (std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttrs) const

const FT_Face &	GetFace () const

virtual bool	IsStroke () const

const wxString &	GetName () const

const char *	NameAsToken () const

void	Draw (KIGFX::GAL *aGal, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aCursor, const TEXT_ATTRIBUTES &aAttrs) const
	Draw a string. More...

void	Draw (KIGFX::GAL *aGal, const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttributes) const

VECTOR2I	StringBoundaryLimits (const wxString &aText, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic) const
	Compute the boundary limits of aText (the bounding box of all shapes). More...

void	LinebreakText (wxString &aText, int aColumnWidth, const VECTOR2I &aGlyphSize, int aThickness, bool aBold, bool aItalic) const
	Insert characters into text to ensure that no lines are wider than aColumnWidth. More...

Static Public Member Functions
static wxString	FontConfigVersion ()

static wxString	FreeTypeVersion ()

static wxString	HarfBuzzVersion ()

static wxString	FontLibraryVersion ()

static OUTLINE_FONT *	LoadFont (const wxString &aFontFileName, bool aBold, bool aItalic)
	Load an outline font. More...

static bool	IsStroke (const wxString &aFontName)

static FONT *	GetFont (const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false)

Protected Member Functions
FT_Error	loadFace (const wxString &aFontFileName)

double	getOverbarOffset (int ascender, int height, int thickness) const

BOX2I	getBoundingBox (const std::vector< std::unique_ptr< GLYPH > > &aGlyphs) const

VECTOR2I	getTextAsGlyphs (BOX2I aBoundingBox, std::vector< std::unique_ptr< GLYPH > > aGlyphs, const wxString &aText, const VECTOR2I &aSize, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, TEXT_STYLE_FLAGS aTextStyle) const

unsigned	linesCount (const wxString &aText) const
	Returns number of lines for a given text. More...

void	drawSingleLineText (KIGFX::GAL aGal, BOX2I aBoundingBox, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aSize, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, bool aItalic, bool aUnderline) const
	Draws a single line of text. More...

VECTOR2I	boundingBoxSingleLine (BOX2I *aBBox, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aSize, bool aItalic) const
	Computes the bounding box for a single line of text. More...

void	getLinePositions (const wxString &aText, const VECTOR2I &aPosition, wxArrayString &aTextLines, std::vector< VECTOR2I > &aPositions, std::vector< VECTOR2I > &aExtents, const TEXT_ATTRIBUTES &aAttrs) const

VECTOR2I	drawMarkup (BOX2I aBoundingBox, std::vector< std::unique_ptr< GLYPH > > aGlyphs, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aSize, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, TEXT_STYLE_FLAGS aTextStyle) const

void	wordbreakMarkup (std::vector< std::pair< wxString, int > > *aWords, const wxString &aText, const VECTOR2I &aSize, TEXT_STYLE_FLAGS aTextStyle) const
	Factor that determines the pitch between 2 lines. More...

Protected Attributes
wxString	m_fontName
	Font name. More...

wxString	m_fontFileName
	Font file name. More...

Static Protected Attributes
static constexpr double	INTERLINE_PITCH_RATIO = 1.62

Private Member Functions
int	faceSize (int aSize) const

int	faceSize () const

int	subscriptSize (int aSize) const

int	subscriptSize () const

Static Private Member Functions
static FONT *	getDefaultFont ()

Private Attributes
FT_Face	m_face

const int	m_faceSize

bool	m_fakeBold

bool	m_fakeItal

std::map< unsigned int, GLYPH_POINTS_LIST >	m_contourCache

Static Private Attributes
static FT_Library	m_freeType = nullptr

static constexpr double	m_outlineFontSizeCompensation = 1.4

static constexpr int	m_charSizeScaler = 64

static constexpr double	m_subscriptSuperscriptSize = 0.64

static constexpr double	m_underlineOffsetScaler = -0.16

static constexpr double	m_subscriptVerticalOffset = -0.25

static constexpr double	m_superscriptVerticalOffset = 0.45

static FONT *	s_defaultFont = nullptr

static std::map< std::tuple< wxString, bool, bool >, FONT * >	s_fontMap

Detailed Description

Class OUTLINE_FONT implements outline font drawing.

Definition at line 49 of file outline_font.h.

Constructor & Destructor Documentation

◆ OUTLINE_FONT()

OUTLINE_FONT::OUTLINE_FONT ( )

Definition at line 48 of file outline_font.cpp.

 :
 m_face(NULL),
 m_faceSize( 16 ),
 m_fakeBold( false ),
 m_fakeItal( false )
{
 if( !m_freeType )
 FT_Init_FreeType( &m_freeType );
}

References m_freeType.

Referenced by LoadFont().

Member Function Documentation

◆ boundingBoxSingleLine()

VECTOR2I FONT::boundingBoxSingleLine	(	BOX2I *	aBBox,
		const wxString &	aText,
		const VECTOR2I &	aPosition,
		const VECTOR2I &	aSize,
		bool	aItalic
	)		const

protectedinherited

Computes the bounding box for a single line of text.

Multiline texts should be split before using the function.

Parameters

aBBox	is an optional pointer to be filled with the bounding box.
aText	is the text to be drawn.
aPosition	is text position.
aSize	is the cap-height and em-width of the text.

Returns: new cursor position

Definition at line 301 of file font.cpp.

{
 TEXT_STYLE_FLAGS textStyle = 0;
 
 if( aItalic )
 textStyle |= TEXT_STYLE::ITALIC;
 
 VECTOR2I extents = drawMarkup( aBBox, nullptr, aText, aPosition, aSize, ANGLE_0, false,
 VECTOR2I(), textStyle );
 
 return extents;
}

References ANGLE_0, KIFONT::FONT::drawMarkup(), and ITALIC.

Referenced by KIFONT::FONT::getLinePositions().

◆ ComputeOverbarVerticalPosition()

double OUTLINE_FONT::ComputeOverbarVerticalPosition ( double aGlyphHeight ) const

overridevirtual

Compute the vertical position of an overbar.

This is the distance between the text baseline and the overbar.

Implements KIFONT::FONT.

Definition at line 142 of file outline_font.cpp.

{
 // The overbar on actual text is positioned above the bounding box of the glyphs. However,
 // that's expensive to calculate so we use an estimation here (as this is only used for
 // calculating bounding boxes).
 return aGlyphHeight * m_outlineFontSizeCompensation;
}

References m_outlineFontSizeCompensation.

◆ ComputeUnderlineVerticalPosition()

double OUTLINE_FONT::ComputeUnderlineVerticalPosition ( double aGlyphHeight ) const

overridevirtual

Compute the vertical position of an underline.

This is the distance between the text baseline and the underline.

Implements KIFONT::FONT.

Definition at line 155 of file outline_font.cpp.

{
 return aGlyphHeight * m_underlineOffsetScaler;
}

References m_underlineOffsetScaler.

◆ Draw() [1/2]

void KIFONT::FONT::Draw	(	KIGFX::GAL *	aGal,
		const wxString &	aText,
		const VECTOR2I &	aPosition,
		const TEXT_ATTRIBUTES &	aAttributes
	)		const

inlineinherited

Definition at line 137 of file font.h.

 {
 Draw( aGal, aText, aPosition, VECTOR2I( 0, 0 ), aAttributes );
 }

References KIFONT::FONT::Draw().

◆ Draw() [2/2]

void FONT::Draw	(	KIGFX::GAL *	aGal,
		const wxString &	aText,
		const VECTOR2I &	aPosition,
		const VECTOR2I &	aCursor,
		const TEXT_ATTRIBUTES &	aAttrs
	)		const

inherited

Draw a string.

Parameters

aGal	is the graphics context.
aText	is the text to be drawn.
aPosition	is the text position in world coordinates.
aCursor	is the current text position (for multiple text blocks within a single text object, such as a run of superscript characters)
aAttrs	are the styling attributes of the text, including its rotation
aGal
aText	is the text to be drawn.
aPosition	is the text object position in world coordinates.
aCursor	is the current text position (for multiple text blocks within a single text object, such as a run of superscript characters)
aAttrs	are the styling attributes of the text, including its rotation

Definition at line 159 of file font.cpp.

{
 if( !aGal || aText.empty() )
 return;
 
 VECTOR2I position( aPosition - aCursor );
 
 // Split multiline strings into separate ones and draw them line by line
 wxArrayString strings_list;
 std::vector<VECTOR2I> positions;
 std::vector<VECTOR2I> extents;
 
 getLinePositions( aText, position, strings_list, positions, extents, aAttrs );
 
 aGal->SetLineWidth( aAttrs.m_StrokeWidth );
 
 for( size_t i = 0; i < strings_list.GetCount(); i++ )
 {
 drawSingleLineText( aGal, nullptr, strings_list[i], positions[i], aAttrs.m_Size,
 aAttrs.m_Angle, aAttrs.m_Mirrored, aPosition, aAttrs.m_Italic,
 aAttrs.m_Underlined );
 }
}

References KIFONT::FONT::drawSingleLineText(), KIFONT::FONT::getLinePositions(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Underlined, and KIGFX::GAL::SetLineWidth().

Referenced by BOARD_ADAPTER::addText(), KIGFX::GAL::BitmapText(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIFONT::FONT::Draw(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), EDA_TEXT::GetEffectiveTextShape(), GRPrintText(), BRDITEMS_PLOTTER::PlotPcbText(), KIGFX::SCH_PAINTER::strokeText(), KIGFX::PCB_PAINTER::strokeText(), PLOTTER::Text(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ drawMarkup()

VECTOR2I FONT::drawMarkup	(	BOX2I *	aBoundingBox,
		std::vector< std::unique_ptr< GLYPH > > *	aGlyphs,
		const wxString &	aText,
		const VECTOR2I &	aPosition,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aAngle,
		bool	aMirror,
		const VECTOR2I &	aOrigin,
		TEXT_STYLE_FLAGS	aTextStyle
	)		const

protectedinherited

Definition at line 233 of file font.cpp.

{
 MARKUP::MARKUP_PARSER markupParser( TO_UTF8( aText ) );
 std::unique_ptr<MARKUP::NODE> root = markupParser.Parse();
 
 return ::drawMarkup( aBoundingBox, aGlyphs, root, aPosition, this, aSize, aAngle, aMirror,
 aOrigin, aTextStyle );
}

References drawMarkup(), MARKUP::MARKUP_PARSER::Parse(), and TO_UTF8.

Referenced by KIFONT::FONT::boundingBoxSingleLine(), KIFONT::FONT::drawSingleLineText(), GetLinesAsGlyphs(), and KIFONT::FONT::StringBoundaryLimits().

◆ drawSingleLineText()

void FONT::drawSingleLineText	(	KIGFX::GAL *	aGal,
		BOX2I *	aBoundingBox,
		const wxString &	aText,
		const VECTOR2I &	aPosition,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aAngle,
		bool	aMirror,
		const VECTOR2I &	aOrigin,
		bool	aItalic,
		bool	aUnderline
	)		const

protectedinherited

Draws a single line of text.

Multiline texts should be split before using the function.

Parameters

aGal	is a pointer to the graphics abstraction layer, or nullptr (nothing is drawn)
aBBox	is an optional pointer to be filled with the bounding box.
aText	is the text to be drawn.
aPosition	is text position.
aSize	is the cap-height and em-width of the text
aAngle	is text angle.
aMirror	is true if text should be drawn mirrored, false otherwise.
aOrigin	is the point around which the text should be rotated, mirrored, etc.

Returns: new cursor position in non-rotated, non-mirrored coordinates

Definition at line 246 of file font.cpp.

{
 if( !aGal )
 return;
 
 TEXT_STYLE_FLAGS textStyle = 0;
 
 if( aItalic )
 textStyle |= TEXT_STYLE::ITALIC;
 
 if( aUnderline )
 textStyle |= TEXT_STYLE::UNDERLINE;
 
 std::vector<std::unique_ptr<GLYPH>> glyphs;
 
 (void) drawMarkup( aBoundingBox, &glyphs, aText, aPosition, aSize, aAngle, aMirror, aOrigin,
 textStyle );
 
 aGal->DrawGlyphs( glyphs );
}

References KIGFX::GAL::DrawGlyphs(), KIFONT::FONT::drawMarkup(), ITALIC, and UNDERLINE.

Referenced by KIFONT::FONT::Draw().

◆ faceSize() [1/2]

int KIFONT::OUTLINE_FONT::faceSize ( ) const

inlineprivate

Definition at line 171 of file outline_font.h.

171{ return faceSize( m_faceSize ); }

KIFONT::OUTLINE_FONT::faceSize

int faceSize() const

Definition: outline_font.h:171

References faceSize(), and m_faceSize.

Referenced by faceSize(), getTextAsGlyphs(), loadFace(), and subscriptSize().

◆ faceSize() [2/2]

int KIFONT::OUTLINE_FONT::faceSize ( int aSize ) const

inlineprivate

Definition at line 167 of file outline_font.h.

 {
 return aSize * m_charSizeScaler * m_outlineFontSizeCompensation;
 };

References m_charSizeScaler, and m_outlineFontSizeCompensation.

◆ FontConfigVersion()

wxString OUTLINE_FONT::FontConfigVersion ( )

static

Definition at line 79 of file outline_font.cpp.

{
 return fontconfig::FONTCONFIG::Version();
}

References fontconfig::FONTCONFIG::Version().

Referenced by GetVersionInfoData().

◆ FontLibraryVersion()

wxString OUTLINE_FONT::FontLibraryVersion ( )

static

Definition at line 85 of file outline_font.cpp.

{
 return wxString::Format( "FreeType %s HarfBuzz %s", FreeTypeVersion(), HarfBuzzVersion() );
}

References Format(), FreeTypeVersion(), and HarfBuzzVersion().

◆ FreeTypeVersion()

wxString OUTLINE_FONT::FreeTypeVersion ( )

static

Definition at line 59 of file outline_font.cpp.

{
 if( !m_freeType )
 FT_Init_FreeType( &m_freeType );
 
 FT_Int major = 0;
 FT_Int minor = 0;
 FT_Int patch = 0;
 FT_Library_Version( m_freeType, &major, &minor, &patch );
 
 return wxString::Format( "%d.%d.%d", major, minor, patch );
}

References Format(), and m_freeType.

Referenced by FontLibraryVersion(), and GetVersionInfoData().

◆ getBoundingBox()

BOX2I OUTLINE_FONT::getBoundingBox ( const std::vector< std::unique_ptr< GLYPH > > & aGlyphs ) const

protected

Definition at line 199 of file outline_font.cpp.

{
 int minX = INT_MAX;
 int minY = INT_MAX;
 int maxX = INT_MIN;
 int maxY = INT_MIN;
 
 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
 {
 BOX2D bbox = glyph->BoundingBox();
 bbox.Normalize();
 
 if( minX > bbox.GetX() )
 minX = bbox.GetX();
 
 if( minY > bbox.GetY() )
 minY = bbox.GetY();
 
 if( maxX < bbox.GetRight() )
 maxX = bbox.GetRight();
 
 if( maxY < bbox.GetBottom() )
 maxY = bbox.GetBottom();
 }
 
 BOX2I ret;
 ret.SetOrigin( minX, minY );
 ret.SetEnd( maxX, maxY );
 return ret;
}

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Normalize(), BOX2< Vec >::SetEnd(), and BOX2< Vec >::SetOrigin().

◆ getDefaultFont()

FONT * FONT::getDefaultFont ( )

staticprivateinherited

Definition at line 56 of file font.cpp.

{
 if( !s_defaultFont )
 s_defaultFont = STROKE_FONT::LoadFont( wxEmptyString );
 
 return s_defaultFont;
}

References KIFONT::STROKE_FONT::LoadFont(), and KIFONT::FONT::s_defaultFont.

Referenced by KIFONT::FONT::GetFont().

◆ GetFace()

const FT_Face & KIFONT::OUTLINE_FONT::GetFace ( ) const

inline

Definition at line 116 of file outline_font.h.

116{ return m_face; }

References m_face.

Referenced by GetInterline().

◆ GetFont()

FONT * FONT::GetFont	(	const wxString &	aFontName = `wxEmptyString`,
		bool	aBold = `false`,
		bool	aItalic = `false`
	)

staticinherited

Definition at line 65 of file font.cpp.

{
 if( aFontName.empty() || aFontName.StartsWith( KICAD_FONT_NAME ) )
 return getDefaultFont();
 
 std::tuple<wxString, bool, bool> key = { aFontName, aBold, aItalic };
 
 FONT* font = s_fontMap[key];
 
 if( !font )
 font = OUTLINE_FONT::LoadFont( aFontName, aBold, aItalic );
 
 if( !font )
 font = getDefaultFont();
 
 s_fontMap[key] = font;
 
 return font;
}

References KIFONT::FONT::getDefaultFont(), KICAD_FONT_NAME, LoadFont(), and KIFONT::FONT::s_fontMap.

Referenced by LABEL_MANAGER::Add(), BOARD_ADAPTER::addText(), KIGFX::GAL::BitmapText(), KIGFX::SCH_PAINTER::boxText(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), LIB_PIN::GetBoundingBox(), EDA_TEXT::getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), FONT_CHOICE::GetFontSelection(), SCH_FIELD::GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), GraphicTextWidth(), GRPrintText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), DRAWING_SHEET_PARSER::parseText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), PlotDrawingSheet(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_PIN::PlotPinTexts(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), LIB_PIN::printPinElectricalTypeName(), LIB_PIN::printPinTexts(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), FIELDS_GRID_TABLE< T >::SetValue(), KIGFX::SCH_PAINTER::strokeText(), KIGFX::PCB_PAINTER::strokeText(), PLOTTER::Text(), and PDF_PLOTTER::Text().

◆ GetInterline()

double OUTLINE_FONT::GetInterline	(	double	aGlyphHeight = `0.0`,
		double	aLineSpacing = `1.0`
	)		const

overridevirtual

Compute the distance (interline) between 2 lines of text (for multiline texts).

This is the distance between baselines, not the space between line bounding boxes.

Implements KIFONT::FONT.

Definition at line 165 of file outline_font.cpp.

{
 double pitch = INTERLINE_PITCH_RATIO;
 
 if( GetFace()->units_per_EM )
 pitch = GetFace()->height / GetFace()->units_per_EM;
 
 double interline = aLineSpacing * aGlyphHeight * pitch * m_outlineFontSizeCompensation;
 
 // FONT TODO this hack is an attempt to fix interline spacing by eyeballing it
 static constexpr double interlineHackMultiplier = 1.2;
 interline *= interlineHackMultiplier;
 
 return interline;
}

References GetFace(), KIFONT::FONT::INTERLINE_PITCH_RATIO, and m_outlineFontSizeCompensation.

◆ getLinePositions()

void FONT::getLinePositions	(	const wxString &	aText,
		const VECTOR2I &	aPosition,
		wxArrayString &	aTextLines,
		std::vector< VECTOR2I > &	aPositions,
		std::vector< VECTOR2I > &	aExtents,
		const TEXT_ATTRIBUTES &	aAttrs
	)		const

protectedinherited

Definition at line 94 of file font.cpp.

{
 wxStringSplit( aText, aTextLines, '\n' );
 int lineCount = aTextLines.Count();
 aPositions.reserve( lineCount );
 
 int interline = GetInterline( aAttrs.m_Size.y, aAttrs.m_LineSpacing );
 int height = 0;
 
 for( int i = 0; i < lineCount; i++ )
 {
 VECTOR2I pos( aPosition.x, aPosition.y + i * interline );
 VECTOR2I end = boundingBoxSingleLine( nullptr, aTextLines[i], pos, aAttrs.m_Size,
 aAttrs.m_Italic );
 VECTOR2I bBox( end - pos );
 
 aExtents.push_back( bBox );
 
 if( i == 0 )
 height += ( aAttrs.m_Size.y * 1.17 ); // 1.17 is a fudge to match 6.0 positioning
 else
 height += interline;
 }
 
 VECTOR2I offset( 0, 0 );
 offset.y += aAttrs.m_Size.y;
 
 switch( aAttrs.m_Valign )
 {
 case GR_TEXT_V_ALIGN_TOP: break;
 case GR_TEXT_V_ALIGN_CENTER: offset.y -= height / 2; break;
 case GR_TEXT_V_ALIGN_BOTTOM: offset.y -= height; break;
 }
 
 for( int i = 0; i < lineCount; i++ )
 {
 VECTOR2I lineSize = aExtents.at( i );
 VECTOR2I lineOffset( offset );
 
 lineOffset.y += i * interline;
 
 switch( aAttrs.m_Halign )
 {
 case GR_TEXT_H_ALIGN_LEFT: break;
 case GR_TEXT_H_ALIGN_CENTER: lineOffset.x = -lineSize.x / 2; break;
 case GR_TEXT_H_ALIGN_RIGHT: lineOffset.x = -lineSize.x; break;
 }
 
 aPositions.push_back( aPosition + lineOffset );
 }
}

References KIFONT::FONT::boundingBoxSingleLine(), KIFONT::FONT::GetInterline(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_LineSpacing, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_Valign, wxStringSplit(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIFONT::FONT::Draw(), and GetLinesAsGlyphs().

◆ GetLinesAsGlyphs()

void OUTLINE_FONT::GetLinesAsGlyphs	(	std::vector< std::unique_ptr< GLYPH > > *	aGlyphs,
		const wxString &	aText,
		const VECTOR2I &	aPosition,
		const TEXT_ATTRIBUTES &	aAttrs
	)		const

Definition at line 231 of file outline_font.cpp.

{
 wxArrayString strings;
 std::vector<VECTOR2I> positions;
 std::vector<VECTOR2I> extents;
 TEXT_STYLE_FLAGS textStyle = 0;
 
 if( aAttrs.m_Italic )
 textStyle |= TEXT_STYLE::ITALIC;
 
 getLinePositions( aText, aPosition, strings, positions, extents, aAttrs );
 
 for( size_t i = 0; i < strings.GetCount(); i++ )
 {
 (void) drawMarkup( nullptr, aGlyphs, strings.Item( i ), positions[i], aAttrs.m_Size,
 aAttrs.m_Angle, aAttrs.m_Mirrored, aPosition, textStyle );
 }
}

References KIFONT::FONT::drawMarkup(), KIFONT::FONT::getLinePositions(), ITALIC, TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_Mirrored, and TEXT_ATTRIBUTES::m_Size.

Referenced by EDA_TEXT::GetRenderCache(), and SCH_FIELD::GetRenderCache().

◆ GetName()

const wxString & KIFONT::FONT::GetName ( void ) const

inlineinherited

Definition at line 121 of file font.h.

121{ return m_fontName; };

KIFONT::FONT::m_fontName

wxString m_fontName

Font name.

Definition: font.h:262

References KIFONT::FONT::m_fontName.

Referenced by DS_DATA_MODEL_IO::format(), EDA_TEXT::GetFontName(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), KIFONT::FONT::NameAsToken(), operator<<(), and FONT_CHOICE::SetFontSelection().

◆ getOverbarOffset()

double OUTLINE_FONT::getOverbarOffset	(	int	ascender,
		int	height,
		int	thickness
	)		const

protected

Definition at line 305 of file outline_font.cpp.

{
 double thicknessRatio = abs( (double) thickness ) / (double) height;
 double ascenderRatio = (double) ascender / (double) height;
 
 if( thicknessRatio < 0.05 )
 return 0.04;
 else if( ascenderRatio < 0.78 )
 return 0.00;
 else if( ascenderRatio < 0.80 )
 return -0.03;
 else
 return -0.06;
}

References std::abs().

Referenced by getTextAsGlyphs().

◆ getTextAsGlyphs()

VECTOR2I OUTLINE_FONT::getTextAsGlyphs	(	BOX2I *	aBoundingBox,
		std::vector< std::unique_ptr< GLYPH > > *	aGlyphs,
		const wxString &	aText,
		const VECTOR2I &	aSize,
		const VECTOR2I &	aPosition,
		const EDA_ANGLE &	aAngle,
		bool	aMirror,
		const VECTOR2I &	aOrigin,
		TEXT_STYLE_FLAGS	aTextStyle
	)		const

protected

Definition at line 321 of file outline_font.cpp.

{
 VECTOR2D glyphSize = aSize;
 FT_Face face = m_face;
 double scaler = faceSize();
 
 if( IsSubscript( aTextStyle ) || IsSuperscript( aTextStyle ) )
 {
 scaler = subscriptSize();
 }
 
 // set glyph resolution so that FT_Load_Glyph() results are good enough for decomposing
 FT_Set_Char_Size( face, 0, scaler, GLYPH_RESOLUTION, 0 );
 
 hb_buffer_t* buf = hb_buffer_create();
 hb_buffer_add_utf8( buf, UTF8( aText ).c_str(), -1, 0, -1 );
 hb_buffer_guess_segment_properties( buf ); // guess direction, script, and language based on
 // contents
 
 unsigned int glyphCount;
 hb_glyph_info_t* glyphInfo = hb_buffer_get_glyph_infos( buf, &glyphCount );
 hb_glyph_position_t* glyphPos = hb_buffer_get_glyph_positions( buf, &glyphCount );
 
 hb_font_t* referencedFont = hb_ft_font_create_referenced( face );
 hb_ft_font_set_funcs( referencedFont );
 hb_shape( referencedFont, buf, nullptr, 0 );
 
 VECTOR2D scaleFactor( glyphSize.x / faceSize(), -glyphSize.y / faceSize() );
 scaleFactor = scaleFactor * m_outlineFontSizeCompensation;
 
 VECTOR2I cursor( 0, 0 );
 
 for( unsigned int i = 0; i < glyphCount; i++ )
 {
 // Don't process glyphs that were already included in a previous cluster
 if( i > 0 && glyphInfo[i].cluster == glyphInfo[i-1].cluster )
 continue;
 
 if( aGlyphs )
 {
 if( m_fakeItal )
 {
 FT_Matrix matrix;
 // Create a 12 degree slant
 const float angle = ( -M_PI * 12 ) / 180.0f;
 matrix.xx = (FT_Fixed) ( cos( angle ) * 0x10000L );
 matrix.xy = (FT_Fixed) ( -sin( angle ) * 0x10000L );
 matrix.yx = (FT_Fixed) ( 0 * 0x10000L ); // Don't rotate in the y direction
 matrix.yy = (FT_Fixed) ( 1 * 0x10000L );
 
 FT_Set_Transform(face, &matrix,0);
 }
 
 FT_Load_Glyph( face, glyphInfo[i].codepoint, FT_LOAD_NO_BITMAP );
 
 if( m_fakeBold )
 FT_Outline_Embolden( &face->glyph->outline, 1 << 6 );
 
 // contours is a collection of all outlines in the glyph; for example the 'o' glyph
 // generally contains 2 contours, one for the glyph outline and one for the hole
 CONTOURS contours;
 
 OUTLINE_DECOMPOSER decomposer( face->glyph->outline );
 decomposer.OutlineToSegments( &contours );
 
 std::unique_ptr<OUTLINE_GLYPH> glyph = std::make_unique<OUTLINE_GLYPH>();
 std::vector<SHAPE_LINE_CHAIN> holes;
 
 for( CONTOUR& c : contours )
 {
 GLYPH_POINTS points = c.m_Points;
 SHAPE_LINE_CHAIN shape;
 
 for( const VECTOR2D& v : points )
 {
 VECTOR2D pt( v + cursor );
 
 if( IsSubscript( aTextStyle ) )
 pt.y += m_subscriptVerticalOffset * scaler;
 else if( IsSuperscript( aTextStyle ) )
 pt.y += m_superscriptVerticalOffset * scaler;
 
 pt *= scaleFactor;
 pt += aPosition;
 
 if( aMirror )
 pt.x = aOrigin.x - ( pt.x - aOrigin.x );
 
 if( !aAngle.IsZero() )
 RotatePoint( pt, aOrigin, aAngle );
 
 shape.Append( pt.x, pt.y );
 }
 
 shape.SetClosed( true );
 
 if( contourIsHole( c ) )
 holes.push_back( std::move( shape ) );
 else
 glyph->AddOutline( std::move( shape ) );
 }
 
 for( SHAPE_LINE_CHAIN& hole : holes )
 {
 if( hole.PointCount() )
 {
 for( int ii = 0; ii < glyph->OutlineCount(); ++ii )
 {
 if( glyph->Outline( ii ).PointInside( hole.GetPoint( 0 ) ) )
 {
 glyph->AddHole( std::move( hole ), ii );
 break;
 }
 }
 }
 }
 
 // FONT TODO we might not want to do Fracture() here;
 // knockout text (eg. silkscreen labels with a background) will
 // need to do that after the contours have been turned into holes
 // and vice versa
 if( glyph->HasHoles() )
 glyph->Fracture( SHAPE_POLY_SET::PM_FAST ); // FONT TODO verify aFastMode
 
 aGlyphs->push_back( std::move( glyph ) );
 }
 
 hb_glyph_position_t& pos = glyphPos[i];
 cursor.x += ( pos.x_advance * GLYPH_SIZE_SCALER );
 cursor.y += ( pos.y_advance * GLYPH_SIZE_SCALER );
 }
 
 int ascender = abs( face->size->metrics.ascender * GLYPH_SIZE_SCALER );
 int height = abs( face->size->metrics.height * GLYPH_SIZE_SCALER );
 int descender = abs( face->size->metrics.descender * GLYPH_SIZE_SCALER );
 VECTOR2I extents( cursor.x * scaleFactor.x, ( ascender + descender ) * abs( scaleFactor.y ) );
 
 // Font metrics don't include all descenders and diacriticals, so beef them up just a little.
 extents.y *= 1.05;
 
 if( IsOverbar( aTextStyle ) )
 {
 std::vector<std::unique_ptr<GLYPH>> underscoreGlyphs;
 
 getTextAsGlyphs( nullptr, &underscoreGlyphs, wxT( "_" ), aSize, { 0, 0 }, ANGLE_0, false,
 { 0, 0 }, aTextStyle & ~TEXT_STYLE::OVERBAR );
 
 OUTLINE_GLYPH* underscoreGlyph = static_cast<OUTLINE_GLYPH*>( underscoreGlyphs[0].get() );
 BOX2I underscoreBBox;
 
 for( const VECTOR2I& pt : underscoreGlyph->Outline( 0 ).CPoints() )
 underscoreBBox.Merge( pt );
 
 int barThickness = underscoreBBox.GetHeight();
 
 // Shorten the bar a little so its rounded ends don't make it over-long
 double barTrim = barThickness / 2.0;
 double barOffset = getOverbarOffset( ascender, height, barThickness / scaleFactor.y );
 
 VECTOR2I topLeft( aPosition );
 VECTOR2I topRight( aPosition );
 
 topLeft.y += ascender * scaleFactor.y * ( 1.0 + barOffset );
 topRight.y = topLeft.y;
 
 topLeft.x += barTrim;
 topRight.x += extents.x - barTrim;
 
 extents.y *= ( 1.0 + barOffset + barOffset );
 extents.x += barTrim;
 
 if( IsItalic() )
 {
 topLeft.x += aSize.y * ITALIC_TILT;
 topRight.x += aSize.y * ITALIC_TILT;
 extents.x += aSize.y * ITALIC_TILT;
 }
 
 if( aMirror )
 {
 topLeft.x = aOrigin.x - ( topLeft.x - aOrigin.x );
 topRight.x = aOrigin.x - ( topRight.x - aOrigin.x );
 }
 
 if( !aAngle.IsZero() )
 {
 RotatePoint( topLeft, aOrigin, aAngle );
 RotatePoint( topRight, aOrigin, aAngle );
 }
 
 if( aGlyphs )
 {
 int  maxError = KiROUND( barThickness / 48 );
 SHAPE_POLY_SET poly;
 
 TransformOvalToPolygon( poly, topLeft, topRight, barThickness, maxError, ERROR_INSIDE );
 
 std::unique_ptr<OUTLINE_GLYPH> overbarGlyph = std::make_unique<OUTLINE_GLYPH>( poly );
 aGlyphs->push_back( std::move( overbarGlyph ) );
 }
 }
 
 hb_buffer_destroy( buf );
 hb_font_destroy( referencedFont );
 
 VECTOR2I cursorDisplacement( cursor.x * scaleFactor.x, -cursor.y * scaleFactor.y );
 
 if( aBBox )
 aBBox->Merge( aPosition + extents );
 
 return VECTOR2I( aPosition.x + cursorDisplacement.x, aPosition.y + cursorDisplacement.y );
}

References std::abs(), PNS::angle(), ANGLE_0, SHAPE_LINE_CHAIN::Append(), contourIsHole(), cursor, ERROR_INSIDE, faceSize(), BOX2< Vec >::GetHeight(), getOverbarOffset(), getTextAsGlyphs(), KIFONT::GLYPH_RESOLUTION, KIFONT::GLYPH_SIZE_SCALER, IsItalic(), IsOverbar(), IsSubscript(), IsSuperscript(), EDA_ANGLE::IsZero(), ITALIC_TILT, KiROUND(), m_face, m_fakeBold, m_fakeItal, m_outlineFontSizeCompensation, m_subscriptVerticalOffset, m_superscriptVerticalOffset, BOX2< Vec >::Merge(), KIFONT::OUTLINE_DECOMPOSER::OutlineToSegments(), OVERBAR, SHAPE_POLY_SET::PM_FAST, RotatePoint(), SHAPE_LINE_CHAIN::SetClosed(), subscriptSize(), TransformOvalToPolygon(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by getTextAsGlyphs(), and GetTextAsGlyphs().

◆ GetTextAsGlyphs()

VECTOR2I OUTLINE_FONT::GetTextAsGlyphs	(	BOX2I *	aBBox,
		std::vector< std::unique_ptr< GLYPH > > *	aGlyphs,
		const wxString &	aText,
		const VECTOR2I &	aSize,
		const VECTOR2I &	aPosition,
		const EDA_ANGLE &	aAngle,
		bool	aMirror,
		const VECTOR2I &	aOrigin,
		TEXT_STYLE_FLAGS	aTextStyle
	)		const

overridevirtual

Convert text string to an array of GLYPHs.

Parameters

aBBox	pointer to a BOX2I that will set to the bounding box, or nullptr
aGlyphs	storage for the returned GLYPHs
aText	text to convert to polygon/polyline
aSize	is the cap-height and em-width of the text
aPosition	position of text (cursor position before this text)
aAngle	text angle
aMirror	is true if text should be drawn mirrored, false otherwise.
aOrigin	is the point around which the text should be rotated, mirrored, etc.
aTextStyle	text style flags

Returns: text cursor position after this text

Implements KIFONT::FONT.

Definition at line 253 of file outline_font.cpp.

{
 // HarfBuzz needs further processing to split tab-delimited text into text runs.
 
 constexpr double TAB_WIDTH = 4 * 0.6;
 
 VECTOR2I position = aPosition;
 wxString textRun;
 
 if( aBBox )
 {
 aBBox->SetOrigin( aPosition );
 aBBox->SetEnd( aPosition );
 }
 
 for( wxUniChar c : aText )
 {
 // Handle tabs as locked to the nearest 4th column (in space-widths).
 if( c == '\t' )
 {
 if( !textRun.IsEmpty() )
 {
 position = getTextAsGlyphs( aBBox, aGlyphs, textRun, aSize, position, aAngle,
 aMirror, aOrigin, aTextStyle );
 textRun.clear();
 }
 
 int tabWidth = KiROUND( aSize.x * TAB_WIDTH );
 int currentIntrusion = ( position.x - aOrigin.x ) % tabWidth;
 
 position.x += tabWidth - currentIntrusion;
 }
 else
 {
 textRun += c;
 }
 }
 
 if( !textRun.IsEmpty() )
 {
 position = getTextAsGlyphs( aBBox, aGlyphs, textRun, aSize, position, aAngle, aMirror,
 aOrigin, aTextStyle );
 }
 
 return position;
}

References getTextAsGlyphs(), KiROUND(), BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), and VECTOR2< T >::x.

◆ HarfBuzzVersion()

wxString OUTLINE_FONT::HarfBuzzVersion ( )

static

Definition at line 73 of file outline_font.cpp.

{
 return wxString::FromUTF8( HB_VERSION_STRING );
}

Referenced by FontLibraryVersion(), and GetVersionInfoData().

◆ IsBold()

bool KIFONT::OUTLINE_FONT::IsBold ( ) const

inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 64 of file outline_font.h.

 {
 return m_face && ( m_fakeBold || ( m_face->style_flags & FT_STYLE_FLAG_BOLD ) );
 }

References m_face, and m_fakeBold.

◆ IsItalic()

bool KIFONT::OUTLINE_FONT::IsItalic ( ) const

inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 69 of file outline_font.h.

 {
 return m_face && ( m_fakeItal || ( m_face->style_flags & FT_STYLE_FLAG_ITALIC ) );
 }

References m_face, and m_fakeItal.

Referenced by getTextAsGlyphs().

◆ IsOutline()

bool KIFONT::OUTLINE_FONT::IsOutline ( ) const

inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 62 of file outline_font.h.

62{ return true; }

◆ IsStroke() [1/2]

virtual bool KIFONT::FONT::IsStroke ( ) const

inlinevirtualinherited

Reimplemented in KIFONT::STROKE_FONT.

Definition at line 112 of file font.h.

112{ return false; }

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), DIALOG_DIMENSION_PROPERTIES::onFontSelected(), DIALOG_TEXT_PROPERTIES::onFontSelected(), DIALOG_TEXTBOX_PROPERTIES::onFontSelected(), operator<<(), BRDITEMS_PLOTTER::PlotPcbText(), KIFONT::FONT::StringBoundaryLimits(), KIGFX::SCH_PAINTER::strokeText(), and KIGFX::PCB_PAINTER::strokeText().

◆ IsStroke() [2/2]

bool FONT::IsStroke ( const wxString & aFontName )

staticinherited

Definition at line 86 of file font.cpp.

{
 // This would need a more complex implementation if we ever support more stroke fonts
 // than the KiCad Font.
 return aFontName == _( "Default Font" ) || aFontName == KICAD_FONT_NAME;
}

References _, and KICAD_FONT_NAME.

◆ LinebreakText()

void FONT::LinebreakText	(	wxString &	aText,
		int	aColumnWidth,
		const VECTOR2I &	aGlyphSize,
		int	aThickness,
		bool	aBold,
		bool	aItalic
	)		const

inherited

Insert
characters into text to ensure that no lines are wider than aColumnWidth.

Definition at line 423 of file font.cpp.

{
 TEXT_STYLE_FLAGS textStyle = 0;
 
 if( aBold )
 textStyle |= TEXT_STYLE::BOLD;
 
 if( aItalic )
 textStyle |= TEXT_STYLE::ITALIC;
 
 int spaceWidth = GetTextAsGlyphs( nullptr, nullptr, wxS( " " ), aSize, VECTOR2I(), ANGLE_0,
 false, VECTOR2I(), textStyle ).x;
 
 wxArrayString textLines;
 wxStringSplit( aText, textLines, '\n' );
 
 aText = wxEmptyString;
 
 for( size_t ii = 0; ii < textLines.Count(); ++ii )
 {
 bool virginLine = true;
 int lineWidth = 0;
 std::vector<std::pair<wxString, int>> words;
 
 wordbreakMarkup( &words, textLines[ii], aSize, textStyle );
 
 for( size_t jj = 0; jj < words.size(); /* advance in loop */ )
 {
 if( virginLine )
 {
 // First word is always placed, even when wider than columnWidth.
 aText += words[jj].first;
 lineWidth += words[jj].second;
 jj++;
 
 virginLine = false;
 }
 else if( lineWidth + spaceWidth + words[jj].second < aColumnWidth - aThickness )
 {
 aText += " " + words[jj].first;
 lineWidth += spaceWidth + words[jj].second;
 jj++;
 }
 else
 {
 aText += '\n';
 
 lineWidth = 0;
 virginLine = true;
 }
 }
 
 // Add the newlines back onto the string
 if( ii != ( textLines.Count() - 1 ) )
 aText += '\n';
 }
}

References ANGLE_0, BOLD, KIFONT::FONT::GetTextAsGlyphs(), ITALIC, KIFONT::FONT::wordbreakMarkup(), wxStringSplit(), and VECTOR2< T >::x.

Referenced by LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), and PCB_TEXTBOX::GetShownText().

◆ linesCount()

unsigned KIFONT::FONT::linesCount ( const wxString & aText ) const

inlineprotectedinherited

Returns number of lines for a given text.

Parameters

aText is the text to be checked.

Returns: unsigned - The number of lines in aText.

Definition at line 202 of file font.h.

 {
 if( aText.empty() )
 return 0; // std::count does not work well with empty strings
 else
 // aText.end() - 1 is to skip a newline character that is potentially at the end
 return std::count( aText.begin(), aText.end() - 1, '\n' ) + 1;
 }

◆ loadFace()

FT_Error OUTLINE_FONT::loadFace ( const wxString & aFontFileName )

protected

Definition at line 116 of file outline_font.cpp.

{
 // TODO: check that going from wxString to char* with UTF-8
 // conversion for filename makes sense on any/all platforms
 FT_Error e = FT_New_Face( m_freeType, aFontFileName.mb_str( wxConvUTF8 ), 0, &m_face );
 
 if( !e )
 {
 FT_Select_Charmap( m_face, FT_Encoding::FT_ENCODING_UNICODE );
 // params:
 // m_face = handle to face object
 // 0 = char width in 1/64th of points ( 0 = same as char height )
 // faceSize() = char height in 1/64th of points
 // GLYPH_RESOLUTION = horizontal device resolution (288dpi, 4x default)
 // 0 = vertical device resolution ( 0 = same as horizontal )
 FT_Set_Char_Size( m_face, 0, faceSize(), GLYPH_RESOLUTION, 0 );
 }
 
 return e;
}

References faceSize(), KIFONT::GLYPH_RESOLUTION, m_face, and m_freeType.

Referenced by LoadFont().

◆ LoadFont()

OUTLINE_FONT * OUTLINE_FONT::LoadFont	(	const wxString &	aFontFileName,
		bool	aBold,
		bool	aItalic
	)

static

Load an outline font.

TrueType (.ttf) and OpenType (.otf) are supported.

Parameters

aFontFileName is the (platform-specific) fully qualified name of the font file

Definition at line 91 of file outline_font.cpp.

{
 OUTLINE_FONT* font = new OUTLINE_FONT();
 
 wxString fontFile;
 using fc = fontconfig::FONTCONFIG;
 
 fc::FF_RESULT retval = Fontconfig()->FindFont( aFontName, fontFile, aBold, aItalic );
 
 if( retval == fc::FF_RESULT::FF_MISSING_BOLD || retval == fc::FF_RESULT::FF_MISSING_BOLD_ITAL )
 font->SetFakeBold();
 
 if( retval == fc::FF_RESULT::FF_MISSING_ITAL || retval == fc::FF_RESULT::FF_MISSING_BOLD_ITAL )
 font->SetFakeItal();
 
 if( retval != fc::FF_RESULT::FF_ERROR )
 (void) font->loadFace( fontFile );
 
 font->m_fontName = aFontName; // Keep asked-for name, even if we substituted.
 font->m_fontFileName = fontFile;
 
 return font;
}

References Fontconfig(), loadFace(), KIFONT::FONT::m_fontFileName, KIFONT::FONT::m_fontName, OUTLINE_FONT(), SetFakeBold(), and SetFakeItal().

Referenced by KIFONT::FONT::GetFont().

◆ NameAsToken()

const char * KIFONT::FONT::NameAsToken ( ) const

inlineinherited

Definition at line 122 of file font.h.

122{ return GetName().utf8_str().data(); }

KIFONT::FONT::GetName

const wxString & GetName() const

Definition: font.h:121

References KIFONT::FONT::GetName().

Referenced by DS_DATA_MODEL_IO::format().

◆ SetFakeBold()

void KIFONT::OUTLINE_FONT::SetFakeBold ( )

inline

Definition at line 74 of file outline_font.h.

 {
 m_fakeBold = true;
 }

References m_fakeBold.

Referenced by LoadFont().

◆ SetFakeItal()

void KIFONT::OUTLINE_FONT::SetFakeItal ( )

inline

Definition at line 79 of file outline_font.h.

 {
 m_fakeItal = true;
 }

References m_fakeItal.

Referenced by LoadFont().

◆ StringBoundaryLimits()

VECTOR2I FONT::StringBoundaryLimits	(	const wxString &	aText,
		const VECTOR2I &	aSize,
		int	aThickness,
		bool	aBold,
		bool	aItalic
	)		const

inherited

Compute the boundary limits of aText (the bounding box of all shapes).

Returns: a VECTOR2I giving the width and height of text.

Definition at line 271 of file font.cpp.

{
 // TODO do we need to parse every time - have we already parsed?
 BOX2I boundingBox;
 TEXT_STYLE_FLAGS textStyle = 0;
 
 if( aBold )
 textStyle |= TEXT_STYLE::BOLD;
 
 if( aItalic )
 textStyle |= TEXT_STYLE::ITALIC;
 
 (void) drawMarkup( &boundingBox, nullptr, aText, VECTOR2I(), aSize, ANGLE_0, false,
 VECTOR2I(), textStyle );
 
 if( IsStroke() )
 {
 // Inflate by a bit more than thickness/2 to catch diacriticals, descenders, etc.
 boundingBox.Inflate( KiROUND( aThickness * 1.25 ) );
 }
 else if( IsOutline() )
 {
 // Outline fonts have thickness built in, and *usually* stay within their ascent/descent
 }
 
 return boundingBox.GetSize();
}

References ANGLE_0, BOLD, boundingBox(), KIFONT::FONT::drawMarkup(), BOX2< Vec >::GetSize(), BOX2< Vec >::Inflate(), KIFONT::FONT::IsOutline(), KIFONT::FONT::IsStroke(), ITALIC, and KiROUND().

Referenced by LABEL_MANAGER::Add(), KIGFX::SCH_PAINTER::boxText(), EDA_TEXT::GetTextBox(), GraphicTextWidth(), and PDF_PLOTTER::Text().

◆ subscriptSize() [1/2]

int KIFONT::OUTLINE_FONT::subscriptSize ( ) const

inlineprivate

Definition at line 178 of file outline_font.h.

178{ return subscriptSize( m_faceSize ); }

References m_faceSize, and subscriptSize().

Referenced by getTextAsGlyphs(), and subscriptSize().

◆ subscriptSize() [2/2]

int KIFONT::OUTLINE_FONT::subscriptSize ( int aSize ) const

inlineprivate

Definition at line 174 of file outline_font.h.

 {
 return KiROUND( faceSize( aSize ) * m_subscriptSuperscriptSize );
 }

References faceSize(), KiROUND(), and m_subscriptSuperscriptSize.

◆ wordbreakMarkup()

void FONT::wordbreakMarkup	(	std::vector< std::pair< wxString, int > > *	aWords,
		const wxString &	aText,
		const VECTOR2I &	aSize,
		TEXT_STYLE_FLAGS	aTextStyle
	)		const

protectedinherited

Factor that determines the pitch between 2 lines.

Definition at line 402 of file font.cpp.

{
 MARKUP::MARKUP_PARSER markupParser( TO_UTF8( aText ) );
 std::unique_ptr<MARKUP::NODE> root = markupParser.Parse();
 
 ::wordbreakMarkup( aWords, root, this, aSize, aTextStyle );
}

References MARKUP::MARKUP_PARSER::Parse(), TO_UTF8, and KIFONT::FONT::wordbreakMarkup().

Referenced by KIFONT::FONT::LinebreakText(), and KIFONT::FONT::wordbreakMarkup().

Member Data Documentation

◆ INTERLINE_PITCH_RATIO

constexpr double KIFONT::FONT::INTERLINE_PITCH_RATIO = 1.62

staticconstexprprotectedinherited

Definition at line 256 of file font.h.

Referenced by KIFONT::STROKE_FONT::GetInterline(), and GetInterline().

◆ m_charSizeScaler

constexpr int KIFONT::OUTLINE_FONT::m_charSizeScaler = 64

staticconstexprprivate

Definition at line 156 of file outline_font.h.

Referenced by faceSize().

◆ m_contourCache

std::map<unsigned int, GLYPH_POINTS_LIST> KIFONT::OUTLINE_FONT::m_contourCache

private

Definition at line 146 of file outline_font.h.

◆ m_face

FT_Face KIFONT::OUTLINE_FONT::m_face

private

Definition at line 139 of file outline_font.h.

Referenced by GetFace(), getTextAsGlyphs(), IsBold(), IsItalic(), and loadFace().

◆ m_faceSize

const int KIFONT::OUTLINE_FONT::m_faceSize

private

Definition at line 140 of file outline_font.h.

Referenced by faceSize(), and subscriptSize().

◆ m_fakeBold

bool KIFONT::OUTLINE_FONT::m_fakeBold

private

Definition at line 141 of file outline_font.h.

Referenced by getTextAsGlyphs(), IsBold(), and SetFakeBold().

◆ m_fakeItal

bool KIFONT::OUTLINE_FONT::m_fakeItal

private

Definition at line 142 of file outline_font.h.

Referenced by getTextAsGlyphs(), IsItalic(), and SetFakeItal().

◆ m_fontFileName

wxString KIFONT::FONT::m_fontFileName

protectedinherited

Font file name.

Definition at line 263 of file font.h.

Referenced by LoadFont(), and KIFONT::STROKE_FONT::loadNewStrokeFont().

◆ m_fontName

wxString KIFONT::FONT::m_fontName

protectedinherited

Font name.

Definition at line 262 of file font.h.

Referenced by KIFONT::FONT::GetName(), LoadFont(), and KIFONT::STROKE_FONT::loadNewStrokeFont().

◆ m_freeType

FT_Library OUTLINE_FONT::m_freeType = nullptr

staticprivate

Definition at line 138 of file outline_font.h.

Referenced by FreeTypeVersion(), loadFace(), and OUTLINE_FONT().

◆ m_outlineFontSizeCompensation

constexpr double KIFONT::OUTLINE_FONT::m_outlineFontSizeCompensation = 1.4

staticconstexprprivate

Definition at line 153 of file outline_font.h.

Referenced by ComputeOverbarVerticalPosition(), faceSize(), GetInterline(), and getTextAsGlyphs().

◆ m_subscriptSuperscriptSize

constexpr double KIFONT::OUTLINE_FONT::m_subscriptSuperscriptSize = 0.64

staticconstexprprivate

Definition at line 163 of file outline_font.h.

Referenced by subscriptSize().

◆ m_subscriptVerticalOffset

constexpr double KIFONT::OUTLINE_FONT::m_subscriptVerticalOffset = -0.25

staticconstexprprivate

Definition at line 180 of file outline_font.h.

Referenced by getTextAsGlyphs().

◆ m_superscriptVerticalOffset

constexpr double KIFONT::OUTLINE_FONT::m_superscriptVerticalOffset = 0.45

staticconstexprprivate

Definition at line 181 of file outline_font.h.

Referenced by getTextAsGlyphs().

◆ m_underlineOffsetScaler

constexpr double KIFONT::OUTLINE_FONT::m_underlineOffsetScaler = -0.16

staticconstexprprivate

Definition at line 165 of file outline_font.h.

Referenced by ComputeUnderlineVerticalPosition().

◆ s_defaultFont

FONT * FONT::s_defaultFont = nullptr

staticprivateinherited

Definition at line 266 of file font.h.

Referenced by KIFONT::FONT::getDefaultFont().

◆ s_fontMap

std::map< std::tuple< wxString, bool, bool >, FONT * > FONT::s_fontMap

staticprivateinherited

Definition at line 268 of file font.h.

Referenced by KIFONT::FONT::GetFont().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OUTLINE_FONT()

Member Function Documentation

◆ boundingBoxSingleLine()

◆ ComputeOverbarVerticalPosition()

◆ ComputeUnderlineVerticalPosition()

◆ Draw() [1/2]

◆ Draw() [2/2]

◆ drawMarkup()

◆ drawSingleLineText()

◆ faceSize() [1/2]

◆ faceSize() [2/2]

◆ FontConfigVersion()

◆ FontLibraryVersion()

◆ FreeTypeVersion()

◆ getBoundingBox()

◆ getDefaultFont()

◆ GetFace()

◆ GetFont()

◆ GetInterline()

◆ getLinePositions()

◆ GetLinesAsGlyphs()

◆ GetName()

◆ getOverbarOffset()

◆ getTextAsGlyphs()

◆ GetTextAsGlyphs()

◆ HarfBuzzVersion()

◆ IsBold()

◆ IsItalic()

◆ IsOutline()

◆ IsStroke() [1/2]

◆ IsStroke() [2/2]

◆ LinebreakText()

◆ linesCount()

◆ loadFace()

◆ LoadFont()

◆ NameAsToken()

◆ SetFakeBold()

◆ SetFakeItal()

◆ StringBoundaryLimits()

◆ subscriptSize() [1/2]

◆ subscriptSize() [2/2]

◆ wordbreakMarkup()

Member Data Documentation

◆ INTERLINE_PITCH_RATIO

◆ m_charSizeScaler

◆ m_contourCache

◆ m_face

◆ m_faceSize

◆ m_fakeBold

◆ m_fakeItal

◆ m_fontFileName

◆ m_fontName

◆ m_freeType

◆ m_outlineFontSizeCompensation

◆ m_subscriptSuperscriptSize

◆ m_subscriptVerticalOffset

◆ m_superscriptVerticalOffset

◆ m_underlineOffsetScaler

◆ s_defaultFont

◆ s_fontMap