2.5 - Groundwork for Adding/Removing Drivers
[blender.git] / source / blender / editors / include / ED_keyframing.h
1 /**
2  * $Id: BIF_keyframing.h 17216 2008-10-29 11:20:02Z aligorith $
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
34 struct KeyingSet;
35
36 struct FCurve;
37 struct BezTriple;
38
39 struct wmOperatorType;
40
41 /* ************ Keyframing Management **************** */
42
43 /* Lesser Keyframing API call:
44  *      Use this when validation of necessary animation data isn't necessary as it already
45  *      exists, and there is a beztriple that can be directly copied into the array.
46  */
47 int insert_bezt_fcurve(struct FCurve *fcu, struct BezTriple *bezt);
48
49 /* Main Keyframing API call: 
50  *      Use this when validation of necessary animation data isn't necessary as it
51  *      already exists. It will insert a keyframe using the current value being keyframed.
52  */
53 void insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag);
54
55 /* -------- */
56
57 /* Main Keyframing API calls: 
58  *      Use this to create any necessary animation data, and then insert a keyframe
59  *      using the current value being keyframed, in the relevant place. Returns success.
60  */
61 short insertkey(struct ID *id, const char group[], const char rna_path[], int array_index, float cfra, short flag);
62
63 /* Main Keyframing API call: 
64  *      Use this to delete keyframe on current frame for relevant channel. Will perform checks just in case.
65  */
66 short deletekey(struct ID *id, const char group[], const char rna_path[], int array_index, float cfra, short flag);
67
68
69 /* Generate menu of KeyingSets */
70 char *ANIM_build_keyingsets_menu(struct ListBase *list, short for_edit);
71
72 /* Initialise builtin KeyingSets on startup */
73 void init_builtin_keyingsets(void);
74
75 /* KeyingSet Editing Operators:
76  *      These can add a new KeyingSet and/or add 'destinations' to the KeyingSets,
77  *      acting as a means by which they can be added outside the Outliner.
78  */
79 void ANIM_OT_keyingset_add_new(struct wmOperatorType *ot);
80 void ANIM_OT_keyingset_add_destination(struct wmOperatorType *ot);
81
82 /* Main Keyframe Management operators: 
83  *      These handle keyframes management from various spaces. They only make use of
84  *      Keying Sets.
85  */
86 void ANIM_OT_insert_keyframe(struct wmOperatorType *ot);
87 void ANIM_OT_delete_keyframe(struct wmOperatorType *ot);
88
89 /* Main Keyframe Management operators: 
90  *      These handle keyframes management from various spaces. They will handle the menus 
91  *      required for each space.
92  */
93 void ANIM_OT_insert_keyframe_menu(struct wmOperatorType *ot);
94 void ANIM_OT_delete_keyframe_menu(struct wmOperatorType *ot); // xxx unimplemented yet
95 void ANIM_OT_delete_keyframe_old(struct wmOperatorType *ot); // xxx rename and keep?
96
97 /* Keyframe managment operators for UI buttons. */
98 void ANIM_OT_insert_keyframe_button(struct wmOperatorType *ot);
99 void ANIM_OT_delete_keyframe_button(struct wmOperatorType *ot);
100
101 /* ************ Drivers ********************** */
102
103 /* Main Driver Management API calls:
104  *      Add a new driver for the specified property on the given ID block
105  */
106 short ANIM_add_driver (struct ID *id, const char rna_path[], int array_index, short flag);
107
108 /* Main Driver Management API calls:
109  *      Remove the driver for the specified property on the given ID block (if available)
110  */
111 short ANIM_remove_driver (struct ID *id, const char rna_path[], int array_index, short flag);
112
113 /* Driver management operators for UI buttons */
114 void ANIM_OT_add_driver_button(struct wmOperatorType *ot);
115 void ANIM_OT_remove_driver_button(struct wmOperatorType *ot);
116
117 /* ************ Auto-Keyframing ********************** */
118 /* Notes:
119  * - All the defines for this (User-Pref settings and Per-Scene settings)
120  *      are defined in DNA_userdef_types.h
121  * - Scene settings take presidence over those for userprefs, with old files
122  *      inheriting userpref settings for the scene settings
123  * - "On/Off + Mode" are stored per Scene, but "settings" are currently stored
124  *      as userprefs
125  */
126
127 /* Auto-Keying macros for use by various tools */
128         /* check if auto-keyframing is enabled (per scene takes presidence) */
129 #define IS_AUTOKEY_ON(scene)    ((scene) ? (scene->autokey_mode & AUTOKEY_ON) : (U.autokey_mode & AUTOKEY_ON))
130         /* check the mode for auto-keyframing (per scene takes presidence)  */
131 #define IS_AUTOKEY_MODE(scene, mode)    ((scene) ? (scene->autokey_mode == AUTOKEY_MODE_##mode) : (U.autokey_mode == AUTOKEY_MODE_##mode))
132         /* check if a flag is set for auto-keyframing (as userprefs only!) */
133 #define IS_AUTOKEY_FLAG(flag)   (U.autokey_flag & AUTOKEY_FLAG_##flag)
134
135 /* ************ Keyframe Checking ******************** */
136
137 /* Main Keyframe Checking API call:
138  * Checks whether a keyframe exists for the given ID-block one the given frame.
139  *  - It is recommended to call this method over the other keyframe-checkers directly,
140  *        in case some detail of the implementation changes...
141  *      - frame: the value of this is quite often result of frame_to_float(CFRA)
142  */
143 short id_frame_has_keyframe(struct ID *id, float frame, short filter);
144
145 /* filter flags for id_cfra_has_keyframe 
146  *
147  * WARNING: do not alter order of these, as also stored in files
148  *      (for v3d->keyflags)
149  */
150 enum {
151                 /* general */
152         ANIMFILTER_KEYS_LOCAL   = (1<<0),               /* only include locally available anim data */
153         ANIMFILTER_KEYS_MUTED   = (1<<1),               /* include muted elements */
154         ANIMFILTER_KEYS_ACTIVE  = (1<<2),               /* only include active-subelements */
155         
156                 /* object specific */
157         ANIMFILTER_KEYS_NOMAT           = (1<<9),               /* don't include material keyframes */
158         ANIMFILTER_KEYS_NOSKEY          = (1<<10),              /* don't include shape keys (for geometry) */
159 } eAnimFilterFlags;
160
161 #endif /*  ED_KEYFRAMING_H */