Merging r47307 through r47325 from trunk into soc-2011-tomato
[blender.git] / source / blender / editors / include / ED_keyframing.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) 2008, Blender Foundation
19  * This is a new part of Blender (with some old code)
20  *
21  * Contributor(s): Joshua Leung
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file ED_keyframing.h
27  *  \ingroup editors
28  */
29
30 #ifndef __ED_KEYFRAMING_H__
31 #define __ED_KEYFRAMING_H__
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct Main;
38 struct ListBase;
39 struct ID;
40 struct Scene;
41
42 struct KeyingSet;
43
44 struct bAction;
45 struct FCurve;
46 struct BezTriple;
47
48 struct bPoseChannel;
49 struct bConstraint;
50
51 struct bContext;
52 struct wmOperatorType;
53 struct ReportList;
54
55 struct PointerRNA;
56 struct PropertyRNA;
57 struct EnumPropertyItem;
58
59 #include "RNA_types.h"
60
61 /* ************ Keyframing Management **************** */
62
63 /* Get the active settings for keyframing settings from context (specifically the given scene) 
64  *      - incl_mode: include settings from keyframing mode in the result (i.e. replace only)
65  */
66 short ANIM_get_keyframing_flags(struct Scene *scene, short incl_mode);
67
68 /* -------- */
69
70 /* Get (or add relevant data to be able to do so) the Active Action for the given 
71  * Animation Data block, given an ID block where the Animation Data should reside.
72  */
73 struct bAction *verify_adt_action(struct ID *id, short add);
74
75 /* Get (or add relevant data to be able to do so) F-Curve from the given Action. 
76  * This assumes that all the destinations are valid.
77  */
78 struct FCurve *verify_fcurve(struct bAction *act, const char group[], struct PointerRNA *ptr,
79                              const char rna_path[], const int array_index, short add);
80
81 /* -------- */
82
83 /* Lesser Keyframing API call:
84  *  Use this when validation of necessary animation data isn't necessary as it already
85  *  exists, and there is a beztriple that can be directly copied into the array.
86  */
87 int insert_bezt_fcurve(struct FCurve *fcu, struct BezTriple *bezt, short flag);
88
89 /* Main Keyframing API call: 
90  *  Use this when validation of necessary animation data isn't necessary as it
91  *  already exists. It will insert a keyframe using the current value being keyframed.
92  *  Returns the index at which a keyframe was added (or -1 if failed)
93  */
94 int insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag);
95
96 /* -------- */
97
98 /* Secondary Keyframing API calls: 
99  *      Use this to insert a keyframe using the current value being keyframed, in the 
100  *      nominated F-Curve (no creation of animation data performed). Returns success.
101  */
102 short insert_keyframe_direct(struct ReportList *reports, struct PointerRNA ptr, struct PropertyRNA *prop, struct FCurve *fcu, float cfra, short flag);
103
104 /* -------- */
105
106 /* Main Keyframing API calls: 
107  *      Use this to create any necessary animation data, and then insert a keyframe
108  *      using the current value being keyframed, in the relevant place. Returns success.
109  */
110 short insert_keyframe(struct ReportList *reports, struct ID *id, struct bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag);
111
112 /* Main Keyframing API call: 
113  *  Use this to delete keyframe on current frame for relevant channel. Will perform checks just in case.
114  */
115 short delete_keyframe(struct ReportList *reports, struct ID *id, struct bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag);
116
117 /* ************ Keying Sets ********************** */
118
119 /* forward decl. for this struct which is declared a bit later... */
120 struct KeyingSetInfo;
121 struct ExtensionRNA;
122
123 /* Polling Callback for KeyingSets */
124 typedef int (*cbKeyingSet_Poll)(struct KeyingSetInfo *ksi, struct bContext *C);
125 /* Context Iterator Callback for KeyingSets */
126 typedef void (*cbKeyingSet_Iterator)(struct KeyingSetInfo *ksi, struct bContext *C, struct KeyingSet *ks);
127 /* Property Specifier Callback for KeyingSets (called from iterators) */
128 typedef void (*cbKeyingSet_Generate)(struct KeyingSetInfo *ksi, struct bContext *C, struct KeyingSet *ks, struct PointerRNA *ptr); 
129
130
131 /* Callback info for 'Procedural' KeyingSets to use */
132 typedef struct KeyingSetInfo {
133         struct KeyingSetInfo *next, *prev;
134         
135         /* info */
136         /* identifier used for class name, which KeyingSet instances reference as "Typeinfo Name" */
137         char idname[64];
138         /* identifier so that user can hook this up to a KeyingSet (used as label). */
139         char name[64];
140         /* short help/description. */
141         char description[240]; /* RNA_DYN_DESCR_MAX */
142         /* keying settings */
143         short keyingflag;
144         
145         /* polling callbacks */
146         /* callback for polling the context for whether the right data is available */
147         cbKeyingSet_Poll poll;
148         
149         /* generate callbacks */
150         /* iterator to use to go through collections of data in context
151          *  - this callback is separate from the 'adding' stage, allowing
152          *    BuiltIn KeyingSets to be manually specified to use
153          */
154         cbKeyingSet_Iterator iter;
155         /* generator to use to add properties based on the data found by iterator */
156         cbKeyingSet_Generate generate;
157         
158         /* RNA integration */
159         struct ExtensionRNA ext;
160 } KeyingSetInfo;
161
162 /* -------- */
163
164 /* Add another data source for Relative Keying Sets to be evaluated with */
165 void ANIM_relative_keyingset_add_source(ListBase *dsources, struct ID *id, struct StructRNA *srna, void *data);
166
167
168 /* mode for modify_keyframes */
169 typedef enum eModifyKey_Modes {
170         MODIFYKEY_MODE_INSERT = 0,
171         MODIFYKEY_MODE_DELETE,
172 } eModifyKey_Modes;
173
174 /* return codes for errors (with Relative KeyingSets) */
175 typedef enum eModifyKey_Returns {
176         /* context info was invalid for using the Keying Set */
177         MODIFYKEY_INVALID_CONTEXT = -1,
178         /* there isn't any typeinfo for generating paths from context */
179         MODIFYKEY_MISSING_TYPEINFO = -2,
180 } eModifyKey_Returns;
181
182 /* poll the current KeyingSet, updating it's set of paths (if "builtin"/"relative") for context changes */
183 short ANIM_validate_keyingset(struct bContext *C, ListBase *dsources, struct KeyingSet *ks);
184
185 /* use the specified KeyingSet to add/remove various Keyframes on the specified frame */
186 int ANIM_apply_keyingset(struct bContext *C, ListBase *dsources, struct bAction *act, struct KeyingSet *ks, short mode, float cfra);
187
188 /* -------- */
189
190 /* Get the first builtin KeyingSet with the given name, which occurs after the given one (or start of list if none given) */
191 struct KeyingSet *ANIM_builtin_keyingset_get_named(struct KeyingSet *prevKS, const char name[]);
192
193 /* Find KeyingSet type info given a name */
194 KeyingSetInfo *ANIM_keyingset_info_find_name(const char name[]);
195
196 /* for RNA type registrations... */
197 void ANIM_keyingset_info_register(KeyingSetInfo *ksi);
198 void ANIM_keyingset_info_unregister(struct Main *bmain, KeyingSetInfo *ksi);
199
200 /* cleanup on exit */
201 void ANIM_keyingset_infos_exit(void);
202
203 /* -------- */
204
205 /* Get the active KeyingSet for the given scene */
206 struct KeyingSet *ANIM_scene_get_active_keyingset(struct Scene *scene);
207
208 /* Get the index of the Keying Set provided, for the given Scene */
209 int ANIM_scene_get_keyingset_index(struct Scene *scene, struct KeyingSet *ks);
210
211 /* Get Keying Set to use for Auto-Keyframing some transforms */
212 struct KeyingSet *ANIM_get_keyingset_for_autokeying(struct Scene *scene, const char *tranformKSName);
213
214 /* Dynamically populate an enum of Keying Sets */
215 struct EnumPropertyItem *ANIM_keying_sets_enum_itemf(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int *free);
216
217 /* Check if KeyingSet can be used in the current context */
218 short ANIM_keyingset_context_ok_poll(struct bContext *C, struct KeyingSet *ks);
219
220 /* ************ Drivers ********************** */
221
222 /* Flags for use by driver creation calls */
223 typedef enum eCreateDriverFlags {
224         CREATEDRIVER_WITH_DEFAULT_DVAR  = (1 << 0),   /* create drivers with a default variable for nicer UI */
225 } eCreateDriverFlags;
226
227 /* -------- */
228
229 /* Low-level call to add a new driver F-Curve. This shouldn't be used directly for most tools,
230  * although there are special cases where this approach is preferable.
231  */
232 struct FCurve *verify_driver_fcurve(struct ID *id, const char rna_path[], const int array_index, short add);
233
234 /* -------- */
235
236 /* Returns whether there is a driver in the copy/paste buffer to paste */
237 short ANIM_driver_can_paste(void);
238
239 /* Main Driver Management API calls:
240  *  Add a new driver for the specified property on the given ID block
241  */
242 short ANIM_add_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag, int type);
243
244 /* Main Driver Management API calls:
245  *  Remove the driver for the specified property on the given ID block (if available)
246  */
247 short ANIM_remove_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag);
248
249 /* Main Driver Management API calls:
250  *  Make a copy of the driver for the specified property on the given ID block
251  */
252 short ANIM_copy_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag);
253
254 /* Main Driver Management API calls:
255  *  Add a new driver for the specified property on the given ID block or replace an existing one
256  *      with the driver + driver-curve data from the buffer 
257  */
258 short ANIM_paste_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag);
259
260 /* ************ Auto-Keyframing ********************** */
261 /* Notes:
262  * - All the defines for this (User-Pref settings and Per-Scene settings)
263  *  are defined in DNA_userdef_types.h
264  * - Scene settings take presidence over those for userprefs, with old files
265  *  inheriting userpref settings for the scene settings
266  * - "On/Off + Mode" are stored per Scene, but "settings" are currently stored
267  *  as userprefs
268  */
269
270 /* Auto-Keying macros for use by various tools */
271 /* check if auto-keyframing is enabled (per scene takes presidence) */
272 #define IS_AUTOKEY_ON(scene)  ((scene) ? (scene->toolsettings->autokey_mode & AUTOKEY_ON) : (U.autokey_mode & AUTOKEY_ON))
273 /* check the mode for auto-keyframing (per scene takes presidence)  */
274 #define IS_AUTOKEY_MODE(scene, mode)  ((scene) ? (scene->toolsettings->autokey_mode == AUTOKEY_MODE_##mode) : (U.autokey_mode == AUTOKEY_MODE_##mode))
275 /* check if a flag is set for auto-keyframing (per scene takes presidence) */
276 #define IS_AUTOKEY_FLAG(scene, flag) \
277         ((scene) ? \
278                 ((scene->toolsettings->autokey_flag & AUTOKEY_FLAG_##flag) || (U.autokey_flag & AUTOKEY_FLAG_##flag)) \
279          : \
280                 (U.autokey_flag & AUTOKEY_FLAG_##flag))
281
282 /* auto-keyframing feature - checks for whether anything should be done for the current frame */
283 int autokeyframe_cfra_can_key(struct Scene *scene, struct ID *id);
284
285 /* ************ Keyframe Checking ******************** */
286
287 /* Lesser Keyframe Checking API call:
288  *      - Used for the buttons to check for keyframes...
289  */
290 short fcurve_frame_has_keyframe(struct FCurve *fcu, float frame, short filter);
291
292 /* Main Keyframe Checking API call:
293  * Checks whether a keyframe exists for the given ID-block one the given frame.
294  *  - It is recommended to call this method over the other keyframe-checkers directly,
295  *    in case some detail of the implementation changes...
296  *      - frame: the value of this is quite often result of BKE_scene_frame_get()
297  */
298 short id_frame_has_keyframe(struct ID *id, float frame, short filter);
299
300 /* filter flags for id_cfra_has_keyframe 
301  *
302  * WARNING: do not alter order of these, as also stored in files
303  *      (for v3d->keyflags)
304  */
305 typedef enum eAnimFilterFlags {
306         /* general */
307         ANIMFILTER_KEYS_LOCAL   = (1 << 0),       /* only include locally available anim data */
308         ANIMFILTER_KEYS_MUTED   = (1 << 1),       /* include muted elements */
309         ANIMFILTER_KEYS_ACTIVE  = (1 << 2),       /* only include active-subelements */
310
311         /* object specific */
312         ANIMFILTER_KEYS_NOMAT   = (1 << 9),   /* don't include material keyframes */
313         ANIMFILTER_KEYS_NOSKEY  = (1 << 10),  /* don't include shape keys (for geometry) */
314 } eAnimFilterFlags;
315
316 /* utility funcs for auto keyframe */
317 int ED_autokeyframe_object(struct bContext *C, struct Scene *scene, struct Object *ob, struct KeyingSet *ks);
318 int ED_autokeyframe_pchan(struct bContext *C, struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, struct KeyingSet *ks);
319
320 /* Names for builtin keying sets so we don't confuse these with labels/text,
321  * defined in python script: keyingsets_builtins.py */
322 #define ANIM_KS_LOCATION_ID         "Location"
323 #define ANIM_KS_ROTATION_ID         "Rotation"
324 #define ANIM_KS_SCALING_ID          "Scaling"
325 #define ANIM_KS_LOC_ROT_SCALE_ID    "LocRotScale"
326 #define ANIM_KS_AVAILABLE_ID        "Available"
327 #define ANIM_KS_WHOLE_CHARACTER_ID  "WholeCharacter"
328
329 #ifdef __cplusplus
330 }
331 #endif
332
333 #endif /*  __ED_KEYFRAMING_H__ */