Remove an XXX because I no longer remember how to reproduce the issue

[libs/gl.git] / source / font.h

diff --git a/source/font.h b/source/font.h
index 28da58229d8bad3f7675599dc2148a6b73a21c42..4eaed9635361ecca51ae5604b84c3c0d533c1109 100644 (file)
--- a/source/font.h
+++ b/source/font.h
@@ -1,17 +1,10 @@
-/* $Id$
-
-This file is part of libmspgl
-Copyright © 2007  Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_GL_FONT_H_
 #define MSP_GL_FONT_H_
 
 #include <map>
 #include <string>
 #include <msp/datafile/objectloader.h>
-#include <msp/strings/utf8.h>
+#include <msp/stringcodec/utf8.h>
 #include "vertexarray.h"
 
 namespace Msp {
@@ -20,6 +13,9 @@ namespace GL {
 class PrimitiveBuilder;
 class Texture2D;
 
+/**
+Stores a set of glyphs and creates strings out of them.
+*/
 class Font
 {
 public:
@@ -32,11 +28,11 @@ public:
        private:
                void init();
                void glyph(unsigned);
+               void kerning(unsigned, unsigned, float);
                void texture();
                void texture_ref(const std::string &);
        };
 
-private:
        struct Glyph
        {
                class Loader: public Msp::DataFile::ObjectLoader<Glyph>
@@ -48,33 +44,51 @@ private:
                };
 
                unsigned code;
-               float x1,y1;
-               float x2,y2;
-               float w,h;
+               float x1, y1;
+               float x2, y2;
+               float w, h;
                float off_x, off_y;
                float advance;
        };
 
+private:
        typedef std::map<unsigned, Glyph> GlyphMap;
+       typedef std::pair<unsigned, unsigned> KerningKey;
+       typedef std::map<KerningKey, float> KerningMap;
 
        RefPtr<const Texture2D> texture;
        float native_size;
        float ascent;
        float descent;
+       float cap_height;
+       float x_height;
        GlyphMap glyphs;
+       KerningMap kerning;
 
 public:
        Font();
+       ~Font();
 
        void set_texture(const Texture2D &);
        const Texture2D &get_texture() const;
-       void add_glyph(unsigned, float, float, float, float, float, float, float, float, float);
+
+       /** Adds a glyph to the font.  There must not be an existing glyph with the
+       same code. */
+       void add_glyph(const Glyph &);
+       void set_kerning(unsigned, unsigned, float);
+
+       /** Returns the size used to generate the font texture.  This serves as a
+       hint for obtaining the best quality when rendering strings. */
        float get_native_size() const { return native_size; }
-       float get_default_size() const { return native_size; }  // Deprecated
+
        float get_ascent() const { return ascent; }
        float get_descent() const { return descent; }
+       float get_cap_height() const { return cap_height; }
+       float get_x_height() const { return x_height; }
 
-       float get_string_width(const std::string &, Codecs::Decoder &) const;
+       /** Returns the width of a string, in multiples of the font size.  Scale the
+       result according to the size used in rendering. */
+       float get_string_width(const std::string &, StringCodec::Decoder &) const;
 
        template<class C>
        float get_string_width(const std::string &str) const
@@ -84,34 +98,41 @@ public:
        }
 
        float get_string_width(const std::string &str) const
-       { return get_string_width<Codecs::Utf8>(str); }
+       { return get_string_width<StringCodec::Utf8>(str); }
 
-       void draw_string(const std::string &, Codecs::Decoder &) const;
-       void draw_string(const std::string &, Codecs::Decoder &, PrimitiveBuilder &) const;
+       /** Draws a string to the framebuffer with Immediate.  It is drawn with size
+       1.0; set up matrices for the desired size before the call. */
+       void draw_string(const std::string &, StringCodec::Decoder &, const Color & = Color()) const;
 
        template<class C>
-       void draw_string(const std::string &str) const
+       void draw_string(const std::string &str, const Color &color = Color()) const
        {
                typename C::Decoder dec;
-               draw_string(str, dec);
+               draw_string(str, dec, color);
        }
 
-       void draw_string(const std::string &str) const
-       { draw_string<Codecs::Utf8>(str); }
+       void draw_string(const std::string &str, const Color &color = Color()) const
+       { draw_string<StringCodec::Utf8>(str, color); }
+
+       /** Builds the primitives for a string.  Two-dimensional vertex and texture
+       coordinates are generated.  Size 1.0 is used for building; set up the
+       builder's matrix before the call.  The texture is not bound, to avoid
+       unnecessary bindings when creating meshes. */
+       void build_string(const std::string &, StringCodec::Decoder &, PrimitiveBuilder &) const;
 
        template<class C>
-       void draw_string(const std::string &str, PrimitiveBuilder &pb) const
+       void build_string(const std::string &str, PrimitiveBuilder &pb) const
        {
                typename C::Decoder dec;
-               draw_string(str, dec, pb);
+               build_string(str, dec, pb);
        }
 
-       void draw_string(const std::string &str, PrimitiveBuilder &pb) const
-       { return draw_string<Codecs::Utf8>(str, pb); }
+       void build_string(const std::string &str, PrimitiveBuilder &pb) const
+       { return build_string<StringCodec::Utf8>(str, pb); }
 
 private:
-       void create_glyph_vertices(const Glyph &, VertexBuilder &) const;
-       float get_glyph_advance(unsigned) const;
+       void create_glyph_quad(const Glyph &, PrimitiveBuilder &) const;
+       float get_glyph_advance(unsigned, unsigned = 0) const;
 };
 
 } // namespace GL