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