1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCOREFONTFACEHANDLE_H
#define ROCKETCOREFONTFACEHANDLE_H
#include "../../Include/Rocket/Core/ReferenceCountable.h"
#include "UnicodeRange.h"
#include "../../Include/Rocket/Core/Font.h"
#include "../../Include/Rocket/Core/FontEffect.h"
#include "../../Include/Rocket/Core/FontGlyph.h"
#include "../../Include/Rocket/Core/Geometry.h"
#include "../../Include/Rocket/Core/String.h"
#include "../../Include/Rocket/Core/Texture.h"
namespace Rocket {
namespace Core {
class FontFaceLayer;
/**
@author Peter Curry
*/
class FontFaceHandle : public ReferenceCountable
{
public:
FontFaceHandle();
virtual ~FontFaceHandle();
/// Returns the average advance of all glyphs in this font face.
/// @return An approximate width of the characters in this font face.
int GetCharacterWidth() const;
/// Returns the point size of this font face.
/// @return The face's point size.
int GetSize() const;
/// Returns the pixel height of a lower-case x in this font face.
/// @return The height of a lower-case x.
int GetXHeight() const;
/// Returns the default height between this font face's baselines.
/// @return The default line height.
int GetLineHeight() const;
/// Returns the font's baseline, as a pixel offset from the bottom of the font.
/// @return The font's baseline.
int GetBaseline() const;
/// Returns the font's glyphs.
/// @return The font's glyphs.
const FontGlyphList& GetGlyphs() const;
/// Returns the width a string will take up if rendered with this handle.
/// @param[in] string The string to measure.
/// @param[in] prior_character The optionally-specified character that immediately precedes the string. This may have an impact on the string width due to kerning.
/// @return The width, in pixels, this string will occupy if rendered with this handle.
virtual int GetStringWidth(const WString& string, word prior_character = 0) const = 0;
/// Generates, if required, the layer configuration for a given array of font effects.
/// @param[in] font_effects The list of font effects to generate the configuration for.
/// @return The index to use when generating geometry using this configuration.
virtual int GenerateLayerConfiguration(FontEffectMap& font_effects) = 0;
/// Generates the texture data for a layer (for the texture database).
/// @param[out] texture_data The pointer to be set to the generated texture data.
/// @param[out] texture_dimensions The dimensions of the texture.
/// @param[in] layer_id The id of the layer to request the texture data from.
/// @param[in] texture_id The index of the texture within the layer to generate.
virtual bool GenerateLayerTexture(const byte*& texture_data, Vector2i& texture_dimensions, FontEffect* layer_id, int texture_id) = 0;
/// Generates the geometry required to render a single line of text.
/// @param[out] geometry An array of geometries to generate the geometry into.
/// @param[in] string The string to render.
/// @param[in] position The position of the baseline of the first character to render.
/// @param[in] colour The colour to render the text.
/// @return The width, in pixels, of the string geometry.
virtual int GenerateString(GeometryList& geometry, const WString& string, const Vector2f& position, const Colourb& colour, int layer_configuration = 0) const = 0;
/// Generates the geometry required to render a line above, below or through a line of text.
/// @param[out] geometry The geometry to append the newly created geometry into.
/// @param[in] position The position of the baseline of the lined text.
/// @param[in] width The width of the string to line.
/// @param[in] height The height to render the line at.
/// @param[in] colour The colour to draw the line in.
virtual void GenerateLine(Geometry* geometry, const Vector2f& position, int width, Font::Line height, const Colourb& colour) const = 0;
/// Returns the font face's raw charset (the charset range as a string).
/// @return The font face's charset.
const String& GetRawCharset() const;
/// Returns the font face's charset.
/// @return The font face's charset.
const UnicodeRangeList& GetCharset() const;
protected:
/// Destroys the handle.
virtual void OnReferenceDeactivate();
FontFaceLayer* GenerateLayer(FontEffect* font_effect);
virtual int GetKerning(word lhs, word rhs) const = 0;
typedef std::vector< int > GlyphKerningList;
typedef std::vector< GlyphKerningList > FontKerningList;
FontGlyphList glyphs;
FontKerningList kerning;
typedef std::map< const FontEffect*, FontFaceLayer* > FontLayerMap;
typedef std::map< String, FontFaceLayer* > FontLayerCache;
typedef std::vector< FontFaceLayer* > LayerConfiguration;
typedef std::vector< LayerConfiguration > LayerConfigurationList;
// The list of all font layers, index by the effect that instanced them.
FontFaceLayer* base_layer;
FontLayerMap layers;
// Each font layer that generated geometry or textures, indexed by the respective generation
// key.
FontLayerCache layer_cache;
// All configurations currently in use on this handle. New configurations will be generated as
// required.
LayerConfigurationList layer_configurations;
// The average advance (in pixels) of all of this face's glyphs.
int average_advance;
int size;
int x_height;
int line_height;
int baseline;
float underline_position;
float underline_thickness;
String raw_charset;
UnicodeRangeList charset;
unsigned int max_codepoint;
};
}
}
#endif
|
