angular-only hinge updated
[blender.git] / extern / bullet2 / src / BulletDynamics / ConstraintSolver / btSequentialImpulseConstraintSolver.h
1 /*
2 Bullet Continuous Collision Detection and Physics Library
3 Copyright (c) 2003-2006 Erwin Coumans  http://continuousphysics.com/Bullet/
4
5 This software is provided 'as-is', without any express or implied warranty.
6 In no event will the authors be held liable for any damages arising from the use of this software.
7 Permission is granted to anyone to use this software for any purpose, 
8 including commercial applications, and to alter it and redistribute it freely, 
9 subject to the following restrictions:
10
11 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
12 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
13 3. This notice may not be removed or altered from any source distribution.
14 */
15
16 #ifndef SEQUENTIAL_IMPULSE_CONSTRAINT_SOLVER_H
17 #define SEQUENTIAL_IMPULSE_CONSTRAINT_SOLVER_H
18
19 #include "btConstraintSolver.h"
20 class btIDebugDraw;
21
22 #include "btContactConstraint.h"
23         
24
25
26 /// btSequentialImpulseConstraintSolver uses a Propagation Method and Sequentially applies impulses
27 /// The approach is the 3D version of Erin Catto's GDC 2006 tutorial. See http://www.gphysics.com
28 /// Although Sequential Impulse is more intuitive, it is mathematically equivalent to Projected Successive Overrelaxation (iterative LCP)
29 /// Applies impulses for combined restitution and penetration recovery and to simulate friction
30 class btSequentialImpulseConstraintSolver : public btConstraintSolver
31 {
32
33 protected:
34         float solve(btRigidBody* body0,btRigidBody* body1, btManifoldPoint& cp, const btContactSolverInfo& info,int iter,btIDebugDraw* debugDrawer);
35         float solveFriction(btRigidBody* body0,btRigidBody* body1, btManifoldPoint& cp, const btContactSolverInfo& info,int iter,btIDebugDraw* debugDrawer);
36         void  prepareConstraints(btPersistentManifold* manifoldPtr, const btContactSolverInfo& info,btIDebugDraw* debugDrawer);
37
38         ContactSolverFunc m_contactDispatch[MAX_CONTACT_SOLVER_TYPES][MAX_CONTACT_SOLVER_TYPES];
39         ContactSolverFunc m_frictionDispatch[MAX_CONTACT_SOLVER_TYPES][MAX_CONTACT_SOLVER_TYPES];
40
41         //choose between several modes, different friction model etc.
42         int     m_solverMode;
43
44 public:
45
46         enum    eSolverMode
47         {
48                 SOLVER_RANDMIZE_ORDER = 1,
49                 SOLVER_FRICTION_SEPARATE = 2,
50                 SOLVER_USE_WARMSTARTING = 4
51         };
52
53         btSequentialImpulseConstraintSolver();
54
55         ///Advanced: Override the default contact solving function for contacts, for certain types of rigidbody
56         ///See btRigidBody::m_contactSolverType and btRigidBody::m_frictionSolverType
57         void    setContactSolverFunc(ContactSolverFunc func,int type0,int type1)
58         {
59                 m_contactDispatch[type0][type1] = func;
60         }
61         
62         ///Advanced: Override the default friction solving function for contacts, for certain types of rigidbody
63         ///See btRigidBody::m_contactSolverType and btRigidBody::m_frictionSolverType
64         void    SetFrictionSolverFunc(ContactSolverFunc func,int type0,int type1)
65         {
66                 m_frictionDispatch[type0][type1] = func;
67         }
68
69         virtual ~btSequentialImpulseConstraintSolver() {}
70         
71         virtual float solveGroup(btPersistentManifold** manifold,int numManifolds,const btContactSolverInfo& info, btIDebugDraw* debugDrawer=0);
72
73         void    setSolverMode(int mode)
74         {
75                 m_solverMode = mode;
76         }
77
78         int     getSolverMode() const
79         {
80                 return m_solverMode;
81         }
82 };
83
84 /// Small variation on btSequentialImpulseConstraintSolver: warmstarting, separate friction, non-randomized ordering
85 class btSequentialImpulseConstraintSolver2 : public btSequentialImpulseConstraintSolver
86 {
87 public:
88
89         btSequentialImpulseConstraintSolver2();
90
91         virtual float solveGroup(btPersistentManifold** manifold,int numManifolds,const btContactSolverInfo& info, btIDebugDraw* debugDrawer=0);
92
93
94 };
95
96
97 #endif //SEQUENTIAL_IMPULSE_CONSTRAINT_SOLVER_H
98