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