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