Cleanup: rename the curveInX etc bbone DNA fields to curve_in_x etc.
[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 struct GHash *BKE_armature_bone_from_name_map(struct bArmature *arm);
88
89 bool BKE_armature_bone_flag_test_recursive(const struct Bone *bone, int flag);
90
91 float distfactor_to_bone(
92     const float vec[3], const float b1[3], const float b2[3], float r1, float r2, float rdist);
93
94 void BKE_armature_where_is(struct bArmature *arm);
95 void BKE_armature_where_is_bone(struct Bone *bone,
96                                 struct Bone *prevbone,
97                                 const bool use_recursion);
98 void BKE_pose_clear_pointers(struct bPose *pose);
99 void BKE_pose_remap_bone_pointers(struct bArmature *armature, struct bPose *pose);
100 void BKE_pchan_rebuild_bbone_handles(struct bPose *pose, struct bPoseChannel *pchan);
101 void BKE_pose_rebuild(struct Main *bmain,
102                       struct Object *ob,
103                       struct bArmature *arm,
104                       const bool do_id_user);
105 void BKE_pose_where_is(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
106 void BKE_pose_where_is_bone(struct Depsgraph *depsgraph,
107                             struct Scene *scene,
108                             struct Object *ob,
109                             struct bPoseChannel *pchan,
110                             float ctime,
111                             bool do_extra);
112 void BKE_pose_where_is_bone_tail(struct bPoseChannel *pchan);
113
114 /* get_objectspace_bone_matrix has to be removed still */
115 void get_objectspace_bone_matrix(struct Bone *bone,
116                                  float M_accumulatedMatrix[4][4],
117                                  int root,
118                                  int posed);
119 void vec_roll_to_mat3(const float vec[3], const float roll, float mat[3][3]);
120 void vec_roll_to_mat3_normalized(const float nor[3], const float roll, float mat[3][3]);
121 void mat3_to_vec_roll(const float mat[3][3], float r_vec[3], float *r_roll);
122 void mat3_vec_to_roll(const float mat[3][3], const float vec[3], float *r_roll);
123
124 /* Common Conversions Between Co-ordinate Spaces */
125 void BKE_armature_mat_world_to_pose(struct Object *ob, float inmat[4][4], float outmat[4][4]);
126 void BKE_armature_loc_world_to_pose(struct Object *ob, const float inloc[3], float outloc[3]);
127 void BKE_armature_mat_pose_to_bone(struct bPoseChannel *pchan,
128                                    float inmat[4][4],
129                                    float outmat[4][4]);
130 void BKE_armature_loc_pose_to_bone(struct bPoseChannel *pchan,
131                                    const float inloc[3],
132                                    float outloc[3]);
133 void BKE_armature_mat_bone_to_pose(struct bPoseChannel *pchan,
134                                    float inmat[4][4],
135                                    float outmat[4][4]);
136 void BKE_armature_mat_pose_to_delta(float delta_mat[4][4],
137                                     float pose_mat[4][4],
138                                     float arm_mat[4][4]);
139
140 void BKE_armature_mat_pose_to_bone_ex(struct Depsgraph *depsgraph,
141                                       struct Object *ob,
142                                       struct bPoseChannel *pchan,
143                                       float inmat[4][4],
144                                       float outmat[4][4]);
145
146 void BKE_pchan_mat3_to_rot(struct bPoseChannel *pchan, float mat[3][3], bool use_compat);
147 void BKE_pchan_apply_mat4(struct bPoseChannel *pchan, float mat[4][4], bool use_comat);
148 void BKE_pchan_to_mat4(struct bPoseChannel *pchan, float chan_mat[4][4]);
149 void BKE_pchan_calc_mat(struct bPoseChannel *pchan);
150
151 /* Simple helper, computes the offset bone matrix. */
152 void BKE_bone_offset_matrix_get(const struct Bone *bone, float offs_bone[4][4]);
153
154 /* Transformation inherited from the parent bone. These matrices apply the effects of
155  * HINGE/NO_SCALE/NO_LOCAL_LOCATION options over the pchan loc/rot/scale transformations. */
156 typedef struct BoneParentTransform {
157   float rotscale_mat[4][4]; /* parent effect on rotation & scale pose channels */
158   float loc_mat[4][4];      /* parent effect on location pose channel */
159 } BoneParentTransform;
160
161 /* Matrix-like algebra operations on the transform */
162 void BKE_bone_parent_transform_clear(struct BoneParentTransform *bpt);
163 void BKE_bone_parent_transform_invert(struct BoneParentTransform *bpt);
164 void BKE_bone_parent_transform_combine(const struct BoneParentTransform *in1,
165                                        const struct BoneParentTransform *in2,
166                                        struct BoneParentTransform *result);
167
168 void BKE_bone_parent_transform_apply(const struct BoneParentTransform *bpt,
169                                      const float inmat[4][4],
170                                      float outmat[4][4]);
171
172 /* Get the current parent transformation for the given pose bone. */
173 void BKE_bone_parent_transform_calc_from_pchan(const struct bPoseChannel *pchan,
174                                                struct BoneParentTransform *r_bpt);
175 void BKE_bone_parent_transform_calc_from_matrices(int bone_flag,
176                                                   const float offs_bone[4][4],
177                                                   const float parent_arm_mat[4][4],
178                                                   const float parent_pose_mat[4][4],
179                                                   struct BoneParentTransform *r_bpt);
180
181 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
182 void BKE_rotMode_change_values(
183     float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
184
185 /* B-Bone support */
186 #define MAX_BBONE_SUBDIV 32
187
188 typedef struct Mat4 {
189   float mat[4][4];
190 } Mat4;
191
192 typedef struct BBoneSplineParameters {
193   int segments;
194   float length;
195
196   /* Non-uniform scale correction. */
197   bool do_scale;
198   float scale[3];
199
200   /* Handle control bone data. */
201   bool use_prev, prev_bbone;
202   bool use_next, next_bbone;
203
204   float prev_h[3], next_h[3];
205   float prev_mat[4][4], next_mat[4][4];
206
207   /* Control values. */
208   float ease1, ease2;
209   float roll1, roll2;
210   float scale_in_x, scale_in_y, scale_out_x, scale_out_y;
211   float curve_in_x, curve_in_y, curve_out_x, curve_out_y;
212 } BBoneSplineParameters;
213
214 void BKE_pchan_bbone_handles_get(struct bPoseChannel *pchan,
215                                  struct bPoseChannel **r_prev,
216                                  struct bPoseChannel **r_next);
217 void BKE_pchan_bbone_spline_params_get(struct bPoseChannel *pchan,
218                                        const bool rest,
219                                        struct BBoneSplineParameters *r_param);
220
221 void BKE_pchan_bbone_spline_setup(struct bPoseChannel *pchan,
222                                   const bool rest,
223                                   const bool for_deform,
224                                   Mat4 *result_array);
225
226 void BKE_pchan_bbone_handles_compute(const BBoneSplineParameters *param,
227                                      float h1[3],
228                                      float *r_roll1,
229                                      float h2[3],
230                                      float *r_roll2,
231                                      bool ease,
232                                      bool offsets);
233 int BKE_pchan_bbone_spline_compute(struct BBoneSplineParameters *param,
234                                    const bool for_deform,
235                                    Mat4 *result_array);
236
237 void BKE_pchan_bbone_segments_cache_compute(struct bPoseChannel *pchan);
238 void BKE_pchan_bbone_segments_cache_copy(struct bPoseChannel *pchan,
239                                          struct bPoseChannel *pchan_from);
240
241 void BKE_pchan_bbone_deform_segment_index(const struct bPoseChannel *pchan,
242                                           float pos,
243                                           int *r_index,
244                                           float *r_blend_next);
245
246 /* like EBONE_VISIBLE */
247 #define PBONE_VISIBLE(arm, bone) \
248   (CHECK_TYPE_INLINE(arm, bArmature *), \
249    CHECK_TYPE_INLINE(bone, Bone *), \
250    (((bone)->layer & (arm)->layer) && !((bone)->flag & BONE_HIDDEN_P)))
251
252 #define PBONE_SELECTABLE(arm, bone) \
253   (PBONE_VISIBLE(arm, bone) && !((bone)->flag & BONE_UNSELECTABLE))
254
255 /* context.selected_pose_bones */
256 #define FOREACH_PCHAN_SELECTED_IN_OBJECT_BEGIN(_ob, _pchan) \
257   for (bPoseChannel *_pchan = (_ob)->pose->chanbase.first; _pchan; _pchan = _pchan->next) { \
258     if (PBONE_VISIBLE(((bArmature *)(_ob)->data), (_pchan)->bone) && \
259         ((_pchan)->bone->flag & BONE_SELECTED)) {
260 #define FOREACH_PCHAN_SELECTED_IN_OBJECT_END \
261   } \
262   } \
263   ((void)0)
264 /* context.visible_pose_bones */
265 #define FOREACH_PCHAN_VISIBLE_IN_OBJECT_BEGIN(_ob, _pchan) \
266   for (bPoseChannel *_pchan = (_ob)->pose->chanbase.first; _pchan; _pchan = _pchan->next) { \
267     if (PBONE_VISIBLE(((bArmature *)(_ob)->data), (_pchan)->bone)) {
268 #define FOREACH_PCHAN_VISIBLE_IN_OBJECT_END \
269   } \
270   } \
271   ((void)0)
272
273 /* Evaluation helpers */
274 struct bKinematicConstraint;
275 struct bPose;
276 struct bSplineIKConstraint;
277
278 struct bPoseChannel *BKE_armature_ik_solver_find_root(struct bPoseChannel *pchan,
279                                                       struct bKinematicConstraint *data);
280 struct bPoseChannel *BKE_armature_splineik_solver_find_root(struct bPoseChannel *pchan,
281                                                             struct bSplineIKConstraint *data);
282
283 void BKE_pose_splineik_init_tree(struct Scene *scene, struct Object *ob, float ctime);
284 void BKE_splineik_execute_tree(struct Depsgraph *depsgraph,
285                                struct Scene *scene,
286                                struct Object *ob,
287                                struct bPoseChannel *pchan_root,
288                                float ctime);
289
290 void BKE_pose_pchan_index_rebuild(struct bPose *pose);
291
292 void BKE_pose_eval_init(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *object);
293
294 void BKE_pose_eval_init_ik(struct Depsgraph *depsgraph,
295                            struct Scene *scene,
296                            struct Object *object);
297
298 void BKE_pose_eval_bone(struct Depsgraph *depsgraph,
299                         struct Scene *scene,
300                         struct Object *object,
301                         int pchan_index);
302
303 void BKE_pose_constraints_evaluate(struct Depsgraph *depsgraph,
304                                    struct Scene *scene,
305                                    struct Object *object,
306                                    int pchan_index);
307
308 void BKE_pose_bone_done(struct Depsgraph *depsgraph, struct Object *object, int pchan_index);
309
310 void BKE_pose_eval_bbone_segments(struct Depsgraph *depsgraph,
311                                   struct Object *object,
312                                   int pchan_index);
313
314 void BKE_pose_iktree_evaluate(struct Depsgraph *depsgraph,
315                               struct Scene *scene,
316                               struct Object *object,
317                               int rootchan_index);
318
319 void BKE_pose_splineik_evaluate(struct Depsgraph *depsgraph,
320                                 struct Scene *scene,
321                                 struct Object *object,
322                                 int rootchan_index);
323
324 void BKE_pose_eval_done(struct Depsgraph *depsgraph, struct Object *object);
325
326 void BKE_pose_eval_cleanup(struct Depsgraph *depsgraph,
327                            struct Scene *scene,
328                            struct Object *object);
329
330 void BKE_pose_eval_proxy_init(struct Depsgraph *depsgraph, struct Object *object);
331 void BKE_pose_eval_proxy_done(struct Depsgraph *depsgraph, struct Object *object);
332 void BKE_pose_eval_proxy_cleanup(struct Depsgraph *depsgraph, struct Object *object);
333
334 void BKE_pose_eval_proxy_copy_bone(struct Depsgraph *depsgraph,
335                                    struct Object *object,
336                                    int pchan_index);
337
338 #ifdef __cplusplus
339 }
340 #endif
341
342 #endif