Merge branch 'blender2.7'
[blender.git] / source / blender / editors / include / ED_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  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file ED_armature.h
27  *  \ingroup editors
28  */
29
30 #ifndef __ED_ARMATURE_H__
31 #define __ED_ARMATURE_H__
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct bArmature;
38 struct Base;
39 struct bContext;
40 struct Bone;
41 struct bPoseChannel;
42 struct Depsgraph;
43 struct IDProperty;
44 struct ListBase;
45 struct Main;
46 struct MeshDeformModifierData;
47 struct Mesh;
48 struct Object;
49 struct ReportList;
50 struct Scene;
51 struct View3D;
52 struct ViewLayer;
53 struct ViewContext;
54 struct wmKeyConfig;
55 struct wmOperator;
56 struct Main;
57 struct UndoType;
58
59 typedef struct EditBone {
60         struct EditBone *next, *prev;
61         /** User-Defined Properties on this Bone */
62         struct IDProperty *prop;
63         /** Editbones have a one-way link  (i.e. children refer
64          * to parents.  This is converted to a two-way link for
65          * normal bones when leaving editmode. */
66         struct EditBone *parent;
67         /** (64 == MAXBONENAME) */
68         char    name[64];
69         /** Roll along axis.  We'll ultimately use the axis/angle method
70          * for determining the transformation matrix of the bone.  The axis
71          * is tail-head while roll provides the angle. Refer to Graphics
72          * Gems 1 p. 466 (section IX.6) if it's not already in here somewhere*/
73         float   roll;
74
75         /** Orientation and length is implicit during editing */
76         float head[3];
77         float tail[3];
78         /** All joints are considered to have zero rotation with respect to
79          * their parents. Therefore any rotations specified during the
80          * animation are automatically relative to the bones' rest positions*/
81         int flag;
82         int layer;
83
84         float dist, weight;
85         /** put them in order! transform uses this as scale */
86         float xwidth, length, zwidth;
87         float rad_head, rad_tail;
88
89         /* Bendy-Bone parameters */
90         float roll1, roll2;
91         float curveOutX, curveOutY;
92         float curveInX, curveInY;
93         float ease1, ease2;
94         float scaleIn, scaleOut;
95
96         /** for envelope scaling */
97         float oldlength;
98
99         short segments;
100
101         /** Type of next/prev bone handles */
102         char bbone_prev_type;
103         char bbone_next_type;
104         /** Next/prev bones to use as handle references when calculating bbones (optional) */
105         struct EditBone *bbone_prev;
106         struct EditBone *bbone_next;
107
108         /* Used for display */
109         /** in Armature space, rest pos matrix */
110         float disp_mat[4][4];
111         /** in Armature space, rest pos matrix */
112         float disp_tail_mat[4][4];
113         /** in Armature space, rest pos matrix (32 == MAX_BBONE_SUBDIV) */
114         float disp_bbone_mat[32][4][4];
115
116         /** connected child temporary during drawing */
117         struct EditBone *bbone_child;
118
119         /* Used to store temporary data */
120         union {
121                 struct EditBone *ebone;
122                 struct Bone     *bone;
123                 void            *p;
124                 int              i;
125         } temp;
126 } EditBone;
127
128 #define BONESEL_ROOT    (1 << 28)
129 #define BONESEL_TIP     (1 << 29)
130 #define BONESEL_BONE    (1 << 30)
131 #define BONESEL_ANY     (BONESEL_TIP | BONESEL_ROOT | BONESEL_BONE)
132
133 #define BONESEL_NOSEL   (1u << 31u)
134
135 /* useful macros */
136 #define EBONE_VISIBLE(arm, ebone) ( \
137         CHECK_TYPE_INLINE(arm, bArmature *), \
138         CHECK_TYPE_INLINE(ebone, EditBone *), \
139         (((arm)->layer & (ebone)->layer) && !((ebone)->flag & BONE_HIDDEN_A)) \
140         )
141
142 #define EBONE_SELECTABLE(arm, ebone) (EBONE_VISIBLE(arm, ebone) && !(ebone->flag & BONE_UNSELECTABLE))
143
144 #define EBONE_EDITABLE(ebone) ( \
145         CHECK_TYPE_INLINE(ebone, EditBone *), \
146         (((ebone)->flag & BONE_SELECTED) && !((ebone)->flag & BONE_EDITMODE_LOCKED)) \
147         )
148
149 /* used in armature_select_hierarchy_exec() */
150 #define BONE_SELECT_PARENT  0
151 #define BONE_SELECT_CHILD   1
152
153 /* armature_ops.c */
154 void ED_operatortypes_armature(void);
155 void ED_operatormacros_armature(void);
156 void ED_keymap_armature(struct wmKeyConfig *keyconf);
157
158 /* editarmature.c */
159 void ED_armature_from_edit(struct Main *bmain, struct bArmature *arm);
160 void ED_armature_to_edit(struct bArmature *arm);
161 void ED_armature_edit_free(struct bArmature *arm);
162
163 void ED_armature_edit_deselect_all(struct Object *obedit);
164 void ED_armature_edit_deselect_all_visible(struct Object *obedit);
165
166 void ED_armature_edit_deselect_all_multi(struct Object **objects, uint objects_len);
167 void ED_armature_edit_deselect_all_visible_multi(struct Object **objects, uint objects_len);
168
169 bool ED_armature_pose_select_pick_with_buffer(
170         struct ViewLayer *view_layer, struct View3D *v3d, struct Base *base, const unsigned int *buffer, short hits,
171         bool extend, bool deselect, bool toggle, bool do_nearest);
172 bool ED_armature_edit_select_pick(
173         struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
174
175 bool ED_armature_edit_select_op_from_tagged(
176         struct bArmature *arm, const int sel_op);
177
178 int join_armature_exec(struct bContext *C, struct wmOperator *op);
179 float ED_armature_ebone_roll_to_vector(const EditBone *bone, const float new_up_axis[3], const bool axis_only);
180 EditBone *ED_armature_ebone_find_name(const struct ListBase *edbo, const char *name);
181 EditBone *ED_armature_ebone_get_mirrored(const struct ListBase *edbo, EditBone *ebo);
182 void ED_armature_edit_sync_selection(struct ListBase *edbo);
183 void ED_armature_edit_validate_active(struct bArmature *arm);
184
185 struct Base *ED_armature_base_and_ebone_from_select_buffer(
186         struct Base **bases, uint bases_len, int hit, struct EditBone **r_ebone);
187 struct Object *ED_armature_object_and_ebone_from_select_buffer(
188         struct Object **objects, uint objects_len, int hit, struct EditBone **r_ebone);
189
190 struct Base *ED_armature_base_and_bone_from_select_buffer(
191         struct Base **bases, uint bases_len, int hit, struct Bone **r_bone);
192
193 EditBone *ED_armature_ebone_add_primitive(struct Object *obedit_arm, float length, bool view_aligned);
194 EditBone *ED_armature_ebone_add(struct bArmature *arm, const char *name);
195
196 void ED_armature_ebone_remove_ex(struct bArmature *arm, EditBone *exBone, bool clear_connected);
197 void ED_armature_ebone_remove(struct bArmature *arm, EditBone *exBone);
198
199 bool ED_armature_ebone_is_child_recursive(EditBone *ebone_parent, EditBone *ebone_child);
200 EditBone *ED_armature_ebone_find_shared_parent(EditBone *ebone_child[], const unsigned int ebone_child_tot);
201
202 void ED_armature_ebone_to_mat3(EditBone *ebone, float mat[3][3]);
203 void ED_armature_ebone_to_mat4(EditBone *ebone, float mat[4][4]);
204
205 void ED_armature_ebone_from_mat3(EditBone *ebone, float mat[3][3]);
206 void ED_armature_ebone_from_mat4(EditBone *ebone, float mat[4][4]);
207
208 void ED_armature_edit_transform_mirror_update(struct Object *obedit);
209 void ED_armature_origin_set(struct Main *bmain, struct Object *ob, float cursor[3], int centermode, int around);
210
211 void ED_armature_transform_bones(struct bArmature *arm, float mat[4][4], const bool do_props);
212 void ED_armature_transform_apply(struct Main *bmain, struct Object *ob, float mat[4][4], const bool do_props);
213 void ED_armature_transform(struct Main *bmain, struct bArmature *arm, float mat[4][4], const bool do_props);
214
215 #define ARM_GROUPS_NAME     1
216 #define ARM_GROUPS_ENVELOPE 2
217 #define ARM_GROUPS_AUTO     3
218
219 void ED_object_vgroup_calc_from_armature(
220         struct ReportList *reports, struct Depsgraph *depsgraph, struct Scene *scene,
221         struct Object *ob, struct Object *par, const int mode, const bool mirror);
222
223 /* if bone is already in list, pass it as param to ignore it */
224 void ED_armature_ebone_unique_name(struct ListBase *ebones, char *name, EditBone *bone);
225 void ED_armature_bone_rename(struct Main *bmain, struct bArmature *arm, const char *oldnamep, const char *newnamep);
226 void ED_armature_bones_flip_names(struct Main *bmain, struct bArmature *arm, struct ListBase *bones_names, const bool do_strip_numbers);
227
228 /* low level selection functions which handle */
229 int  ED_armature_ebone_selectflag_get(const EditBone *ebone);
230 void ED_armature_ebone_selectflag_set(EditBone *ebone, int flag);
231 void ED_armature_ebone_select_set(EditBone *ebone, bool select);
232 void ED_armature_ebone_selectflag_enable(EditBone *ebone, int flag);
233 void ED_armature_ebone_selectflag_disable(EditBone *ebone, int flag);
234
235 /* editarmature_undo.c */
236 void ED_armature_undosys_type(struct UndoType *ut);
237
238 /* armature_utils.c */
239 void ED_armature_ebone_listbase_temp_clear(struct ListBase *lb);
240 void ED_armature_ebone_listbase_free(struct ListBase *lb);
241 void ED_armature_ebone_listbase_copy(struct ListBase *lb_dst, struct ListBase *lb_src);
242
243 /* poseobject.c */
244 bool ED_object_posemode_exit_ex(struct Main *bmain, struct Object *ob);
245 bool ED_object_posemode_exit(struct bContext *C, struct Object *ob);
246 bool ED_object_posemode_enter_ex(struct Main *bmain, struct Object *ob);
247 bool ED_object_posemode_enter(struct bContext *C, struct Object *ob);
248 bool ED_pose_deselect_all(struct Object *ob, int select_mode, const bool ignore_visibility);
249 void ED_pose_deselect_all_multi(struct Object **objects, uint objects_len, int select_mode, const bool ignore_visibility);
250 void ED_pose_bone_select_tag_update(struct Object *ob);
251 void ED_pose_bone_select(struct Object *ob, struct bPoseChannel *pchan, bool select);
252 void ED_pose_recalculate_paths(struct bContext *C, struct Scene *scene, struct Object *ob, bool current_frame_only);
253 struct Object *ED_pose_object_from_context(struct bContext *C);
254
255 /* meshlaplacian.c */
256 void ED_mesh_deform_bind_callback(
257         struct MeshDeformModifierData *mmd,
258         struct Mesh *cagemesh,
259         float *vertexcos, int totvert, float cagemat[4][4]);
260
261 #ifdef __cplusplus
262 }
263 #endif
264
265 #endif /* __ED_ARMATURE_H__ */