src/moving_object.hpp

   1 //  $Id: moving_object.h 2295 2005-03-30 01:52:14Z matzebraun $
   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 #ifndef SUPERTUX_MOVING_OBJECT_H
  20 #define SUPERTUX_MOVING_OBJECT_H
  21
  22 #include "game_object.hpp"
  23 #include "collision_hit.hpp"
  24 #include "math/vector.hpp"
  25 #include "math/rect.hpp"
  26
  27 class Sector;
  28 class CollisionGrid;
  29
  30 enum CollisionGroup {
  31   COLGROUP_DISABLED,
  32   COLGROUP_MOVING,
  33   // moving object but don't collide against other moving objects
  34   COLGROUP_MOVING_ONLY_STATIC,
  35   COLGROUP_STATIC,
  36   COLGROUP_MOVINGSTATIC,
  37   COLGROUP_TOUCHABLE,
  38
  39   COLGROUP_TILEMAP /* not really used at the moment */
  40 };
  41
  42 /**
  43  * Base class for all dynamic/moving game objects. This class contains things
  44  * for handling the bounding boxes and collision feedback.
  45  */
  46 class MovingObject : public GameObject
  47 {
  48 public:
  49   MovingObject();
  50   virtual ~MovingObject();
  51
  52   /** this function is called when the object collided with any other object
  53    */
  54   virtual HitResponse collision(GameObject& other,
  55                                 const CollisionHit& hit) = 0;
  56   /** called when tiles with special attributes have been touched */
  57   virtual void collision_tile(uint32_t tile_attributes)
  58   {
  59     (void) tile_attributes;
  60   }
  61
  62   const Vector& get_pos() const
  63   {
  64     return bbox.p1;
  65   }
  66
  67   /** returns the bounding box of the Object */
  68   const Rect& get_bbox() const
  69   {
  70     return bbox;
  71   }
  72
  73   const Vector& get_movement() const
  74   {
  75     return movement;
  76   }
  77
  78   /** places the moving object at a specific position. Be carefull when
  79    * using this function. There are no collision detection checks performed
  80    * here so bad things could happen.
  81    */
  82   virtual void set_pos(const Vector& pos)
  83   {
  84     bbox.set_pos(pos);
  85   }
  86
  87   CollisionGroup get_group() const
  88   {
  89     return group;
  90   }
  91
  92   void set_group(CollisionGroup group)
  93   {
  94     this->group = group;
  95   }
  96
  97 protected:
  98   friend class Sector;
  99   friend class CollisionGrid;
 100   friend class Platform;
 101
 102   /** The bounding box of the object (as used for collision detection, this
 103    * isn't necessarily the bounding box for graphics)
 104    */
 105   Rect bbox;
 106   /** The movement that will happen till next frame
 107    */
 108   Vector movement;
 109   /** The collision group */
 110   CollisionGroup group;
 111 };
 112
 113 #endif