]> git.tdb.fi Git - libs/gl.git/blob - source/font.h
Check for null camera in View::render
[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 ligature(unsigned, unsigned, unsigned);
33                 void texture();
34                 void texture_ref(const std::string &);
35         };
36
37         struct Glyph
38         {
39                 class Loader: public Msp::DataFile::ObjectLoader<Glyph>
40                 {
41                 public:
42                         Loader(Glyph &);
43                 private:
44                         void texcoords(float, float, float, float);
45                 };
46
47                 unsigned code;
48                 float x1, y1;
49                 float x2, y2;
50                 float w, h;
51                 float off_x, off_y;
52                 float advance;
53
54                 Glyph();
55         };
56
57 private:
58         typedef std::map<unsigned, Glyph> GlyphMap;
59         typedef std::pair<unsigned, unsigned> CodePair;
60         typedef std::map<CodePair, float> KerningMap;
61         typedef std::map<CodePair, unsigned> LigatureMap;
62
63         RefPtr<const Texture2D> texture;
64         float native_size;
65         float ascent;
66         float descent;
67         float cap_height;
68         float x_height;
69         GlyphMap glyphs;
70         KerningMap kerning;
71         LigatureMap ligatures;
72
73 public:
74         Font();
75         ~Font();
76
77         void set_texture(const Texture2D &);
78         const Texture2D &get_texture() const;
79
80         /** Adds a glyph to the font.  There must not be an existing glyph with the
81         same code. */
82         void add_glyph(const Glyph &);
83         void set_kerning(unsigned, unsigned, float);
84
85         /** Returns the size used to generate the font texture.  This serves as a
86         hint for obtaining the best quality when rendering strings. */
87         float get_native_size() const { return native_size; }
88
89         float get_ascent() const { return ascent; }
90         float get_descent() const { return descent; }
91         float get_cap_height() const { return cap_height; }
92         float get_x_height() const { return x_height; }
93
94         /** Returns the width of a string, in multiples of the font size.  Scale the
95         result according to the size used in rendering. */
96         float get_string_width(const std::string &, StringCodec::Decoder &) const;
97
98         template<class C>
99         float get_string_width(const std::string &str) const
100         {
101                 typename C::Decoder dec;
102                 return get_string_width(str, dec);
103         }
104
105         float get_string_width(const std::string &str) const
106         { return get_string_width<StringCodec::Utf8>(str); }
107
108         /** Builds the primitives for a string.  Two-dimensional vertex and texture
109         coordinates are generated.  Size 1.0 is used for building; set up the
110         builder's matrix before the call.  The texture is not bound, to avoid
111         unnecessary bindings when creating meshes. */
112         void build_string(const std::string &, StringCodec::Decoder &, PrimitiveBuilder &) const;
113
114         template<class C>
115         void build_string(const std::string &str, PrimitiveBuilder &pb) const
116         {
117                 typename C::Decoder dec;
118                 build_string(str, dec, pb);
119         }
120
121         void build_string(const std::string &str, PrimitiveBuilder &pb) const
122         { return build_string<StringCodec::Utf8>(str, pb); }
123
124 private:
125         void create_glyph_quad(const Glyph &, PrimitiveBuilder &) const;
126         float get_glyph_advance(unsigned, unsigned = 0) const;
127         unsigned get_ligature(unsigned, unsigned) const;
128 };
129
130 } // namespace GL
131 } // namespace Msp
132
133 #endif