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