lib/special/game_object.h

   1 //  $Id$
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 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
  20 #ifndef SUPERTUX_GAMEOBJECT_H
  21 #define SUPERTUX_GAMEOBJECT_H
  22
  23 #include <string>
  24
  25 class DrawingContext;
  26
  27 /**
  28  * Base class for all game objects. This contains functions for:
  29  *  -querying the actual type of the object
  30  *  -a flag that indicates if the object wants to be removed. Objects with this
  31  *   flag will be removed at the end of each frame. This is alot safer than
  32  *   having some uncontrollable "delete this" in the code.
  33  *  -an action function that is called once per frame and allows the object to
  34  *   update it's state.
  35  *
  36  * Most GameObjects will also implement the DrawableObject interface so that
  37  * they can actually be drawn on screen.
  38  */
  39 class GameObject // TODO rename this once the game has been converted
  40 {
  41 public:
  42   GameObject();
  43   virtual ~GameObject();
  44
  45   /** This function is called once per frame and allows the object to update
  46    * it's state. The elapsed_time is the time since the last frame and should be
  47    * the base for all timed things.
  48    */
  49   virtual void action(float elapsed_time) = 0;
  50
  51   /** The GameObject should draw itself onto the provided DrawingContext if this
  52    * function is called.
  53    */
  54   virtual void draw(DrawingContext& context) = 0;
  55
  56   /** returns true if the object is not scheduled to be removed yet */
  57   bool is_valid() const
  58   { return !wants_to_die; }
  59   /** schedules this object to be removed at the end of the frame */
  60   void remove_me()
  61   { wants_to_die = true; }
  62
  63 private:
  64   /** this flag indicates if the object should be removed at the end of the
  65    * frame
  66    */
  67   bool wants_to_die;
  68 };
  69
  70 #endif /*SUPERTUX_GAMEOBJECT_H*/
  71