Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/scriptimprovements/src/lib/collision_reaction/collision_event.h @ 10565

Last change on this file since 10565 was 10013, checked in by patrick, 18 years ago

merged the collision reaction branche back to trunk

File size: 3.5 KB
Line 
1/*!
2 * @file collision_event.h
3 *  Definition of a collision event
4 *
5 *  A collision event represents a collision of two bouning boxes. Every CollisionEvent belongs to a Collision object that
6 *  represents the collision of two WorldEntities.
7 *
8 *  There are different types of collisions: obb collisions and bsp collisions. Both collision types use different techniques
9 *  to represent collisions. This is why this class saves bounding boxes from the OBB as well as the planes from BSP.
10 */
11
12#ifndef _COLLISION_EVENT_H
13#define _COLLISION_EVENT_H
14
15#include "vector.h"
16#include "cr_engine.h"
17
18#include "cr_defs.h"
19
20
21class WorldEntity;
22class BoundingVolume;
23class Plane;
24
25namespace CoRe
26{
27
28  //! A class representing a simple collision
29  class CollisionEvent
30  {
31  public:
32    CollisionEvent();
33    virtual ~CollisionEvent();
34
35    /** collides two WorldEntities @param entityA world entity A, @param entityB world entity B, @param bvA volume A @param bvB volumeB */
36    inline void collide(CREngine::CollisionType type, WorldEntity* entityA, WorldEntity* entityB, BoundingVolume* bvA, BoundingVolume* bvB)
37    { this->collisionType = type; this->entityA = entityA; this->entityB = entityB; this->bvA = bvA; this->bvB = bvB; }
38    /** collides two WorldEntities @param entity world entity , @param ground ground plane, @param position position on the ground */
39    inline void collide(CREngine::CollisionType type, WorldEntity* entity, WorldEntity* groundEntity, Vector normal, Vector position, bool bInWall)
40    {
41      this->collisionType = type;
42      this->entityA = entity;
43      this->entityB = groundEntity;
44      this->groundNormal = normal;
45      this->position = position;
46      this->bInWall = bInWall;
47    }
48
49
50    /** @return CollisionEvent WorldEntity A */
51    inline const WorldEntity* getEntityA() const  { return this->entityA; }
52    /** @return CollisionEvent WorldEntity B */
53    inline const WorldEntity* getEntityB() const  { return this->entityB; }
54    /** @return Bounding Volume from EntityA */
55    inline const BoundingVolume* getBVA() const { return this->bvA; }
56    /** @return Bounding Volume from EntityB */
57    inline const BoundingVolume* getBVB() const {  return this->bvB;  }
58
59    /** @return ground plane if collided with bsp model */
60    inline const Vector& getGroundNormal() const  { return this->groundNormal; }
61
62    /** @return position of the position, only accurate if this is a collision with the ground!!! */
63    inline const Vector& getCollisionPosition() const  {  return this->position;  }
64
65    /** @return the type of the collision */
66    inline int getType() const  {  return this->collisionType;  }
67
68    /** @return true if the entity is in the wall */
69    inline bool isInWall() const  {  return this->bInWall;  }
70
71
72  private:
73    WorldEntity*      entityA;                       //!< the collision body A
74    WorldEntity*      entityB;                       //!< the collision body B
75
76    BoundingVolume*   bvA;                           //!< reference to the bounding volume A
77    BoundingVolume*   bvB;                           //!< reference to the bounding volume B
78
79    Vector            groundNormal;                  //!< the ground plane with which it collides (only for bsp-model collisions
80    Vector            position;                      //!< position of the collision on the ground plane
81
82    bool              bInWall;                       //!< true if is in wall
83    int               collisionType;                 //!< collision type
84  };
85
86}
87#endif /* _COLLISION_EVENT_H */
Note: See TracBrowser for help on using the repository browser.