src/object/display_effect.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_OBJECT_DISPLAY_EFFECT_HPP
  18 #define HEADER_SUPERTUX_OBJECT_DISPLAY_EFFECT_HPP
  19
  20 #include "scripting/display_effect.hpp"
  21 #include "supertux/game_object.hpp"
  22 #include "supertux/script_interface.hpp"
  23
  24 class DisplayEffect : public GameObject,
  25                       public scripting::DisplayEffect,
  26                       public ScriptInterface
  27 {
  28 public:
  29   DisplayEffect(std::string name = "");
  30   virtual ~DisplayEffect();
  31
  32   void expose(HSQUIRRELVM vm, SQInteger table_idx);
  33   void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  34
  35   void update(float elapsed_time);
  36   void draw(DrawingContext& context);
  37
  38   /**
  39    * @name Scriptable Methods
  40    * @{
  41    */
  42
  43   void fade_out(float fadetime);
  44   void fade_in(float fadetime);
  45   void set_black(bool enabled);
  46   bool is_black();
  47   void sixteen_to_nine(float fadetime);
  48   void four_to_three(float fadetime);
  49
  50   /**
  51    * @}
  52    */
  53
  54 private:
  55   enum FadeType {
  56     NO_FADE, FADE_IN, FADE_OUT
  57   };
  58   FadeType screen_fade;
  59   float screen_fadetime;
  60   float screen_fading;
  61   FadeType border_fade;
  62   float border_fadetime;
  63   float border_fading;
  64   float border_size;
  65
  66   bool black;
  67   bool borders;
  68 };
  69
  70 #endif
  71
  72 /* EOF */