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