KIFONT::OUTLINE_FONT Class Reference

Class OUTLINE_FONT implements outline font drawing. More...

#include <outline_font.h>

Inheritance diagram for KIFONT::OUTLINE_FONT:

Public Types
enum class	EMBEDDING_PERMISSION {   INSTALLABLE , EDITABLE , PRINT_PREVIEW_ONLY , RESTRICTED ,   INVALID }

Public Member Functions
	OUTLINE_FONT ()
bool	IsOutline () const override
bool	IsBold () const override
bool	IsItalic () const override
void	SetFakeBold ()
void	SetFakeItal ()
const wxString &	GetFileName () const
EMBEDDING_PERMISSION	GetEmbeddingPermission () const
double	GetInterline (double aGlyphHeight, const METRICS &aFontMetrics) const override
	Compute the distance (interline) between 2 lines of text (for multiline texts).
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.
void	GetLinesAsGlyphs (std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttrs, const METRICS &aFontMetrics) 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 &aAttributes, const METRICS &aFontMetrics) const
	Draw a string.
void	Draw (KIGFX::GAL *aGal, const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttributes, const METRICS &aFontMetrics) const
VECTOR2I	StringBoundaryLimits (const wxString &aText, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic, const METRICS &aFontMetrics) const
	Compute the boundary limits of aText (the bounding box of all shapes).
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.

Static Public Member Functions
static OUTLINE_FONT *	LoadFont (const wxString &aFontFileName, bool aBold, bool aItalic, const std::vector< wxString > *aEmbeddedFiles, bool aForDrawingSheet)
	Load an outline font.
static bool	IsStroke (const wxString &aFontName)
static FONT *	GetFont (const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false, const std::vector< wxString > *aEmbeddedFiles=nullptr, bool aForDrawingSheet=false)

Protected Member Functions
FT_Error	loadFace (const wxString &aFontFileName, int aFaceIndex)
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.
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 METRICS &aFontMetrics) const
	Draws a single line of text.
VECTOR2I	boundingBoxSingleLine (BOX2I *aBBox, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aSize, bool aItalic, const METRICS &aFontMetrics) const
	Computes the bounding box for a single line of text.
void	getLinePositions (const wxString &aText, const VECTOR2I &aPosition, wxArrayString &aTextLines, std::vector< VECTOR2I > &aPositions, std::vector< VECTOR2I > &aExtents, const TEXT_ATTRIBUTES &aAttrs, const METRICS &aFontMetrics) 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 METRICS &aFontMetrics) const
void	wordbreakMarkup (std::vector< std::pair< wxString, int > > *aWords, const wxString &aText, const VECTOR2I &aSize, TEXT_STYLE_FLAGS aTextStyle) const

Protected Attributes
wxString	m_fontName
	Font name.
wxString	m_fontFileName
	Font file name.

Private Member Functions
VECTOR2I	getTextAsGlyphsUnlocked (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
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
bool	m_forDrawingSheet
std::map< unsigned int, std::vector< std::vector< VECTOR2D > > >	m_contourCache

Static Private Attributes
static std::mutex	m_freeTypeMutex
	Mutex for freetype access, FT_Library and FT_Face are not thread safe.
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, bool >, FONT * >	s_fontMap

Detailed Description

Class OUTLINE_FONT implements outline font drawing.

Definition at line 52 of file outline_font.h.

Member Enumeration Documentation

EMBEDDING_PERMISSION

enum class KIFONT::OUTLINE_FONT::EMBEDDING_PERMISSION

strong

Enumerator
INSTALLABLE
EDITABLE
PRINT_PREVIEW_ONLY
RESTRICTED
INVALID

Definition at line 56 of file outline_font.h.

Constructor & Destructor Documentation

OUTLINE_FONT()

OUTLINE_FONT::OUTLINE_FONT

(

)

Definition at line 47 of file outline_font.cpp.

References m_freeType, and m_freeTypeMutex.

Member Function Documentation

boundingBoxSingleLine()

VECTOR2I FONT::boundingBoxSingleLine ( BOX2I *  aBBox, const wxString &  aText, const VECTOR2I &  aPosition, const VECTOR2I &  aSize, bool  aItalic, const METRICS &  aFontMetrics  ) 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 465 of file font.cpp.

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

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

Draw() [1/2]

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

inlineinherited

Definition at line 166 of file font.h.

Draw() [2/2]

void FONT::Draw ( KIGFX::GAL *  aGal, const wxString &  aText, const VECTOR2I &  aPosition, const VECTOR2I &  aCursor, const TEXT_ATTRIBUTES &  aAttrs, const METRICS &  aFontMetrics  ) 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 258 of file font.cpp.

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(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), EDA_TEXT::GetEffectiveTextShape(), GRPrintText(), KIGFX::knockoutText(), PLOTTER::PlotText(), KIGFX::PCB_PAINTER::strokeText(), KIGFX::strokeText(), PLOTTER::Text(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), TUNING_STATUS_VIEW_ITEM::ViewDraw(), ROUTER_STATUS_VIEW_ITEM::ViewDraw(), and KIGFX::ANCHOR_DEBUG::ViewDraw().

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 METRICS &  aFontMetrics  ) const

protectedinherited

Definition at line 384 of file font.cpp.

References MARKUP_CACHE::Get(), MARKUP::MARKUP_PARSER::Parse(), MARKUP_CACHE::Put(), MARKUP_CACHE::ENTRY::root, s_markupCache, s_markupCacheMutex, MARKUP_CACHE::ENTRY::source, 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 METRICS &  aFontMetrics  ) 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 410 of file font.cpp.

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

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

faceSize() [1/2]

int KIFONT::OUTLINE_FONT::faceSize ( ) const

inlineprivate

Definition at line 185 of file outline_font.h.

References faceSize().

Referenced by faceSize(), getTextAsGlyphsUnlocked(), and loadFace().

faceSize() [2/2]

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

inlineprivate

Definition at line 181 of file outline_font.h.

getBoundingBox()

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

protected

Definition at line 174 of file outline_font.cpp.

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 137 of file font.cpp.

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

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

GetEmbeddingPermission()

OUTLINE_FONT::EMBEDDING_PERMISSION OUTLINE_FONT::GetEmbeddingPermission

(

)

const

Definition at line 61 of file outline_font.cpp.

References EDITABLE, INSTALLABLE, m_face, PRINT_PREVIEW_ONLY, and RESTRICTED.

GetFace()

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

inline

Definition at line 116 of file outline_font.h.

Referenced by GetInterline().

GetFileName()

const wxString & KIFONT::OUTLINE_FONT::GetFileName ( ) const

inline

Definition at line 89 of file outline_font.h.

GetFont()

FONT * FONT::GetFont ( const wxString &  aFontName = wxEmptyString, bool  aBold = false, bool  aItalic = false, const std::vector< wxString > *  aEmbeddedFiles = nullptr, bool  aForDrawingSheet = false  )

staticinherited

Definition at line 146 of file font.cpp.

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

Referenced by LABEL_MANAGER::Add(), BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), SCH_EASYEDAPRO_PARSER::ApplyFontStyle(), KIGFX::GAL::BitmapText(), BOOST_AUTO_TEST_CASE(), KIGFX::boxText(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), EDA_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PREVIEW::DrawTextNextToCursor(), drawTicksAlongLine(), EDA_TEXT::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), FONT_CHOICE::GetFontSelection(), SCH_FIELD::GetRenderCache(), GRPrintText(), GRTextWidth(), FEATURES_MANAGER::InitFeatureList(), KIGFX::knockoutText(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), DRAWING_SHEET_PARSER::parseText(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), PlotDrawingSheet(), SCH_PIN::PlotPinTexts(), BRDITEMS_PLOTTER::PlotText(), PLOTTER::PlotText(), SCH_FIELD::Print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), SCH_PIN::printPinElectricalTypeName(), SCH_PIN::printPinTexts(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PIN_LAYOUT_CACHE::recomputeCaches(), SCH_IO_KICAD_SEXPR_PARSER::removeEntryInFontTextMap(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), EDA_TEXT::SetBold(), EDA_TEXT::SetFontIndex(), EDA_TEXT::SetItalic(), FIELDS_GRID_TABLE::SetValue(), KIGFX::PCB_PAINTER::strokeText(), KIGFX::strokeText(), PLOTTER::Text(), PDF_PLOTTER::Text(), TUNING_STATUS_VIEW_ITEM::ViewDraw(), ROUTER_STATUS_VIEW_ITEM::ViewDraw(), and KIGFX::ANCHOR_DEBUG::ViewDraw().

GetInterline()

double OUTLINE_FONT::GetInterline ( double  aGlyphHeight, const METRICS &  aFontMetrics  ) 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 146 of file outline_font.cpp.

References GetFace(), and KIFONT::METRICS::GetInterline().

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 METRICS &  aFontMetrics  ) const

protectedinherited

Definition at line 179 of file font.cpp.

References KIFONT::FONT::boundingBoxSingleLine(), KIFONT::FONT::GetInterline(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, KIFONT::FONT::IsStroke(), TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Italic, TEXT_ATTRIBUTES::m_LineSpacing, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, 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 METRICS &	aFontMetrics
	)		const

Definition at line 206 of file outline_font.cpp.

References KIFONT::FONT::drawMarkup(), KIFONT::FONT::getLinePositions(), 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 ( ) const

inlineinherited

Definition at line 149 of file font.h.

Referenced by TEXT_ATTRIBUTES::Compare(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), DS_DATA_MODEL_IO::format(), EDA_TEXT::GetFontIndex(), EDA_TEXT::GetFontName(), FIELDS_GRID_TABLE::GetValue(), operator<<(), EDA_TEXT::SetBold(), FONT_CHOICE::SetFontSelection(), and EDA_TEXT::SetItalic().

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 281 of file outline_font.cpp.

References getTextAsGlyphsUnlocked(), and m_freeTypeMutex.

Referenced by 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 229 of file outline_font.cpp.

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

getTextAsGlyphsUnlocked()

VECTOR2I OUTLINE_FONT::getTextAsGlyphsUnlocked ( 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

private

Definition at line 337 of file outline_font.cpp.

References SHAPE_LINE_CHAIN::Append(), GLYPH_CACHE_KEY::codepoint, contourIsHole(), cursor, faceSize(), KIFONT::GLYPH_RESOLUTION, KIFONT::GLYPH_SIZE_SCALER, IsSubscript(), IsSuperscript(), EDA_ANGLE::IsZero(), KIFONT::GLYPH_DATA::m_Contours, m_face, m_fakeBold, m_fakeItal, m_forDrawingSheet, KIFONT::CONTOUR::m_Orientation, m_outlineFontSizeCompensation, KIFONT::CONTOUR::m_Points, m_subscriptVerticalOffset, m_superscriptVerticalOffset, KIFONT::GLYPH_DATA::m_TriangulationData, KIFONT::CONTOUR::m_Winding, BOX2< Vec >::Merge(), KIFONT::OUTLINE_DECOMPOSER::OutlineToSegments(), SHAPE_LINE_CHAIN::ReservePoints(), RotatePoint(), SHAPE_LINE_CHAIN::SetClosed(), subscriptSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by getTextAsGlyphs().

IsBold()

bool KIFONT::OUTLINE_FONT::IsBold ( ) const

inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 69 of file outline_font.h.

IsItalic()

bool KIFONT::OUTLINE_FONT::IsItalic ( ) const

inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 74 of file outline_font.h.

IsOutline()

bool KIFONT::OUTLINE_FONT::IsOutline ( ) const

inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 67 of file outline_font.h.

IsStroke() [1/2]

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

inlinevirtualinherited

Reimplemented in KIFONT::STROKE_FONT.

Definition at line 138 of file font.h.

Referenced by SCHEMATIC::EmbedFonts(), BOARD::EmbedFonts(), KIFONT::FONT::getLinePositions(), EDA_TEXT::GetTextBox(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), DIALOG_DIMENSION_PROPERTIES::onFontSelected(), DIALOG_TEXT_PROPERTIES::onFontSelected(), DIALOG_TEXTBOX_PROPERTIES::onFontSelected(), operator<<(), EDA_TEXT::SetBold(), EDA_TEXT::SetItalic(), KIFONT::FONT::StringBoundaryLimits(), KIGFX::PCB_PAINTER::strokeText(), and KIGFX::strokeText().

IsStroke() [2/2]

bool FONT::IsStroke ( const wxString &  aFontName )

staticinherited

Definition at line 171 of file font.cpp.

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 589 of file font.cpp.

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

Referenced by PCB_TEXTBOX::GetShownText(), and SCH_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 219 of file font.h.

loadFace()

FT_Error OUTLINE_FONT::loadFace ( const wxString &  aFontFileName, int  aFaceIndex  )

protected

Definition at line 120 of file outline_font.cpp.

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

LoadFont()

OUTLINE_FONT * OUTLINE_FONT::LoadFont ( const wxString &  aFontFileName, bool  aBold, bool  aItalic, const std::vector< wxString > *  aEmbeddedFiles, bool  aForDrawingSheet  )

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 86 of file outline_font.cpp.

References Fontconfig().

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

NameAsToken()

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

inlineinherited

Definition at line 150 of file font.h.

Referenced by DS_DATA_MODEL_IO::format().

SetFakeBold()

void KIFONT::OUTLINE_FONT::SetFakeBold ( )

inline

Definition at line 79 of file outline_font.h.

SetFakeItal()

void KIFONT::OUTLINE_FONT::SetFakeItal ( )

inline

Definition at line 84 of file outline_font.h.

StringBoundaryLimits()

VECTOR2I FONT::StringBoundaryLimits ( const wxString &  aText, const VECTOR2I &  aSize, int  aThickness, bool  aBold, bool  aItalic, const METRICS &  aFontMetrics  ) 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 435 of file font.cpp.

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

Referenced by LABEL_MANAGER::Add(), EDA_TEXT::GetTextBox(), KIGFX::GetTextExtents(), GRTextWidth(), PIN_LAYOUT_CACHE::recomputeExtentsCache(), PDF_PLOTTER::Text(), and SCH_PIN::validateExtentsCache().

subscriptSize() [1/2]

int KIFONT::OUTLINE_FONT::subscriptSize ( ) const

inlineprivate

Definition at line 192 of file outline_font.h.

References subscriptSize().

Referenced by getTextAsGlyphsUnlocked(), and subscriptSize().

subscriptSize() [2/2]

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

inlineprivate

Definition at line 188 of file outline_font.h.

References KiROUND().

wordbreakMarkup()

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

protectedinherited

Definition at line 568 of file font.cpp.

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

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

Member Data Documentation

m_charSizeScaler

constexpr int KIFONT::OUTLINE_FONT::m_charSizeScaler = 64

staticconstexprprivate

Definition at line 170 of file outline_font.h.

m_contourCache

std::map<unsigned int, std::vector<std::vector<VECTOR2D> > > KIFONT::OUTLINE_FONT::m_contourCache

private

Definition at line 160 of file outline_font.h.

m_face

FT_Face KIFONT::OUTLINE_FONT::m_face

private

Definition at line 150 of file outline_font.h.

Referenced by GetEmbeddingPermission(), getTextAsGlyphsUnlocked(), and loadFace().

m_faceSize

const int KIFONT::OUTLINE_FONT::m_faceSize

private

Definition at line 152 of file outline_font.h.

m_fakeBold

bool KIFONT::OUTLINE_FONT::m_fakeBold

private

Definition at line 153 of file outline_font.h.

Referenced by getTextAsGlyphsUnlocked().

m_fakeItal

bool KIFONT::OUTLINE_FONT::m_fakeItal

private

Definition at line 154 of file outline_font.h.

Referenced by getTextAsGlyphsUnlocked().

m_fontFileName

wxString KIFONT::FONT::m_fontFileName

protectedinherited

Font file name.

Definition at line 279 of file font.h.

Referenced by KIFONT::STROKE_FONT::loadNewStrokeFont().

m_fontName

wxString KIFONT::FONT::m_fontName

protectedinherited

Font name.

Definition at line 278 of file font.h.

Referenced by KIFONT::STROKE_FONT::loadNewStrokeFont().

m_forDrawingSheet

bool KIFONT::OUTLINE_FONT::m_forDrawingSheet

private

Definition at line 156 of file outline_font.h.

Referenced by getTextAsGlyphsUnlocked().

m_freeType

FT_Library OUTLINE_FONT::m_freeType = nullptr

staticprivate

Definition at line 149 of file outline_font.h.

Referenced by loadFace(), and OUTLINE_FONT().

m_freeTypeMutex

std::mutex OUTLINE_FONT::m_freeTypeMutex

staticprivate

Mutex for freetype access, FT_Library and FT_Face are not thread safe.

Definition at line 148 of file outline_font.h.

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

m_outlineFontSizeCompensation

constexpr double KIFONT::OUTLINE_FONT::m_outlineFontSizeCompensation = 1.4

staticconstexprprivate

Definition at line 167 of file outline_font.h.

Referenced by getTextAsGlyphsUnlocked().

m_subscriptSuperscriptSize

constexpr double KIFONT::OUTLINE_FONT::m_subscriptSuperscriptSize = 0.64

staticconstexprprivate

Definition at line 177 of file outline_font.h.

m_subscriptVerticalOffset

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

staticconstexprprivate

Definition at line 194 of file outline_font.h.

Referenced by getTextAsGlyphsUnlocked().

m_superscriptVerticalOffset

constexpr double KIFONT::OUTLINE_FONT::m_superscriptVerticalOffset = 0.45

staticconstexprprivate

Definition at line 195 of file outline_font.h.

Referenced by getTextAsGlyphsUnlocked().

m_underlineOffsetScaler

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

staticconstexprprivate

Definition at line 179 of file outline_font.h.

s_defaultFont

FONT * FONT::s_defaultFont = nullptr

staticprivateinherited

Definition at line 282 of file font.h.

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

s_fontMap

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

staticprivateinherited

Definition at line 284 of file font.h.

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

---

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

• outline_font.h
• outline_font.cpp