e59958f060c8f7be83a62173a8dcccf2c430b4b7
[blender.git] / intern / iksolver / intern / IK_QJacobianSolver.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Original Author: Laurence
25  * Contributor(s): Brecht
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef NAN_INCLUDED_IK_QJacobianSolver_h
31
32 #define NAN_INCLUDED_IK_QJacobianSolver_h
33
34 /**
35  * @author Laurence Bourn
36  * @date 28/6/2001
37  */
38
39 #include <vector>
40 #include <list>
41
42 #include "MT_Vector3.h"
43 #include "MT_Transform.h"
44 #include "IK_QJacobian.h"
45 #include "IK_QSegment.h"
46 #include "IK_QTask.h"
47
48 class IK_QJacobianSolver
49 {
50 public:
51         IK_QJacobianSolver();
52         ~IK_QJacobianSolver() {};
53
54         // setup pole vector constraint
55         void SetPoleVectorConstraint(IK_QSegment *tip, MT_Vector3& goal,
56                 MT_Vector3& polegoal, float poleangle, bool getangle);
57         float GetPoleAngle() { return m_poleangle; };
58
59         // call setup once before solving, if it fails don't solve
60         bool Setup(IK_QSegment *root, std::list<IK_QTask*>& tasks);
61
62         // returns true if converged, false if max number of iterations was used
63         bool Solve(
64                 IK_QSegment *root,
65                 std::list<IK_QTask*> tasks,
66                 const MT_Scalar tolerance,
67                 const int max_iterations
68         );
69
70 private:
71         void AddSegmentList(IK_QSegment *seg);
72         bool UpdateAngles(MT_Scalar& norm);
73         void ConstrainPoleVector(IK_QSegment *root, std::list<IK_QTask*>& tasks);
74
75         MT_Scalar ComputeScale();
76         void Scale(float scale, std::list<IK_QTask*>& tasks);
77
78 private:
79
80         IK_QJacobian m_jacobian;
81         IK_QJacobian m_jacobian_sub;
82
83         bool m_secondary_enabled;
84
85         std::vector<IK_QSegment*> m_segments;
86
87         MT_Transform m_rootmatrix;
88
89         bool m_poleconstraint;
90         bool m_getpoleangle;
91         MT_Vector3 m_goal;
92         MT_Vector3 m_polegoal;
93         float m_poleangle;
94         IK_QSegment *m_poletip;
95 };
96
97 #endif
98