lib/math/physic.h

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.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
  19 //  02111-1307, USA.
  20
  21 #ifndef SUPERTUX_PHYSIC_H
  22 #define SUPERTUX_PHYSIC_H
  23
  24 #include "math/vector.h"
  25
  26 /// Physics engine.
  27 /** This is a very simplistic physics engine handling accelerated and constant
  28   * movement along with gravity.
  29   */
  30 class Physic
  31 {
  32 public:
  33     Physic();
  34     ~Physic();
  35
  36     /// Resets all velocities and accelerations to 0.
  37     void reset();
  38
  39     /// Sets velocity to a fixed value.
  40     void set_velocity(float vx, float vy);
  41
  42     void set_velocity_x(float vx);
  43     void set_velocity_y(float vy);
  44
  45     /// Velocities invertion.
  46     void inverse_velocity_x();
  47     void inverse_velocity_y();
  48
  49     float get_velocity_x();
  50     float get_velocity_y();
  51
  52     /// Set acceleration.
  53     /** Sets acceleration applied to the object. (Note that gravity is
  54      * eventually added to the vertical acceleration)
  55      */
  56     void set_acceleration(float ax, float ay);
  57
  58     void set_acceleration_x(float ax);
  59     void set_acceleration_y(float ay);
  60
  61     float get_acceleration_x();
  62     float get_acceleration_y();
  63
  64     /// Enables or disables handling of gravity.
  65     void enable_gravity(bool gravity_enabled);
  66
  67     /// Applies the physical simulation to given x and y coordinates.
  68     void apply(float frame_ratio, float &x, float &y, float& gravity = 10);
  69
  70     /// applies the physical simulation to given x and y coordinates.
  71     void apply(Vector& vector, float frame_ratio, float& gravity = 10);
  72
  73 private:
  74     /// horizontal and vertical acceleration
  75     float ax, ay;
  76     /// horizontal and vertical velocity
  77     float vx, vy;
  78     /// should we respect gravity in out calculations?
  79     bool gravity_enabled;
  80 };
  81
  82 #endif /*SUPERTUX_PHYSIC_H*/