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