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