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