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