TextMetrics.h
1/* Copyright (C) 2015-2024 Marc Boris Duerner
2
3 This library is free software; you can redistribute it and/or
4 modify it under the terms of the GNU Lesser General Public
5 License as published by the Free Software Foundation; either
6 version 2.1 of the License, or (at your option) any later version.
7
8 As a special exception, you may use this file as part of a free
9 software library without restriction. Specifically, if other files
10 instantiate templates or use macros or inline functions from this
11 file, or you compile this file and link it with other files to
12 produce an executable, this file does not by itself cause the
13 resulting executable to be covered by the GNU General Public
14 License. This exception does not however invalidate any other
15 reasons why the executable file might be covered by the GNU Library
16 General Public License.
17
18 This library is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
22
23 You should have received a copy of the GNU Lesser General Public
24 License along with this library; if not, write to the Free Software
25 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
26 MA 02110-1301 USA
27*/
28
29#ifndef PT_GFX_TEXTMETRICS_H
30#define PT_GFX_TEXTMETRICS_H
31
32#include <Pt/Gfx/Api.h>
33
34namespace Pt {
35
36namespace Gfx {
37
48class PT_GFX_API TextMetrics
49{
50 public:
54
57 Float advance() const
58 {
59 return _advance;
60 }
61
64 void setAdvance(Float n)
65 {
66 _advance = n;
67 }
68
71 Float bearingX() const
72 {
73 return _bearingX;
74 }
75
78 void setBearingX(Float n)
79 {
80 _bearingX = n;
81 }
82
85 Float bearingY() const
86 {
87 return _bearingY;
88 }
89
92 void setBearingY(Float n)
93 {
94 _bearingY = n;
95 }
96
99 Float boundingWidth() const
100 {
101 return _boundingWidth;
102 }
103
106 void setBoundingWidth(Float n)
107 {
108 _boundingWidth = n;
109 }
110
113 Float boundingHeight() const
114 {
115 return _boundingHeight;
116 }
117
120 void setBoundingHeight(Float n)
121 {
122 _boundingHeight = n;
123 }
124
125 private:
126 Float _advance;
127 Float _bearingX;
128 Float _bearingY;
129 Float _boundingWidth;
130 Float _boundingHeight;
131};
132
133} // namespace
134
135} // namespace
136
137#endif // include guard
Float boundingWidth() const
Returns the width of the bounding box.
Definition TextMetrics.h:99
void setBoundingHeight(Float n)
Sets the bounding box height.
Definition TextMetrics.h:120
Float boundingHeight() const
Returns the height of the bounding box.
Definition TextMetrics.h:113
Float bearingY() const
Returns the vertical bearing from baseline to top of bounding box.
Definition TextMetrics.h:85
Float advance() const
Returns the advance width of the text.
Definition TextMetrics.h:57
TextMetrics()
Constructs empty text metrics.
void setAdvance(Float n)
Sets the advance width of the text.
Definition TextMetrics.h:64
void setBearingX(Float n)
Sets the horizontal bearing.
Definition TextMetrics.h:78
void setBearingY(Float n)
Sets the vertical bearing.
Definition TextMetrics.h:92
void setBoundingWidth(Float n)
Sets the bounding box width.
Definition TextMetrics.h:106
Float bearingX() const
Returns the horizontal bearing from origin to bounding box.
Definition TextMetrics.h:71
Graphics and imaging services.
Definition Api-Argb32Image.h:12
Core module.
Definition Allocator.h:33