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 The 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>
33
34#include <callback_gal.h>
35
36
37int GetPenSizeForBold( int aTextSize )
38{
39 return KiROUND( aTextSize / 5.0 );
40}
41
42
43int GetPenSizeForDemiBold( int aTextSize )
44{
45 return KiROUND( aTextSize / 6.0 );
46}
47
48
49int GetPenSizeForBold( const wxSize& aTextSize )
50{
51 return GetPenSizeForBold( std::min( aTextSize.x, aTextSize.y ) );
52}
53
54
55int GetPenSizeForDemiBold( const wxSize& aTextSize )
56{
57 return GetPenSizeForDemiBold( std::min( aTextSize.x, aTextSize.y ) );
58}
59
60
61int GetPenSizeForNormal( int aTextSize )
62{
63 return KiROUND( aTextSize / 8.0 );
64}
65
66
67int GetPenSizeForNormal( const wxSize& aTextSize )
68{
69 return GetPenSizeForNormal( std::min( aTextSize.x, aTextSize.y ) );
70}
71
72
73int ClampTextPenSize( int aPenSize, int aSize, bool aStrict )
74{
75 double scale = aStrict ? 0.18 : 0.25;
76 int maxWidth = KiROUND( (double) aSize * scale );
77
78 return std::min( aPenSize, maxWidth );
79}
80
81
82float ClampTextPenSize( float aPenSize, int aSize, bool aStrict )
83{
84 double scale = aStrict ? 0.18 : 0.25;
85 float maxWidth = (float) aSize * scale;
86
87 return std::min( aPenSize, maxWidth );
88}
89
90
91int ClampTextPenSize( int aPenSize, const VECTOR2I& aSize, bool aStrict )
92{
93 int size = std::min( std::abs( aSize.x ), std::abs( aSize.y ) );
94
95 return ClampTextPenSize( aPenSize, size, aStrict );
96}
97
98
99int GRTextWidth( const wxString& aText, KIFONT::FONT* aFont, const VECTOR2I& aSize,
100 int aThickness, bool aBold, bool aItalic, const KIFONT::METRICS& aFontMetrics )
101{
102 if( !aFont )
103 aFont = KIFONT::FONT::GetFont();
104 wxString evaluated( aText );
105
106 if( evaluated.Contains( wxS( "@{" ) ) )
107 {
108 EXPRESSION_EVALUATOR evaluator;
109 evaluated = evaluator.Evaluate( evaluated );
110 }
111
112 return KiROUND( aFont->StringBoundaryLimits( evaluated, aSize, aThickness, aBold, aItalic,
113 aFontMetrics ).x );
114}
115
116
117void GRPrintText( wxDC* aDC, const VECTOR2I& aPos, const COLOR4D& aColor, const wxString& aText,
118 const EDA_ANGLE& aOrient, const VECTOR2I& aSize,
119 enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify,
120 int aWidth, bool aItalic, bool aBold, KIFONT::FONT* aFont,
121 const KIFONT::METRICS& aFontMetrics )
122{
124 bool fill_mode = true;
125 wxString evaluatedText( aText );
126
127 if( evaluatedText.Contains( wxS( "@{" ) ) )
128 {
129 EXPRESSION_EVALUATOR evaluator;
130 evaluatedText = evaluator.Evaluate( evaluatedText );
131 }
132
133 if( !aFont )
134 aFont = KIFONT::FONT::GetFont();
135
136 if( aWidth == 0 ) // Use default values if aWidth == 0
137 {
138 if( aBold )
139 aWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
140 else
141 aWidth = GetPenSizeForNormal( std::min( aSize.x, aSize.y ) );
142 }
143
144 if( aWidth < 0 )
145 {
146 aWidth = -aWidth;
147 fill_mode = false;
148 }
149
150 CALLBACK_GAL callback_gal( empty_opts,
151 // Stroke callback
152 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
153 {
154 if( fill_mode )
155 GRLine( aDC, aPt1, aPt2, aWidth, aColor );
156 else
157 GRCSegm( aDC, aPt1, aPt2, aWidth, aColor );
158 },
159 // Polygon callback
160 [&]( const SHAPE_LINE_CHAIN& aPoly )
161 {
162 GRClosedPoly( aDC, aPoly.PointCount(), aPoly.CPoints().data(), true, aColor );
163 } );
164
165 TEXT_ATTRIBUTES attributes;
166 attributes.m_Angle = aOrient;
167 attributes.m_StrokeWidth = aWidth;
168 attributes.m_Italic = aItalic;
169 attributes.m_Bold = aBold;
170 attributes.m_Halign = aH_justify;
171 attributes.m_Valign = aV_justify;
172 attributes.m_Size = aSize;
173
174 aFont->Draw( &callback_gal, evaluatedText, aPos, attributes, aFontMetrics );
175}
176
177
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
High-level wrapper for evaluating mathematical and string expressions in wxString format.
wxString Evaluate(const wxString &aInput)
Main evaluation function - processes input string and evaluates all} expressions.
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, const std::vector< wxString > *aEmbeddedFiles=nullptr, bool aForDrawingSheet=false)
Definition font.cpp:147
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:250
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:427
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:352
int GetPenSizeForBold(int aTextSize)
Definition gr_text.cpp:37
int GetPenSizeForDemiBold(int aTextSize)
Definition gr_text.cpp:43
int GetPenSizeForNormal(int aTextSize)
Definition gr_text.cpp:61
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:99
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:117
int ClampTextPenSize(int aPenSize, int aSize, bool aStrict)
Pen width should not allow characters to become cluttered up in their own fatness.
Definition gr_text.cpp:73
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition eda_angle.h:400
const int scale
GR_TEXT_H_ALIGN_T
This is API surface mapped to common.types.HorizontalAlignment.
GR_TEXT_V_ALIGN_T
This is API surface mapped to common.types.VertialAlignment.
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695