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 something solid */
  84   virtual void collision_solid(const CollisionHit& hit)
  85   {
  86     (void) hit;
  87   }
  88   /** this function is called when the object collided with any other object */
  89   virtual HitResponse collision(GameObject& other, const CollisionHit& hit) = 0;
  90   /** called when tiles with special attributes have been touched */
  91   virtual void collision_tile(uint32_t tile_attributes)
  92   {
  93     (void) tile_attributes;
  94   }
  95
  96   const Vector& get_pos() const
  97   {
  98     return bbox.p1;
  99   }
 100
 101   /** returns the bounding box of the Object */
 102   const Rect& get_bbox() const
 103   {
 104     return bbox;
 105   }
 106
 107   const Vector& get_movement() const
 108   {
 109     return movement;
 110   }
 111
 112   /** places the moving object at a specific position. Be carefull when
 113    * using this function. There are no collision detection checks performed
 114    * here so bad things could happen.
 115    */
 116   virtual void set_pos(const Vector& pos)
 117   {
 118     dest.move(pos-get_pos());
 119     bbox.set_pos(pos);
 120   }
 121
 122   /**
 123    * sets the moving object's bbox to a specific width. Be careful when
 124    * using this function. There are no collision detection checks performed
 125    * here so bad things could happen.
 126    */
 127   virtual void set_width(float w)
 128   {
 129     dest.set_width(w);
 130     bbox.set_width(w);
 131   }
 132
 133   /**
 134    * sets the moving object's bbox to a specific size. Be careful when
 135    * using this function. There are no collision detection checks performed
 136    * here so bad things could happen.
 137    */
 138   virtual void set_size(float w, float h)
 139   {
 140     dest.set_size(w, h);
 141     bbox.set_size(w, h);
 142   }
 143
 144   CollisionGroup get_group() const
 145   {
 146     return group;
 147   }
 148
 149   void set_group(CollisionGroup group)
 150   {
 151     this->group = group;
 152   }
 153
 154 protected:
 155   friend class Sector;
 156   friend class CollisionGrid;
 157   friend class Platform;
 158
 159   /** The bounding box of the object (as used for collision detection, this
 160    * isn't necessarily the bounding box for graphics)
 161    */
 162   Rect bbox;
 163   /** The movement that will happen till next frame
 164    */
 165   Vector movement;
 166   /** The collision group */
 167   CollisionGroup group;
 168
 169 private:
 170   /**
 171    * this is only here for internal collision detection use (don't touch this
 172    * from outside collision detection code)
 173    *
 174    * This field holds the currently anticipated destination of the object
 175    * during collision detection
 176    */
 177   Rect dest;
 178 };
 179
 180 #endif