KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KIFONT::STROKE_FONT Class Reference

Implement a stroke font drawing. More...

#include <stroke_font.h>

Inheritance diagram for KIFONT::STROKE_FONT:
KIFONT::FONT

Public Member Functions

 STROKE_FONT ()
 
bool IsStroke () const override
 
double GetInterline (double aGlyphHeight, const METRICS &aFontMetrics) 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...
 
virtual bool IsOutline () const
 
virtual bool IsBold () const
 
virtual bool IsItalic () 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. More...
 
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). 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 STROKE_FONTLoadFont (const wxString &aFontName)
 Load a stroke font. More...
 
static bool IsStroke (const wxString &aFontName)
 
static FONTGetFont (const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false)
 

Protected Member Functions

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 METRICS &aFontMetrics) const
 Draws a single line of text. More...
 
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. More...
 
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. More...
 
wxString m_fontFileName
 Font file name. More...
 

Private Member Functions

void loadNewStrokeFont (const char *const aNewStrokeFont[], int aNewStrokeFontSize)
 Load the standard KiCad stroke font. More...
 

Static Private Member Functions

static FONTgetDefaultFont ()
 

Private Attributes

const std::vector< std::shared_ptr< GLYPH > > * m_glyphs
 
const std::vector< BOX2D > * m_glyphBoundingBoxes
 
double m_maxGlyphWidth
 

Static Private Attributes

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

Detailed Description

Implement a stroke font drawing.

A stroke font is composed of lines.

Definition at line 53 of file stroke_font.h.

Constructor & Destructor Documentation

◆ STROKE_FONT()

STROKE_FONT::STROKE_FONT ( )

Definition at line 57 of file stroke_font.cpp.

Referenced by LoadFont().

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
aBBoxis an optional pointer to be filled with the bounding box.
aTextis the text to be drawn.
aPositionis text position.
aSizeis the cap-height and em-width of the text.
Returns
new cursor position

Definition at line 464 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 164 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
aGalis the graphics context.
aTextis the text to be drawn.
aPositionis the text position in world coordinates.
aCursoris the current text position (for multiple text blocks within a single text object, such as a run of superscript characters)
aAttrsare the styling attributes of the text, including its rotation
aGal
aTextis the text to be drawn.
aPositionis the text object position in world coordinates.
aCursoris the current text position (for multiple text blocks within a single text object, such as a run of superscript characters)
aAttrsare the styling attributes of the text, including its rotation

Definition at line 257 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::SCH_PAINTER::knockoutText(), PLOTTER::PlotText(), KIGFX::SCH_PAINTER::strokeText(), KIGFX::PCB_PAINTER::strokeText(), PLOTTER::Text(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), TUNING_STATUS_VIEW_ITEM::ViewDraw(), and ROUTER_STATUS_VIEW_ITEM::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

◆ 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
aGalis a pointer to the graphics abstraction layer, or nullptr (nothing is drawn)
aBBoxis an optional pointer to be filled with the bounding box.
aTextis the text to be drawn.
aPositionis text position.
aSizeis the cap-height and em-width of the text
aAngleis text angle.
aMirroris true if text should be drawn mirrored, false otherwise.
aOriginis the point around which the text should be rotated, mirrored, etc.
Returns
new cursor position in non-rotated, non-mirrored coordinates

Definition at line 409 of file font.cpp.

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

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

◆ getDefaultFont()

FONT * FONT::getDefaultFont ( )
staticprivateinherited

Definition at line 137 of file font.cpp.

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

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

◆ GetFont()

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

Definition at line 146 of file font.cpp.

References KIFONT::FONT::getDefaultFont(), KICAD_FONT_NAME, KIFONT::OUTLINE_FONT::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::SCH_PAINTER::boxText(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), 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(), GRPrintText(), GRTextWidth(), KIGFX::SCH_PAINTER::knockoutText(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), DRAWING_SHEET_PARSER::parseText(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), PlotDrawingSheet(), LIB_PIN::PlotPinTexts(), BRDITEMS_PLOTTER::PlotText(), PLOTTER::PlotText(), 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(), EDA_TEXT::SetFontIndex(), FIELDS_GRID_TABLE< T >::SetValue(), KIGFX::SCH_PAINTER::strokeText(), KIGFX::PCB_PAINTER::strokeText(), PLOTTER::Text(), PDF_PLOTTER::Text(), TUNING_STATUS_VIEW_ITEM::ViewDraw(), and ROUTER_STATUS_VIEW_ITEM::ViewDraw().

◆ GetInterline()

double STROKE_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 194 of file stroke_font.cpp.

References KIFONT::METRICS::GetInterline().

◆ getLinePositions()

◆ GetName()

◆ GetTextAsGlyphs()

VECTOR2I STROKE_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
aBBoxpointer to a BOX2I that will set to the bounding box, or nullptr
aGlyphsstorage for the returned GLYPHs
aTexttext to convert to polygon/polyline
aSizeis the cap-height and em-width of the text
aPositionposition of text (cursor position before this text)
aAngletext angle
aMirroris true if text should be drawn mirrored, false otherwise.
aOriginis the point around which the text should be rotated, mirrored, etc.
aTextStyletext style flags
Returns
text cursor position after this text

Implements KIFONT::FONT.

Definition at line 202 of file stroke_font.cpp.

References KIFONT::STROKE_GLYPH::BoundingBox(), cursor, BOX2< Vec >::GetEnd(), ITALIC_TILT, KiROUND(), m_glyphBoundingBoxes, m_glyphs, BOX2< Vec >::Normalize(), BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), KIFONT::STROKE_GLYPH::Transform(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE().

◆ IsBold()

virtual bool KIFONT::FONT::IsBold ( ) const
inlinevirtualinherited

Reimplemented in KIFONT::OUTLINE_FONT.

Definition at line 140 of file font.h.

Referenced by operator<<().

◆ IsItalic()

virtual bool KIFONT::FONT::IsItalic ( ) const
inlinevirtualinherited

Reimplemented in KIFONT::OUTLINE_FONT.

Definition at line 141 of file font.h.

Referenced by operator<<().

◆ IsOutline()

◆ IsStroke() [1/2]

bool KIFONT::STROKE_FONT::IsStroke ( ) const
inlineoverridevirtual

Reimplemented from KIFONT::FONT.

Definition at line 58 of file stroke_font.h.

◆ IsStroke() [2/2]

bool FONT::IsStroke ( const wxString &  aFontName)
staticinherited

Definition at line 170 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 588 of file font.cpp.

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

Referenced by LIB_TEXTBOX::GetShownText(), 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
aTextis the text to be checked.
Returns
unsigned - The number of lines in aText.

Definition at line 217 of file font.h.

◆ LoadFont()

STROKE_FONT * STROKE_FONT::LoadFont ( const wxString &  aFontName)
static

Load a stroke font.

Parameters
aFontNameis the name of the font. If empty, the standard KiCad stroke font is loaded.

Definition at line 65 of file stroke_font.cpp.

References loadNewStrokeFont(), newstroke_font, newstroke_font_bufsize, and STROKE_FONT().

Referenced by BOOST_AUTO_TEST_CASE(), and KIFONT::FONT::getDefaultFont().

◆ loadNewStrokeFont()

void STROKE_FONT::loadNewStrokeFont ( const char *const  aNewStrokeFont[],
int  aNewStrokeFontSize 
)
private

Load the standard KiCad stroke font.

Parameters
aNewStrokeFontis the pointer to the font data.
aNewStrokeFontSizeis the size of the font data.

Definition at line 99 of file stroke_font.cpp.

References buildGlyphBoundingBox(), FONT_OFFSET, g_defaultFontGlyphBoundingBoxes, g_defaultFontGlyphs, g_defaultFontInitialized, g_defaultFontLoadMutex, KICAD_FONT_NAME, KIFONT::FONT::m_fontFileName, KIFONT::FONT::m_fontName, m_glyphBoundingBoxes, m_glyphs, m_maxGlyphWidth, STROKE_FONT_SCALE, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadFont().

◆ NameAsToken()

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

Definition at line 148 of file font.h.

Referenced by DS_DATA_MODEL_IO::format().

◆ 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 434 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(), KIGFX::SCH_PAINTER::boxText(), EDA_TEXT::GetTextBox(), GRTextWidth(), PDF_PLOTTER::Text(), and LIB_PIN::validateExtentsCache().

◆ wordbreakMarkup()

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

Member Data Documentation

◆ m_fontFileName

wxString KIFONT::FONT::m_fontFileName
protectedinherited

Font file name.

Definition at line 277 of file font.h.

Referenced by loadNewStrokeFont().

◆ m_fontName

wxString KIFONT::FONT::m_fontName
protectedinherited

Font name.

Definition at line 276 of file font.h.

Referenced by loadNewStrokeFont().

◆ m_glyphBoundingBoxes

const std::vector<BOX2D>* KIFONT::STROKE_FONT::m_glyphBoundingBoxes
private

Definition at line 90 of file stroke_font.h.

Referenced by GetTextAsGlyphs(), and loadNewStrokeFont().

◆ m_glyphs

const std::vector<std::shared_ptr<GLYPH> >* KIFONT::STROKE_FONT::m_glyphs
private

Definition at line 89 of file stroke_font.h.

Referenced by GetTextAsGlyphs(), and loadNewStrokeFont().

◆ m_maxGlyphWidth

double KIFONT::STROKE_FONT::m_maxGlyphWidth
private

Definition at line 91 of file stroke_font.h.

Referenced by loadNewStrokeFont().

◆ s_defaultFont

FONT * FONT::s_defaultFont = nullptr
staticprivateinherited

Definition at line 280 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 282 of file font.h.

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


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