]> git.tdb.fi Git - libs/gl.git/blob - source/font.h
Give meshes a higher priority when loading
[libs/gl.git] / source / font.h
1 #ifndef MSP_GL_FONT_H_
2 #define MSP_GL_FONT_H_
3
4 #include <map>
5 #include <string>
6 #include <msp/datafile/objectloader.h>
7 #include <msp/stringcodec/utf8.h>
8 #include "vertexarray.h"
9
10 namespace Msp {
11 namespace GL {
12
13 class PrimitiveBuilder;
14 class Texture2D;
15
16 /**
17 Stores a set of glyphs and creates strings out of them.
18 */
19 class Font
20 {
21 public:
22         class Loader: public DataFile::CollectionObjectLoader<Font>
23         {
24         public:
25                 Loader(Font &);
26                 Loader(Font &, Collection &);
27
28         private:
29                 void init();
30                 void glyph(unsigned);
31                 void kerning(unsigned, unsigned, float);
32                 void texture();
33                 void texture_ref(const std::string &);
34         };
35
36         struct Glyph
37         {
38                 class Loader: public Msp::DataFile::ObjectLoader<Glyph>
39                 {
40                 public:
41                         Loader(Glyph &);
42                 private:
43                         void texcoords(float, float, float, float);
44                 };
45
46                 unsigned code;
47                 float x1, y1;
48                 float x2, y2;
49                 float w, h;
50                 float off_x, off_y;
51                 float advance;
52         };
53
54 private:
55         typedef std::map<unsigned, Glyph> GlyphMap;
56         typedef std::pair<unsigned, unsigned> KerningKey;
57         typedef std::map<KerningKey, float> KerningMap;
58
59         RefPtr<const Texture2D> texture;
60         float native_size;
61         float ascent;
62         float descent;
63         GlyphMap glyphs;
64         KerningMap kerning;
65
66 public:
67         Font();
68         ~Font();
69
70         void set_texture(const Texture2D &);
71         const Texture2D &get_texture() const;
72
73         /** Adds a glyph to the font.  There must not be an existing glyph with the
74         same code. */
75         void add_glyph(const Glyph &);
76         void set_kerning(unsigned, unsigned, float);
77
78         /** Returns the size used to generate the font texture.  This serves as a
79         hint for obtaining the best quality when rendering strings. */
80         float get_native_size() const { return native_size; }
81
82         float get_ascent() const { return ascent; }
83         float get_descent() const { return descent; }
84
85         /** Returns the width of a string, in multiples of the font size.  Scale the
86         result according to the size used in rendering. */
87         float get_string_width(const std::string &, StringCodec::Decoder &) const;
88
89         template<class C>
90         float get_string_width(const std::string &str) const
91         {
92                 typename C::Decoder dec;
93                 return get_string_width(str, dec);
94         }
95
96         float get_string_width(const std::string &str) const
97         { return get_string_width<StringCodec::Utf8>(str); }
98
99         /** Draws a string to the framebuffer with Immediate.  It is drawn with size
100         1.0; set up matrices for the desired size before the call. */
101         void draw_string(const std::string &, StringCodec::Decoder &, const Color & = Color()) const;
102
103         template<class C>
104         void draw_string(const std::string &str, const Color &color = Color()) const
105         {
106                 typename C::Decoder dec;
107                 draw_string(str, dec, color);
108         }
109
110         void draw_string(const std::string &str, const Color &color = Color()) const
111         { draw_string<StringCodec::Utf8>(str, color); }
112
113         /** Builds the primitives for a string.  Two-dimensional vertex and texture
114         coordinates are generated.  Size 1.0 is used for building; set up the
115         builder's matrix before the call.  The texture is not bound, to avoid
116         unnecessary bindings when creating meshes. */
117         void build_string(const std::string &, StringCodec::Decoder &, PrimitiveBuilder &) const;
118
119         template<class C>
120         void build_string(const std::string &str, PrimitiveBuilder &pb) const
121         {
122                 typename C::Decoder dec;
123                 build_string(str, dec, pb);
124         }
125
126         void build_string(const std::string &str, PrimitiveBuilder &pb) const
127         { return build_string<StringCodec::Utf8>(str, pb); }
128
129 private:
130         void create_glyph_quad(const Glyph &, PrimitiveBuilder &) const;
131         float get_glyph_advance(unsigned, unsigned = 0) const;
132 };
133
134 } // namespace GL
135 } // namespace Msp
136
137 #endif