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