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