src/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 /** This is a very simplistic physics engine handling accelerated and constant
  25   * movement along with gravity.
  26   */
  27 class Physic
  28 {
  29 public:
  30     Physic();
  31     ~Physic();
  32
  33     /** resets all velocities and accelerations to 0 */
  34     void reset();
  35
  36     /** sets velocity to a fixed value */
  37     void set_velocity(float vx, float vy);
  38
  39     void set_velocity_x(float vx);
  40     void set_velocity_y(float vy);
  41
  42     /** velocities invertion */
  43     void inverse_velocity_x();
  44     void inverse_velocity_y();
  45
  46     float get_velocity_x();
  47     float get_velocity_y();
  48
  49     /** sets acceleration applied to the object. (Note that gravity is
  50      * eventually added to the vertical acceleration)
  51      */
  52     void set_acceleration(float ax, float ay);
  53
  54     void set_acceleration_x(float ax);
  55     void set_acceleration_y(float ay);
  56
  57     float get_acceleration_x();
  58     float get_acceleration_y();
  59
  60     /** enables or disables handling of gravity */
  61     void enable_gravity(bool gravity_enabled);
  62
  63     /** applies the physical simulation to given x and y coordinates */
  64     void apply(float frame_ratio, float &x, float &y);
  65
  66 private:
  67     /// horizontal and vertical acceleration
  68     float ax, ay;
  69     /// horizontal and vertical velocity
  70     float vx, vy;
  71     /// should we respect gravity in out calculations?
  72     bool gravity_enabled;
  73 };
  74
  75 #endif /*SUPERTUX_PHYSIC_H*/