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