KiCad PCB EDA Suite
gr_text.cpp File Reference
#include <fctsys.h>
#include <gr_basic.h>
#include <common.h>
#include <plotter.h>
#include <eda_text.h>
#include <trigo.h>
#include <macros.h>
#include <base_screen.h>
#include <gr_text.h>
#include <math/util.h>
#include <basic_gal.h>

Go to the source code of this file.

Functions

int GetPenSizeForBold (int aTextSize)
 Function GetPensizeForBold. More...
 
int GetPenSizeForNormal (int aTextSize)
 Function GetPensizeForNormal. More...
 
int Clamp_Text_PenSize (int aPenSize, int aSize, bool aBold)
 Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness. More...
 
float Clamp_Text_PenSize (float aPenSize, int aSize, bool aBold)
 
int Clamp_Text_PenSize (int aPenSize, wxSize aSize, bool aBold)
 
int GraphicTextWidth (const wxString &aText, const wxSize &aSize, bool aItalic, bool aBold)
 Function GraphicTextWidth. More...
 
void GRText (wxDC *aDC, const wxPoint &aPos, COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
 Function GRText Draw a graphic text (like module texts) More...
 
void GRHaloText (wxDC *aDC, const wxPoint &aPos, COLOR4D aBgColor, COLOR4D aColor1, COLOR4D aColor2, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
 Draw graphic text with a border, so that it can be read on different backgrounds. More...
 

Function Documentation

◆ Clamp_Text_PenSize() [1/3]

int Clamp_Text_PenSize ( int  aPenSize,
int  aSize,
bool  aBold 
)

Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.

Function Clamp_Text_PenSize As a rule, pen width should not be >1/4em, otherwise the character will be cluttered up in its own fatness The pen width max is aSize/4 for bold texts, and aSize/6 for normal texts The "best" pen width is aSize/5 for bold texts, so the clamp is consistant with bold option.

Bold fonts are generally around aSize/5 in width, so we limit them to aSize/4, and normal text to aSize/6.

Parameters
aPenSize= the pen size to clamp
aSizethe char size (height or width)
aBold= true if text accept bold pen size
Returns
the max pen size allowed

Definition at line 72 of file gr_text.cpp.

73 {
74  double scale = aBold ? 4.0 : 6.0;
75  int maxWidth = KiROUND( (double) aSize / scale );
76 
77  return std::min( aPenSize, maxWidth );
78 }
const int scale
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References KiROUND(), and scale.

Referenced by Clamp_Text_PenSize(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextPenWidth(), LIB_PIN::PlotPinTexts(), LIB_PIN::PrintPinTexts(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ Clamp_Text_PenSize() [2/3]

float Clamp_Text_PenSize ( float  aPenSize,
int  aSize,
bool  aBold 
)

Definition at line 81 of file gr_text.cpp.

82 {
83  float scale = aBold ? 4.0 : 6.0;
84  float maxWidth = (float) aSize / scale;
85 
86  return std::min( aPenSize, maxWidth );
87 }
const int scale

References scale.

◆ Clamp_Text_PenSize() [3/3]

int Clamp_Text_PenSize ( int  aPenSize,
wxSize  aSize,
bool  aBold 
)

Definition at line 90 of file gr_text.cpp.

91 {
92  int size = std::min( std::abs( aSize.x ), std::abs( aSize.y ) );
93 
94  return Clamp_Text_PenSize( aPenSize, size, aBold );
95 }
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:72

References Clamp_Text_PenSize().

◆ GetPenSizeForBold()

int GetPenSizeForBold ( int  aTextSize)

Function GetPensizeForBold.

Returns
the "best" value for a pen size to draw/plot a bold text
Parameters
aTextSize= the char size (height or width)

Definition at line 51 of file gr_text.cpp.

52 {
53  return KiROUND( aTextSize / 5.0 );
54 }
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References KiROUND().

Referenced by EDA_TEXT::GetEffectiveTextPenWidth(), GRText(), SCH_LEGACY_PLUGIN::loadText(), SCH_EAGLE_PLUGIN::loadTextAttributes(), WS_DATA_ITEM_TEXT::SyncDrawItems(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

◆ GetPenSizeForNormal()

int GetPenSizeForNormal ( int  aTextSize)

Function GetPensizeForNormal.

Returns
the "best" value for a pen size to draw/plot a non-bold text
Parameters
aTextSize= the char size (height or width)

Definition at line 57 of file gr_text.cpp.

58 {
59  return KiROUND( aTextSize / 8.0 );
60 }
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References KiROUND().

Referenced by EDA_TEXT::GetEffectiveTextPenWidth().

◆ GraphicTextWidth()

int GraphicTextWidth ( const wxString &  aText,
const wxSize &  aSize,
bool  italic,
bool  bold 
)

Function GraphicTextWidth.

Returns
the X size of the graphic text the full X size is GraphicTextWidth + the thickness of graphic lines

Definition at line 98 of file gr_text.cpp.

99 {
100  basic_gal.SetFontItalic( aItalic );
101  basic_gal.SetFontBold( aBold );
102  basic_gal.SetGlyphSize( VECTOR2D( aSize ) );
103 
104  VECTOR2D tsize = basic_gal.GetTextLineSize( aText );
105 
106  return KiROUND( tsize.x );
107 }
void SetFontItalic(const bool aItalic)
Set italic property of current font.
VECTOR2D GetTextLineSize(const UTF8 &aText) const
Compute the X and Y size of a given text.
void SetFontBold(const bool aBold)
Set bold property of current font.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
BASIC_GAL basic_gal(basic_displayOptions)

References basic_gal, KIGFX::GAL::GetTextLineSize(), KiROUND(), KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetGlyphSize(), and VECTOR2< T >::x.

Referenced by SVG_PLOTTER::Text().

◆ GRHaloText()

void GRHaloText ( wxDC *  aDC,
const wxPoint aPos,
COLOR4D  aBgColor,
COLOR4D  aColor1,
COLOR4D  aColor2,
const wxString &  aText,
double  aOrient,
const wxSize &  aSize,
enum EDA_TEXT_HJUSTIFY_T  aH_justify,
enum EDA_TEXT_VJUSTIFY_T  aV_justify,
int  aWidth,
bool  aItalic,
bool  aBold,
void(*)(int x0, int y0, int xf, int yf, void *aData)  aCallback = nullptr,
void *  aCallbackData = nullptr,
PLOTTER aPlotter = nullptr 
)

Draw graphic text with a border, so that it can be read on different backgrounds.

See GRText for most of the parameters. If aBgColor is a dark color text is drawn in aColor2 with aColor1 border; otherwise colors are swapped.

Definition at line 179 of file gr_text.cpp.

185 {
186  // Swap color if contrast would be better
187  // TODO: Maybe calculate contrast some way other than brightness
188  if( aBgColor.GetBrightness() > 0.5 )
189  {
190  COLOR4D c = aColor1;
191  aColor1 = aColor2;
192  aColor2 = c;
193  }
194 
195  // Draw the background
196  GRText( aDC, aPos, aColor1, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic,
197  aBold, aCallback, aCallbackData, aPlotter );
198 
199  // Draw the text
200  GRText( aDC, aPos, aColor2, aText, aOrient, aSize, aH_justify, aV_justify, aWidth/4, aItalic,
201  aBold, aCallback, aCallbackData, aPlotter );
202 }
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1....
Definition: color4d.h:329
void GRText(wxDC *aDC, const wxPoint &aPos, COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Function GRText Draw a graphic text (like module texts)
Definition: gr_text.cpp:134
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References KIGFX::COLOR4D::GetBrightness(), and GRText().

◆ GRText()

void GRText ( wxDC *  aDC,
const wxPoint aPos,
COLOR4D  aColor,
const wxString &  aText,
double  aOrient,
const wxSize &  aSize,
enum EDA_TEXT_HJUSTIFY_T  aH_justify,
enum EDA_TEXT_VJUSTIFY_T  aV_justify,
int  aWidth,
bool  aItalic,
bool  aBold,
void(*)(int x0, int y0, int xf, int yf, void *aData)  aCallback,
void *  aCallbackData,
PLOTTER aPlotter 
)

Function GRText Draw a graphic text (like module texts)

Parameters
aDC= the current Device Context. NULL if draw within a 3D GL Canvas
aPos= text position (according to h_justify, v_justify)
aColor(COLOR4D) = text color
aText= text to draw
aOrient= angle in 0.1 degree
aSize= text size (size.x or size.y can be < 0 for mirrored texts)
aH_justify= horizontal justification (Left, center, right)
aV_justify= vertical justification (bottom, center, top)
aWidth= line width (pen width) (use default width if aWidth = 0) if width < 0 : draw segments in sketch mode, width = abs(width) Use a value min(aSize.x, aSize.y) / 5 for a bold text
aItalic= true to simulate an italic font
aBold= true to use a bold font. Useful only with default width value (aWidth = 0)
aCallback(int x0, int y0, int xf, int yf, void* aData ) is a function called (if non null) to draw each segment. used to draw 3D texts or for plotting. NULL for normal drawings
aCallbackData= is the auxiliary parameter aData for the callback function. can be nullptr if no auxiliary parameter is needed
aPlotter= a pointer to a PLOTTER instance, when this function is used to plot the text. NULL to draw this text.

Definition at line 134 of file gr_text.cpp.

139 {
140  bool fill_mode = true;
141 
142  if( aWidth == 0 && aBold ) // Use default values if aWidth == 0
143  aWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
144 
145  if( aWidth < 0 )
146  {
147  aWidth = -aWidth;
148  fill_mode = false;
149  }
150 
151  basic_gal.SetIsFill( fill_mode );
152  basic_gal.SetLineWidth( aWidth );
153 
154  EDA_TEXT dummy;
155  dummy.SetItalic( aItalic );
156  dummy.SetBold( aBold );
157  dummy.SetHorizJustify( aH_justify );
158  dummy.SetVertJustify( aV_justify );
159 
160  wxSize size = aSize;
161  dummy.SetMirrored( size.x < 0 );
162 
163  if( size.x < 0 )
164  size.x = - size.x;
165 
166  dummy.SetTextSize( size );
167 
169  basic_gal.SetPlotter( aPlotter );
170  basic_gal.SetCallback( aCallback, aCallbackData );
171  basic_gal.m_DC = aDC;
172  basic_gal.m_Color = aColor;
173  basic_gal.SetClipBox( nullptr );
174 
175  basic_gal.StrokeText( aText, VECTOR2D( aPos ), aOrient * M_PI/1800 );
176 }
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:51
void SetCallback(void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aData)
Definition: basic_gal.h:86
virtual void SetTextAttributes(const EDA_TEXT *aText)
Loads attributes of the given text (bold/italic/underline/mirrored and so on).
virtual void SetLineWidth(float aLineWidth)
Set the line width.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:112
VECTOR2< double > VECTOR2D
Definition: vector2d.h:593
virtual void SetIsFill(bool aIsFillEnabled)
Enable/disable fill.
COLOR4D m_Color
Definition: basic_gal.h:63
virtual void StrokeText(const wxString &aText, const VECTOR2D &aPosition, double aRotationAngle)
Draws a vector type text using preloaded Newstroke font.
void SetPlotter(PLOTTER *aPlotter)
Definition: basic_gal.h:81
wxDC * m_DC
Definition: basic_gal.h:62
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
BASIC_GAL basic_gal(basic_displayOptions)
void SetClipBox(EDA_RECT *aClipBox)
Set a clip box for drawings If NULL, no clip will be made.
Definition: basic_gal.h:94

References basic_gal, dummy(), GetPenSizeForBold(), BASIC_GAL::m_Color, BASIC_GAL::m_DC, BASIC_GAL::SetCallback(), BASIC_GAL::SetClipBox(), KIGFX::GAL::SetIsFill(), KIGFX::GAL::SetLineWidth(), BASIC_GAL::SetPlotter(), KIGFX::GAL::SetTextAttributes(), and KIGFX::GAL::StrokeText().

Referenced by BOARD_ADAPTER::AddGraphicsShapesWithClearanceToContainer(), BOARD_ADAPTER::AddShapeWithClearanceToContainer(), export_vrml_pcbtext(), export_vrml_text_module(), GRHaloText(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), LIB_PIN::PrintPinElectricalTypeName(), LIB_PIN::PrintPinTexts(), PLOTTER::Text(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), TEXTE_PCB::TransformShapeWithClearanceToPolygonSet(), and EDA_TEXT::TransformTextShapeToSegmentList().