source: orxonox.OLD/branches/scriptimprovements/src/lib/collision_reaction/cr_engine.h @ 10596

/*!
 * @file cr_engine.h
 * @brief The collision reaction engine, defining generic collision reactions to collision events
 *
 * some parts of this module are tuned for efficiency. They are probably not self-explenatory anymore :D
 *  - Collision/ CollisionEvent objects recycling: This class contains a class of precached objects of these types
 *      they are used for fast registration of collision events: These objects can be get by the interface functions and
 *      are returned after one cycle automaticly by reseting the cached lists to its initial state. So do not wonder :D
 */

#ifndef _CR_ENGINE_
#define _CR_ENGINE_

#include "base_object.h"

#include <vector>

class WorldEntity;


namespace CoRe
{
  class Collision;
  class CollisionEvent;
  class CollisionReaction;


  //! A default singleton class.
  class CREngine : public BaseObject
  {
    ObjectListDeclaration(CREngine);

    typedef std::vector<CollisionEvent*>             CollisionEventVector;
    typedef std::vector<Collision*>                  CollisionVector;
    typedef std::vector<Collision*>::iterator        CollisionIterator;
    typedef std::vector<CollisionEvent*>::iterator   CollisionEventIterator;


  public:
    typedef enum ReactionType {
      CR_PHYSICS_MOMENTUM   = 0,           //!< physical reaction: conservervation of momentum
      CR_PHYSICS_STEP_BACK,                //!< physical reaction: just go to the last position without collisions
      CR_PHYSICS_GROUND_WALK,              //!< physical reaction: stand on the ground, no movement: simple normal force away from the gravity force
      CR_PHYSICS_FULL_WALK,                //!< physical reaction: walking on the ground (inkl. hills etc)
      CR_PHYSICS_DAMAGE,                   //!< physical reaction: daling damage according to the object energy and their structural stability

      CR_OBJECT_DAMAGE,                    //!< object raction: deals damage according to the objects specific damage potential (like weapons, nukes, etc.)
      CR_OBJECT_PICKUP,                    //!< object rection: calling the objects pickup functions, let them handle the collision (once!)

      CR_VERTEX_TRAFO,                     //!< vertex trafo: transforming the vertex according to the damage

      CR_SPECIAL_CALLBACK,                 //!< special: call a callback function

      CR_NUMBER
    };

    typedef enum CollisionType {
      CR_COLLISION_TYPE_AXIS_X       = 0,  //!< collision on x axis
      CR_COLLISION_TYPE_AXIS_X_NEG,        //!< collision on negative x axis
      CR_COLLISION_TYPE_AXIS_Y,            //!< collision on y axis
      CR_COLLISION_TYPE_AXIS_Y_NEG,        //!< collision on negative y axis
      CR_COLLISION_TYPE_AXIS_Z,            //!< collision on z axis
      CR_COLLISION_TYPE_AXIS_Z_NEG,        //!< collision on negative z axis
      CR_COLLISION_TYPE_OBB,               //!< object aligned bounding box collide

      CR_COLLISION_TYPE_NUMBER
    };


    virtual ~CREngine(void);

    /** @returns a Pointer to the only object of this Class */
    inline static CREngine* getInstance() { if (!singletonRef) singletonRef = new CREngine();  return singletonRef; };

    Collision* popCollisionObject();
    CollisionEvent* popCollisionEventObject();

    void handleCollisions();

    void debug();


  private:
    CREngine();
    void init();

    void reset();


  private:
    static CREngine*                    singletonRef;             //!< the reference to the CREngine object (singleton)

    CollisionVector                     collisionsUsed;           //!< a list of used, cached collisions
    CollisionVector                     collisionsUnused;         //!< a list of unused, cached collisions

    CollisionEventVector                collisionEventsUsed;      //!< a list of used, cached collision events
    CollisionEventVector                collisionEventsUnused;    //!< a list of unused, cached collision events

    CollisionReaction*                  _reactionList[CREngine::CR_NUMBER];  //!< the collision reaction list containing all reactions types


  };

}
#endif /* _CR_ENGINE_ */