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