src/textscroller.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.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 __TEXTSCROLLER_H__
  22 #define __TEXTSCROLLER_H__
  23
  24 #include <vector>
  25 #include <string>
  26 #include <map>
  27 #include <memory>
  28
  29 #include "screen.hpp"
  30 #include "math/vector.hpp"
  31 #include "math/rect.hpp"
  32 #include "video/color.hpp"
  33
  34 class DrawingContext;
  35 class Surface;
  36 class Font;
  37
  38 /**
  39  * Helper class for InfoBox: Represents a line of text
  40  */
  41 class InfoBoxLine
  42 {
  43 public:
  44   enum LineType { NORMAL, NORMAL_LEFT, SMALL, HEADING, REFERENCE, IMAGE};
  45
  46   InfoBoxLine(char format_char, const std::string& text);
  47   ~InfoBoxLine();
  48
  49   void draw(DrawingContext& context, const Rect& bbox, int layer);
  50   float get_height();
  51
  52   static const std::vector<InfoBoxLine*> split(const std::string& text, float width);
  53
  54 private:
  55   InfoBoxLine::LineType lineType;
  56   Font* font;
  57   Color color;
  58   std::string text;
  59   Surface* image;
  60 };
  61
  62 /** This class is displaying a box with information text inside the game
  63  */
  64 class InfoBox
  65 {
  66 public:
  67   InfoBox(const std::string& text);
  68   ~InfoBox();
  69
  70   void draw(DrawingContext& context);
  71   void scrolldown();
  72   void scrollup();
  73   void pagedown();
  74   void pageup();
  75
  76 private:
  77   size_t firstline;
  78   std::vector<InfoBoxLine*> lines;
  79   std::map<std::string, Surface*> images;
  80   Surface* arrow_scrollup;
  81   Surface* arrow_scrolldown;
  82 };
  83
  84 /**
  85  * Screen that displays intro text, extro text, etc.
  86  */
  87 class TextScroller : public Screen
  88 {
  89 public:
  90   TextScroller(const std::string& file);
  91   virtual ~TextScroller();
  92
  93   void setup();
  94   void draw(DrawingContext& context);
  95   void update(float elapsed_time);
  96
  97   static Color small_color;
  98   static Color heading_color;
  99   static Color reference_color;
 100   static Color normal_color;
 101 private:
 102   float defaultspeed;
 103   float speed;
 104   std::string music;
 105   std::auto_ptr<Surface> background;
 106   std::vector<InfoBoxLine*> lines;
 107   float scroll;
 108   bool fading;
 109 };
 110
 111 #endif