lib/video/font.h

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20
  21 #ifndef SUPERTUX_FONT_H
  22 #define SUPERTUX_FONT_H
  23
  24 #include <string>
  25
  26 #include "video/surface.h"
  27 #include "math/vector.h"
  28
  29 namespace SuperTux
  30   {
  31
  32   /** Reads a text file (using LispReader, so it as to be in its formatting)
  33       and displays it in a StarTrek fashion */
  34   void display_text_file(const std::string& file, float scroll_speed);
  35
  36   /* Text type */
  37   class Font
  38     {
  39     public:
  40       /* Kinds of texts. */
  41       enum FontType {
  42         TEXT, // images for all characters
  43         NUM   // only images for numbers
  44       };
  45
  46       Font(const std::string& file, FontType type, int w, int h, int shadowsize=2);
  47       ~Font();
  48
  49       /** returns the height of the font */
  50       float get_height() const;
  51       /** returns the width of a given text. (Note that I won't add a normal
  52        * get_width function here, as we might switch to variable width fonts in the
  53        * future.
  54        */
  55       float get_text_width(const std::string& text) const;
  56
  57     private:
  58       friend class DrawingContext;
  59
  60       void draw(const std::string& text, const Vector& pos,
  61                 Uint32 drawing_effect = NONE_EFFECT);
  62       void draw_chars(Surface* pchars, const std::string& text,
  63                       const Vector& position, Uint32 drawing_effect);
  64
  65       Surface* chars;
  66       Surface* shadow_chars;
  67       FontType type;
  68       int w;
  69       int h;
  70       int shadowsize;
  71
  72       /// the number of the first character that is represented in the font
  73       int first_char;
  74       /// the number of the last character that is represented in the font
  75       int last_char;
  76     };
  77
  78 } //namespace SuperTux
  79
  80 #endif /*SUPERTUX_FONT_H*/
  81