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