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