lib/special/moving_object.h

   1 //  $Id$
   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
  20 #ifndef SUPERTUX_MOVING_OBJECT_H
  21 #define SUPERTUX_MOVING_OBJECT_H
  22
  23 #include "game_object.h"
  24 #include "collision_hit.h"
  25 #include "math/vector.h"
  26 #include "math/rectangle.h"
  27
  28 class Sector;
  29 class CollisionGrid;
  30
  31 namespace SuperTux
  32   {
  33
  34   /**
  35    * Base class for all dynamic/moving game objects. This class contains things
  36    * for handling the bounding boxes and collision feedback.
  37    */
  38   class MovingObject : public GameObject
  39     {
  40     public:
  41       MovingObject();
  42       virtual ~MovingObject();
  43
  44       /** this function is called when the object collided with any other object
  45        */
  46       virtual HitResponse collision(GameObject& other,
  47           const CollisionHit& hit) = 0;
  48
  49       const Vector& get_pos() const
  50         {
  51           return bbox.p1;
  52         }
  53
  54       /** returns the bounding box of the Object */
  55       const Rectangle& get_bbox() const
  56       {
  57         return bbox;
  58       }
  59
  60       const Vector& get_movement() const
  61       {
  62         return movement;
  63       }
  64
  65     protected:
  66       friend class Sector;
  67       friend class CollisionGrid;
  68
  69       /** The bounding box of the object (as used for collision detection, this
  70        * isn't necessarily the bounding box for graphics)
  71        */
  72       Rectangle bbox;
  73       /** The movement that will happen till next frame
  74        */
  75       Vector movement;
  76     };
  77
  78 } //namespace SuperTux
  79
  80 #endif /*SUPERTUX_MOVING_OBJECT_H*/
  81