doxygen: blender/editors tagged.
[blender.git] / source / blender / editors / armature / armature_intern.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/editors/armature/armature_intern.h
30  *  \ingroup edarmature
31  */
32
33 #ifndef ED_ARMATURE_INTERN_H
34 #define ED_ARMATURE_INTERN_H
35
36 /* internal exports only */
37 struct wmOperatorType;
38
39 struct bContext;
40 struct Scene;
41 struct Object;
42 struct bAction;
43 struct bPoseChannel;
44
45 struct bArmature;
46 struct EditBone;
47
48 struct ListBase;
49 struct LinkData;
50
51 /* ******************************************************* */
52 /* editarmature.c 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_switch_direction(struct wmOperatorType *ot);
58
59 void ARMATURE_OT_subdivide(struct wmOperatorType *ot);
60
61 void ARMATURE_OT_parent_set(struct wmOperatorType *ot);
62 void ARMATURE_OT_parent_clear(struct wmOperatorType *ot);
63
64 void ARMATURE_OT_select_all(struct wmOperatorType *ot);
65 void ARMATURE_OT_select_inverse(struct wmOperatorType *ot);
66 void ARMATURE_OT_select_hierarchy(struct wmOperatorType *ot);
67 void ARMATURE_OT_select_linked(struct wmOperatorType *ot);
68
69 void ARMATURE_OT_delete(struct wmOperatorType *ot);
70 void ARMATURE_OT_duplicate(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
79 void ARMATURE_OT_autoside_names(struct wmOperatorType *ot);
80 void ARMATURE_OT_flip_names(struct wmOperatorType *ot);
81
82 void ARMATURE_OT_flags_set(struct wmOperatorType *ot);
83
84 void ARMATURE_OT_layers_show_all(struct wmOperatorType *ot);
85 void ARMATURE_OT_armature_layers(struct wmOperatorType *ot);
86 void ARMATURE_OT_bone_layers(struct wmOperatorType *ot);
87
88 /* ******************************************************* */
89 /* Pose-Mode Operators */
90 void POSE_OT_hide(struct wmOperatorType *ot);
91 void POSE_OT_reveal(struct wmOperatorType *ot);
92
93 void POSE_OT_armature_apply(struct wmOperatorType *ot);
94 void POSE_OT_visual_transform_apply(struct wmOperatorType *ot);
95
96 void POSE_OT_rot_clear(struct wmOperatorType *ot);
97 void POSE_OT_loc_clear(struct wmOperatorType *ot);
98 void POSE_OT_scale_clear(struct wmOperatorType *ot);
99 void POSE_OT_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_inverse(struct wmOperatorType *ot);
106 void POSE_OT_select_parent(struct wmOperatorType *ot);
107 void POSE_OT_select_hierarchy(struct wmOperatorType *ot);
108 void POSE_OT_select_linked(struct wmOperatorType *ot);
109 void POSE_OT_select_constraint_target(struct wmOperatorType *ot);
110 void POSE_OT_select_grouped(struct wmOperatorType *ot);
111 void POSE_OT_select_flip_active(struct wmOperatorType *ot);
112
113 void POSE_OT_group_add(struct wmOperatorType *ot);
114 void POSE_OT_group_remove(struct wmOperatorType *ot);
115 void POSE_OT_group_assign(struct wmOperatorType *ot);
116 void POSE_OT_group_unassign(struct wmOperatorType *ot);
117 void POSE_OT_group_select(struct wmOperatorType *ot);
118 void POSE_OT_group_deselect(struct wmOperatorType *ot);
119
120 void POSE_OT_paths_calculate(struct wmOperatorType *ot);
121 void POSE_OT_paths_clear(struct wmOperatorType *ot);
122
123 void POSE_OT_autoside_names(struct wmOperatorType *ot);
124 void POSE_OT_flip_names(struct wmOperatorType *ot);
125
126 void POSE_OT_quaternions_flip(struct wmOperatorType *ot);
127
128 void POSE_OT_flags_set(struct wmOperatorType *ot);
129
130 void POSE_OT_armature_layers(struct wmOperatorType *ot);
131 void POSE_OT_bone_layers(struct wmOperatorType *ot);
132
133 /* ******************************************************* */
134 /* Etch-A-Ton */
135
136 void SKETCH_OT_gesture(struct wmOperatorType *ot);
137 void SKETCH_OT_delete(struct wmOperatorType *ot);
138 void SKETCH_OT_draw_stroke(struct wmOperatorType *ot);
139 void SKETCH_OT_draw_preview(struct wmOperatorType *ot);
140 void SKETCH_OT_finish_stroke(struct wmOperatorType *ot);
141 void SKETCH_OT_cancel_stroke(struct wmOperatorType *ot);
142 void SKETCH_OT_convert(struct wmOperatorType *ot);
143 void SKETCH_OT_select(struct wmOperatorType *ot);
144
145 /* ******************************************************* */
146 /* Pose Tool Utilities (for PoseLib, Pose Sliding, etc.) */
147 /* poseUtils.c */
148
149 /* Temporary data linking PoseChannels with the F-Curves they affect */
150 typedef struct tPChanFCurveLink {
151         struct tPChanFCurveLink *next, *prev;
152         
153         ListBase fcurves;                       /* F-Curves for this PoseChannel (wrapped with LinkData) */
154         struct bPoseChannel *pchan;     /* Pose Channel which data is attached to */
155         
156         char *pchan_path;                       /* RNA Path to this Pose Channel (needs to be freed when we're done) */
157         
158                 // TODO: need to include axis-angle here at some stage
159         float oldloc[3];                        /* transform values at start of operator (to be restored before each modal step) */
160         float oldrot[3];
161         float oldscale[3];
162         float oldquat[4];
163 } tPChanFCurveLink;
164
165 /* ----------- */
166
167 void poseAnim_mapping_get(struct bContext *C, ListBase *pfLinks, struct Object *ob, struct bAction *act);
168 void poseAnim_mapping_free(ListBase *pfLinks);
169
170 void poseAnim_mapping_refresh(struct bContext *C, struct Scene *scene, struct Object *ob);
171 void poseAnim_mapping_reset(ListBase *pfLinks);
172 void poseAnim_mapping_autoKeyframe(struct bContext *C, struct Scene *scene, struct Object *ob, ListBase *pfLinks, float cframe);
173
174 LinkData *poseAnim_mapping_getNextFCurve(ListBase *fcuLinks, LinkData *prev, char *path);
175
176 /* ******************************************************* */
177 /* PoseLib */
178 /* poselib.c */
179
180 void POSELIB_OT_new(struct wmOperatorType *ot);
181 void POSELIB_OT_unlink(struct wmOperatorType *ot);
182
183 void POSELIB_OT_action_sanitise(struct wmOperatorType *ot);
184
185 void POSELIB_OT_pose_add(struct wmOperatorType *ot);
186 void POSELIB_OT_pose_remove(struct wmOperatorType *ot);
187 void POSELIB_OT_pose_rename(struct wmOperatorType *ot);
188
189 void POSELIB_OT_browse_interactive(struct wmOperatorType *ot);
190 void POSELIB_OT_apply_pose(struct wmOperatorType *ot);
191
192 /* ******************************************************* */
193 /* Pose Sliding Tools */
194 /* poseSlide.c */
195
196 void POSE_OT_push(struct wmOperatorType *ot);
197 void POSE_OT_relax(struct wmOperatorType *ot);
198 void POSE_OT_breakdown(struct wmOperatorType *ot);
199
200 /* ******************************************************* */
201 /* editarmature.c */
202
203 EditBone *make_boneList(struct ListBase *edbo, struct ListBase *bones, struct EditBone *parent, struct Bone *actBone);
204 void BIF_sk_selectStroke(struct bContext *C, short mval[2], short extend);
205
206 /* duplicate method */
207 void preEditBoneDuplicate(struct ListBase *editbones);
208 struct EditBone *duplicateEditBone(struct EditBone *curBone, char *name, struct ListBase *editbones, struct Object *ob);
209 void updateDuplicateSubtarget(struct EditBone *dupBone, struct ListBase *editbones, struct Object *ob);
210
211 /* duplicate method (cross objects */
212
213 /* editbones is the target list */
214 struct EditBone *duplicateEditBoneObjects(struct EditBone *curBone, char *name, struct ListBase *editbones, struct Object *src_ob, struct Object *dst_ob);
215
216 /* editbones is the source list */
217 void updateDuplicateSubtargetObjects(struct EditBone *dupBone, struct ListBase *editbones, struct Object *src_ob, struct Object *dst_ob);
218
219 #endif /* ED_ARMATURE_INTERN_H */
220