KiCad PCB EDA Suite
draw_graphic_text.cpp
Go to the documentation of this file.
1 
6 /*
7  * This program source code file is part of KiCad, a free EDA CAD application.
8  *
9  * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
10  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
11  * Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
12  * Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
13  *
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version 2
17  * of the License, or (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, you may find one here:
26  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
27  * or you may search the http://www.gnu.org website for the version 2 license,
28  * or you may write to the Free Software Foundation, Inc.,
29  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
30  */
31 
32 #include <fctsys.h>
33 #include <gr_basic.h>
34 #include <common.h>
35 #include <plotter.h>
36 #include <eda_text.h> // EDA_TEXT_HJUSTIFY_T and EDA_TEXT_VJUSTIFY_T
37 #include <trigo.h>
38 #include <macros.h>
39 #include <base_screen.h>
40 #include <draw_graphic_text.h>
41 
42 #include <basic_gal.h>
43 
49 int GetPenSizeForBold( int aTextSize )
50 {
51  return KiROUND( aTextSize / 5.0 );
52 }
53 
54 
67 int Clamp_Text_PenSize( int aPenSize, int aSize, bool aBold )
68 {
69  int penSize = aPenSize;
70  double scale = aBold ? 4.0 : 6.0;
71  int maxWidth = KiROUND( std::abs( aSize ) / scale );
72 
73  if( penSize > maxWidth )
74  penSize = maxWidth;
75 
76  return penSize;
77 }
78 
79 
80 int Clamp_Text_PenSize( int aPenSize, wxSize aSize, bool aBold )
81 {
82  int size = std::min( std::abs( aSize.x ), std::abs( aSize.y ) );
83 
84  return Clamp_Text_PenSize( aPenSize, size, aBold );
85 }
86 
87 
88 int GraphicTextWidth( const wxString& aText, const wxSize& aSize, bool aItalic, bool aBold )
89 {
90  basic_gal.SetFontItalic( aItalic );
91  basic_gal.SetFontBold( aBold );
92  basic_gal.SetGlyphSize( VECTOR2D( aSize ) );
93 
94  VECTOR2D tsize = basic_gal.GetTextLineSize( aText );
95 
96  return KiROUND( tsize.x );
97 }
98 
99 
125 void DrawGraphicText( EDA_RECT* aClipBox,
126  wxDC* aDC,
127  const wxPoint& aPos,
128  COLOR4D aColor,
129  const wxString& aText,
130  double aOrient,
131  const wxSize& aSize,
132  enum EDA_TEXT_HJUSTIFY_T aH_justify,
133  enum EDA_TEXT_VJUSTIFY_T aV_justify,
134  int aWidth,
135  bool aItalic,
136  bool aBold,
137  void (* aCallback)( int x0, int y0, int xf, int yf, void* aData ),
138  void* aCallbackData,
139  PLOTTER* aPlotter )
140 {
141  bool fill_mode = true;
142 
143  if( aWidth == 0 && aBold ) // Use default values if aWidth == 0
144  aWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
145 
146  if( aWidth < 0 )
147  {
148  aWidth = -aWidth;
149  fill_mode = false;
150  }
151 
152  basic_gal.SetIsFill( fill_mode );
153  basic_gal.SetLineWidth( aWidth );
154 
155  EDA_TEXT dummy;
156  dummy.SetItalic( aItalic );
157  dummy.SetBold( aBold );
158  dummy.SetHorizJustify( aH_justify );
159  dummy.SetVertJustify( aV_justify );
160 
161  wxSize size = aSize;
162  dummy.SetMirrored( size.x < 0 );
163 
164  if( size.x < 0 )
165  size.x = - size.x;
166 
167  dummy.SetTextSize( size );
168 
169  basic_gal.SetTextAttributes( &dummy );
170  basic_gal.SetPlotter( aPlotter );
171  basic_gal.SetCallback( aCallback, aCallbackData );
172  basic_gal.m_DC = aDC;
173  basic_gal.m_Color = aColor;
174  basic_gal.SetClipBox( aClipBox );
175 
176  basic_gal.StrokeText( aText, VECTOR2D( aPos ), aOrient * M_PI/1800 );
177 }
178 
179 
180 void DrawGraphicHaloText( EDA_RECT* aClipBox, wxDC * aDC,
181  const wxPoint &aPos,
182  const COLOR4D aBgColor,
183  COLOR4D aColor1,
184  COLOR4D aColor2,
185  const wxString &aText,
186  double aOrient,
187  const wxSize &aSize,
188  enum EDA_TEXT_HJUSTIFY_T aH_justify,
189  enum EDA_TEXT_VJUSTIFY_T aV_justify,
190  int aWidth, bool aItalic, bool aBold,
191  void (*aCallback)( int x0, int y0, int xf, int yf, void* aData ),
192  void* aCallbackData,
193  PLOTTER * aPlotter )
194 {
195  // Swap color if contrast would be better
196  // TODO: Maybe calculate contrast some way other than brightness
197  if( aBgColor.GetBrightness() > 0.5 )
198  {
199  COLOR4D c = aColor1;
200  aColor1 = aColor2;
201  aColor2 = c;
202  }
203 
204  // Draw the background
205  DrawGraphicText( aClipBox, aDC, aPos, aColor1, aText, aOrient, aSize,
206  aH_justify, aV_justify, aWidth, aItalic, aBold,
207  aCallback, aCallbackData, aPlotter );
208 
209  // Draw the text
210  DrawGraphicText( aClipBox, aDC, aPos, aColor2, aText, aOrient, aSize,
211  aH_justify, aV_justify, aWidth/4, aItalic, aBold,
212  aCallback, aCallbackData, aPlotter );
213 }
214 
234 void PLOTTER::Text( const wxPoint& aPos,
235  const COLOR4D aColor,
236  const wxString& aText,
237  double aOrient,
238  const wxSize& aSize,
239  enum EDA_TEXT_HJUSTIFY_T aH_justify,
240  enum EDA_TEXT_VJUSTIFY_T aV_justify,
241  int aWidth,
242  bool aItalic,
243  bool aBold,
244  bool aMultilineAllowed,
245  void* aData )
246 {
247  int textPensize = aWidth;
248 
249  if( textPensize == 0 && aBold ) // Use default values if aWidth == 0
250  textPensize = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
251 
252  if( textPensize >= 0 )
253  textPensize = Clamp_Text_PenSize( aWidth, aSize, aBold );
254  else
255  textPensize = -Clamp_Text_PenSize( -aWidth, aSize, aBold );
256 
257  SetCurrentLineWidth( textPensize, aData );
258 
259  SetColor( aColor );
260 
261  DrawGraphicText( NULL, NULL, aPos, aColor, aText,
262  aOrient, aSize,
263  aH_justify, aV_justify,
264  textPensize, aItalic, aBold, nullptr, nullptr, this );
265 
266  if( aWidth != textPensize )
267  SetCurrentLineWidth( aWidth, aData );
268 }
void SetMirrored(bool isMirrored)
Definition: eda_text.h:191
void SetFontItalic(const bool aItalic)
Set italic property of current font.
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize As a rule, pen width should not be >1/4em, otherwise the character will b...
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:62
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
virtual void SetColor(COLOR4D color)=0
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).
void SetItalic(bool isItalic)
Definition: eda_text.h:182
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:227
Definition of base KiCad text object.
void DrawGraphicHaloText(EDA_RECT *aClipBox, wxDC *aDC, const wxPoint &aPos, const 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. ...
#define abs(a)
Definition: auxiliary.h:84
void DrawGraphicText(EDA_RECT *aClipBox, 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 DrawGraphicText Draw a graphic text (like module texts)
virtual void SetLineWidth(float aLineWidth)
Set the line width.
This file contains miscellaneous commonly used macros and functions.
virtual void Text(const wxPoint &aPos, const 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, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels...
Definition: eda_text.h:127
void SetFontBold(const bool aBold)
Set bold property of current font.
VECTOR2< double > VECTOR2D
Definition: vector2d.h:586
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 SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:207
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1...
Definition: color4d.h:255
int GraphicTextWidth(const wxString &aText, const wxSize &aSize, bool aItalic, bool aBold)
Function GraphicTextWidth.
void SetPlotter(PLOTTER *aPlotter)
Definition: basic_gal.h:81
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:69
Base plotter engine class.
Definition: plotter.h:97
const int scale
wxDC * m_DC
Definition: basic_gal.h:62
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:206
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
The common library.
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
BASIC_GAL basic_gal(basic_displayOptions)
BASE_SCREEN class implementation.
VECTOR2D GetTextLineSize(const UTF8 &aText) const
Compute the X and Y size of a given text.
void SetBold(bool aBold)
Definition: eda_text.h:185
void SetClipBox(EDA_RECT *aClipBox)
Set a clip box for drawings If NULL, no clip will be made.
Definition: basic_gal.h:94
#define min(a, b)
Definition: auxiliary.h:85
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39