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