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