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