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 namespace SuperTux
  26   {
  27
  28   class DrawingContext;
  29
  30   class ObjectRemoveListener;
  31
  32   /**
  33    * Base class for all game objects. This contains functions for:
  34    *  -querying the actual type of the object
  35    *  -a flag that indicates if the object wants to be removed. Objects with this
  36    *   flag will be removed at the end of each frame. This is alot safer than
  37    *   having some uncontrollable "delete this" in the code.
  38    *  -an action function that is called once per frame and allows the object to
  39    *   update it's state.
  40    *
  41    * Most GameObjects will also implement the DrawableObject interface so that
  42    * they can actually be drawn on screen.
  43    */
  44   class GameObject
  45     {
  46     public:
  47       GameObject();
  48       virtual ~GameObject();
  49
  50       /** This function is called once per frame and allows the object to update
  51        * it's state. The elapsed_time is the time since the last frame in
  52        * seconds and should be the base for all timed calculations (don't use
  53        * SDL_GetTicks directly as this will fail in pause mode)
  54        */
  55       virtual void action(float elapsed_time) = 0;
  56
  57       /** The GameObject should draw itself onto the provided DrawingContext if this
  58        * function is called.
  59        */
  60       virtual void draw(DrawingContext& context) = 0;
  61
  62       /** returns true if the object is not scheduled to be removed yet */
  63       bool is_valid() const
  64         {
  65           return !wants_to_die;
  66         }
  67       /** schedules this object to be removed at the end of the frame */
  68       void remove_me()
  69       {
  70         wants_to_die = true;
  71       }
  72       /** registers a remove listener which will be called if the object
  73        * gets removed/destroyed
  74        */
  75       void add_remove_listener(ObjectRemoveListener* listener)
  76       {
  77         RemoveListenerListEntry* entry = new RemoveListenerListEntry();
  78         entry->next = remove_listeners;
  79         entry->listener = listener;
  80
  81         remove_listeners = entry;
  82       }
  83
  84       // flags
  85       enum {
  86         /// the tile so you can stand on it
  87         FLAG_SOLID       = 0x0001,
  88         /// can be used to temporatily disable collision detection
  89         FLAG_NO_COLLDET  = 0x0002
  90       };
  91
  92       int get_flags() const
  93       {
  94         return flags;
  95       }
  96
  97     private:
  98       /** this flag indicates if the object should be removed at the end of the
  99        * frame
 100        */
 101       bool wants_to_die;
 102
 103       struct RemoveListenerListEntry
 104       {
 105         RemoveListenerListEntry* next;
 106         ObjectRemoveListener* listener;
 107       };
 108       RemoveListenerListEntry* remove_listeners;
 109
 110     protected:
 111       int flags;
 112     };
 113
 114 }
 115 #endif /*SUPERTUX_GAMEOBJECT_H*/
 116