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