ClangFormat: apply to source, most of intern
[blender.git] / intern / iksolver / extern / IK_solver.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  * Original author: Laurence
19  */
20
21 /** \file
22  * \ingroup iksolver
23  */
24
25 /**
26  * \page IK - Blender inverse kinematics module.
27  *
28  * \section about About the IK module
29  *
30  * This module allows you to create segments and form them into
31  * tree. You can then define a goal points that the end of a given
32  * segment should attempt to reach - an inverse kinematic problem.
33  * This module will then modify the segments in the tree in order
34  * to get the as near as possible to the goal. This solver uses an
35  * inverse jacobian method to find a solution.
36  *
37  * \section issues Known issues with this IK solver.
38  *
39  * - There is currently no support for joint constraints in the
40  * solver. This is within the realms of possibility - please ask
41  * if this functionality is required.
42  * - The solver is slow, inverse jacobian methods in general give
43  * 'smooth' solutions and the method is also very flexible, it
44  * does not rely on specific angle parameterization and can be
45  * extended to deal with different joint types and joint
46  * constraints. However it is not suitable for real time use.
47  * Other algorithms exist which are more suitable for real-time
48  * applications, please ask if this functionality is required.
49  *
50  * \section dependencies Dependencies
51  *
52  * This module only depends on Moto.
53  */
54
55 #ifndef __IK_SOLVER_H__
56 #define __IK_SOLVER_H__
57
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61
62 /**
63  * Typical order of calls for solving an IK problem:
64  *
65  * - create number of IK_Segment's and set their parents and transforms
66  * - create an IK_Solver
67  * - set a number of goals for the IK_Solver to solve
68  * - call IK_Solve
69  * - free the IK_Solver
70  * - get basis and translation changes from segments
71  * - free all segments
72  */
73
74 /**
75  * IK_Segment defines a single segment of an IK tree.
76  * - Individual segments are always defined in local coordinates.
77  * - The segment is assumed to be oriented in the local
78  *   y-direction.
79  * - start is the start of the segment relative to the end
80  *   of the parent segment.
81  * - rest_basis is a column major matrix defineding the rest
82  *   position (w.r.t. which the limits are defined), must
83  *   be a pure rotation
84  * - basis is a column major matrix defining the current change
85  *   from the rest basis, must be a pure rotation
86  * - length is the length of the bone.
87  *
88  * - basis_change and translation_change respectively define
89  *   the change in rotation or translation. basis_change is a
90  *   column major 3x3 matrix.
91  *
92  * The local transformation is then defined as:
93  * start * rest_basis * basis * basis_change * translation_change * translate(0,length,0)
94  */
95
96 typedef void IK_Segment;
97
98 enum IK_SegmentFlag {
99   IK_XDOF = 1,
100   IK_YDOF = 2,
101   IK_ZDOF = 4,
102   IK_TRANS_XDOF = 8,
103   IK_TRANS_YDOF = 16,
104   IK_TRANS_ZDOF = 32
105 };
106
107 typedef enum IK_SegmentAxis {
108   IK_X = 0,
109   IK_Y = 1,
110   IK_Z = 2,
111   IK_TRANS_X = 3,
112   IK_TRANS_Y = 4,
113   IK_TRANS_Z = 5
114 } IK_SegmentAxis;
115
116 extern IK_Segment *IK_CreateSegment(int flag);
117 extern void IK_FreeSegment(IK_Segment *seg);
118
119 extern void IK_SetParent(IK_Segment *seg, IK_Segment *parent);
120 extern void IK_SetTransform(
121     IK_Segment *seg, float start[3], float rest_basis[][3], float basis[][3], float length);
122 extern void IK_SetLimit(IK_Segment *seg, IK_SegmentAxis axis, float lmin, float lmax);
123 extern void IK_SetStiffness(IK_Segment *seg, IK_SegmentAxis axis, float stiffness);
124
125 extern void IK_GetBasisChange(IK_Segment *seg, float basis_change[][3]);
126 extern void IK_GetTranslationChange(IK_Segment *seg, float *translation_change);
127
128 /**
129  * An IK_Solver must be created to be able to execute the solver.
130  *
131  * An arbitray number of goals can be created, stating that a given
132  * end effector must have a given position or rotation. If multiple
133  * goals are specified, they can be weighted (range 0..1) to get
134  * some control over their importance.
135  *
136  * IK_Solve will execute the solver, that will run until either the
137  * system converges, or a maximum number of iterations is reached.
138  * It returns 1 if the system converged, 0 otherwise.
139  */
140
141 typedef void IK_Solver;
142
143 IK_Solver *IK_CreateSolver(IK_Segment *root);
144 void IK_FreeSolver(IK_Solver *solver);
145
146 void IK_SolverAddGoal(IK_Solver *solver, IK_Segment *tip, float goal[3], float weight);
147 void IK_SolverAddGoalOrientation(IK_Solver *solver,
148                                  IK_Segment *tip,
149                                  float goal[][3],
150                                  float weight);
151 void IK_SolverSetPoleVectorConstraint(IK_Solver *solver,
152                                       IK_Segment *tip,
153                                       float goal[3],
154                                       float polegoal[3],
155                                       float poleangle,
156                                       int getangle);
157 float IK_SolverGetPoleAngle(IK_Solver *solver);
158
159 int IK_Solve(IK_Solver *solver, float tolerance, int max_iterations);
160
161 #define IK_STRETCH_STIFF_EPS 0.01f
162 #define IK_STRETCH_STIFF_MIN 0.001f
163 #define IK_STRETCH_STIFF_MAX 1e10
164
165 #ifdef __cplusplus
166 }
167 #endif
168
169 #endif  // __IK_SOLVER_H__