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