lib/special/collision_hit.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 #ifndef SUPERTUX_COLLISION_HIT_H
  20 #define SUPERTUX_COLLISION_HIT_H
  21
  22 #include "math/vector.h"
  23
  24 namespace SuperTux
  25 {
  26
  27 /**
  28  * Used as return value for the collision functions, to indicate how the
  29  * collision should be handled
  30  */
  31 enum HitResponse
  32 {
  33   // note: keep the elements in this order
  34
  35   /// don't move the object
  36   ABORT_MOVE = 0,
  37   /// move object out of collision and check for collisions again
  38   /// if this happens to often then the move will just be aborted
  39   CONTINUE,
  40   /// do the move ignoring the collision
  41   FORCE_MOVE
  42 };
  43
  44 /**
  45  * This class collects data about a collision
  46  */
  47 class CollisionHit
  48 {
  49 public:
  50   /// penetration depth
  51   float depth;
  52   /// time of the collision (between 0 and 1 in relation to movement)
  53   float time;
  54   /// The normal of the side we collided with
  55   Vector normal;
  56 };
  57
  58 }
  59
  60 #endif
  61