src/video/font.hpp

   1 //  $Id: font.h 2298 2005-03-30 12:01:02Z matzebraun $
   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 #ifndef SUPERTUX_FONT_H
  21 #define SUPERTUX_FONT_H
  22
  23 #include <string>
  24 #include <stdint.h>
  25
  26 #include "video/surface.hpp"
  27 #include "math/vector.hpp"
  28
  29 enum FontAlignment {
  30   LEFT_ALLIGN,
  31   CENTER_ALLIGN,
  32   RIGHT_ALLIGN
  33 };
  34
  35 class Font
  36 {
  37 public:
  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,
  44        int shadowsize=2);
  45   ~Font();
  46
  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    * Supports breaklines.
  51    */
  52   float get_text_width(const std::string& text) const;
  53
  54   /** returns the height of a given text. This function supports breaklines.
  55    * In case, you are positive that your text doesn't use break lines, you can
  56    * just use get_height().
  57    */
  58   float get_text_height(const std::string& text) const;
  59   /// returns the height of the font.
  60   float get_height() const;
  61
  62   /** Draws the given text to the screen. Also needs the position.
  63    * Type of alignment, drawing effect and alpha are optional. */
  64   void draw(const std::string& text, const Vector& pos,
  65             FontAlignment allignment = LEFT_ALLIGN,
  66             uint32_t drawing_effect = NONE_EFFECT, uint8_t alpha = 255) const;
  67
  68 private:
  69   friend class DrawingContext;
  70
  71   void draw_text(const std::string& text, const Vector& pos,
  72                  uint32_t drawing_effect = NONE_EFFECT, uint8_t alpha = 255) const;
  73
  74   void draw_chars(Surface* pchars, const std::string& text,
  75                   const Vector& position, uint32_t drawing_effect, uint8_t alpha) const;
  76
  77   Surface* chars;
  78   Surface* shadow_chars;
  79   FontType type;
  80   int w;
  81   int h;
  82   int shadowsize;
  83
  84   /// the number of the first character that is represented in the font
  85   uint32_t first_char;
  86   /// the number of the last character that is represented in the font
  87   uint32_t char_count;
  88 };
  89
  90 #endif