KiCad PCB EDA Suite
gr_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 <gr_text.h>
41 
42 #include <basic_gal.h>
43 
49 int GetPenSizeForBold( int aTextSize )
50 {
51  return KiROUND( aTextSize / 5.0 );
52 }
53 
54 
64 int Clamp_Text_PenSize( int aPenSize, int aSize, bool aBold )
65 {
66  double scale = aBold ? 4.0 : 6.0;
67  int maxWidth = KiROUND( (double) aSize / scale );
68 
69  return std::min( aPenSize, maxWidth );
70 }
71 
72 
73 float Clamp_Text_PenSize( float aPenSize, int aSize, bool aBold )
74 {
75  float scale = aBold ? 4.0 : 6.0;
76  float maxWidth = (float) aSize / scale;
77 
78  return std::min( aPenSize, maxWidth );
79 }
80 
81 
82 int Clamp_Text_PenSize( int aPenSize, wxSize aSize, bool aBold )
83 {
84  int size = std::min( std::abs( aSize.x ), std::abs( aSize.y ) );
85 
86  return Clamp_Text_PenSize( aPenSize, size, aBold );
87 }
88 
89 
90 int GraphicTextWidth( const wxString& aText, const wxSize& aSize, bool aItalic, bool aBold )
91 {
92  basic_gal.SetFontItalic( aItalic );
93  basic_gal.SetFontBold( aBold );
94  basic_gal.SetGlyphSize( VECTOR2D( aSize ) );
95 
96  VECTOR2D tsize = basic_gal.GetTextLineSize( aText );
97 
98  return KiROUND( tsize.x );
99 }
100 
101 
126 void GRText( wxDC* aDC, const wxPoint& aPos, COLOR4D aColor, const wxString& aText,
127  double aOrient, const wxSize& aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify,
128  enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold,
129  void (* aCallback)( int x0, int y0, int xf, int yf, void* aData ),
130  void* aCallbackData, PLOTTER* aPlotter )
131 {
132  bool fill_mode = true;
133 
134  if( aWidth == 0 && aBold ) // Use default values if aWidth == 0
135  aWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
136 
137  if( aWidth < 0 )
138  {
139  aWidth = -aWidth;
140  fill_mode = false;
141  }
142 
143  basic_gal.SetIsFill( fill_mode );
144  basic_gal.SetLineWidth( aWidth );
145 
146  EDA_TEXT dummy;
147  dummy.SetItalic( aItalic );
148  dummy.SetBold( aBold );
149  dummy.SetHorizJustify( aH_justify );
150  dummy.SetVertJustify( aV_justify );
151 
152  wxSize size = aSize;
153  dummy.SetMirrored( size.x < 0 );
154 
155  if( size.x < 0 )
156  size.x = - size.x;
157 
158  dummy.SetTextSize( size );
159 
161  basic_gal.SetPlotter( aPlotter );
162  basic_gal.SetCallback( aCallback, aCallbackData );
163  basic_gal.m_DC = aDC;
164  basic_gal.m_Color = aColor;
165  basic_gal.SetClipBox( nullptr );
166 
167  basic_gal.StrokeText( aText, VECTOR2D( aPos ), aOrient * M_PI/1800 );
168 }
169 
170 
171 void GRHaloText( wxDC * aDC, const wxPoint &aPos, const COLOR4D aBgColor, COLOR4D aColor1,
172  COLOR4D aColor2, const wxString &aText, double aOrient, const wxSize &aSize,
173  enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify,
174  int aWidth, bool aItalic, bool aBold,
175  void (*aCallback)( int x0, int y0, int xf, int yf, void* aData ),
176  void* aCallbackData, PLOTTER * aPlotter )
177 {
178  // Swap color if contrast would be better
179  // TODO: Maybe calculate contrast some way other than brightness
180  if( aBgColor.GetBrightness() > 0.5 )
181  {
182  COLOR4D c = aColor1;
183  aColor1 = aColor2;
184  aColor2 = c;
185  }
186 
187  // Draw the background
188  GRText( aDC, aPos, aColor1, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic,
189  aBold, aCallback, aCallbackData, aPlotter );
190 
191  // Draw the text
192  GRText( aDC, aPos, aColor2, aText, aOrient, aSize, aH_justify, aV_justify, aWidth/4, aItalic,
193  aBold, aCallback, aCallbackData, aPlotter );
194 }
195 
215 void PLOTTER::Text( const wxPoint& aPos,
216  const COLOR4D aColor,
217  const wxString& aText,
218  double aOrient,
219  const wxSize& aSize,
220  enum EDA_TEXT_HJUSTIFY_T aH_justify,
221  enum EDA_TEXT_VJUSTIFY_T aV_justify,
222  int aWidth,
223  bool aItalic,
224  bool aBold,
225  bool aMultilineAllowed,
226  void* aData )
227 {
228  int textPensize = aWidth;
229 
230  if( textPensize == 0 && aBold ) // Use default values if aWidth == 0
231  textPensize = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
232 
233  if( textPensize >= 0 )
234  textPensize = Clamp_Text_PenSize( aWidth, aSize, aBold );
235  else
236  textPensize = -Clamp_Text_PenSize( -aWidth, aSize, aBold );
237 
238  SetCurrentLineWidth( textPensize, aData );
239 
240  SetColor( aColor );
241 
242  GRText( NULL, aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, textPensize,
243  aItalic, aBold, nullptr, nullptr, this );
244 
245  if( aWidth != textPensize )
246  SetCurrentLineWidth( aWidth, aData );
247 }
void SetFontItalic(const bool aItalic)
Set italic property of current font.
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:44
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1....
Definition: color4d.h:269
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:49
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).
int GraphicTextWidth(const wxString &aText, const wxSize &aSize, bool aItalic, bool aBold)
Function GraphicTextWidth.
Definition: gr_text.cpp:90
VECTOR2D GetTextLineSize(const UTF8 &aText) const
Compute the X and Y size of a given text.
#define abs(a)
Definition: auxiliary.h:84
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.
Definition: gr_text.cpp:215
Class EDA_TEXT is a mix-in class (via multiple inheritance) that handles texts such as labels,...
Definition: eda_text.h:109
void SetFontBold(const bool aBold)
Set bold property of current font.
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:64
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 SetPlotter(PLOTTER *aPlotter)
Definition: basic_gal.h:81
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:126
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:51
Base plotter engine class.
Definition: plotter.h:97
void GRHaloText(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.
Definition: gr_text.cpp:171
const int scale
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.
The common library.
void SetGlyphSize(const VECTOR2D aGlyphSize)
Set the font glyph size.
BASIC_GAL basic_gal(basic_displayOptions)
BASE_SCREEN class implementation.
void SetClipBox(EDA_RECT *aClipBox)
Set a clip box for drawings If NULL, no clip will be made.
Definition: basic_gal.h:94
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114
#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