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