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 EvaluationContext;
43 struct IDProperty;
44 struct ListBase;
45 struct MeshDeformModifierData;
46 struct DerivedMesh;
47 struct Object;
48 struct ReportList;
49 struct Scene;
50 struct ViewLayer;
51 struct ViewContext;
52 struct wmKeyConfig;
53 struct wmOperator;
54 struct Main;
55
56 typedef struct EditBone {
57         struct EditBone *next, *prev;
58         struct IDProperty *prop; /* User-Defined Properties on this Bone */
59         struct EditBone *parent; /* Editbones have a one-way link  (i.e. children refer
60                                   * to parents.  This is converted to a two-way link for
61                                   * normal bones when leaving editmode. */
62         char    name[64];       /* MAXBONENAME */
63         float   roll;           /* Roll along axis.  We'll ultimately use the axis/angle method
64                                  * for determining the transformation matrix of the bone.  The axis
65                                  * is tail-head while roll provides the angle. Refer to Graphics
66                                  * Gems 1 p. 466 (section IX.6) if it's not already in here somewhere*/
67
68         float head[3];          /* Orientation and length is implicit during editing */
69         float tail[3];
70         /* All joints are considered to have zero rotation with respect to
71          * their parents.       Therefore any rotations specified during the
72          * animation are automatically relative to the bones' rest positions*/
73         int flag;
74         int layer;
75         
76         float dist, weight;
77         float xwidth, length, zwidth;  /* put them in order! transform uses this as scale */
78         float rad_head, rad_tail;
79
80         /* Bendy-Bone parameters */
81         float roll1, roll2;
82         float curveOutX, curveOutY;
83         float curveInX, curveInY;
84         float ease1, ease2;
85         float scaleIn, scaleOut;
86
87         float oldlength;        /* for envelope scaling */
88         
89         short segments;
90
91         /* Used for display */
92         float disp_mat[4][4];  /*  in Armature space, rest pos matrix */
93         float disp_tail_mat[4][4];  /*  in Armature space, rest pos matrix */
94         /* 32 == MAX_BBONE_SUBDIV */
95         float disp_bbone_mat[32][4][4]; /*  in Armature space, rest pos matrix */
96
97         /* Used to store temporary data */
98         union {
99                 struct EditBone *ebone;
100                 struct Bone     *bone;
101                 void            *p;
102                 int              i;
103         } temp;
104 } EditBone;
105
106 #define BONESEL_ROOT    (1 << 28)
107 #define BONESEL_TIP     (1 << 29)
108 #define BONESEL_BONE    (1 << 30)
109 #define BONESEL_ANY     (BONESEL_TIP | BONESEL_ROOT | BONESEL_BONE)
110
111 #define BONESEL_NOSEL   (1u << 31u)
112
113 /* useful macros */
114 #define EBONE_VISIBLE(arm, ebone) ( \
115         CHECK_TYPE_INLINE(arm, bArmature *), \
116         CHECK_TYPE_INLINE(ebone, EditBone *), \
117         (((arm)->layer & (ebone)->layer) && !((ebone)->flag & BONE_HIDDEN_A)) \
118         )
119
120 #define EBONE_SELECTABLE(arm, ebone) (EBONE_VISIBLE(arm, ebone) && !(ebone->flag & BONE_UNSELECTABLE))
121
122 #define EBONE_EDITABLE(ebone) ( \
123         CHECK_TYPE_INLINE(ebone, EditBone *), \
124         (((ebone)->flag & BONE_SELECTED) && !((ebone)->flag & BONE_EDITMODE_LOCKED)) \
125         )
126
127 /* used in armature_select_hierarchy_exec() */
128 #define BONE_SELECT_PARENT  0
129 #define BONE_SELECT_CHILD   1
130
131 /* armature_ops.c */
132 void ED_operatortypes_armature(void);
133 void ED_operatormacros_armature(void);
134 void ED_keymap_armature(struct wmKeyConfig *keyconf);
135
136 /* editarmature.c */
137 void ED_armature_from_edit(struct bArmature *arm);
138 void ED_armature_to_edit(struct bArmature *arm);
139 void ED_armature_edit_free(struct bArmature *arm);
140
141 void ED_armature_deselect_all(struct Object *obedit);
142 void ED_armature_deselect_all_visible(struct Object *obedit);
143
144 bool ED_do_pose_selectbuffer(
145         const struct EvaluationContext *eval_ctx,
146         struct ViewLayer *view_layer, struct Base *base, const unsigned int *buffer, short hits,
147         bool extend, bool deselect, bool toggle, bool do_nearest);
148 bool ED_armature_select_pick(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
149 int join_armature_exec(struct bContext *C, struct wmOperator *op);
150 struct Bone *get_indexed_bone(struct Object *ob, int index);
151 float ED_rollBoneToVector(EditBone *bone, const float new_up_axis[3], const bool axis_only);
152 EditBone *ED_armature_bone_find_name(const ListBase *edbo, const char *name);
153 EditBone *ED_armature_bone_get_mirrored(const struct ListBase *edbo, EditBone *ebo);
154 void ED_armature_sync_selection(struct ListBase *edbo);
155 void ED_armature_validate_active(struct bArmature *arm);
156
157 EditBone *ED_armature_edit_bone_add_primitive(struct Object *obedit_arm, float length, bool view_aligned);
158 EditBone *ED_armature_edit_bone_add(struct bArmature *arm, const char *name);
159
160 void ED_armature_edit_bone_remove_ex(struct bArmature *arm, EditBone *exBone, bool clear_connected);
161 void ED_armature_edit_bone_remove(struct bArmature *arm, EditBone *exBone);
162
163 bool ED_armature_ebone_is_child_recursive(EditBone *ebone_parent, EditBone *ebone_child);
164 EditBone *ED_armature_bone_find_shared_parent(EditBone *ebone_child[], const unsigned int ebone_child_tot);
165
166 void ED_armature_ebone_to_mat3(EditBone *ebone, float mat[3][3]);
167 void ED_armature_ebone_to_mat4(EditBone *ebone, float mat[4][4]);
168
169 void ED_armature_ebone_from_mat3(EditBone *ebone, float mat[3][3]);
170 void ED_armature_ebone_from_mat4(EditBone *ebone, float mat[4][4]);
171
172 void transform_armature_mirror_update(struct Object *obedit);
173 void ED_armature_origin_set(struct Object *ob, float cursor[3], int centermode, int around);
174
175 void ED_armature_transform_bones(struct bArmature *arm, float mat[4][4], const bool do_props);
176 void ED_armature_apply_transform(struct Object *ob, float mat[4][4], const bool do_props);
177 void ED_armature_transform(struct bArmature *arm, float mat[4][4], const bool do_props);
178
179 #define ARM_GROUPS_NAME     1
180 #define ARM_GROUPS_ENVELOPE 2
181 #define ARM_GROUPS_AUTO     3
182
183 void create_vgroups_from_armature(
184         struct ReportList *reports, const struct EvaluationContext *eval_ctx, struct Scene *scene,
185         struct Object *ob, struct Object *par, const int mode, const bool mirror);
186
187 /* if bone is already in list, pass it as param to ignore it */
188 void unique_editbone_name(struct ListBase *ebones, char *name, EditBone *bone);
189 void ED_armature_bone_rename(struct bArmature *arm, const char *oldnamep, const char *newnamep);
190 void ED_armature_bones_flip_names(struct bArmature *arm, struct ListBase *bones_names, const bool do_strip_numbers);
191
192 void undo_push_armature(struct bContext *C, const char *name);
193
194 /* low level selection functions which handle */
195 int  ED_armature_ebone_selectflag_get(const EditBone *ebone);
196 void ED_armature_ebone_selectflag_set(EditBone *ebone, int flag);
197 void ED_armature_ebone_select_set(EditBone *ebone, bool select);
198 void ED_armature_ebone_selectflag_enable(EditBone *ebone, int flag);
199 void ED_armature_ebone_selectflag_disable(EditBone *ebone, int flag);
200
201 /* armature_utils.c */
202 void ED_armature_ebone_listbase_temp_clear(struct ListBase *lb);
203 void ED_armature_ebone_listbase_free(struct ListBase *lb);
204 void ED_armature_ebone_listbase_copy(struct ListBase *lb_dst, struct ListBase *lb_src);
205
206 /* poseobject.c */
207 void ED_armature_exit_posemode(struct bContext *C, struct Base *base);
208 void ED_armature_enter_posemode(struct bContext *C, struct Base *base);
209 void ED_pose_de_selectall(struct Object *ob, int select_mode, const bool ignore_visibility);
210 void ED_pose_bone_select(struct Object *ob, struct bPoseChannel *pchan, bool select);
211 void ED_pose_recalculate_paths(struct bContext *C, struct Scene *scene, struct Object *ob);
212 struct Object *ED_pose_object_from_context(struct bContext *C);
213
214 /* sketch */
215
216 int ED_operator_sketch_mode_active_stroke(struct bContext *C);
217 int ED_operator_sketch_full_mode(struct bContext *C);
218 int ED_operator_sketch_mode(const struct bContext *C);
219
220 void BIF_convertSketch(struct bContext *C);
221 void BIF_deleteSketch(struct bContext *C);
222 void BIF_selectAllSketch(struct bContext *C, int mode); /* -1: deselect, 0: select, 1: toggle */
223
224 void  BIF_makeListTemplates(const struct bContext *C);
225 int   BIF_currentTemplate(const struct bContext *C);
226 void  BIF_freeTemplates(struct bContext *C);
227 void  BIF_setTemplate(struct bContext *C, int index);
228 int   BIF_nbJointsTemplate(const struct bContext *C);
229 const char *BIF_nameBoneTemplate(const struct bContext *C);
230
231 void BDR_drawSketch(const struct bContext *vc);
232 int BDR_drawSketchNames(struct ViewContext *vc);
233
234 /* meshlaplacian.c */
235 void mesh_deform_bind(struct Scene *scene,
236                       struct MeshDeformModifierData *mmd,
237                       struct DerivedMesh *cagedm,
238                       float *vertexcos, int totvert, float cagemat[4][4]);
239         
240 #ifdef __cplusplus
241 }
242 #endif
243
244 #endif /* __ED_ARMATURE_H__ */