Merge from trunk -r 25003:25745.
[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., 59 Temple Place * Suite 330, Boston, MA  02111*1307, 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 /* ************ Keyframing Management **************** */
51
52 /* Get the active settings for keyframing settings from context (specifically the given scene) 
53  *      - incl_mode: include settings from keyframing mode in the result (i.e. replace only)
54  */
55 short ANIM_get_keyframing_flags(struct Scene *scene, short incl_mode);
56
57 /* -------- */
58
59 /* Get (or add relevant data to be able to do so) the Active Action for the given 
60  * Animation Data block, given an ID block where the Animation Data should reside.
61  */
62 struct bAction *verify_adt_action(struct ID *id, short add);
63
64 /* Get (or add relevant data to be able to do so) F-Curve from the given Action. 
65  * This assumes that all the destinations are valid.
66  */
67 struct FCurve *verify_fcurve(struct bAction *act, const char group[], const char rna_path[], const int array_index, short add);
68
69 /* -------- */
70
71 /* Lesser Keyframing API call:
72  *      Use this when validation of necessary animation data isn't necessary as it already
73  *      exists, and there is a beztriple that can be directly copied into the array.
74  */
75 int insert_bezt_fcurve(struct FCurve *fcu, struct BezTriple *bezt, short flag);
76
77 /* Main Keyframing API call: 
78  *      Use this when validation of necessary animation data isn't necessary as it
79  *      already exists. It will insert a keyframe using the current value being keyframed.
80  *      Returns the index at which a keyframe was added (or -1 if failed)
81  */
82 int insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag);
83
84 /* -------- */
85
86 /* Secondary Keyframing API calls: 
87  *      Use this to insert a keyframe using the current value being keyframed, in the 
88  *      nominated F-Curve (no creation of animation data performed). Returns success.
89  */
90 short insert_keyframe_direct(struct PointerRNA ptr, struct PropertyRNA *prop, struct FCurve *fcu, float cfra, short flag);
91
92
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 /* temporary struct to gather data combos to keyframe
110  * (is used by modify_keyframes for 'relative' KeyingSets, provided via the dsources arg)
111  */
112 typedef struct bCommonKeySrc {
113         struct bCommonKeySrc *next, *prev;
114                 
115                 /* general data/destination-source settings */
116         struct ID *id;                                  /* id-block this comes from */
117         
118                 /* specific cases */
119         struct bPoseChannel *pchan;     
120         struct bConstraint *con;
121 } bCommonKeySrc;
122
123 /* -------- */
124
125 /* mode for modify_keyframes */
126 typedef enum eModifyKey_Modes {
127         MODIFYKEY_MODE_INSERT = 0,
128         MODIFYKEY_MODE_DELETE,
129 } eModifyKey_Modes;
130
131 /* Keyframing Helper Call - use the provided Keying Set to Add/Remove Keyframes */
132 int modify_keyframes(struct Scene *scene, struct ListBase *dsources, struct bAction *act, struct KeyingSet *ks, short mode, float cfra);
133
134 /* -------- */
135
136 /* Generate menu of KeyingSets */
137 char *ANIM_build_keyingsets_menu(struct ListBase *list, short for_edit);
138
139 /* Get the first builtin KeyingSet with the given name, which occurs after the given one (or start of list if none given) */
140 struct KeyingSet *ANIM_builtin_keyingset_get_named(struct KeyingSet *prevKS, char name[]);
141
142 /* Initialise builtin KeyingSets on startup */
143 void init_builtin_keyingsets(void);
144
145
146 /* -------- */
147
148 /* Get the active KeyingSet for the given scene */
149 struct KeyingSet *ANIM_scene_get_active_keyingset(struct Scene *scene);
150
151 /* ************ Drivers ********************** */
152
153 /* Returns whether there is a driver in the copy/paste buffer to paste */
154 short ANIM_driver_can_paste(void);
155
156 /* Main Driver Management API calls:
157  *      Add a new driver for the specified property on the given ID block
158  */
159 short ANIM_add_driver(struct ID *id, const char rna_path[], int array_index, short flag, int type);
160
161 /* Main Driver Management API calls:
162  *      Remove the driver for the specified property on the given ID block (if available)
163  */
164 short ANIM_remove_driver(struct ID *id, const char rna_path[], int array_index, short flag);
165
166 /* Main Driver Management API calls:
167  *      Make a copy of the driver for the specified property on the given ID block
168  */
169 short ANIM_copy_driver(struct ID *id, const char rna_path[], int array_index, short flag);
170
171 /* Main Driver Management API calls:
172  *      Add a new driver for the specified property on the given ID block or replace an existing one
173  *      with the driver + driver-curve data from the buffer 
174  */
175 short ANIM_paste_driver(struct ID *id, const char rna_path[], int array_index, short flag);
176
177 /* ************ Auto-Keyframing ********************** */
178 /* Notes:
179  * - All the defines for this (User-Pref settings and Per-Scene settings)
180  *      are defined in DNA_userdef_types.h
181  * - Scene settings take presidence over those for userprefs, with old files
182  *      inheriting userpref settings for the scene settings
183  * - "On/Off + Mode" are stored per Scene, but "settings" are currently stored
184  *      as userprefs
185  */
186
187 /* Auto-Keying macros for use by various tools */
188         /* check if auto-keyframing is enabled (per scene takes presidence) */
189 #define IS_AUTOKEY_ON(scene)    ((scene) ? (scene->toolsettings->autokey_mode & AUTOKEY_ON) : (U.autokey_mode & AUTOKEY_ON))
190         /* check the mode for auto-keyframing (per scene takes presidence)  */
191 #define IS_AUTOKEY_MODE(scene, mode)    ((scene) ? (scene->toolsettings->autokey_mode == AUTOKEY_MODE_##mode) : (U.autokey_mode == AUTOKEY_MODE_##mode))
192         /* check if a flag is set for auto-keyframing (as userprefs only!) */
193 #define IS_AUTOKEY_FLAG(flag)   (U.autokey_flag & AUTOKEY_FLAG_##flag)
194
195 /* auto-keyframing feature - checks for whether anything should be done for the current frame */
196 int autokeyframe_cfra_can_key(struct Scene *scene, struct ID *id);
197
198 /* ************ Keyframe Checking ******************** */
199
200 /* Lesser Keyframe Checking API call:
201  *      - Used for the buttons to check for keyframes...
202  */
203 short fcurve_frame_has_keyframe(struct FCurve *fcu, float frame, short filter);
204
205 /* Main Keyframe Checking API call:
206  * Checks whether a keyframe exists for the given ID-block one the given frame.
207  *  - It is recommended to call this method over the other keyframe-checkers directly,
208  *        in case some detail of the implementation changes...
209  *      - frame: the value of this is quite often result of frame_to_float(CFRA)
210  */
211 short id_frame_has_keyframe(struct ID *id, float frame, short filter);
212
213 /* filter flags for id_cfra_has_keyframe 
214  *
215  * WARNING: do not alter order of these, as also stored in files
216  *      (for v3d->keyflags)
217  */
218 typedef enum eAnimFilterFlags {
219                 /* general */
220         ANIMFILTER_KEYS_LOCAL   = (1<<0),               /* only include locally available anim data */
221         ANIMFILTER_KEYS_MUTED   = (1<<1),               /* include muted elements */
222         ANIMFILTER_KEYS_ACTIVE  = (1<<2),               /* only include active-subelements */
223         
224                 /* object specific */
225         ANIMFILTER_KEYS_NOMAT           = (1<<9),               /* don't include material keyframes */
226         ANIMFILTER_KEYS_NOSKEY          = (1<<10),              /* don't include shape keys (for geometry) */
227 } eAnimFilterFlags;
228
229 #endif /*  ED_KEYFRAMING_H */