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