src/scripting/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_SCRIPTING_DISPLAY_EFFECT_HPP
  18 #define HEADER_SUPERTUX_SCRIPTING_DISPLAY_EFFECT_HPP
  19
  20 namespace scripting {
  21
  22 class DisplayEffect
  23 {
  24 public:
  25 #ifndef SCRIPTING_API
  26   virtual ~DisplayEffect()
  27   {}
  28 #endif
  29
  30   /// fade display to black
  31   virtual void fade_out(float fadetime) = 0;
  32   /// fade display from black to normal
  33   virtual void fade_in(float fadetime) = 0;
  34   /// set display black (or back to normal)
  35   virtual void set_black(bool enabled) = 0;
  36   /// check if display is set to black
  37   virtual bool is_black() = 0;
  38   /// set black borders for cutscenes
  39   virtual void sixteen_to_nine(float fadetime) = 0;
  40   /// deactivate borders
  41   virtual void four_to_three(float fadetime) = 0;
  42
  43   // fade display until just a small visible circle is left
  44   // (like what happens in some cartoons at the end)
  45   // void shrink_fade(Vector goal, float radius, float fadetime);
  46 };
  47
  48 }
  49
  50 #endif
  51
  52 /* EOF */