engines/engine_physics.h

   1 #ifndef ENGINE_PHYSICS
   2 #define ENGINE_PHYSICS
   3
   4 /*!
   5  * \file engine_physics.h
   6  * \brief Module in charge of computing the physic of the game
   7  * \author Guélaud Lepetit
   8  */
   9
  10 #include <cmath>
  11 #include "box.h"
  12 #include "entity.h"
  13
  14 /*!
  15  * \namespace engine
  16  *
  17  * Namespace containing the "game engine" side of the project as a library
  18  */
  19 namespace engine
  20 {
  21     /*!
  22      * \class Engine_physics
  23      * \brief The module on charge of calculating the physic of the game
  24      *
  25      * In particular, calculation of collision between 2 game objects
  26      * And moving a game object
  27      *
  28      */
  29     class Engine_physics
  30     {
  31     public:
  32         /*!
  33          * \brief Tests if two game objects are colliding
  34          * \param e1 First game object
  35          * \param e2 Second game object
  36          * \return true if and only if there both have a collider and are in contact
  37          */
  38         static bool is_collision(Entity &e1, Entity &e2);
  39
  40     };
  41 }
  42
  43 #endif // ENGINE_PHYSICS