KiCad PCB EDA Suite
Loading...
Searching...
No Matches
gr_text.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 2012 Wayne Stambaugh <[email protected]>
7 * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#include <gr_basic.h>
28#include <plotters/plotter.h>
29#include <trigo.h>
30#include <math/util.h> // for KiROUND
31#include <font/font.h>
32
33#include <callback_gal.h>
34
35
40int GetPenSizeForBold( int aTextSize )
41{
42 return KiROUND( aTextSize / 5.0 );
43}
44
45
46int GetPenSizeForDemiBold( int aTextSize )
47{
48 return KiROUND( aTextSize / 6 );
49}
50
51
52int GetPenSizeForBold( const wxSize& aTextSize )
53{
54 return GetPenSizeForBold( std::min( aTextSize.x, aTextSize.y ) );
55}
56
57
58int GetPenSizeForDemiBold( const wxSize& aTextSize )
59{
60 return GetPenSizeForDemiBold( std::min( aTextSize.x, aTextSize.y ) );
61}
62
63
64int GetPenSizeForNormal( int aTextSize )
65{
66 return KiROUND( aTextSize / 8.0 );
67}
68
69
70int GetPenSizeForNormal( const wxSize& aTextSize )
71{
72 return GetPenSizeForNormal( std::min( aTextSize.x, aTextSize.y ) );
73}
74
75
87int Clamp_Text_PenSize( int aPenSize, int aSize, bool aStrict )
88{
89 double scale = aStrict ? 0.18 : 0.25;
90 int maxWidth = KiROUND( (double) aSize * scale );
91
92 return std::min( aPenSize, maxWidth );
93}
94
95
96float Clamp_Text_PenSize( float aPenSize, int aSize, bool aStrict )
97{
98 double scale = aStrict ? 0.18 : 0.25;
99 float maxWidth = (float) aSize * scale;
100
101 return std::min( aPenSize, maxWidth );
102}
103
104
105int Clamp_Text_PenSize( int aPenSize, const VECTOR2I& aSize, bool aStrict )
106{
107 int size = std::min( std::abs( aSize.x ), std::abs( aSize.y ) );
108
109 return Clamp_Text_PenSize( aPenSize, size, aStrict );
110}
111
112
113int GRTextWidth( const wxString& aText, KIFONT::FONT* aFont, const VECTOR2I& aSize,
114 int aThickness, bool aBold, bool aItalic, const KIFONT::METRICS& aFontMetrics )
115{
116 if( !aFont )
117 aFont = KIFONT::FONT::GetFont();
118
119 return KiROUND( aFont->StringBoundaryLimits( aText, aSize, aThickness, aBold, aItalic,
120 aFontMetrics ).x );
121}
122
123
142void GRPrintText( wxDC* aDC, const VECTOR2I& aPos, const COLOR4D& aColor, const wxString& aText,
143 const EDA_ANGLE& aOrient, const VECTOR2I& aSize,
144 enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify,
145 int aWidth, bool aItalic, bool aBold, KIFONT::FONT* aFont,
146 const KIFONT::METRICS& aFontMetrics )
147{
149 bool fill_mode = true;
150
151 if( !aFont )
152 aFont = KIFONT::FONT::GetFont();
153
154 if( aWidth == 0 && aBold ) // Use default values if aWidth == 0
155 aWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
156
157 if( aWidth < 0 )
158 {
159 aWidth = -aWidth;
160 fill_mode = false;
161 }
162
163 CALLBACK_GAL callback_gal( empty_opts,
164 // Stroke callback
165 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
166 {
167 if( fill_mode )
168 GRLine( aDC, aPt1, aPt2, aWidth, aColor );
169 else
170 GRCSegm( aDC, aPt1, aPt2, aWidth, aColor );
171 },
172 // Polygon callback
173 [&]( const SHAPE_LINE_CHAIN& aPoly )
174 {
175 GRClosedPoly( aDC, aPoly.PointCount(), aPoly.CPoints().data(), true, aColor );
176 } );
177
178 TEXT_ATTRIBUTES attributes;
179 attributes.m_Angle = aOrient;
180 attributes.m_StrokeWidth = aWidth;
181 attributes.m_Italic = aItalic;
182 attributes.m_Bold = aBold;
183 attributes.m_Halign = aH_justify;
184 attributes.m_Valign = aV_justify;
185 attributes.m_Size = aSize;
186
187 aFont->Draw( &callback_gal, aText, aPos, attributes, aFontMetrics );
188}
189
190
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:131
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false)
Definition: font.cpp:146
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.
Definition: font.cpp:257
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).
Definition: font.cpp:434
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
void GRCSegm(wxDC *DC, const VECTOR2I &A, const VECTOR2I &B, int width, const COLOR4D &Color)
Definition: gr_basic.cpp:201
void GRLine(wxDC *DC, int x1, int y1, int x2, int y2, int width, const COLOR4D &Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:171
void GRClosedPoly(wxDC *DC, int n, const VECTOR2I *Points, bool Fill, const COLOR4D &Color)
Draw a closed polyline and fill it if Fill, in object space.
Definition: gr_basic.cpp:351
int GetPenSizeForBold(int aTextSize)
Definition: gr_text.cpp:40
int GetPenSizeForDemiBold(int aTextSize)
Definition: gr_text.cpp:46
int GetPenSizeForNormal(int aTextSize)
Definition: gr_text.cpp:64
int GRTextWidth(const wxString &aText, KIFONT::FONT *aFont, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic, const KIFONT::METRICS &aFontMetrics)
Definition: gr_text.cpp:113
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aStrict)
Pen width should not allow characters to become cluttered up in their own fatness.
Definition: gr_text.cpp:87
void GRPrintText(wxDC *aDC, const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aWidth, bool aItalic, bool aBold, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics)
Print a graphic text through wxDC.
Definition: gr_text.cpp:142
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:424
const int scale
GR_TEXT_H_ALIGN_T
GR_TEXT_V_ALIGN_T
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:85