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 width of a given text. (Note that I won't add a normal
  46        * get_width function here, as we might switch to variable width fonts in the
  47        * future.)
  48        * Supports breaklines.
  49        */
  50       float get_text_width(const std::string& text) const;
  51
  52       /** returns the height of a given text. (Note that I won't add a normal
  53        * get_width function here, as we might switch to variable width fonts in the
  54        * future.)
  55        * Supports breaklines.
  56        * In case, you are positive that your text doesn't use break lines, you can
  57        * just use get_height().
  58        */
  59       float get_text_height(const std::string& text) const;
  60       /// returns the height of the font.
  61       float get_height() const;
  62
  63     private:
  64       friend class DrawingContext;
  65
  66       void draw(const std::string& text, const Vector& pos,
  67                 Uint32 drawing_effect = NONE_EFFECT, int alpha = 255);
  68       void draw_center(const std::string& text, const Vector& pos,
  69                 Uint32 drawing_effect = NONE_EFFECT, int alpha = 255);
  70       void draw_chars(Surface* pchars, const std::string& text,
  71                       const Vector& position, Uint32 drawing_effect, int alpha);
  72
  73       Surface* chars;
  74       Surface* shadow_chars;
  75       FontType type;
  76       int w;
  77       int h;
  78       int shadowsize;
  79
  80       /// the number of the first character that is represented in the font
  81       int first_char;
  82       /// the number of the last character that is represented in the font
  83       int last_char;
  84     };
  85
  86
  87   /** Reads a text file (using LispReader, so it as to be in its formatting)
  88       and displays it in a StarTrek fashion */
  89   void display_text_file(const std::string& file, float scroll_speed, Font* heading_font, Font* normal_font, Font* small_font, Font* reference_font );
  90
  91 } //namespace SuperTux
  92
  93 #endif /*SUPERTUX_FONT_H*/
  94