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