6839e13ffe17bef8a5d78fdd38225168a080bffd
[blender.git] / source / blender / blenkernel / BKE_armature.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  */
19 #ifndef __BKE_ARMATURE_H__
20 #define __BKE_ARMATURE_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 struct Bone;
27 struct Depsgraph;
28 struct GHash;
29 struct ListBase;
30 struct Main;
31 struct Object;
32 struct PoseTree;
33 struct Scene;
34 struct bArmature;
35 struct bConstraint;
36 struct bPose;
37 struct bPoseChannel;
38
39 typedef struct PoseTarget {
40   struct PoseTarget *next, *prev;
41
42   struct bConstraint *con; /* the constraint of this target */
43   int tip;                 /* index of tip pchan in PoseTree */
44 } PoseTarget;
45
46 typedef struct PoseTree {
47   struct PoseTree *next, *prev;
48
49   int type;       /* type of IK that this serves (CONSTRAINT_TYPE_KINEMATIC or ..._SPLINEIK) */
50   int totchannel; /* number of pose channels */
51
52   struct ListBase targets;     /* list of targets of the tree */
53   struct bPoseChannel **pchan; /* array of pose channels */
54   int *parent;                 /* and their parents */
55
56   float (*basis_change)[3][3]; /* basis change result from solver */
57   int iterations;              /* iterations from the constraint */
58   int stretch;                 /* disable stretching */
59 } PoseTree;
60
61 /*  Core armature functionality */
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65
66 struct bArmature *BKE_armature_add(struct Main *bmain, const char *name);
67 struct bArmature *BKE_armature_from_object(struct Object *ob);
68 int BKE_armature_bonelist_count(struct ListBase *lb);
69 void BKE_armature_bonelist_free(struct ListBase *lb);
70 void BKE_armature_free(struct bArmature *arm);
71 void BKE_armature_make_local(struct Main *bmain, struct bArmature *arm, const bool lib_local);
72 void BKE_armature_copy_data(struct Main *bmain,
73                             struct bArmature *arm_dst,
74                             const struct bArmature *arm_src,
75                             const int flag);
76 struct bArmature *BKE_armature_copy(struct Main *bmain, const struct bArmature *arm);
77
78 /* Bounding box. */
79 struct BoundBox *BKE_armature_boundbox_get(struct Object *ob);
80
81 bool BKE_pose_minmax(
82     struct Object *ob, float r_min[3], float r_max[3], bool use_hidden, bool use_select);
83
84 int bone_autoside_name(char name[64], int strip_number, short axis, float head, float tail);
85
86 struct Bone *BKE_armature_find_bone_name(struct bArmature *arm, const char *name);
87
88 void BKE_armature_bone_hash_make(struct bArmature *arm);
89 void BKE_armature_bone_hash_free(struct bArmature *arm);
90
91 bool BKE_armature_bone_flag_test_recursive(const struct Bone *bone, int flag);
92
93 float distfactor_to_bone(
94     const float vec[3], const float b1[3], const float b2[3], float r1, float r2, float rdist);
95
96 void BKE_armature_where_is(struct bArmature *arm);
97 void BKE_armature_where_is_bone(struct Bone *bone,
98                                 struct Bone *prevbone,
99                                 const bool use_recursion);
100 void BKE_pose_clear_pointers(struct bPose *pose);
101 void BKE_pose_remap_bone_pointers(struct bArmature *armature, struct bPose *pose);
102 void BKE_pchan_rebuild_bbone_handles(struct bPose *pose, struct bPoseChannel *pchan);
103 void BKE_pose_rebuild(struct Main *bmain,
104                       struct Object *ob,
105                       struct bArmature *arm,
106                       const bool do_id_user);
107 void BKE_pose_where_is(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
108 void BKE_pose_where_is_bone(struct Depsgraph *depsgraph,
109                             struct Scene *scene,
110                             struct Object *ob,
111                             struct bPoseChannel *pchan,
112                             float ctime,
113                             bool do_extra);
114 void BKE_pose_where_is_bone_tail(struct bPoseChannel *pchan);
115
116 /* get_objectspace_bone_matrix has to be removed still */
117 void get_objectspace_bone_matrix(struct Bone *bone,
118                                  float M_accumulatedMatrix[4][4],
119                                  int root,
120                                  int posed);
121 void vec_roll_to_mat3(const float vec[3], const float roll, float mat[3][3]);
122 void vec_roll_to_mat3_normalized(const float nor[3], const float roll, float mat[3][3]);
123 void mat3_to_vec_roll(const float mat[3][3], float r_vec[3], float *r_roll);
124 void mat3_vec_to_roll(const float mat[3][3], const float vec[3], float *r_roll);
125
126 /* Common Conversions Between Co-ordinate Spaces */
127 void BKE_armature_mat_world_to_pose(struct Object *ob, float inmat[4][4], float outmat[4][4]);
128 void BKE_armature_loc_world_to_pose(struct Object *ob, const float inloc[3], float outloc[3]);
129 void BKE_armature_mat_pose_to_bone(struct bPoseChannel *pchan,
130                                    float inmat[4][4],
131                                    float outmat[4][4]);
132 void BKE_armature_loc_pose_to_bone(struct bPoseChannel *pchan,
133                                    const float inloc[3],
134                                    float outloc[3]);
135 void BKE_armature_mat_bone_to_pose(struct bPoseChannel *pchan,
136                                    float inmat[4][4],
137                                    float outmat[4][4]);
138 void BKE_armature_mat_pose_to_delta(float delta_mat[4][4],
139                                     float pose_mat[4][4],
140                                     float arm_mat[4][4]);
141
142 void BKE_armature_mat_pose_to_bone_ex(struct Depsgraph *depsgraph,
143                                       struct Object *ob,
144                                       struct bPoseChannel *pchan,
145                                       float inmat[4][4],
146                                       float outmat[4][4]);
147
148 void BKE_pchan_mat3_to_rot(struct bPoseChannel *pchan, float mat[3][3], bool use_compat);
149 void BKE_pchan_rot_to_mat3(const struct bPoseChannel *pchan, float mat[3][3]);
150 void BKE_pchan_apply_mat4(struct bPoseChannel *pchan, float mat[4][4], bool use_comat);
151 void BKE_pchan_to_mat4(const struct bPoseChannel *pchan, float chan_mat[4][4]);
152 void BKE_pchan_calc_mat(struct bPoseChannel *pchan);
153
154 /* Simple helper, computes the offset bone matrix. */
155 void BKE_bone_offset_matrix_get(const struct Bone *bone, float offs_bone[4][4]);
156
157 /* Transformation inherited from the parent bone. These matrices apply the effects of
158  * HINGE/NO_SCALE/NO_LOCAL_LOCATION options over the pchan loc/rot/scale transformations. */
159 typedef struct BoneParentTransform {
160   float rotscale_mat[4][4]; /* parent effect on rotation & scale pose channels */
161   float loc_mat[4][4];      /* parent effect on location pose channel */
162 } BoneParentTransform;
163
164 /* Matrix-like algebra operations on the transform */
165 void BKE_bone_parent_transform_clear(struct BoneParentTransform *bpt);
166 void BKE_bone_parent_transform_invert(struct BoneParentTransform *bpt);
167 void BKE_bone_parent_transform_combine(const struct BoneParentTransform *in1,
168                                        const struct BoneParentTransform *in2,
169                                        struct BoneParentTransform *result);
170
171 void BKE_bone_parent_transform_apply(const struct BoneParentTransform *bpt,
172                                      const float inmat[4][4],
173                                      float outmat[4][4]);
174
175 /* Get the current parent transformation for the given pose bone. */
176 void BKE_bone_parent_transform_calc_from_pchan(const struct bPoseChannel *pchan,
177                                                struct BoneParentTransform *r_bpt);
178 void BKE_bone_parent_transform_calc_from_matrices(int bone_flag,
179                                                   const float offs_bone[4][4],
180                                                   const float parent_arm_mat[4][4],
181                                                   const float parent_pose_mat[4][4],
182                                                   struct BoneParentTransform *r_bpt);
183
184 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
185 void BKE_rotMode_change_values(
186     float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
187
188 /* B-Bone support */
189 #define MAX_BBONE_SUBDIV 32
190
191 typedef struct Mat4 {
192   float mat[4][4];
193 } Mat4;
194
195 typedef struct BBoneSplineParameters {
196   int segments;
197   float length;
198
199   /* Non-uniform scale correction. */
200   bool do_scale;
201   float scale[3];
202
203   /* Handle control bone data. */
204   bool use_prev, prev_bbone;
205   bool use_next, next_bbone;
206
207   float prev_h[3], next_h[3];
208   float prev_mat[4][4], next_mat[4][4];
209
210   /* Control values. */
211   float ease1, ease2;
212   float roll1, roll2;
213   float scale_in_x, scale_in_y, scale_out_x, scale_out_y;
214   float curve_in_x, curve_in_y, curve_out_x, curve_out_y;
215 } BBoneSplineParameters;
216
217 void BKE_pchan_bbone_handles_get(struct bPoseChannel *pchan,
218                                  struct bPoseChannel **r_prev,
219                                  struct bPoseChannel **r_next);
220 void BKE_pchan_bbone_spline_params_get(struct bPoseChannel *pchan,
221                                        const bool rest,
222                                        struct BBoneSplineParameters *r_param);
223
224 void BKE_pchan_bbone_spline_setup(struct bPoseChannel *pchan,
225                                   const bool rest,
226                                   const bool for_deform,
227                                   Mat4 *result_array);
228
229 void BKE_pchan_bbone_handles_compute(const BBoneSplineParameters *param,
230                                      float h1[3],
231                                      float *r_roll1,
232                                      float h2[3],
233                                      float *r_roll2,
234                                      bool ease,
235                                      bool offsets);
236 int BKE_pchan_bbone_spline_compute(struct BBoneSplineParameters *param,
237                                    const bool for_deform,
238                                    Mat4 *result_array);
239
240 void BKE_pchan_bbone_segments_cache_compute(struct bPoseChannel *pchan);
241 void BKE_pchan_bbone_segments_cache_copy(struct bPoseChannel *pchan,
242                                          struct bPoseChannel *pchan_from);
243
244 void BKE_pchan_bbone_deform_segment_index(const struct bPoseChannel *pchan,
245                                           float pos,
246                                           int *r_index,
247                                           float *r_blend_next);
248
249 /* like EBONE_VISIBLE */
250 #define PBONE_VISIBLE(arm, bone) \
251   (CHECK_TYPE_INLINE(arm, bArmature *), \
252    CHECK_TYPE_INLINE(bone, Bone *), \
253    (((bone)->layer & (arm)->layer) && !((bone)->flag & BONE_HIDDEN_P)))
254
255 #define PBONE_SELECTABLE(arm, bone) \
256   (PBONE_VISIBLE(arm, bone) && !((bone)->flag & BONE_UNSELECTABLE))
257
258 /* context.selected_pose_bones */
259 #define FOREACH_PCHAN_SELECTED_IN_OBJECT_BEGIN(_ob, _pchan) \
260   for (bPoseChannel *_pchan = (_ob)->pose->chanbase.first; _pchan; _pchan = _pchan->next) { \
261     if (PBONE_VISIBLE(((bArmature *)(_ob)->data), (_pchan)->bone) && \
262         ((_pchan)->bone->flag & BONE_SELECTED)) {
263 #define FOREACH_PCHAN_SELECTED_IN_OBJECT_END \
264   } \
265   } \
266   ((void)0)
267 /* context.visible_pose_bones */
268 #define FOREACH_PCHAN_VISIBLE_IN_OBJECT_BEGIN(_ob, _pchan) \
269   for (bPoseChannel *_pchan = (_ob)->pose->chanbase.first; _pchan; _pchan = _pchan->next) { \
270     if (PBONE_VISIBLE(((bArmature *)(_ob)->data), (_pchan)->bone)) {
271 #define FOREACH_PCHAN_VISIBLE_IN_OBJECT_END \
272   } \
273   } \
274   ((void)0)
275
276 /* Evaluation helpers */
277 struct bKinematicConstraint;
278 struct bPose;
279 struct bSplineIKConstraint;
280
281 struct bPoseChannel *BKE_armature_ik_solver_find_root(struct bPoseChannel *pchan,
282                                                       struct bKinematicConstraint *data);
283 struct bPoseChannel *BKE_armature_splineik_solver_find_root(struct bPoseChannel *pchan,
284                                                             struct bSplineIKConstraint *data);
285
286 void BKE_pose_splineik_init_tree(struct Scene *scene, struct Object *ob, float ctime);
287 void BKE_splineik_execute_tree(struct Depsgraph *depsgraph,
288                                struct Scene *scene,
289                                struct Object *ob,
290                                struct bPoseChannel *pchan_root,
291                                float ctime);
292
293 void BKE_pose_pchan_index_rebuild(struct bPose *pose);
294
295 void BKE_pose_eval_init(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *object);
296
297 void BKE_pose_eval_init_ik(struct Depsgraph *depsgraph,
298                            struct Scene *scene,
299                            struct Object *object);
300
301 void BKE_pose_eval_bone(struct Depsgraph *depsgraph,
302                         struct Scene *scene,
303                         struct Object *object,
304                         int pchan_index);
305
306 void BKE_pose_constraints_evaluate(struct Depsgraph *depsgraph,
307                                    struct Scene *scene,
308                                    struct Object *object,
309                                    int pchan_index);
310
311 void BKE_pose_bone_done(struct Depsgraph *depsgraph, struct Object *object, int pchan_index);
312
313 void BKE_pose_eval_bbone_segments(struct Depsgraph *depsgraph,
314                                   struct Object *object,
315                                   int pchan_index);
316
317 void BKE_pose_iktree_evaluate(struct Depsgraph *depsgraph,
318                               struct Scene *scene,
319                               struct Object *object,
320                               int rootchan_index);
321
322 void BKE_pose_splineik_evaluate(struct Depsgraph *depsgraph,
323                                 struct Scene *scene,
324                                 struct Object *object,
325                                 int rootchan_index);
326
327 void BKE_pose_eval_done(struct Depsgraph *depsgraph, struct Object *object);
328
329 void BKE_pose_eval_cleanup(struct Depsgraph *depsgraph,
330                            struct Scene *scene,
331                            struct Object *object);
332
333 void BKE_pose_eval_proxy_init(struct Depsgraph *depsgraph, struct Object *object);
334 void BKE_pose_eval_proxy_done(struct Depsgraph *depsgraph, struct Object *object);
335 void BKE_pose_eval_proxy_cleanup(struct Depsgraph *depsgraph, struct Object *object);
336
337 void BKE_pose_eval_proxy_copy_bone(struct Depsgraph *depsgraph,
338                                    struct Object *object,
339                                    int pchan_index);
340
341 #ifdef __cplusplus
342 }
343 #endif
344
345 #endif