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_SUPERTUX_SCREEN_HPP
18#define HEADER_SUPERTUX_SUPERTUX_SCREEN_HPP
19
20class Compositor;
21class Controller;
22
23/**
24 * Abstract base class for code the MainLoop runs exclusively and full-screen.
25 *
26 * Examples of Screens are: The TitleScreen, a WorldMap, a level's
27 * GameSession, a TextScroller, ...
28 */
29class Screen
30{
31public:
32 virtual ~Screen()
33 {}
34
35 /**
36 * gets called before this screen gets activated (which is at least once
37 * before the first draw or update call
38 */
39 virtual void setup()
40 {}
41 /** gets called when the current screen is temporarily suspended */
42 virtual void leave()
43 {}
44
45 /**
46 * gets called once per frame. The screen should draw itself in this function.
47 * State changes should not be done in this function, but rather in update
48 */
49 virtual void draw(Compositor& compositor) = 0;
50
51 /**
52 * gets called for once (per logical) frame. Screens should do their state
53 * updates and logic here
54 */
55 virtual void update(float dt_sec, const Controller& controller) = 0;
56};
57
58#endif
59
60/* EOF */
61