src/object/text_object.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  02111-1307, USA.
  19
  20 #ifndef __TEXTOBJECT_H__
  21 #define __TEXTOBJECT_H__
  22
  23 #include "game_object.hpp"
  24 #include "scripting/text.hpp"
  25 #include "script_interface.hpp"
  26
  27 class Font;
  28
  29 /** A text object intended for scripts that want to tell a story */
  30 class TextObject : public GameObject, public Scripting::Text,
  31                    public ScriptInterface
  32 {
  33 public:
  34   TextObject();
  35   virtual ~TextObject();
  36
  37   void expose(HSQUIRRELVM vm, SQInteger table_idx);
  38   void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  39
  40   void set_text(const std::string& text);
  41   void set_font(const std::string& name);
  42   void fade_in(float fadetime);
  43   void fade_out(float fadetime);
  44   void set_visible(bool visible);
  45   void set_centered(bool centered);
  46   bool is_visible();
  47
  48   void draw(DrawingContext& context);
  49   void update(float elapsed_time);
  50
  51 private:
  52   Font* font;
  53   std::string text;
  54   float fading;
  55   float fadetime;
  56   bool visible;
  57   bool centered;
  58 };
  59
  60 #endif