* make BulletSoftBody own small lib to make sure bullet libs don't grow too large...
[blender-staging.git] / intern / iksolver / extern / IK_solver.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /**
31
32  * $Id$
33  * Copyright (C) 2001 NaN Technologies B.V.
34  *
35  * @author Laurence, Brecht
36  * @mainpage IK - Blender inverse kinematics module.
37  *
38  * @section about About the IK module
39  *
40  * This module allows you to create segments and form them into 
41  * tree. You can then define a goal points that the end of a given 
42  * segment should attempt to reach - an inverse kinematic problem.
43  * This module will then modify the segments in the tree in order
44  * to get the as near as possible to the goal. This solver uses an
45  * inverse jacobian method to find a solution.
46  * 
47  * @section issues Known issues with this IK solver.
48  *
49  * - There is currently no support for joint constraints in the
50  * solver. This is within the realms of possibility - please ask
51  * if this functionality is required.
52  * - The solver is slow, inverse jacobian methods in general give
53  * 'smooth' solutions and the method is also very flexible, it 
54  * does not rely on specific angle parameterization and can be 
55  * extended to deal with different joint types and joint 
56  * constraints. However it is not suitable for real time use. 
57  * Other algorithms exist which are more suitable for real-time
58  * applications, please ask if this functionality is required.     
59  * 
60  * @section dependencies Dependencies
61  * 
62  * This module only depends on Moto.
63  */
64
65 #ifndef NAN_INCLUDED_IK_solver_h
66 #define NAN_INCLUDED_IK_solver_h
67
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71
72 /**
73  * Typical order of calls for solving an IK problem:
74  *
75  * - create number of IK_Segment's and set their parents and transforms
76  * - create an IK_Solver
77  * - set a number of goals for the IK_Solver to solve
78  * - call IK_Solve
79  * - free the IK_Solver
80  * - get basis and translation changes from segments
81  * - free all segments
82  */
83
84 /**
85  * IK_Segment defines a single segment of an IK tree. 
86  * - Individual segments are always defined in local coordinates.
87  * - The segment is assumed to be oriented in the local 
88  *   y-direction.
89  * - start is the start of the segment relative to the end 
90  *   of the parent segment.
91  * - rest_basis is a column major matrix defineding the rest
92  *   position (w.r.t. which the limits are defined), must
93  *   be a pure rotation
94  * - basis is a column major matrix defining the current change
95  *   from the rest basis, must be a pure rotation
96  * - length is the length of the bone.  
97  *
98  * - basis_change and translation_change respectively define
99  *   the change in rotation or translation. basis_change is a
100  *   column major 3x3 matrix.
101  *
102  * The local transformation is then defined as:
103  * start * rest_basis * basis * basis_change * translation_change * translate(0,length,0) 
104  *
105  */
106
107 typedef void IK_Segment;
108
109 enum IK_SegmentFlag {
110         IK_XDOF = 1,
111         IK_YDOF = 2,
112         IK_ZDOF = 4,
113         IK_TRANS_XDOF = 8,
114         IK_TRANS_YDOF = 16,
115         IK_TRANS_ZDOF = 32
116 };
117
118 typedef enum IK_SegmentAxis {
119         IK_X = 0,
120         IK_Y = 1,
121         IK_Z = 2,
122         IK_TRANS_X = 3,
123         IK_TRANS_Y = 4,
124         IK_TRANS_Z = 5
125 } IK_SegmentAxis;
126
127 extern IK_Segment *IK_CreateSegment(int flag);
128 extern void IK_FreeSegment(IK_Segment *seg);
129
130 extern void IK_SetParent(IK_Segment *seg, IK_Segment *parent);
131 extern void IK_SetTransform(IK_Segment *seg, float start[3], float rest_basis[][3], float basis[][3], float length);
132 extern void IK_SetLimit(IK_Segment *seg, IK_SegmentAxis axis, float lmin, float lmax);
133 extern void IK_SetStiffness(IK_Segment *seg, IK_SegmentAxis axis, float stiffness);
134
135 extern void IK_GetBasisChange(IK_Segment *seg, float basis_change[][3]);
136 extern void IK_GetTranslationChange(IK_Segment *seg, float *translation_change);
137
138 /**
139  * An IK_Solver must be created to be able to execute the solver.
140  * 
141  * An arbitray number of goals can be created, stating that a given
142  * end effector must have a given position or rotation. If multiple
143  * goals are specified, they can be weighted (range 0..1) to get
144  * some control over their importance.
145  * 
146  * IK_Solve will execute the solver, that will run until either the
147  * system converges, or a maximum number of iterations is reached.
148  * It returns 1 if the system converged, 0 otherwise.
149  */ 
150
151 typedef void IK_Solver;
152
153 IK_Solver *IK_CreateSolver(IK_Segment *root);
154 void IK_FreeSolver(IK_Solver *solver);
155
156 void IK_SolverAddGoal(IK_Solver *solver, IK_Segment *tip, float goal[3], float weight);
157 void IK_SolverAddGoalOrientation(IK_Solver *solver, IK_Segment *tip, float goal[][3], float weight);
158 void IK_SolverSetPoleVectorConstraint(IK_Solver *solver, IK_Segment *tip, float goal[3], float polegoal[3], float poleangle, int getangle);
159 float IK_SolverGetPoleAngle(IK_Solver *solver);
160
161 int IK_Solve(IK_Solver *solver, float tolerance, int max_iterations);
162
163
164 #ifdef __cplusplus
165 }
166 #endif
167
168 #endif // NAN_INCLUDED_IK_solver_h
169