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 GHash;
39 struct Main;
40 struct bArmature;
41 struct bPoseChannel;
42 struct bConstraint;
43 struct Scene;
44 struct Object;
45 struct PoseTree;
46 struct ListBase;
47
48 typedef struct PoseTarget {
49         struct PoseTarget *next, *prev;
50
51         struct bConstraint *con;        /* the constrait of this target */
52         int tip;                        /* index of tip pchan in PoseTree */
53 } PoseTarget;
54
55 typedef struct PoseTree {
56         struct PoseTree *next, *prev;
57         
58         int type;                       /* type of IK that this serves (CONSTRAINT_TYPE_KINEMATIC or ..._SPLINEIK) */
59         int totchannel;                 /* number of pose channels */
60         
61         struct ListBase targets;        /* list of targets of the tree */
62         struct bPoseChannel **pchan;    /* array of pose channels */
63         int     *parent;                /* and their parents */
64
65         float (*basis_change)[3][3];    /* basis change result from solver */
66         int iterations;                 /* iterations from the constraint */
67         int stretch;                    /* disable stretching */
68 } PoseTree;
69
70 /*      Core armature functionality */
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75 struct bArmature *BKE_armature_add(struct Main *bmain, const char *name);
76 struct bArmature *BKE_armature_from_object(struct Object *ob);
77 int  BKE_armature_bonelist_count(struct ListBase *lb);
78 void BKE_armature_bonelist_free(struct ListBase *lb);
79 void BKE_armature_free(struct bArmature *arm);
80 void BKE_armature_make_local(struct Main *bmain, struct bArmature *arm, const bool lib_local);
81 struct bArmature *BKE_armature_copy(struct Main *bmain, const struct bArmature *arm);
82
83 /* Bounding box. */
84 struct BoundBox *BKE_armature_boundbox_get(struct Object *ob);
85
86 bool BKE_pose_minmax(struct Object *ob, float r_min[3], float r_max[3], bool use_hidden, bool use_select);
87
88 int bone_autoside_name(char name[64], int strip_number, short axis, float head, float tail);
89
90 struct Bone  *BKE_armature_find_bone_name(struct bArmature *arm, const char *name);
91 struct GHash *BKE_armature_bone_from_name_map(struct bArmature *arm);
92
93 bool         BKE_armature_bone_flag_test_recursive(const struct Bone *bone, int flag);
94
95 float distfactor_to_bone(const float vec[3], const float b1[3], const float b2[3], float r1, float r2, float rdist);
96
97 void BKE_armature_where_is(struct bArmature *arm);
98 void BKE_armature_where_is_bone(struct Bone *bone, struct Bone *prevbone, const bool use_recursion);
99 void BKE_pose_clear_pointers(struct bPose *pose);
100 void BKE_pose_rebuild(struct Object *ob, struct bArmature *arm);
101 void BKE_pose_where_is(struct Scene *scene, struct Object *ob);
102 void BKE_pose_where_is_bone(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime, bool do_extra);
103 void BKE_pose_where_is_bone_tail(struct bPoseChannel *pchan);
104
105 /* get_objectspace_bone_matrix has to be removed still */
106 void get_objectspace_bone_matrix(struct Bone *bone, float M_accumulatedMatrix[4][4], int root, int posed);
107 void vec_roll_to_mat3(const float vec[3], const float roll, float mat[3][3]);
108 void vec_roll_to_mat3_normalized(const float nor[3], const float roll, float mat[3][3]);
109 void mat3_to_vec_roll(float mat[3][3], float r_vec[3], float *r_roll);
110
111 /* Common Conversions Between Co-ordinate Spaces */
112 void BKE_armature_mat_world_to_pose(struct Object *ob, float inmat[4][4], float outmat[4][4]);
113 void BKE_armature_loc_world_to_pose(struct Object *ob, const float inloc[3], float outloc[3]);
114 void BKE_armature_mat_pose_to_bone(struct bPoseChannel *pchan, float inmat[4][4], float outmat[4][4]);
115 void BKE_armature_loc_pose_to_bone(struct bPoseChannel *pchan, const float inloc[3], float outloc[3]);
116 void BKE_armature_mat_bone_to_pose(struct bPoseChannel *pchan, float inmat[4][4], float outmat[4][4]);
117 void BKE_armature_mat_pose_to_delta(float delta_mat[4][4], float pose_mat[4][4], float arm_mat[4][4]);
118
119 void BKE_armature_mat_pose_to_bone_ex(struct Object *ob, struct bPoseChannel *pchan, float inmat[4][4], float outmat[4][4]);
120
121 void BKE_pchan_mat3_to_rot(struct bPoseChannel *pchan, float mat[3][3], bool use_compat);
122 void BKE_pchan_apply_mat4(struct bPoseChannel *pchan, float mat[4][4], bool use_comat);
123 void BKE_pchan_to_mat4(struct bPoseChannel *pchan, float chan_mat[4][4]);
124 void BKE_pchan_calc_mat(struct bPoseChannel *pchan);
125
126 /* Get the "pchan to pose" transform matrix. These matrices apply the effects of
127  * HINGE/NO_SCALE/NO_LOCAL_LOCATION options over the pchan loc/rot/scale transformations. */
128 void BKE_pchan_to_pose_mat(struct bPoseChannel *pchan, float rotscale_mat[4][4], float loc_mat[4][4]);
129
130 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
131 void BKE_rotMode_change_values(float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
132
133 /* B-Bone support */
134 #define MAX_BBONE_SUBDIV    32
135
136 typedef struct Mat4 {
137         float mat[4][4];
138 } Mat4;
139
140 void equalize_bbone_bezier(float *data, int desired);
141 void b_bone_spline_setup(struct bPoseChannel *pchan, int rest, Mat4 result_array[MAX_BBONE_SUBDIV]);
142
143 /* like EBONE_VISIBLE */
144 #define PBONE_VISIBLE(arm, bone) ( \
145         CHECK_TYPE_INLINE(arm, bArmature *), \
146         CHECK_TYPE_INLINE(bone, Bone *), \
147         (((bone)->layer & (arm)->layer) && !((bone)->flag & BONE_HIDDEN_P)) \
148         )
149
150 #define PBONE_SELECTABLE(arm, bone) \
151         (PBONE_VISIBLE(arm, bone) && !((bone)->flag & BONE_UNSELECTABLE))
152
153 /* Evaluation helpers */
154 struct bKinematicConstraint;
155 struct bPose;
156 struct bSplineIKConstraint;
157 struct EvaluationContext;
158
159 struct bPoseChannel *BKE_armature_ik_solver_find_root(
160         struct bPoseChannel *pchan,
161         struct bKinematicConstraint *data);
162 struct bPoseChannel *BKE_armature_splineik_solver_find_root(
163         struct bPoseChannel *pchan,
164         struct bSplineIKConstraint *data);
165
166 void BKE_pose_splineik_init_tree(struct Scene *scene, struct Object *ob, float ctime);
167 void BKE_splineik_execute_tree(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan_root, float ctime);
168
169 void BKE_pose_eval_init(struct EvaluationContext *eval_ctx,
170                         struct Scene *scene,
171                         struct Object *ob,
172                         struct bPose *pose);
173
174 void BKE_pose_eval_bone(struct EvaluationContext *eval_ctx,
175                         struct Scene *scene,
176                         struct Object *ob,
177                         struct bPoseChannel *pchan);
178
179 void BKE_pose_constraints_evaluate(struct EvaluationContext *eval_ctx,
180                                    struct Scene *scene,
181                                    struct Object *ob,
182                                    struct bPoseChannel *pchan);
183
184 void BKE_pose_bone_done(struct EvaluationContext *eval_ctx,
185                         struct bPoseChannel *pchan);
186
187 void BKE_pose_iktree_evaluate(struct EvaluationContext *eval_ctx,
188                               struct Scene *scene,
189                               struct Object *ob,
190                               struct bPoseChannel *rootchan);
191
192 void BKE_pose_splineik_evaluate(struct EvaluationContext *eval_ctx,
193                                 struct Scene *scene,
194                                 struct Object *ob,
195                                 struct bPoseChannel *rootchan);
196
197 void BKE_pose_eval_flush(struct EvaluationContext *eval_ctx,
198                          struct Scene *scene,
199                          struct Object *ob,
200                          struct bPose *pose);
201
202 void BKE_pose_eval_proxy_copy(struct EvaluationContext *eval_ctx,
203                               struct Object *ob);
204
205 #ifdef __cplusplus
206 }
207 #endif
208
209 #endif
210