src/scripting/display_effect.hpp

Go to the documentation of this file.
00001 //  SuperTux
00002 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
00003 //
00004 //  This program is free software: you can redistribute it and/or modify
00005 //  it under the terms of the GNU General Public License as published by
00006 //  the Free Software Foundation, either version 3 of the License, or
00007 //  (at your option) any later version.
00008 //
00009 //  This program is distributed in the hope that it will be useful,
00010 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 //  GNU General Public License for more details.
00013 //
00014 //  You should have received a copy of the GNU General Public License
00015 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
00016 
00017 #ifndef HEADER_SUPERTUX_SCRIPTING_DISPLAY_EFFECT_HPP
00018 #define HEADER_SUPERTUX_SCRIPTING_DISPLAY_EFFECT_HPP
00019 
00020 namespace scripting {
00021 
00022 class DisplayEffect
00023 {
00024 public:
00025 #ifndef SCRIPTING_API
00026   virtual ~DisplayEffect()
00027   {}
00028 #endif
00029 
00031   virtual void fade_out(float fadetime) = 0;
00033   virtual void fade_in(float fadetime) = 0;
00035   virtual void set_black(bool enabled) = 0;
00037   virtual bool is_black() = 0;
00039   virtual void sixteen_to_nine(float fadetime) = 0;
00041   virtual void four_to_three(float fadetime) = 0;
00042 
00043   // fade display until just a small visible circle is left
00044   // (like what happens in some cartoons at the end)
00045   // void shrink_fade(Vector goal, float radius, float fadetime);
00046 };
00047 
00048 }
00049 
00050 #endif
00051 
00052 /* EOF */

Generated on Mon Jun 9 03:38:19 2014 for SuperTux by  doxygen 1.5.1