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