src/moving_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_MOVING_OBJECT_H
  20 #define SUPERTUX_MOVING_OBJECT_H
  21
  22 #include <stdint.h>
  23
  24 #include "game_object.hpp"
  25 #include "collision_hit.hpp"
  26 #include "math/vector.hpp"
  27 #include "math/rect.hpp"
  28
  29 class Sector;
  30 class CollisionGrid;
  31
  32 enum CollisionGroup {
  33   /** Objects in DISABLED group are not tested for collisions */
  34   COLGROUP_DISABLED,
  35   /**
  36    * "default" is moving object. MovingObjects get tested against all other
  37    * objects and against other movingobjects
  38    */
  39   COLGROUP_MOVING,
  40   /**
  41    * a Moving object, that is not tested against other MovingObjects (or other
  42    * MovingOnlyStatic objects), but is tested against all other objects.
  43    */
  44   COLGROUP_MOVING_ONLY_STATIC,
  45   /**
  46    * Doesn't move and isn't explicitely checked for collisions with other
  47    * objects (but other objects might check with this)
  48    * The difference to COLGROUP_TOUCHABLE is that we can do multiple
  49    * collision response tests in a row which is needed for static object
  50    * that tux walks on. The results for collisions with STATIC objects
  51    * are also sorted by time (so that the first hit gets handled first).
  52    *
  53    * Use this for static obstacles
  54    */
  55   COLGROUP_STATIC,
  56   /**
  57    * Isn't explicitely checked for collisions with other objects. But other
  58    * objects might check with this object.
  59    * Difference to COLGROUP_STATIC is that collisions with this object are
  60    * only tested once and collision response is typically not handled
  61    *
  62    * Use this for touchable things like spikes/areas or collectibles like
  63    * coins
  64    */
  65   COLGROUP_TOUCHABLE,
  66
  67   /**
  68    * Should be used for tilemaps
  69    */
  70   COLGROUP_TILEMAP
  71 };
  72
  73 /**
  74  * Base class for all dynamic/moving game objects. This class contains things
  75  * for handling the bounding boxes and collision feedback.
  76  */
  77 class MovingObject : public GameObject
  78 {
  79 public:
  80   MovingObject();
  81   virtual ~MovingObject();
  82
  83   /** this function is called when the object collided with any other object
  84    */
  85   virtual HitResponse collision(GameObject& other,
  86                                 const CollisionHit& hit) = 0;
  87   /** called when tiles with special attributes have been touched */
  88   virtual void collision_tile(uint32_t tile_attributes)
  89   {
  90     (void) tile_attributes;
  91   }
  92
  93   const Vector& get_pos() const
  94   {
  95     return bbox.p1;
  96   }
  97
  98   /** returns the bounding box of the Object */
  99   const Rect& get_bbox() const
 100   {
 101     return bbox;
 102   }
 103
 104   const Vector& get_movement() const
 105   {
 106     return movement;
 107   }
 108
 109   /** places the moving object at a specific position. Be carefull when
 110    * using this function. There are no collision detection checks performed
 111    * here so bad things could happen.
 112    */
 113   virtual void set_pos(const Vector& pos)
 114   {
 115     dest.move(pos-get_pos());
 116     bbox.set_pos(pos);
 117   }
 118
 119   /**
 120    * sets the moving object's bbox to a specific width. Be careful when
 121    * using this function. There are no collision detection checks performed
 122    * here so bad things could happen.
 123    */
 124   virtual void set_width(float w)
 125   {
 126     dest.set_width(w);
 127     bbox.set_width(w);
 128   }
 129
 130   /**
 131    * sets the moving object's bbox to a specific size. Be careful when
 132    * using this function. There are no collision detection checks performed
 133    * here so bad things could happen.
 134    */
 135   virtual void set_size(float w, float h)
 136   {
 137     dest.set_size(w, h);
 138     bbox.set_size(w, h);
 139   }
 140
 141   CollisionGroup get_group() const
 142   {
 143     return group;
 144   }
 145
 146   void set_group(CollisionGroup group)
 147   {
 148     this->group = group;
 149   }
 150
 151 protected:
 152   friend class Sector;
 153   friend class CollisionGrid;
 154   friend class Platform;
 155
 156   /** The bounding box of the object (as used for collision detection, this
 157    * isn't necessarily the bounding box for graphics)
 158    */
 159   Rect bbox;
 160   /** The movement that will happen till next frame
 161    */
 162   Vector movement;
 163   /** The collision group */
 164   CollisionGroup group;
 165
 166 private:
 167   /**
 168    * this is only here for internal collision detection use (don't touch this
 169    * from outside collision detection code)
 170    *
 171    * This field holds the currently anticipated destination of the object
 172    * during collision detection
 173    */
 174   Rect dest;
 175 };
 176
 177 #endif