Merging trunk up to revision 41245.
[blender.git] / source / gameengine / Physics / common / PHY_Pro.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file PHY_Pro.h
29  *  \ingroup phys
30  */
31
32 #ifndef PHY_PROPSH
33 #define PHY_PROPSH
34
35 #include <MT_Scalar.h>
36
37 // Properties of dynamic objects
38 struct PHY_ShapeProps {
39         MT_Scalar  m_mass;                  // Total mass
40         MT_Scalar  m_inertia;               // Inertia, should be a tensor some time 
41         MT_Scalar  m_lin_drag;              // Linear drag (air, water) 0 = concrete, 1 = vacuum, inverted and called dampening in blenders UI
42         MT_Scalar  m_ang_drag;              // Angular drag, inverted and called dampening in blenders UI
43         MT_Scalar  m_friction_scaling[3];   // Scaling for anisotropic friction. Component in range [0, 1]   
44         MT_Scalar  m_clamp_vel_min;                     // Clamp the minimum velocity, this ensures an object moves at a minimum speed unless its stationary
45         MT_Scalar  m_clamp_vel_max;                     // Clamp max velocity
46         bool       m_do_anisotropic;        // Should I do anisotropic friction? 
47         bool       m_do_fh;                 // Should the object have a linear Fh spring?
48         bool       m_do_rot_fh;             // Should the object have an angular Fh spring?
49 };
50
51
52 // Properties of collidable objects (non-ghost objects)
53 struct PHY_MaterialProps {
54         MT_Scalar m_restitution;           // restitution of energie after a collision 0 = inelastic, 1 = elastic
55         MT_Scalar m_friction;              // Coulomb friction (= ratio between the normal en maximum friction force)
56         MT_Scalar m_fh_spring;             // Spring constant (both linear and angular)
57         MT_Scalar m_fh_damping;            // Damping factor (linear and angular) in range [0, 1]
58         MT_Scalar m_fh_distance;           // The range above the surface where Fh is active.    
59         bool      m_fh_normal;             // Should the object slide off slopes?
60 };
61
62 #endif //PHY_PROPSH
63