Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / armature / armature_intern.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) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/armature/armature_intern.h
28  *  \ingroup edarmature
29  */
30
31 #ifndef __ARMATURE_INTERN_H__
32 #define __ARMATURE_INTERN_H__
33
34 /* internal exports only */
35 struct wmOperatorType;
36
37 struct bContext;
38 struct Scene;
39 struct Object;
40 struct Base;
41 struct bAction;
42 struct bPoseChannel;
43
44 struct bArmature;
45 struct EditBone;
46 struct Bone;
47
48 struct ListBase;
49 struct LinkData;
50
51 /* ******************************************************* */
52 /* Armature EditMode Operators */
53 void ARMATURE_OT_bone_primitive_add(struct wmOperatorType *ot);
54
55 void ARMATURE_OT_align(struct wmOperatorType *ot);
56 void ARMATURE_OT_calculate_roll(struct wmOperatorType *ot);
57 void ARMATURE_OT_roll_clear(struct wmOperatorType *ot);
58 void ARMATURE_OT_switch_direction(struct wmOperatorType *ot);
59
60 void ARMATURE_OT_subdivide(struct wmOperatorType *ot);
61
62 void ARMATURE_OT_parent_set(struct wmOperatorType *ot);
63 void ARMATURE_OT_parent_clear(struct wmOperatorType *ot);
64
65 void ARMATURE_OT_select_all(struct wmOperatorType *ot);
66 void ARMATURE_OT_select_mirror(struct wmOperatorType *ot);
67 void ARMATURE_OT_select_more(struct wmOperatorType *ot);
68 void ARMATURE_OT_select_less(struct wmOperatorType *ot);
69 void ARMATURE_OT_select_hierarchy(struct wmOperatorType *ot);
70 void ARMATURE_OT_select_linked(struct wmOperatorType *ot);
71 void ARMATURE_OT_select_similar(struct wmOperatorType *ot);
72 void ARMATURE_OT_shortest_path_pick(struct wmOperatorType *ot);
73
74 void ARMATURE_OT_delete(struct wmOperatorType *ot);
75 void ARMATURE_OT_dissolve(struct wmOperatorType *ot);
76 void ARMATURE_OT_duplicate(struct wmOperatorType *ot);
77 void ARMATURE_OT_symmetrize(struct wmOperatorType *ot);
78 void ARMATURE_OT_extrude(struct wmOperatorType *ot);
79 void ARMATURE_OT_hide(struct wmOperatorType *ot);
80 void ARMATURE_OT_reveal(struct wmOperatorType *ot);
81 void ARMATURE_OT_click_extrude(struct wmOperatorType *ot);
82 void ARMATURE_OT_fill(struct wmOperatorType *ot);
83 void ARMATURE_OT_merge(struct wmOperatorType *ot);
84 void ARMATURE_OT_separate(struct wmOperatorType *ot);
85 void ARMATURE_OT_split(struct wmOperatorType *ot);
86
87 void ARMATURE_OT_autoside_names(struct wmOperatorType *ot);
88 void ARMATURE_OT_flip_names(struct wmOperatorType *ot);
89
90 void ARMATURE_OT_layers_show_all(struct wmOperatorType *ot);
91 void ARMATURE_OT_armature_layers(struct wmOperatorType *ot);
92 void ARMATURE_OT_bone_layers(struct wmOperatorType *ot);
93
94 /* ******************************************************* */
95 /* Pose-Mode Operators */
96 void POSE_OT_hide(struct wmOperatorType *ot);
97 void POSE_OT_reveal(struct wmOperatorType *ot);
98
99 void POSE_OT_armature_apply(struct wmOperatorType *ot);
100 void POSE_OT_visual_transform_apply(struct wmOperatorType *ot);
101
102 void POSE_OT_rot_clear(struct wmOperatorType *ot);
103 void POSE_OT_loc_clear(struct wmOperatorType *ot);
104 void POSE_OT_scale_clear(struct wmOperatorType *ot);
105 void POSE_OT_transforms_clear(struct wmOperatorType *ot);
106 void POSE_OT_user_transforms_clear(struct wmOperatorType *ot);
107
108 void POSE_OT_copy(struct wmOperatorType *ot);
109 void POSE_OT_paste(struct wmOperatorType *ot);
110
111 void POSE_OT_select_all(struct wmOperatorType *ot);
112 void POSE_OT_select_parent(struct wmOperatorType *ot);
113 void POSE_OT_select_hierarchy(struct wmOperatorType *ot);
114 void POSE_OT_select_linked(struct wmOperatorType *ot);
115 void POSE_OT_select_constraint_target(struct wmOperatorType *ot);
116 void POSE_OT_select_grouped(struct wmOperatorType *ot);
117 void POSE_OT_select_mirror(struct wmOperatorType *ot);
118
119 void POSE_OT_group_add(struct wmOperatorType *ot);
120 void POSE_OT_group_remove(struct wmOperatorType *ot);
121 void POSE_OT_group_move(struct wmOperatorType *ot);
122 void POSE_OT_group_sort(struct wmOperatorType *ot);
123 void POSE_OT_group_assign(struct wmOperatorType *ot);
124 void POSE_OT_group_unassign(struct wmOperatorType *ot);
125 void POSE_OT_group_select(struct wmOperatorType *ot);
126 void POSE_OT_group_deselect(struct wmOperatorType *ot);
127
128 void POSE_OT_paths_calculate(struct wmOperatorType *ot);
129 void POSE_OT_paths_update(struct wmOperatorType *ot);
130 void POSE_OT_paths_clear(struct wmOperatorType *ot);
131
132 void POSE_OT_autoside_names(struct wmOperatorType *ot);
133 void POSE_OT_flip_names(struct wmOperatorType *ot);
134
135 void POSE_OT_rotation_mode_set(struct wmOperatorType *ot);
136
137 void POSE_OT_quaternions_flip(struct wmOperatorType *ot);
138
139 void POSE_OT_bone_layers(struct wmOperatorType *ot);
140 void POSE_OT_toggle_bone_selection_overlay(struct wmOperatorType *ot);
141
142 /* ******************************************************* */
143 /* Pose Tool Utilities (for PoseLib, Pose Sliding, etc.) */
144 /* pose_utils.c */
145
146 /* Temporary data linking PoseChannels with the F-Curves they affect */
147 typedef struct tPChanFCurveLink {
148         struct tPChanFCurveLink *next, *prev;
149
150         ListBase fcurves;               /* F-Curves for this PoseChannel (wrapped with LinkData) */
151         struct bPoseChannel *pchan;     /* Pose Channel which data is attached to */
152
153         char *pchan_path;               /* RNA Path to this Pose Channel (needs to be freed when we're done) */
154
155         float oldloc[3];                /* transform values at start of operator (to be restored before each modal step) */
156         float oldrot[3];
157         float oldscale[3];
158         float oldquat[4];
159         float oldangle;
160         float oldaxis[3];
161
162         float roll1, roll2;             /* old bbone values (to be restored along with the transform properties) */
163         float curveInX, curveInY;       /* (NOTE: we haven't renamed these this time, as their names are already long enough) */
164         float curveOutX, curveOutY;
165         float ease1, ease2;
166         float scaleIn, scaleOut;
167
168         struct IDProperty *oldprops;    /* copy of custom properties at start of operator (to be restored before each modal step) */
169 } tPChanFCurveLink;
170
171 /* ----------- */
172
173 void poseAnim_mapping_get(struct bContext *C, ListBase *pfLinks, struct Object *ob, struct bAction *act);
174 void poseAnim_mapping_free(ListBase *pfLinks);
175
176 void poseAnim_mapping_refresh(struct bContext *C, struct Scene *scene, struct Object *ob);
177 void poseAnim_mapping_reset(ListBase *pfLinks);
178 void poseAnim_mapping_autoKeyframe(struct bContext *C, struct Scene *scene, struct Object *ob, ListBase *pfLinks, float cframe);
179
180 LinkData *poseAnim_mapping_getNextFCurve(ListBase *fcuLinks, LinkData *prev, const char *path);
181
182 /* ******************************************************* */
183 /* PoseLib */
184 /* pose_lib.c */
185
186 void POSELIB_OT_new(struct wmOperatorType *ot);
187 void POSELIB_OT_unlink(struct wmOperatorType *ot);
188
189 void POSELIB_OT_action_sanitize(struct wmOperatorType *ot);
190
191 void POSELIB_OT_pose_add(struct wmOperatorType *ot);
192 void POSELIB_OT_pose_remove(struct wmOperatorType *ot);
193 void POSELIB_OT_pose_rename(struct wmOperatorType *ot);
194 void POSELIB_OT_pose_move(struct wmOperatorType *ot);
195
196 void POSELIB_OT_browse_interactive(struct wmOperatorType *ot);
197 void POSELIB_OT_apply_pose(struct wmOperatorType *ot);
198
199 /* ******************************************************* */
200 /* Pose Sliding Tools */
201 /* pose_slide.c */
202
203 void POSE_OT_push(struct wmOperatorType *ot);
204 void POSE_OT_relax(struct wmOperatorType *ot);
205 void POSE_OT_breakdown(struct wmOperatorType *ot);
206
207 void POSE_OT_propagate(struct wmOperatorType *ot);
208
209 /* ******************************************************* */
210 /* Various Armature Edit/Pose Editing API's */
211
212 /* Ideally, many of these defines would not be needed as everything would be strictly self-contained
213  * within each file, but some tools still have a bit of overlap which makes things messy -- Feb 2013
214  */
215
216 EditBone *make_boneList(struct ListBase *edbo, struct ListBase *bones, struct EditBone *parent, struct Bone *actBone);
217
218 /* duplicate method */
219 void preEditBoneDuplicate(struct ListBase *editbones);
220 void postEditBoneDuplicate(struct ListBase *editbones, struct Object *ob);
221 struct EditBone *duplicateEditBone(struct EditBone *curBone, const char *name, struct ListBase *editbones, struct Object *ob);
222 void updateDuplicateSubtarget(struct EditBone *dupBone, struct ListBase *editbones, struct Object *ob);
223
224 /* duplicate method (cross objects) */
225 /* editbones is the target list */
226 struct EditBone *duplicateEditBoneObjects(struct EditBone *curBone, const char *name, struct ListBase *editbones, struct Object *src_ob, struct Object *dst_ob);
227
228 /* editbones is the source list */
229 void updateDuplicateSubtargetObjects(struct EditBone *dupBone, struct ListBase *editbones, struct Object *src_ob, struct Object *dst_ob);
230
231 EditBone *add_points_bone(struct Object *obedit, float head[3], float tail[3]);
232 void bone_free(struct bArmature *arm, struct EditBone *bone);
233
234 void armature_tag_select_mirrored(struct bArmature *arm);
235 void armature_select_mirrored_ex(struct bArmature *arm, const int flag);
236 void armature_select_mirrored(struct bArmature *arm);
237 void armature_tag_unselect(struct bArmature *arm);
238
239 void *get_nearest_bone(
240         struct bContext *C, const int xy[2], bool findunsel,
241         struct Base **r_base);
242
243 void *get_bone_from_selectbuffer(
244         struct Base **bases, uint bases_len,
245         bool is_editmode, const unsigned int *buffer, short hits,
246         bool findunsel, bool do_nearest,
247         struct Base **r_base);
248
249 int bone_looper(struct Object *ob, struct Bone *bone, void *data,
250                 int (*bone_func)(struct Object *, struct Bone *, void *));
251
252
253 #endif /* __ARMATURE_INTERN_H__ */
254