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