KiCad PCB EDA Suite
Loading...
Searching...
No Matches
outline_font.h
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) 2021 Ola Rinta-Koski
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * Outline font class
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#ifndef OUTLINE_FONT_H_
28#define OUTLINE_FONT_H_
29
30#include <gal/gal.h>
32#ifdef _MSC_VER
33#include <ft2build.h>
34#else
35#include <freetype2/ft2build.h>
36#endif
37#include FT_FREETYPE_H
38#include FT_OUTLINE_H
39
40#include <font/font.h>
41#include <font/glyph.h>
43#include <embedded_files.h>
44
45#include <mutex>
46
47namespace KIFONT
48{
53{
54public:
55
64
66
67 bool IsOutline() const override { return true; }
68
69 bool IsBold() const override
70 {
71 return m_face && ( m_fakeBold || ( m_face->style_flags & FT_STYLE_FLAG_BOLD ) );
72 }
73
74 bool IsItalic() const override
75 {
76 return m_face && ( m_fakeItal || ( m_face->style_flags & FT_STYLE_FLAG_ITALIC ) );
77 }
78
79 // Accessors to distinguish fake vs real style for diagnostics and rendering decisions
80 bool IsFakeItalic() const { return m_fakeItal; }
81 bool IsFakeBold() const { return m_fakeBold; }
82
84 {
85 m_fakeBold = true;
86 }
87
89 {
90 m_fakeItal = true;
91 }
92
93 const wxString& GetFileName() const { return m_fontFileName; }
94
95 EMBEDDING_PERMISSION GetEmbeddingPermission() const;
96
102 static OUTLINE_FONT* LoadFont( const wxString& aFontFileName, bool aBold, bool aItalic,
103 const std::vector<wxString>* aEmbeddedFiles,
104 bool aForDrawingSheet );
105
111 double GetInterline( double aGlyphHeight, const METRICS& aFontMetrics ) const override;
112
113 VECTOR2I GetTextAsGlyphs( BOX2I* aBoundingBox, std::vector<std::unique_ptr<GLYPH>>* aGlyphs,
114 const wxString& aText, const VECTOR2I& aSize,
115 const VECTOR2I& aPosition, const EDA_ANGLE& aAngle, bool aMirror,
116 const VECTOR2I& aOrigin, TEXT_STYLE_FLAGS aTextStyle ) const override;
117
118 void GetLinesAsGlyphs( std::vector<std::unique_ptr<GLYPH>>* aGlyphs, const wxString& aText,
119 const VECTOR2I& aPosition, const TEXT_ATTRIBUTES& aAttrs,
120 const METRICS& aFontMetrics ) const;
121
122 const FT_Face& GetFace() const { return m_face; }
123
124#if 0
125 void RenderToOpenGLCanvas( KIGFX::OPENGL_FREETYPE& aTarget, const wxString& aString,
126 const VECTOR2D& aSize, const wxPoint& aPosition,
127 const EDA_ANGLE& aAngle, bool aMirror ) const;
128#endif
129
130protected:
131 FT_Error loadFace( const wxString& aFontFileName, int aFaceIndex );
132
133 BOX2I getBoundingBox( const std::vector<std::unique_ptr<GLYPH>>& aGlyphs ) const;
134
135 VECTOR2I getTextAsGlyphs( BOX2I* aBoundingBox, std::vector<std::unique_ptr<GLYPH>>* aGlyphs,
136 const wxString& aText, const VECTOR2I& aSize,
137 const VECTOR2I& aPosition, const EDA_ANGLE& aAngle, bool aMirror,
138 const VECTOR2I& aOrigin, TEXT_STYLE_FLAGS aTextStyle ) const;
139
140private:
141 VECTOR2I getTextAsGlyphsUnlocked( BOX2I* aBoundingBox,
142 std::vector<std::unique_ptr<GLYPH>>* aGlyphs,
143 const wxString& aText, const VECTOR2I& aSize,
144 const VECTOR2I& aPosition, const EDA_ANGLE& aAngle,
145 bool aMirror, const VECTOR2I& aOrigin,
146 TEXT_STYLE_FLAGS aTextStyle ) const;
147
148private:
149 // FreeType variables
150
154 static std::mutex m_freeTypeMutex;
155 static FT_Library m_freeType;
156 FT_Face m_face;
157
158 const int m_faceSize;
161
163
164 // cache for glyphs converted to straight segments
165 // key is glyph index (FT_GlyphSlot field glyph_index)
166 std::map<unsigned int, std::vector<std::vector<VECTOR2D>>> m_contourCache;
167
168 // The height of the KiCad stroke font is the distance between stroke endpoints for a vertical
169 // line of cap-height. So the cap-height of the font is actually stroke-width taller than its
170 // height.
171 // Outline fonts are normally scaled on full-height (including ascenders and descenders), so we
172 // need to compensate to keep them from being much smaller than their stroked counterparts.
173 static constexpr double m_outlineFontSizeCompensation = 1.4;
174
175 // FT_Set_Char_Size() gets character width and height specified in 1/64ths of a point
176 static constexpr int m_charSizeScaler = 64;
177
178 // The KiCad stroke font uses a subscript/superscript size ratio of 0.7. This ratio is also
179 // commonly used in LaTeX, but fonts with designed-in subscript and superscript glyphs are more
180 // likely to use 0.58.
181 // For auto-generated subscript and superscript glyphs in outline fonts we split the difference
182 // with 0.64.
183 static constexpr double m_subscriptSuperscriptSize = 0.64;
184
185 static constexpr double m_underlineOffsetScaler = -0.16;
186
187 int faceSize( int aSize ) const
188 {
190 };
191
192 int faceSize() const { return faceSize( m_faceSize ); }
193
194 // also for superscripts
195 int subscriptSize( int aSize ) const
196 {
197 return KiROUND( faceSize( aSize ) * m_subscriptSuperscriptSize );
198 }
199 int subscriptSize() const { return subscriptSize( m_faceSize ); }
200
201 static constexpr double m_subscriptVerticalOffset = -0.25;
202 static constexpr double m_superscriptVerticalOffset = 0.45;
203};
204
205} //namespace KIFONT
206
207#endif // OUTLINE_FONT_H_
BOX2I getBoundingBox(BOARD_ITEM *aItem)
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
wxString m_fontFileName
Font file name.
Definition font.h:291
Class OUTLINE_FONT implements outline font drawing.
static std::mutex m_freeTypeMutex
Mutex for freetype access, FT_Library and FT_Face are not thread safe.
static FT_Library m_freeType
static constexpr double m_superscriptVerticalOffset
bool IsFakeItalic() const
bool IsFakeBold() const
const FT_Face & GetFace() const
int subscriptSize(int aSize) const
bool IsItalic() const override
static constexpr int m_charSizeScaler
int faceSize(int aSize) const
bool IsOutline() const override
std::map< unsigned int, std::vector< std::vector< VECTOR2D > > > m_contourCache
static constexpr double m_subscriptSuperscriptSize
const wxString & GetFileName() const
static constexpr double m_outlineFontSizeCompensation
static constexpr double m_underlineOffsetScaler
int subscriptSize() const
bool IsBold() const override
static constexpr double m_subscriptVerticalOffset
unsigned int TEXT_STYLE_FLAGS
Definition font.h:64
#define GAL_API
Definition gal.h:28
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695
VECTOR2< double > VECTOR2D
Definition vector2d.h:694