src/object/display_effect.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 __OBJECT_DISPLAY_EFFECT_H__
  21 #define __OBJECT_DISPLAY_EFFECT_H__
  22
  23 #include "scripting/display_effect.hpp"
  24 #include "game_object.hpp"
  25 #include "script_interface.hpp"
  26
  27 class DisplayEffect : public GameObject, public Scripting::DisplayEffect,
  28                       public ScriptInterface
  29 {
  30 public:
  31     DisplayEffect(std::string name = "");
  32     virtual ~DisplayEffect();
  33
  34     void expose(HSQUIRRELVM vm, SQInteger table_idx);
  35     void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  36
  37     void update(float elapsed_time);
  38     void draw(DrawingContext& context);
  39
  40
  41     /**
  42      * @name Scriptable Methods
  43      * @{
  44      */
  45
  46     void fade_out(float fadetime);
  47     void fade_in(float fadetime);
  48     void set_black(bool enabled);
  49     bool is_black();
  50     void sixteen_to_nine(float fadetime);
  51     void four_to_three(float fadetime);
  52
  53     /**
  54      * @}
  55      */
  56
  57 private:
  58     enum FadeType {
  59         NO_FADE, FADE_IN, FADE_OUT
  60     };
  61     FadeType screen_fade;
  62     float screen_fadetime;
  63     float screen_fading;
  64     FadeType border_fade;
  65     float border_fadetime;
  66     float border_fading;
  67     float border_size;
  68
  69     bool black;
  70     bool borders;
  71 };
  72
  73 #endif