Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_armature.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_ARMATURE_H__
28 #define __BKE_ARMATURE_H__
29
30 /** \file BKE_armature.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 struct bPose;
37 struct Bone;
38 struct Depsgraph;
39 struct GHash;
40 struct Main;
41 struct bArmature;
42 struct bPoseChannel;
43 struct bConstraint;
44 struct Scene;
45 struct Object;
46 struct PoseTree;
47 struct ListBase;
48
49 typedef struct PoseTarget {
50         struct PoseTarget *next, *prev;
51
52         struct bConstraint *con;        /* the constraint of this target */
53         int tip;                        /* index of tip pchan in PoseTree */
54 } PoseTarget;
55
56 typedef struct PoseTree {
57         struct PoseTree *next, *prev;
58
59         int type;                       /* type of IK that this serves (CONSTRAINT_TYPE_KINEMATIC or ..._SPLINEIK) */
60         int totchannel;                 /* number of pose channels */
61
62         struct ListBase targets;        /* list of targets of the tree */
63         struct bPoseChannel **pchan;    /* array of pose channels */
64         int     *parent;                /* and their parents */
65
66         float (*basis_change)[3][3];    /* basis change result from solver */
67         int iterations;                 /* iterations from the constraint */
68         int stretch;                    /* disable stretching */
69 } PoseTree;
70
71 /*      Core armature functionality */
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
76 struct bArmature *BKE_armature_add(struct Main *bmain, const char *name);
77 struct bArmature *BKE_armature_from_object(struct Object *ob);
78 int  BKE_armature_bonelist_count(struct ListBase *lb);
79 void BKE_armature_bonelist_free(struct ListBase *lb);
80 void BKE_armature_free(struct bArmature *arm);
81 void BKE_armature_make_local(struct Main *bmain, struct bArmature *arm, const bool lib_local);
82 void BKE_armature_copy_data(struct Main *bmain, struct bArmature *arm_dst, const struct bArmature *arm_src, const int flag);
83 struct bArmature *BKE_armature_copy(struct Main *bmain, const struct bArmature *arm);
84
85 /* Bounding box. */
86 struct BoundBox *BKE_armature_boundbox_get(struct Object *ob);
87
88 bool BKE_pose_minmax(struct Object *ob, float r_min[3], float r_max[3], bool use_hidden, bool use_select);
89
90 int bone_autoside_name(char name[64], int strip_number, short axis, float head, float tail);
91
92 struct Bone  *BKE_armature_find_bone_name(struct bArmature *arm, const char *name);
93 struct GHash *BKE_armature_bone_from_name_map(struct bArmature *arm);
94
95 bool         BKE_armature_bone_flag_test_recursive(const struct Bone *bone, int flag);
96
97 float distfactor_to_bone(const float vec[3], const float b1[3], const float b2[3], float r1, float r2, float rdist);
98
99 void BKE_armature_where_is(struct bArmature *arm);
100 void BKE_armature_where_is_bone(struct Bone *bone, struct Bone *prevbone, const bool use_recursion);
101 void BKE_pose_clear_pointers(struct bPose *pose);
102 void BKE_pose_remap_bone_pointers(struct bArmature *armature, struct bPose *pose);
103 void BKE_pchan_rebuild_bbone_handles(struct bPose *pose, struct bPoseChannel *pchan);
104 void BKE_pose_rebuild(struct Main *bmain, struct Object *ob, struct bArmature *arm, 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, struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime, bool do_extra);
107 void BKE_pose_where_is_bone_tail(struct bPoseChannel *pchan);
108
109 /* get_objectspace_bone_matrix has to be removed still */
110 void get_objectspace_bone_matrix(struct Bone *bone, float M_accumulatedMatrix[4][4], int root, int posed);
111 void vec_roll_to_mat3(const float vec[3], const float roll, float mat[3][3]);
112 void vec_roll_to_mat3_normalized(const float nor[3], const float roll, float mat[3][3]);
113 void mat3_to_vec_roll(const float mat[3][3], float r_vec[3], float *r_roll);
114 void mat3_vec_to_roll(const float mat[3][3], const float vec[3], float *r_roll);
115
116 /* Common Conversions Between Co-ordinate Spaces */
117 void BKE_armature_mat_world_to_pose(struct Object *ob, float inmat[4][4], float outmat[4][4]);
118 void BKE_armature_loc_world_to_pose(struct Object *ob, const float inloc[3], float outloc[3]);
119 void BKE_armature_mat_pose_to_bone(struct bPoseChannel *pchan, float inmat[4][4], float outmat[4][4]);
120 void BKE_armature_loc_pose_to_bone(struct bPoseChannel *pchan, const float inloc[3], float outloc[3]);
121 void BKE_armature_mat_bone_to_pose(struct bPoseChannel *pchan, float inmat[4][4], float outmat[4][4]);
122 void BKE_armature_mat_pose_to_delta(float delta_mat[4][4], float pose_mat[4][4], float arm_mat[4][4]);
123
124 void BKE_armature_mat_pose_to_bone_ex(struct Depsgraph *depsgraph, struct Object *ob, struct bPoseChannel *pchan, float inmat[4][4], float outmat[4][4]);
125
126 void BKE_pchan_mat3_to_rot(struct bPoseChannel *pchan, float mat[3][3], bool use_compat);
127 void BKE_pchan_apply_mat4(struct bPoseChannel *pchan, float mat[4][4], bool use_comat);
128 void BKE_pchan_to_mat4(struct bPoseChannel *pchan, float chan_mat[4][4]);
129 void BKE_pchan_calc_mat(struct bPoseChannel *pchan);
130
131 /* Get the "pchan to pose" transform matrix. These matrices apply the effects of
132  * HINGE/NO_SCALE/NO_LOCAL_LOCATION options over the pchan loc/rot/scale transformations. */
133 void BKE_pchan_to_pose_mat(struct bPoseChannel *pchan, float rotscale_mat[4][4], float loc_mat[4][4]);
134
135 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
136 void BKE_rotMode_change_values(float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
137
138 /* B-Bone support */
139 #define MAX_BBONE_SUBDIV    32
140
141 typedef struct Mat4 {
142         float mat[4][4];
143 } Mat4;
144
145 typedef struct BBoneSplineParameters {
146         int segments;
147         float length;
148
149         /* Non-uniform scale correction. */
150         bool do_scale;
151         float scale[3];
152
153         /* Handle control bone data. */
154         bool use_prev, prev_bbone;
155         bool use_next, next_bbone;
156
157         float prev_h[3], next_h[3];
158         float prev_mat[4][4], next_mat[4][4];
159
160         /* Control values. */
161         float ease1, ease2;
162         float roll1, roll2;
163         float scaleIn, scaleOut;
164         float curveInX, curveInY, curveOutX, curveOutY;
165 } BBoneSplineParameters;
166
167 void BKE_pchan_bbone_handles_get(
168         struct bPoseChannel *pchan, struct bPoseChannel **r_prev, struct bPoseChannel **r_next);
169 void BKE_pchan_bbone_spline_params_get(
170         struct bPoseChannel *pchan, const bool rest, struct BBoneSplineParameters *r_param);
171
172 void BKE_pchan_bbone_spline_setup(
173         struct bPoseChannel *pchan, const bool rest, Mat4 result_array[MAX_BBONE_SUBDIV]);
174
175 void BKE_pchan_bbone_handles_compute(
176         const BBoneSplineParameters *param,
177         float h1[3], float *r_roll1,
178         float h2[3], float *r_roll2,
179         bool ease, bool offsets);
180 int  BKE_pchan_bbone_spline_compute(
181         struct BBoneSplineParameters *param, Mat4 result_array[MAX_BBONE_SUBDIV]);
182
183 void BKE_pchan_bbone_segments_cache_compute(
184         struct bPoseChannel *pchan);
185 void BKE_pchan_bbone_segments_cache_copy(
186         struct bPoseChannel *pchan, struct bPoseChannel *pchan_from);
187
188 /* like EBONE_VISIBLE */
189 #define PBONE_VISIBLE(arm, bone) ( \
190         CHECK_TYPE_INLINE(arm, bArmature *), \
191         CHECK_TYPE_INLINE(bone, Bone *), \
192         (((bone)->layer & (arm)->layer) && !((bone)->flag & BONE_HIDDEN_P)) \
193         )
194
195 #define PBONE_SELECTABLE(arm, bone) \
196         (PBONE_VISIBLE(arm, bone) && !((bone)->flag & BONE_UNSELECTABLE))
197
198
199 /* context.selected_pose_bones */
200 #define FOREACH_PCHAN_SELECTED_IN_OBJECT_BEGIN(_ob, _pchan) \
201         for (bPoseChannel *_pchan = (_ob)->pose->chanbase.first; _pchan;  _pchan = _pchan->next) { \
202                 if (PBONE_VISIBLE(((bArmature *)(_ob)->data), (_pchan)->bone) && ((_pchan)->bone->flag & BONE_SELECTED)) {
203 #define FOREACH_PCHAN_SELECTED_IN_OBJECT_END \
204                 } \
205         } ((void)0)
206 /* context.visible_pose_bones */
207 #define FOREACH_PCHAN_VISIBLE_IN_OBJECT_BEGIN(_ob, _pchan) \
208         for (bPoseChannel *_pchan = (_ob)->pose->chanbase.first; _pchan;  _pchan = _pchan->next) { \
209                 if (PBONE_VISIBLE(((bArmature *)(_ob)->data), (_pchan)->bone)) {
210 #define FOREACH_PCHAN_VISIBLE_IN_OBJECT_END \
211                 } \
212         } ((void)0)
213
214
215 /* Evaluation helpers */
216 struct bKinematicConstraint;
217 struct bPose;
218 struct bSplineIKConstraint;
219
220 struct bPoseChannel *BKE_armature_ik_solver_find_root(
221         struct bPoseChannel *pchan,
222         struct bKinematicConstraint *data);
223 struct bPoseChannel *BKE_armature_splineik_solver_find_root(
224         struct bPoseChannel *pchan,
225         struct bSplineIKConstraint *data);
226
227 void BKE_pose_splineik_init_tree(struct Scene *scene, struct Object *ob, float ctime);
228 void BKE_splineik_execute_tree(
229         struct Depsgraph *depsgraph, struct Scene *scene,
230         struct Object *ob, struct bPoseChannel *pchan_root, float ctime);
231
232 void BKE_pose_eval_init(
233         struct Depsgraph *depsgraph,
234         struct Scene *scene,
235         struct Object *ob);
236
237 void BKE_pose_eval_init_ik(
238         struct Depsgraph *depsgraph,
239         struct Scene *scene,
240         struct Object *ob);
241
242 void BKE_pose_eval_bone(
243         struct Depsgraph *depsgraph,
244         struct Scene *scene,
245         struct Object *ob,
246         int pchan_index);
247
248 void BKE_pose_constraints_evaluate(
249         struct Depsgraph *depsgraph,
250         struct Scene *scene,
251         struct Object *ob,
252         int pchan_index);
253
254 void BKE_pose_bone_done(
255         struct Depsgraph *depsgraph,
256         struct Object *ob,
257         int pchan_index);
258
259 void BKE_pose_eval_bbone_segments(
260         struct Depsgraph *depsgraph,
261         struct Object *ob,
262         int pchan_index);
263
264 void BKE_pose_iktree_evaluate(
265         struct Depsgraph *depsgraph,
266         struct Scene *scene,
267         struct Object *ob,
268         int rootchan_index);
269
270 void BKE_pose_splineik_evaluate(
271         struct Depsgraph *depsgraph,
272         struct Scene *scene,
273         struct Object *ob,
274         int rootchan_index);
275
276 void BKE_pose_eval_done(
277         struct Depsgraph *depsgraph,
278         struct Object *object);
279
280 void BKE_pose_eval_cleanup(
281         struct Depsgraph *depsgraph,
282         struct Scene *scene,
283         struct Object *ob);
284
285 void BKE_pose_eval_proxy_init(struct Depsgraph *depsgraph,
286                               struct Object *object);
287 void BKE_pose_eval_proxy_done(struct Depsgraph *depsgraph,
288                               struct Object *object);
289 void BKE_pose_eval_proxy_cleanup(struct Depsgraph *depsgraph,
290                                  struct Object *object);
291
292 void BKE_pose_eval_proxy_copy_bone(
293         struct Depsgraph *depsgraph,
294         struct Object *object,
295         int pchan_index);
296
297 /* BBOne deformation cache.
298  *
299  * The idea here is to pre-calculate deformation queternions, matricies and such
300  * used by armature_deform_verts().
301  */
302 struct ObjectBBoneDeform;
303 struct ObjectBBoneDeform * BKE_armature_cached_bbone_deformation_get(
304         struct Object *object);
305 void BKE_armature_cached_bbone_deformation_free_data(struct Object *object);
306 void BKE_armature_cached_bbone_deformation_free(struct Object *object);
307 void BKE_armature_cached_bbone_deformation_update(struct Object *object);
308
309 #ifdef __cplusplus
310 }
311 #endif
312
313 #endif