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   /// Font
  33   class Font
  34     {
  35     public:
  36       /// Kinds of texts.
  37       enum FontType {
  38         TEXT, // images for all characters
  39         NUM   // only images for numbers
  40       };
  41
  42       Font(const std::string& file, FontType type, int w, int h, int shadowsize=2);
  43       ~Font();
  44
  45       /// returns the height of the font.
  46       float get_height() const;
  47       /** returns the width of a given text. (Note that I won't add a normal
  48        * get_width function here, as we might switch to variable width fonts in the
  49        * future.
  50        */
  51       float get_text_width(const std::string& text) const;
  52
  53     private:
  54       friend class DrawingContext;
  55
  56       void draw(const std::string& text, const Vector& pos,
  57                 Uint32 drawing_effect = NONE_EFFECT);
  58       void draw_chars(Surface* pchars, const std::string& text,
  59                       const Vector& position, Uint32 drawing_effect);
  60
  61       Surface* chars;
  62       Surface* shadow_chars;
  63       FontType type;
  64       int w;
  65       int h;
  66       int shadowsize;
  67
  68       /// the number of the first character that is represented in the font
  69       int first_char;
  70       /// the number of the last character that is represented in the font
  71       int last_char;
  72     };
  73
  74
  75   /** Reads a text file (using LispReader, so it as to be in its formatting)
  76       and displays it in a StarTrek fashion */
  77   void display_text_file(const std::string& file, float scroll_speed, Font* heading_font, Font* normal_font, Font* small_font, Font* reference_font );
  78
  79 } //namespace SuperTux
  80
  81 #endif /*SUPERTUX_FONT_H*/
  82