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