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