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