AnimChannels Filtering Refactor - Part 4
[blender.git] / source / blender / editors / include / ED_anim_api.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ED_anim_api.h
30  *  \ingroup editors
31  */
32
33 #ifndef ED_ANIM_API_H
34 #define ED_ANIM_API_H
35
36 struct ID;
37 struct ListBase;
38 struct AnimData;
39
40 struct bContext;
41 struct wmKeyConfig;
42 struct ReportList;
43 struct ScrArea;
44 struct SpaceLink;
45 struct ARegion;
46 struct View2D;
47
48 struct Scene;
49 struct Object;
50
51 struct bDopeSheet;
52
53 struct bActionGroup;
54 struct FCurve;
55 struct FModifier;
56
57 struct uiBlock;
58 struct uiLayout;
59
60 /* ************************************************ */
61 /* ANIMATION CHANNEL FILTERING */
62 /* anim_filter.c */
63
64 /* --------------- Context --------------------- */
65
66 /* This struct defines a structure used for animation-specific 
67  * 'context' information
68  */
69 typedef struct bAnimContext {
70         void *data;                             /* data to be filtered for use in animation editor */
71         short datatype;                 /* type of data eAnimCont_Types */
72         
73         short mode;                             /* editor->mode */
74         short spacetype;                /* sa->spacetype */
75         short regiontype;               /* active region -> type (channels or main) */
76         struct ScrArea *sa;             /* editor host */
77         struct SpaceLink *sl;   /* editor data */
78         struct ARegion *ar;             /* region within editor */
79         
80         struct Scene *scene;    /* active scene */
81         struct Object *obact;   /* active object */
82         ListBase *markers;              /* active set of markers */
83         
84         struct ReportList *reports;     /* pointer to current reports list */
85 } bAnimContext;
86
87 /* Main Data container types */
88 // XXX was ACTCONT_*
89 typedef enum eAnimCont_Types {
90         ANIMCONT_NONE = 0,              /* invalid or no data */
91         ANIMCONT_ACTION,                /* action (bAction) */
92         ANIMCONT_SHAPEKEY,              /* shapekey (Key) */
93         ANIMCONT_GPENCIL,               /* grease pencil (screen) */
94         ANIMCONT_DOPESHEET,             /* dopesheet (bDopesheet) */
95         ANIMCONT_FCURVES,               /* animation F-Curves (bDopesheet) */
96         ANIMCONT_DRIVERS,               /* drivers (bDopesheet) */
97         ANIMCONT_NLA                    /* nla (bDopesheet) */
98 } eAnimCont_Types;
99
100 /* --------------- Channels -------------------- */
101
102 /* This struct defines a structure used for quick and uniform access for 
103  * channels of animation data
104  */
105 typedef struct bAnimListElem {
106         struct bAnimListElem *next, *prev;
107         
108         void    *data;                  /* source data this elem represents */
109         int     type;                   /* one of the ANIMTYPE_* values */
110         int             flag;                   /* copy of elem's flags for quick access */
111         int     index;                  /* for un-named data, the index of the data in it's collection */
112         
113         short   datatype;               /* type of motion data to expect */
114         void    *key_data;              /* motion data - mostly F-Curves, but can be other types too */
115         
116         
117         struct ID *id;                  /* ID block that channel is attached to */
118         struct AnimData *adt;   /* source of the animation data attached to ID block (for convenience) */
119         
120         void    *owner;                 /* group or channel which acts as this channel's owner */
121         short   ownertype;              /* type of owner */
122 } bAnimListElem;
123
124
125 /* Some types for easier type-testing 
126  * NOTE: need to keep the order of these synchronised with the channels define code
127  *              which is used for drawing and handling channel lists for 
128  */
129 typedef enum eAnim_ChannelType {
130         ANIMTYPE_NONE= 0,
131         ANIMTYPE_ANIMDATA,
132         ANIMTYPE_SPECIALDATA,
133         
134         ANIMTYPE_SUMMARY,
135         
136         ANIMTYPE_SCENE,
137         ANIMTYPE_OBJECT,
138         ANIMTYPE_GROUP,
139         ANIMTYPE_FCURVE,
140         
141         ANIMTYPE_FILLACTD,
142         ANIMTYPE_FILLDRIVERS,
143         
144         ANIMTYPE_DSMAT,
145         ANIMTYPE_DSLAM,
146         ANIMTYPE_DSCAM,
147         ANIMTYPE_DSCUR,
148         ANIMTYPE_DSSKEY,
149         ANIMTYPE_DSWOR,
150         ANIMTYPE_DSNTREE,
151         ANIMTYPE_DSPART,
152         ANIMTYPE_DSMBALL,
153         ANIMTYPE_DSARM,
154         ANIMTYPE_DSMESH,
155         ANIMTYPE_DSTEX,
156         ANIMTYPE_DSLAT,
157         
158         ANIMTYPE_SHAPEKEY,
159         
160         ANIMTYPE_GPDATABLOCK,
161         ANIMTYPE_GPLAYER,
162         
163         ANIMTYPE_NLATRACK,
164         ANIMTYPE_NLAACTION,
165         
166                 /* always as last item, the total number of channel types... */
167         ANIMTYPE_NUM_TYPES
168 } eAnim_ChannelType;
169
170 /* types of keyframe data in bAnimListElem */
171 typedef enum eAnim_KeyType {
172         ALE_NONE = 0,           /* no keyframe data */
173         ALE_FCURVE,                     /* F-Curve */
174         ALE_GPFRAME,            /* Grease Pencil Frames */
175         ALE_NLASTRIP,           /* NLA Strips */
176         
177         ALE_ALL,                        /* All channels summary */
178         ALE_SCE,                        /* Scene summary */
179         ALE_OB,                         /* Object summary */
180         ALE_ACT,                        /* Action summary */
181         ALE_GROUP                       /* Action Group summary */
182 } eAnim_KeyType;
183
184 /* ----------------- Filtering -------------------- */
185
186 /* filtering flags  - under what circumstances should a channel be returned */
187 typedef enum eAnimFilter_Flags {
188         /* data which channel represents is fits the dopesheet filters (i.e. scene visibility criteria) */
189         // XXX: it's hard to think of any examples where this *ISN'T* the case... perhaps becomes implicit?
190         ANIMFILTER_DATA_VISIBLE   = (1<<0),
191         /* channel is visible within the channel-list hierarchy (i.e. F-Curves within Groups in ActEdit) */
192         ANIMFILTER_LIST_VISIBLE   = (1<<1),
193         /* channel has specifically been tagged as visible in Graph Editor (* Graph Editor Only) */
194         ANIMFILTER_CURVE_VISIBLE  = (1<<2),
195         
196         /* include summary channels and "expanders" (for drawing/mouse-selection in channel list) */
197         ANIMFILTER_LIST_CHANNELS  = (1<<3),
198         
199         /* for its type, channel should be "active" one */
200         ANIMFILTER_ACTIVE         = (1<<4),
201         /* channel is a child of the active group (* Actions speciality) */
202         ANIMFILTER_ACTGROUPED     = (1<<5),
203         
204         /* channel must be selected/not-selected, but both must not be set together */
205         ANIMFILTER_SEL            = (1<<6),
206         ANIMFILTER_UNSEL          = (1<<7),
207         
208         /* editability status - must be editable to be included */
209         ANIMFILTER_FOREDIT        = (1<<8),
210         /* only selected animchannels should be considerable as editable - mainly for Graph Editor's option for keys on select curves only */
211         ANIMFILTER_SELEDIT        = (1<<9), 
212         
213         /* flags used to enforce certain data types */
214         // NOTE: the ones for curves and NLA tracks were redundant and have been removed for now...
215         ANIMFILTER_ANIMDATA       = (1<<10),
216         
217         /* duplicate entries for animation data attached to multi-user blocks must not occur */
218         ANIMFILTER_NODUPLIS       = (1<<11),
219         
220         /* for checking if we should keep some collapsed channel around (internal use only!) */
221         ANIMFILTER_TMP_PEEK       = (1<<30)
222 } eAnimFilter_Flags;
223
224 /* ---------- Flag Checking Macros ------------ */
225 // xxx check on all of these flags again...
226
227 /* Dopesheet only */
228         /* 'Scene' channels */
229 #define SEL_SCEC(sce) ((sce->flag & SCE_DS_SELECTED))
230 #define EXPANDED_SCEC(sce) ((sce->flag & SCE_DS_COLLAPSED)==0)
231         /* 'Sub-Scene' channels (flags stored in Data block) */
232 #define FILTER_WOR_SCED(wo) ((wo->flag & WO_DS_EXPAND))
233 #define FILTER_NTREE_SCED(ntree) ((ntree->flag & NTREE_DS_EXPAND))
234         /* 'Object' channels */
235 #define SEL_OBJC(base) ((base->flag & SELECT))
236 #define EXPANDED_OBJC(ob) ((ob->nlaflag & OB_ADS_COLLAPSED)==0)
237         /* 'Sub-object' channels (flags stored in Data block) */
238 #define FILTER_SKE_OBJD(key) ((key->flag & KEY_DS_EXPAND))
239 #define FILTER_MAT_OBJD(ma) ((ma->flag & MA_DS_EXPAND))
240 #define FILTER_LAM_OBJD(la) ((la->flag & LA_DS_EXPAND))
241 #define FILTER_CAM_OBJD(ca) ((ca->flag & CAM_DS_EXPAND))
242 #define FILTER_CUR_OBJD(cu) ((cu->flag & CU_DS_EXPAND))
243 #define FILTER_PART_OBJD(part) ((part->flag & PART_DS_EXPAND))
244 #define FILTER_MBALL_OBJD(mb) ((mb->flag2 & MB_DS_EXPAND))
245 #define FILTER_ARM_OBJD(arm) ((arm->flag & ARM_DS_EXPAND))
246 #define FILTER_MESH_OBJD(me) ((me->flag & ME_DS_EXPAND))
247 #define FILTER_LATTICE_OBJD(lt) ((lt->flag & LT_DS_EXPAND))
248
249         /* 'Sub-object/Action' channels (flags stored in Action) */
250 #define SEL_ACTC(actc) ((actc->flag & ACT_SELECTED))
251 #define EXPANDED_ACTC(actc) ((actc->flag & ACT_COLLAPSED)==0)
252         /* 'Sub-AnimData' channels */
253 #define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED)==0)
254         /* Texture expanders */
255 #define FILTER_TEX_DATA(tex) ((tex->flag & TEX_DS_EXPAND))
256
257 /* Actions (also used for Dopesheet) */
258         /* Action Channel Group */
259 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED)==0)
260 #define EXPANDED_AGRP(ac, agrp) \
261         ( ( ((ac)->spacetype == SPACE_IPO) && (agrp->flag & AGRP_EXPANDED_G) ) || \
262           ( ((ac)->spacetype != SPACE_IPO) && (agrp->flag & AGRP_EXPANDED)   ) )
263 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
264         /* F-Curve Channels */
265 #define EDITABLE_FCU(fcu) ((fcu->flag & FCURVE_PROTECTED)==0)
266 #define SEL_FCU(fcu) (fcu->flag & (FCURVE_ACTIVE|FCURVE_SELECTED))
267
268 /* ShapeKey mode only */
269 #define EDITABLE_SHAPEKEY(kb) ((kb->flag & KEYBLOCK_LOCKED)==0)
270 #define SEL_SHAPEKEY(kb) (kb->flag & KEYBLOCK_SEL)
271
272 /* Grease Pencil only */
273         /* Grease Pencil datablock settings */
274 #define EXPANDED_GPD(gpd) (gpd->flag & GP_DATA_EXPAND) 
275         /* Grease Pencil Layer settings */
276 #define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED)==0)
277 #define SEL_GPL(gpl) ((gpl->flag & GP_LAYER_ACTIVE) || (gpl->flag & GP_LAYER_SELECT))
278
279 /* NLA only */
280 #define SEL_NLT(nlt) (nlt->flag & NLATRACK_SELECTED)
281 #define EDITABLE_NLT(nlt) ((nlt->flag & NLATRACK_PROTECTED)==0)
282
283 /* -------------- Channel Defines -------------- */
284
285 /* channel heights */
286 #define ACHANNEL_FIRST                  -16
287 #define ACHANNEL_HEIGHT                 16
288 #define ACHANNEL_HEIGHT_HALF    8
289 #define ACHANNEL_SKIP                   2
290 #define ACHANNEL_STEP                   (ACHANNEL_HEIGHT + ACHANNEL_SKIP)
291
292 /* channel widths */
293 #define ACHANNEL_NAMEWIDTH              200
294
295 /* channel toggle-buttons */
296 #define ACHANNEL_BUTTON_WIDTH   16
297
298
299 /* -------------- NLA Channel Defines -------------- */
300
301 /* NLA channel heights */
302 #define NLACHANNEL_FIRST                        -16
303 #define NLACHANNEL_HEIGHT                       24
304 #define NLACHANNEL_HEIGHT_HALF  12
305 #define NLACHANNEL_SKIP                 2
306 #define NLACHANNEL_STEP                 (NLACHANNEL_HEIGHT + NLACHANNEL_SKIP)
307
308 /* channel widths */
309 #define NLACHANNEL_NAMEWIDTH            200
310
311 /* channel toggle-buttons */
312 #define NLACHANNEL_BUTTON_WIDTH 16
313
314 /* ---------------- API  -------------------- */
315
316 /* Obtain list of filtered Animation channels to operate on.
317  * Returns the number of channels in the list
318  */
319 size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype);
320
321 /* Obtain current anim-data context from Blender Context info.
322  * Returns whether the operation was successful. 
323  */
324 short ANIM_animdata_get_context(const struct bContext *C, bAnimContext *ac);
325
326 /* Obtain current anim-data context (from Animation Editor) given 
327  * that Blender Context info has already been set. 
328  * Returns whether the operation was successful.
329  */
330 short ANIM_animdata_context_getdata(bAnimContext *ac);
331
332 /* ************************************************ */
333 /* ANIMATION CHANNELS LIST */
334 /* anim_channels_*.c */
335
336 /* ------------------------ Drawing TypeInfo -------------------------- */
337
338 /* flag-setting behaviour */
339 typedef enum eAnimChannels_SetFlag {
340         ACHANNEL_SETFLAG_CLEAR = 0,             /* turn off */
341         ACHANNEL_SETFLAG_ADD,                   /* turn on */
342         ACHANNEL_SETFLAG_INVERT,                /* on->off, off->on */
343         ACHANNEL_SETFLAG_TOGGLE                 /* some on -> all off // all on */
344 } eAnimChannels_SetFlag;
345
346 /* types of settings for AnimChannels */
347 typedef enum eAnimChannel_Settings {
348         ACHANNEL_SETTING_SELECT = 0,
349         ACHANNEL_SETTING_PROTECT,                       // warning: for drawing UI's, need to check if this is off (maybe inverse this later)
350         ACHANNEL_SETTING_MUTE,
351         ACHANNEL_SETTING_EXPAND,
352         ACHANNEL_SETTING_VISIBLE,                       /* only for Graph Editor */
353         ACHANNEL_SETTING_SOLO                           /* only for NLA Tracks */
354 } eAnimChannel_Settings;
355
356
357 /* Drawing, mouse handling, and flag setting behaviour... */
358 typedef struct bAnimChannelType {
359         /* type data */
360                 /* name of the channel type, for debugging */
361         const char *channel_type_name;
362         
363         /* drawing */
364                 /* get RGB color that is used to draw the majority of the backdrop */
365         void (*get_backdrop_color)(bAnimContext *ac, bAnimListElem *ale, float *color);
366                 /* draw backdrop strip for channel */
367         void (*draw_backdrop)(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
368                 /* get depth of indention (relative to the depth channel is nested at) */
369         short (*get_indent_level)(bAnimContext *ac, bAnimListElem *ale);
370                 /* get offset in pixels for the start of the channel (in addition to the indent depth) */
371         short (*get_offset)(bAnimContext *ac, bAnimListElem *ale);
372         
373         /* get name (for channel lists) */
374         void (*name)(bAnimListElem *ale, char *name);
375         /* get icon (for channel lists) */
376         int (*icon)(bAnimListElem *ale);
377         
378         /* settings */
379                 /* check if the given setting is valid in the current context */
380         short (*has_setting)(bAnimContext *ac, bAnimListElem *ale, int setting);
381                 /* get the flag used for this setting */
382         int (*setting_flag)(bAnimContext *ac, int setting, short *neg);
383                 /* get the pointer to int/short where data is stored, 
384                  * with type being  sizeof(ptr_data) which should be fine for runtime use...
385                  *      - assume that setting has been checked to be valid for current context
386                  */
387         void *(*setting_ptr)(bAnimListElem *ale, int setting, short *type);
388 } bAnimChannelType;
389
390 /* ------------------------ Drawing API -------------------------- */
391
392 /* Get typeinfo for the given channel */
393 bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
394
395 /* Print debugging info about a given channel */
396 void ANIM_channel_debug_print_info(bAnimListElem *ale, short indent_level);
397
398 /* Draw the given channel */
399 void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
400 /* Draw the widgets for the given channel */
401 void ANIM_channel_draw_widgets(bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc);
402
403
404 /* ------------------------ Editing API -------------------------- */
405
406 /* Check if some setting for a channel is enabled 
407  * Returns: 1 = On, 0 = Off, -1 = Invalid
408  *
409  *      - setting: eAnimChannel_Settings
410  */
411 short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, int setting);
412
413 /* Change value of some setting for a channel 
414  *      - setting: eAnimChannel_Settings
415  *      - mode: eAnimChannels_SetFlag
416  */
417 void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, short mode);
418
419
420 /* Flush visibility (for Graph Editor) changes up/down hierarchy for changes in the given setting 
421  *      - anim_data: list of the all the anim channels that can be chosen
422  *              -> filtered using ANIMFILTER_CHANNELS only, since if we took VISIBLE too,
423  *                then the channels under closed expanders get ignored...
424  *      - ale_setting: the anim channel (not in the anim_data list directly, though occuring there)
425  *              with the new state of the setting that we want flushed up/down the hierarchy 
426  *      - setting: type of setting to set
427  *      - on: whether the visibility setting has been enabled or disabled 
428  */
429 void ANIM_flush_setting_anim_channels(bAnimContext *ac, ListBase *anim_data, bAnimListElem *ale_setting, int setting, short on);
430
431
432 /* Deselect all animation channels */
433 void ANIM_deselect_anim_channels(bAnimContext *ac, void *data, short datatype, short test, short sel);
434
435 /* Set the 'active' channel of type channel_type, in the given action */
436 void ANIM_set_active_channel(bAnimContext *ac, void *data, short datatype, int filter, void *channel_data, short channel_type);
437
438
439 /* Delete the F-Curve from the given AnimData block (if possible), as appropriate according to animation context */
440 void ANIM_fcurve_delete_from_animdata(bAnimContext *ac, struct AnimData *adt, struct FCurve *fcu);
441
442 /* ************************************************ */
443 /* DRAWING API */
444 /* anim_draw.c */
445
446 /* Get string representing the given frame number as an appropriately represented frame or timecode */
447 void ANIM_timecode_string_from_frame(char *str, struct Scene *scene, int power, short timecodes, float cfra);
448
449 /* ---------- Current Frame Drawing ---------------- */
450
451 /* flags for Current Frame Drawing */
452 enum {
453                 /* plain time indicator with no special indicators */
454         DRAWCFRA_PLAIN                  = 0,
455                 /* draw box indicating current frame number */
456         DRAWCFRA_SHOW_NUMBOX    = (1<<0),
457                 /* time indication in seconds or frames */
458         DRAWCFRA_UNIT_SECONDS   = (1<<1),
459                 /* show time-offset line */
460         DRAWCFRA_SHOW_TIMEOFS   = (1<<2)
461 } eAnimEditDraw_CurrentFrame; 
462
463 /* main call to draw current-frame indicator in an Animation Editor */
464 void ANIM_draw_cfra(const struct bContext *C, struct View2D *v2d, short flag);
465
466 /* ------------- Preview Range Drawing -------------- */
467
468 /* main call to draw preview range curtains */
469 void ANIM_draw_previewrange(const struct bContext *C, struct View2D *v2d);
470
471 /* ************************************************* */
472 /* F-MODIFIER TOOLS */
473
474 /* ------------- UI Panel Drawing -------------- */
475
476 /* draw a given F-Modifier for some layout/UI-Block */
477 void ANIM_uiTemplate_fmodifier_draw(struct uiLayout *layout, struct ID *id, ListBase *modifiers, struct FModifier *fcm);
478
479 /* ------------- Copy/Paste Buffer -------------- */
480
481
482 /* free the copy/paste buffer */
483 void free_fmodifiers_copybuf(void);
484
485 /* copy the given F-Modifiers to the buffer, returning whether anything was copied or not
486  * assuming that the buffer has been cleared already with free_fmodifiers_copybuf()
487  *      - active: only copy the active modifier
488  */
489 short ANIM_fmodifiers_copy_to_buf(ListBase *modifiers, short active);
490
491 /* 'Paste' the F-Modifier(s) from the buffer to the specified list 
492  *      - replace: free all the existing modifiers to leave only the pasted ones 
493  */
494 short ANIM_fmodifiers_paste_from_buf(ListBase *modifiers, short replace);
495
496 /* ************************************************* */
497 /* ASSORTED TOOLS */
498
499 /* ------------ Animation F-Curves <-> Icons/Names Mapping ------------ */
500 /* anim_ipo_utils.c */
501
502 /* Get icon + name for channel-list displays for F-Curve */
503 int getname_anim_fcurve(char *name, struct ID *id, struct FCurve *fcu);
504
505 /* Automatically determine a color for the nth F-Curve */
506 void getcolor_fcurve_rainbow(int cur, int tot, float *out);
507
508 /* ----------------- NLA-Mapping ----------------------- */
509 /* anim_draw.c */
510
511 /* Obtain the AnimData block providing NLA-scaling for the given channel if applicable */
512 struct AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale);
513
514 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve */
515 void ANIM_nla_mapping_apply_fcurve(struct AnimData *adt, struct FCurve *fcu, short restore, short only_keys);
516
517 /* ..... */
518
519 /* Perform auto-blending/extend refreshes after some operations */
520 // NOTE: defined in space_nla/nla_edit.c, not in animation/
521 void ED_nla_postop_refresh(bAnimContext *ac);
522
523 /* ------------- Unit Conversion Mappings ------------- */
524 /* anim_draw.c */
525
526 /* flags for conversion mapping */
527 typedef enum eAnimUnitConv_Flags {
528                 /* restore to original internal values */
529         ANIM_UNITCONV_RESTORE   = (1<<0),
530                 /* ignore handles (i.e. only touch main keyframes) */
531         ANIM_UNITCONV_ONLYKEYS  = (1<<1),
532                 /* only touch selected BezTriples */
533         ANIM_UNITCONV_ONLYSEL   = (1<<2),
534                 /* only touch selected vertices */
535         ANIM_UNITCONV_SELVERTS  = (1<<3)
536 } eAnimUnitConv_Flags;
537
538 /* Get unit conversion factor for given ID + F-Curve */
539 float ANIM_unit_mapping_get_factor(struct Scene *scene, struct ID *id, struct FCurve *fcu, short restore);
540
541 /* Apply/Unapply units conversions to keyframes */
542 void ANIM_unit_mapping_apply_fcurve(struct Scene *scene, struct ID *id, struct FCurve *fcu, short flag);
543
544 /* ------------- Utility macros ----------------------- */
545
546 /* provide access to Keyframe Type info in BezTriple
547  * NOTE: this is so that we can change it from being stored in 'hide'
548  */
549 #define BEZKEYTYPE(bezt) ((bezt)->hide)
550
551 /* set/clear/toggle macro 
552  *      - channel - channel with a 'flag' member that we're setting
553  *      - smode - 0=clear, 1=set, 2=invert
554  *      - sflag - bitflag to set
555  */
556 #define ACHANNEL_SET_FLAG(channel, smode, sflag) \
557         { \
558                 if (smode == ACHANNEL_SETFLAG_INVERT)   (channel)->flag ^= (sflag); \
559                 else if (smode == ACHANNEL_SETFLAG_ADD) (channel)->flag |= (sflag); \
560                 else                                                                    (channel)->flag &= ~(sflag); \
561         }
562         
563 /* set/clear/toggle macro, where the flag is negative 
564  *      - channel - channel with a 'flag' member that we're setting
565  *      - smode - 0=clear, 1=set, 2=invert
566  *      - sflag - bitflag to set
567  */
568 #define ACHANNEL_SET_FLAG_NEG(channel, smode, sflag) \
569         { \
570                 if (smode == ACHANNEL_SETFLAG_INVERT)   (channel)->flag ^= (sflag); \
571                 else if (smode == ACHANNEL_SETFLAG_ADD) (channel)->flag &= ~(sflag); \
572                 else                                                                    (channel)->flag |= (sflag); \
573         }
574
575
576 /* --------- anim_deps.c, animation updates -------- */
577
578 void ANIM_id_update(struct Scene *scene, struct ID *id);
579 void ANIM_list_elem_update(struct Scene *scene, bAnimListElem *ale);
580
581 /* data -> channels syncing */
582 void ANIM_sync_animchannels_to_data(const struct bContext *C);
583
584 /* ************************************************* */
585 /* OPERATORS */
586         
587         /* generic animation channels */
588 void ED_operatortypes_animchannels(void);
589 void ED_keymap_animchannels(struct wmKeyConfig *keyconf);
590
591         /* generic time editing */
592 void ED_operatortypes_anim(void);
593 void ED_keymap_anim(struct wmKeyConfig *keyconf);
594         
595         /* space_graph */
596 void ED_operatormacros_graph(void);
597         /* space_action */
598 void ED_operatormacros_action(void);
599
600 /* ************************************************ */
601
602 #endif /* ED_ANIM_API_H */
603