angular-only hinge updated
[blender.git] / extern / bullet2 / src / BulletDynamics / ConstraintSolver / btGeneric6DofConstraint.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 GENERIC_6DOF_CONSTRAINT_H
17 #define GENERIC_6DOF_CONSTRAINT_H
18
19 #include "LinearMath/btVector3.h"
20
21 #include "BulletDynamics/ConstraintSolver/btJacobianEntry.h"
22 #include "btTypedConstraint.h"
23
24 class btRigidBody;
25
26
27
28 /// btGeneric6DofConstraint between two rigidbodies each with a pivotpoint that descibes the axis location in local space
29 /// btGeneric6DofConstraint can leave any of the 6 degree of freedom 'free' or 'locked'
30 /// Work in progress (is still a Hinge actually)
31 class btGeneric6DofConstraint : public btTypedConstraint
32 {
33         btJacobianEntry m_jacLinear[3];                 // 3 orthogonal linear constraints
34         btJacobianEntry m_jacAng[3];            // 3 orthogonal angular constraints
35
36         btTransform     m_frameInA;                     // the constraint space w.r.t body A
37         btTransform     m_frameInB;                     // the constraint space w.r.t body B
38
39         btScalar      m_lowerLimit[6];  // the constraint lower limits
40         btScalar      m_upperLimit[6];  // the constraint upper limits
41
42         btScalar                m_accumulatedImpulse[6];
43
44                 
45 public:
46         btGeneric6DofConstraint(btRigidBody& rbA, btRigidBody& rbB, const btTransform& frameInA, const btTransform& frameInB );
47
48         btGeneric6DofConstraint();
49
50         virtual void    buildJacobian();
51
52         virtual void    solveConstraint(btScalar        timeStep);
53
54         void    updateRHS(btScalar      timeStep);
55
56         btScalar computeAngle(int axis) const;
57
58         void    setLinearLowerLimit(const btVector3& linearLower)
59         {
60                 m_lowerLimit[0] = linearLower.getX();
61                 m_lowerLimit[1] = linearLower.getY();
62                 m_lowerLimit[2] = linearLower.getZ();
63         }
64
65         void    setLinearUpperLimit(const btVector3& linearUpper)
66         {
67                 m_upperLimit[0] = linearUpper.getX();
68                 m_upperLimit[1] = linearUpper.getY();
69                 m_upperLimit[2] = linearUpper.getZ();
70         }
71
72         void    setAngularLowerLimit(const btVector3& angularLower)
73         {
74                 m_lowerLimit[3] = angularLower.getX();
75                 m_lowerLimit[4] = angularLower.getY();
76                 m_lowerLimit[5] = angularLower.getZ();
77         }
78
79         void    setAngularUpperLimit(const btVector3& angularUpper)
80         {
81                 m_upperLimit[3] = angularUpper.getX();
82                 m_upperLimit[4] = angularUpper.getY();
83                 m_upperLimit[5] = angularUpper.getZ();
84         }
85
86         //first 3 are linear, next 3 are angular
87         void SetLimit(int axis, btScalar lo, btScalar hi)
88         {
89                 m_lowerLimit[axis] = lo; 
90                 m_upperLimit[axis] = hi; 
91         }
92
93         //free means upper < lower, 
94         //locked means upper == lower
95         //limited means upper > lower
96         //limitIndex: first 3 are linear, next 3 are angular
97         bool    isLimited(int limitIndex)
98         {
99                 return (m_upperLimit[limitIndex] >= m_lowerLimit[limitIndex]);
100         }
101
102         const btRigidBody& getRigidBodyA() const
103         {
104                 return m_rbA;
105         }
106         const btRigidBody& getRigidBodyB() const
107         {
108                 return m_rbB;
109         }
110         
111
112 };
113
114 #endif //GENERIC_6DOF_CONSTRAINT_H