src/game_object.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 SUPERTUX_GAMEOBJECT_H
  20 #define SUPERTUX_GAMEOBJECT_H
  21
  22 #include <string>
  23 #include "refcounter.hpp"
  24
  25 class DrawingContext;
  26 class ObjectRemoveListener;
  27
  28 /**
  29  * This is a base class for all game objects. Each sector of a level will hold a
  30  * list of active GameObject while the game is played.
  31  *
  32  * This class is responsible for:
  33  *  - Updating and Drawing the object. This should happen in the update() and
  34  *    draw() functions. Both are called once per frame.
  35  *  - Providing a safe way to remove the object by calling the remove_me
  36  *    functions.
  37  */
  38 class GameObject : public RefCounter
  39 {
  40 public:
  41   GameObject();
  42   virtual ~GameObject();
  43
  44   /** This function is called once per frame and allows the object to update
  45    * it's state. The elapsed_time is the time since the last frame in
  46    * seconds and should be the base for all timed calculations (don't use
  47    * SDL_GetTicks directly as this will fail in pause mode)
  48    */
  49   virtual void update(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   {
  59     return !wants_to_die;
  60   }
  61
  62   /** schedules this object to be removed at the end of the frame */
  63   void remove_me()
  64   {
  65     wants_to_die = true;
  66   }
  67
  68   /** registers a remove listener which will be called if the object
  69    * gets removed/destroyed
  70    */
  71   void add_remove_listener(ObjectRemoveListener* listener);
  72
  73   /**
  74    * unregisters a remove listener, so it will no longer be called if the object
  75    * gets removed/destroyed
  76    */
  77   void del_remove_listener(ObjectRemoveListener* listener);
  78
  79   const std::string& get_name() const
  80   {
  81     return name;
  82   }
  83
  84 private:
  85   /** this flag indicates if the object should be removed at the end of the
  86    * frame
  87    */
  88   bool wants_to_die;
  89
  90   struct RemoveListenerListEntry
  91   {
  92     RemoveListenerListEntry* next;
  93     ObjectRemoveListener* listener;
  94   };
  95   RemoveListenerListEntry* remove_listeners;
  96
  97 protected:
  98   /**
  99    * a name for the gameobject, this is mostly a hint for scripts and for
 100    * debugging, don't rely on names being set or being unique
 101    */
 102   std::string name;
 103 };
 104
 105 #endif /*SUPERTUX_GAMEOBJECT_H*/