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   COLGROUP_STATIC,
  34   COLGROUP_MOVINGSTATIC,
  35   COLGROUP_TOUCHABLE,
  36
  37   COLGROUP_TILEMAP /* not really used at the moment */
  38 };
  39
  40 /**
  41  * Base class for all dynamic/moving game objects. This class contains things
  42  * for handling the bounding boxes and collision feedback.
  43  */
  44 class MovingObject : public GameObject
  45 {
  46 public:
  47   MovingObject();
  48   virtual ~MovingObject();
  49
  50   /** this function is called when the object collided with any other object
  51    */
  52   virtual HitResponse collision(GameObject& other,
  53                                 const CollisionHit& hit) = 0;
  54
  55   const Vector& get_pos() const
  56   {
  57     return bbox.p1;
  58   }
  59
  60   /** returns the bounding box of the Object */
  61   const Rect& get_bbox() const
  62   {
  63     return bbox;
  64   }
  65
  66   const Vector& get_movement() const
  67   {
  68     return movement;
  69   }
  70
  71   /** places the moving object at a specific position. Be carefull when
  72    * using this function. There are no collision detection checks performed
  73    * here so bad things could happen.
  74    */
  75   virtual void set_pos(const Vector& pos)
  76   {
  77     bbox.set_pos(pos);
  78   }
  79
  80   CollisionGroup get_group() const
  81   {
  82     return group;
  83   }
  84
  85   void set_group(CollisionGroup group)
  86   {
  87     this->group = group;
  88   }
  89
  90 protected:
  91   friend class Sector;
  92   friend class CollisionGrid;
  93   friend class Platform;
  94
  95   /** The bounding box of the object (as used for collision detection, this
  96    * isn't necessarily the bounding box for graphics)
  97    */
  98   Rect bbox;
  99   /** The movement that will happen till next frame
 100    */
 101   Vector movement;
 102   /** The collision group */
 103   CollisionGroup group;
 104 };
 105
 106 #endif