Animato: Added 'experimental' grouping schemes for F-Curves
[blender-staging.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 FCurve;
35 struct BezTriple;
36
37 struct wmOperatorType;
38
39 /* ************ Keyframing Management **************** */
40
41 /* Lesser Keyframing API call:
42  *      Use this when validation of necessary animation data isn't necessary as it already
43  *      exists, and there is a beztriple that can be directly copied into the array.
44  */
45 int insert_bezt_fcurve(struct FCurve *fcu, struct BezTriple *bezt);
46
47 /* Main Keyframing API call: 
48  *      Use this when validation of necessary animation data isn't necessary as it
49  *      already exists. It will insert a keyframe using the current value being keyframed.
50  */
51 void insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag);
52
53
54 /* flags for use by keyframe creation/deletion calls */
55 enum {
56                 /* used by isnertkey() and insert_vert_icu() */
57         INSERTKEY_NEEDED        = (1<<0),       /* only insert keyframes where they're needed */
58         INSERTKEY_MATRIX        = (1<<1),       /* insert 'visual' keyframes where possible/needed */
59         INSERTKEY_FAST          = (1<<2),       /* don't recalculate handles,etc. after adding key */
60         INSERTKEY_FASTR         = (1<<3),       /* don't realloc mem (or increase count, as array has already been set out) */
61         INSERTKEY_REPLACE       = (1<<4),       /* only replace an existing keyframe (this overrides INSERTKEY_NEEDED) */
62         
63                 /* used by common_*key() functions - Note: these are generally mutually exclusive (only one will work at a time) */
64         COMMONKEY_ADDMAP        = (1<<10),      /* common key: add texture-slot offset bitflag to adrcode before use */
65         COMMONKEY_PCHANROT      = (1<<11),      /* common key: extend channel list using relevant pchan-rotations */
66                 /* all possible items for common_*key() functions */
67         COMMONKEY_MODES         = (COMMONKEY_ADDMAP|COMMONKEY_PCHANROT)
68 } eInsertKeyFlags;
69
70 /* -------- */
71
72 /* Main Keyframing API calls: 
73  *      Use this to create any necessary animation data, and then insert a keyframe
74  *      using the current value being keyframed, in the relevant place. Returns success.
75  */
76 short insertkey(struct ID *id, const char group[], const char rna_path[], int array_index, float cfra, short flag);
77
78 /* Main Keyframing API call: 
79  *      Use this to delete keyframe on current frame for relevant channel. Will perform checks just in case.
80  */
81 short deletekey(struct ID *id, const char group[], const char rna_path[], int array_index, float cfra, short flag);
82
83
84 /* Main Keyframe Management operators: 
85  *      These handle keyframes management from various spaces. They will handle the menus 
86  *      required for each space.
87  */
88 void ANIM_OT_insert_keyframe(struct wmOperatorType *ot);
89 void ANIM_OT_delete_keyframe(struct wmOperatorType *ot);
90
91 /* ************ Auto-Keyframing ********************** */
92 /* Notes:
93  * - All the defines for this (User-Pref settings and Per-Scene settings)
94  *      are defined in DNA_userdef_types.h
95  * - Scene settings take presidence over those for userprefs, with old files
96  *      inheriting userpref settings for the scene settings
97  * - "On/Off + Mode" are stored per Scene, but "settings" are currently stored
98  *      as userprefs
99  */
100
101 /* Auto-Keying macros for use by various tools */
102         /* check if auto-keyframing is enabled (per scene takes presidence) */
103 #define IS_AUTOKEY_ON                   ((scene) ? (scene->autokey_mode & AUTOKEY_ON) : (U.autokey_mode & AUTOKEY_ON))
104         /* check the mode for auto-keyframing (per scene takes presidence)  */
105 #define IS_AUTOKEY_MODE(mode)   ((scene) ? (scene->autokey_mode == AUTOKEY_MODE_##mode) : (U.autokey_mode == AUTOKEY_MODE_##mode))
106         /* check if a flag is set for auto-keyframing (as userprefs only!) */
107 #define IS_AUTOKEY_FLAG(flag)   (U.autokey_flag & AUTOKEY_FLAG_##flag)
108
109 /* ************ Keyframe Checking ******************** */
110
111 /* Main Keyframe Checking API call:
112  * Checks whether a keyframe exists for the given ID-block one the given frame.
113  *  - It is recommended to call this method over the other keyframe-checkers directly,
114  *        in case some detail of the implementation changes...
115  *      - frame: the value of this is quite often result of frame_to_float(CFRA)
116  */
117 short id_frame_has_keyframe(struct ID *id, float frame, short filter);
118
119 /* filter flags for id_cfra_has_keyframe 
120  *
121  * WARNING: do not alter order of these, as also stored in files
122  *      (for v3d->keyflags)
123  */
124 enum {
125                 /* general */
126         ANIMFILTER_KEYS_LOCAL   = (1<<0),               /* only include locally available anim data */
127         ANIMFILTER_KEYS_MUTED   = (1<<1),               /* include muted elements */
128         ANIMFILTER_KEYS_ACTIVE  = (1<<2),               /* only include active-subelements */
129         
130                 /* object specific */
131         ANIMFILTER_KEYS_NOMAT           = (1<<9),               /* don't include material keyframes */
132         ANIMFILTER_KEYS_NOSKEY          = (1<<10),              /* don't include shape keys (for geometry) */
133 } eAnimFilterFlags;
134
135 #endif /*  ED_KEYFRAMING_H */