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