Holiday coding log :)
[blender.git] / source / blender / editors / include / ED_anim_api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ED_anim_api.h
28  *  \ingroup editors
29  */
30
31 #ifndef __ED_ANIM_API_H__
32 #define __ED_ANIM_API_H__
33
34 struct ID;
35 struct ListBase;
36 struct AnimData;
37
38 struct bContext;
39 struct wmKeyConfig;
40 struct ReportList;
41 struct ScrArea;
42 struct SpaceLink;
43 struct ARegion;
44 struct View2D;
45
46 struct Scene;
47 struct Object;
48
49 struct bDopeSheet;
50
51 struct bActionGroup;
52 struct FCurve;
53 struct FModifier;
54
55 struct uiBlock;
56 struct uiLayout;
57
58 struct PointerRNA;
59 struct PropertyRNA;
60
61 /* ************************************************ */
62 /* ANIMATION CHANNEL FILTERING */
63 /* anim_filter.c */
64
65 /* --------------- Context --------------------- */
66
67 /* This struct defines a structure used for animation-specific 
68  * 'context' information
69  */
70 typedef struct bAnimContext {
71         void *data;             /* data to be filtered for use in animation editor */
72         short datatype;         /* type of data eAnimCont_Types */
73         
74         short mode;             /* editor->mode */
75         short spacetype;        /* sa->spacetype */
76         short regiontype;       /* active region -> type (channels or main) */
77         struct ScrArea *sa;     /* editor host */
78         struct SpaceLink *sl;   /* editor data */
79         struct ARegion *ar;     /* region within editor */
80         
81         struct bDopeSheet *ads; /* dopesheet data for editor (or which is being used) */
82         
83         struct Scene *scene;    /* active scene */
84         struct Object *obact;   /* active object */
85         ListBase *markers;      /* active set of markers */
86         
87         struct ReportList *reports; /* pointer to current reports list */
88 } bAnimContext;
89
90 /* Main Data container types */
91 typedef enum eAnimCont_Types {
92         ANIMCONT_NONE      = 0, /* invalid or no data */
93         ANIMCONT_ACTION    = 1, /* action (bAction) */
94         ANIMCONT_SHAPEKEY  = 2, /* shapekey (Key) */
95         ANIMCONT_GPENCIL   = 3, /* grease pencil (screen) */
96         ANIMCONT_DOPESHEET = 4, /* dopesheet (bDopesheet) */
97         ANIMCONT_FCURVES   = 5, /* animation F-Curves (bDopesheet) */
98         ANIMCONT_DRIVERS   = 6, /* drivers (bDopesheet) */
99         ANIMCONT_NLA       = 7, /* nla (bDopesheet) */
100         ANIMCONT_CHANNEL   = 8, /* animation channel (bAnimListElem) */
101         ANIMCONT_MASK      = 9  /* mask dopesheet */
102 } eAnimCont_Types;
103
104 /* --------------- Channels -------------------- */
105
106 /* This struct defines a structure used for quick and uniform access for 
107  * channels of animation data
108  */
109 typedef struct bAnimListElem {
110         struct bAnimListElem *next, *prev;
111         
112         void    *data;          /* source data this elem represents */
113         int     type;           /* one of the ANIMTYPE_* values */
114         int     flag;           /* copy of elem's flags for quick access */
115         int     index;          /* for un-named data, the index of the data in it's collection */
116         
117         short   datatype;       /* type of motion data to expect */
118         void   *key_data;       /* motion data - mostly F-Curves, but can be other types too */
119         
120         
121         struct ID *id;          /* ID block that channel is attached to */
122         struct AnimData *adt;   /* source of the animation data attached to ID block (for convenience) */
123 } bAnimListElem;
124
125
126 /* Some types for easier type-testing 
127  * NOTE: need to keep the order of these synchronized with the channels define code
128  *      which is used for drawing and handling channel lists for
129  */
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         
145         ANIMTYPE_DSMAT,
146         ANIMTYPE_DSLAM,
147         ANIMTYPE_DSCAM,
148         ANIMTYPE_DSCUR,
149         ANIMTYPE_DSSKEY,
150         ANIMTYPE_DSWOR,
151         ANIMTYPE_DSNTREE,
152         ANIMTYPE_DSPART,
153         ANIMTYPE_DSMBALL,
154         ANIMTYPE_DSARM,
155         ANIMTYPE_DSMESH,
156         ANIMTYPE_DSTEX,
157         ANIMTYPE_DSLAT,
158         ANIMTYPE_DSSPK,
159         
160         ANIMTYPE_SHAPEKEY,
161         
162         ANIMTYPE_GPDATABLOCK,
163         ANIMTYPE_GPLAYER,
164
165         ANIMTYPE_MASKDATABLOCK,
166         ANIMTYPE_MASKLAYER,
167         
168         ANIMTYPE_NLATRACK,
169         ANIMTYPE_NLAACTION,
170         
171         /* always as last item, the total number of channel types... */
172         ANIMTYPE_NUM_TYPES
173 } eAnim_ChannelType;
174
175 /* types of keyframe data in bAnimListElem */
176 typedef enum eAnim_KeyType {
177         ALE_NONE = 0,       /* no keyframe data */
178         ALE_FCURVE,         /* F-Curve */
179         ALE_GPFRAME,        /* Grease Pencil Frames */
180         ALE_MASKLAY,        /* Mask */
181         ALE_NLASTRIP,       /* NLA Strips */
182
183         ALE_ALL,            /* All channels summary */
184         ALE_SCE,            /* Scene summary */
185         ALE_OB,             /* Object summary */
186         ALE_ACT,            /* Action summary */
187         ALE_GROUP           /* Action Group summary */
188 } eAnim_KeyType;
189
190 /* ----------------- Filtering -------------------- */
191
192 /* filtering flags  - under what circumstances should a channel be returned */
193 typedef enum eAnimFilter_Flags {
194         /* data which channel represents is fits the dopesheet filters (i.e. scene visibility criteria) */
195         // XXX: it's hard to think of any examples where this *ISN'T* the case... perhaps becomes implicit?
196         ANIMFILTER_DATA_VISIBLE   = (1 << 0),
197         /* channel is visible within the channel-list hierarchy (i.e. F-Curves within Groups in ActEdit) */
198         ANIMFILTER_LIST_VISIBLE   = (1 << 1),
199         /* channel has specifically been tagged as visible in Graph Editor (* Graph Editor Only) */
200         ANIMFILTER_CURVE_VISIBLE  = (1 << 2),
201         
202         /* include summary channels and "expanders" (for drawing/mouse-selection in channel list) */
203         ANIMFILTER_LIST_CHANNELS  = (1 << 3),
204         
205         /* for its type, channel should be "active" one */
206         ANIMFILTER_ACTIVE         = (1 << 4),
207         /* channel is a child of the active group (* Actions speciality) */
208         ANIMFILTER_ACTGROUPED     = (1 << 5),
209         
210         /* channel must be selected/not-selected, but both must not be set together */
211         ANIMFILTER_SEL            = (1 << 6),
212         ANIMFILTER_UNSEL          = (1 << 7),
213         
214         /* editability status - must be editable to be included */
215         ANIMFILTER_FOREDIT        = (1 << 8),
216         /* only selected animchannels should be considerable as editable - mainly for Graph Editor's option for keys on select curves only */
217         ANIMFILTER_SELEDIT        = (1 << 9),
218         
219         /* flags used to enforce certain data types */
220         // NOTE: the ones for curves and NLA tracks were redundant and have been removed for now...
221         ANIMFILTER_ANIMDATA       = (1 << 10),
222         
223         /* duplicate entries for animation data attached to multi-user blocks must not occur */
224         ANIMFILTER_NODUPLIS       = (1 << 11),
225         
226         /* for checking if we should keep some collapsed channel around (internal use only!) */
227         ANIMFILTER_TMP_PEEK       = (1 << 30)
228 } eAnimFilter_Flags;
229
230 /* ---------- Flag Checking Macros ------------ */
231 // xxx check on all of these flags again...
232
233 /* Dopesheet only */
234 /* 'Scene' channels */
235 #define SEL_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene), ((sce->flag & SCE_DS_SELECTED)))
236 #define EXPANDED_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene), ((sce->flag & SCE_DS_COLLAPSED) == 0))
237 /* 'Sub-Scene' channels (flags stored in Data block) */
238 #define FILTER_WOR_SCED(wo) (CHECK_TYPE_INLINE(wo, World), (wo->flag & WO_DS_EXPAND))
239 /* 'Object' channels */
240 #define SEL_OBJC(base)          (CHECK_TYPE_INLINE(base, Base), ((base->flag & SELECT)))
241 #define EXPANDED_OBJC(ob)       (CHECK_TYPE_INLINE(ob, Object), ((ob->nlaflag & OB_ADS_COLLAPSED) == 0))
242 /* 'Sub-object' channels (flags stored in Data block) */
243 #define FILTER_SKE_OBJD(key)    (CHECK_TYPE_INLINE(key, Key), ((key->flag & KEY_DS_EXPAND)))
244 #define FILTER_MAT_OBJD(ma)     (CHECK_TYPE_INLINE(ma, Material), ((ma->flag & MA_DS_EXPAND)))
245 #define FILTER_LAM_OBJD(la)     (CHECK_TYPE_INLINE(la, Lamp), ((la->flag & LA_DS_EXPAND)))
246 #define FILTER_CAM_OBJD(ca)     (CHECK_TYPE_INLINE(ca, Camera), ((ca->flag & CAM_DS_EXPAND)))
247 #define FILTER_CUR_OBJD(cu)     (CHECK_TYPE_INLINE(cu, Curve), ((cu->flag & CU_DS_EXPAND)))
248 #define FILTER_PART_OBJD(part)  (CHECK_TYPE_INLINE(part, ParticleSettings), ((part->flag & PART_DS_EXPAND)))
249 #define FILTER_MBALL_OBJD(mb)   (CHECK_TYPE_INLINE(mb, MetaBall), ((mb->flag2 & MB_DS_EXPAND)))
250 #define FILTER_ARM_OBJD(arm)    (CHECK_TYPE_INLINE(arm, bArmature), ((arm->flag & ARM_DS_EXPAND)))
251 #define FILTER_MESH_OBJD(me)    (CHECK_TYPE_INLINE(me, Mesh), ((me->flag & ME_DS_EXPAND)))
252 #define FILTER_LATTICE_OBJD(lt) (CHECK_TYPE_INLINE(lt, Lattice), ((lt->flag & LT_DS_EXPAND)))
253 #define FILTER_SPK_OBJD(spk)    (CHECK_TYPE_INLINE(spk, Speaker), ((spk->flag & SPK_DS_EXPAND)))
254 /* Variable use expanders */
255 #define FILTER_NTREE_DATA(ntree) (CHECK_TYPE_INLINE(ntree, bNodeTree), ((ntree->flag & NTREE_DS_EXPAND)))
256 #define FILTER_TEX_DATA(tex)     (CHECK_TYPE_INLINE(tex, Tex), ((tex->flag & TEX_DS_EXPAND)))
257
258 /* 'Sub-object/Action' channels (flags stored in Action) */
259 #define SEL_ACTC(actc) ((actc->flag & ACT_SELECTED))
260 #define EXPANDED_ACTC(actc) ((actc->flag & ACT_COLLAPSED) == 0)
261 /* 'Sub-AnimData' channels */
262 #define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED) == 0)
263
264
265 /* Actions (also used for Dopesheet) */
266 /* Action Channel Group */
267 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED) == 0)
268 #define EXPANDED_AGRP(ac, agrp) \
269         ( ((!(ac) || ((ac)->spacetype != SPACE_IPO)) && (agrp->flag & AGRP_EXPANDED)) || \
270           (( (ac) && ((ac)->spacetype == SPACE_IPO)) && (agrp->flag & AGRP_EXPANDED_G)) )
271 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
272 /* F-Curve Channels */
273 #define EDITABLE_FCU(fcu) ((fcu->flag & FCURVE_PROTECTED) == 0)
274 #define SEL_FCU(fcu) (fcu->flag & FCURVE_SELECTED)
275
276 /* ShapeKey mode only */
277 #define EDITABLE_SHAPEKEY(kb) ((kb->flag & KEYBLOCK_LOCKED) == 0)
278 #define SEL_SHAPEKEY(kb) (kb->flag & KEYBLOCK_SEL)
279
280 /* Grease Pencil only */
281 /* Grease Pencil datablock settings */
282 #define EXPANDED_GPD(gpd) (gpd->flag & GP_DATA_EXPAND) 
283 /* Grease Pencil Layer settings */
284 #define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED) == 0)
285 #define SEL_GPL(gpl) (gpl->flag & GP_LAYER_SELECT)
286
287 /* Mask Only */
288 /* Grease Pencil datablock settings */
289 #define EXPANDED_MASK(mask) (mask->flag & MASK_ANIMF_EXPAND)
290 /* Grease Pencil Layer settings */
291 #define EDITABLE_MASK(masklay) ((masklay->flag & MASK_LAYERFLAG_LOCKED) == 0)
292 #define SEL_MASKLAY(masklay) (masklay->flag & SELECT)
293
294
295
296 /* NLA only */
297 #define SEL_NLT(nlt) (nlt->flag & NLATRACK_SELECTED)
298 #define EDITABLE_NLT(nlt) ((nlt->flag & NLATRACK_PROTECTED) == 0)
299
300 /* -------------- Channel Defines -------------- */
301
302 /* channel heights */
303 #define ACHANNEL_FIRST          (-0.8f * U.widget_unit)
304 #define ACHANNEL_HEIGHT         (0.8f * U.widget_unit)
305 #define ACHANNEL_HEIGHT_HALF    (0.4f * U.widget_unit)
306 #define ACHANNEL_SKIP           (0.1f * U.widget_unit)
307 #define ACHANNEL_STEP           (ACHANNEL_HEIGHT + ACHANNEL_SKIP)
308
309 /* channel widths */
310 #define ACHANNEL_NAMEWIDTH      (10 * U.widget_unit)
311
312 /* channel toggle-buttons */
313 #define ACHANNEL_BUTTON_WIDTH   (0.8f * U.widget_unit)
314
315
316 /* -------------- NLA Channel Defines -------------- */
317
318 /* NLA channel heights */
319 // XXX: NLACHANNEL_FIRST isn't used?
320 #define NLACHANNEL_FIRST                (-0.8f * U.widget_unit)
321 #define NLACHANNEL_HEIGHT(snla)         ((snla && (snla->flag & SNLA_NOSTRIPCURVES)) ? (0.8f * U.widget_unit) : (1.2f * U.widget_unit))
322 #define NLACHANNEL_HEIGHT_HALF(snla)    ((snla && (snla->flag & SNLA_NOSTRIPCURVES)) ? (0.4f * U.widget_unit) : (0.6f * U.widget_unit))
323 #define NLACHANNEL_SKIP                 (0.1f * U.widget_unit)
324 #define NLACHANNEL_STEP(snla)           (NLACHANNEL_HEIGHT(snla) + NLACHANNEL_SKIP)
325
326 /* channel widths */
327 #define NLACHANNEL_NAMEWIDTH                    (10 * U.widget_unit)
328
329 /* channel toggle-buttons */
330 #define NLACHANNEL_BUTTON_WIDTH                 (0.8f * U.widget_unit)
331
332 /* ---------------- API  -------------------- */
333
334 /* Obtain list of filtered Animation channels to operate on.
335  * Returns the number of channels in the list
336  */
337 size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype);
338
339 /* Obtain current anim-data context from Blender Context info.
340  * Returns whether the operation was successful. 
341  */
342 short ANIM_animdata_get_context(const struct bContext *C, bAnimContext *ac);
343
344 /* Obtain current anim-data context (from Animation Editor) given 
345  * that Blender Context info has already been set. 
346  * Returns whether the operation was successful.
347  */
348 short ANIM_animdata_context_getdata(bAnimContext *ac);
349
350 /* ************************************************ */
351 /* ANIMATION CHANNELS LIST */
352 /* anim_channels_*.c */
353
354 /* ------------------------ Drawing TypeInfo -------------------------- */
355
356 /* flag-setting behavior */
357 typedef enum eAnimChannels_SetFlag {
358         ACHANNEL_SETFLAG_CLEAR  = 0,     /* turn off */
359         ACHANNEL_SETFLAG_ADD    = 1,     /* turn on */
360         ACHANNEL_SETFLAG_INVERT = 2,     /* on->off, off->on */
361         ACHANNEL_SETFLAG_TOGGLE = 3      /* some on -> all off // all on */
362 } eAnimChannels_SetFlag;
363
364 /* types of settings for AnimChannels */
365 typedef enum eAnimChannel_Settings {
366         ACHANNEL_SETTING_SELECT   = 0,
367         ACHANNEL_SETTING_PROTECT  = 1, /* warning: for drawing UI's, need to check if this is off (maybe inverse this later) */
368         ACHANNEL_SETTING_MUTE     = 2,
369         ACHANNEL_SETTING_EXPAND   = 3,
370         ACHANNEL_SETTING_VISIBLE  = 4,  /* only for Graph Editor */
371         ACHANNEL_SETTING_SOLO     = 5   /* only for NLA Tracks */
372 } eAnimChannel_Settings;
373
374
375 /* Drawing, mouse handling, and flag setting behavior... */
376 typedef struct bAnimChannelType {
377         /* type data */
378         /* name of the channel type, for debugging */
379         const char *channel_type_name;
380         
381         /* drawing */
382         /* get RGB color that is used to draw the majority of the backdrop */
383         void (*get_backdrop_color)(bAnimContext *ac, bAnimListElem *ale, float r_color[3]);
384         /* draw backdrop strip for channel */
385         void (*draw_backdrop)(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
386         /* get depth of indention (relative to the depth channel is nested at) */
387         short (*get_indent_level)(bAnimContext *ac, bAnimListElem *ale);
388         /* get offset in pixels for the start of the channel (in addition to the indent depth) */
389         short (*get_offset)(bAnimContext *ac, bAnimListElem *ale);
390         
391         /* get name (for channel lists) */
392         void (*name)(bAnimListElem *ale, char *name);
393         /* get RNA property+pointer for editing the name */
394         short (*name_prop)(bAnimListElem *ale, struct PointerRNA *ptr, struct PropertyRNA **prop);
395         /* get icon (for channel lists) */
396         int (*icon)(bAnimListElem *ale);
397         
398         /* settings */
399         /* check if the given setting is valid in the current context */
400         short (*has_setting)(bAnimContext *ac, bAnimListElem *ale, int setting);
401         /* get the flag used for this setting */
402         int (*setting_flag)(bAnimContext *ac, int setting, short *neg);
403         /* get the pointer to int/short where data is stored,
404          * with type being  sizeof(ptr_data) which should be fine for runtime use...
405          *      - assume that setting has been checked to be valid for current context
406          */
407         void *(*setting_ptr)(bAnimListElem * ale, int setting, short *type);
408 } bAnimChannelType;
409
410 /* ------------------------ Drawing API -------------------------- */
411
412 /* Get typeinfo for the given channel */
413 bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
414
415 /* Print debugging info about a given channel */
416 void ANIM_channel_debug_print_info(bAnimListElem *ale, short indent_level);
417
418 /* Draw the given channel */
419 void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
420 /* Draw the widgets for the given channel */
421 void ANIM_channel_draw_widgets(struct bContext *C, bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc, size_t channel_index);
422
423
424 /* ------------------------ Editing API -------------------------- */
425
426 /* Check if some setting for a channel is enabled 
427  * Returns: 1 = On, 0 = Off, -1 = Invalid
428  *
429  *  - setting: eAnimChannel_Settings
430  */
431 short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, int setting);
432
433 /* Change value of some setting for a channel 
434  *      - setting: eAnimChannel_Settings
435  *      - mode: eAnimChannels_SetFlag
436  */
437 void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, short mode);
438
439
440 /* Flush visibility (for Graph Editor) changes up/down hierarchy for changes in the given setting 
441  *      - anim_data: list of the all the anim channels that can be chosen
442  *              -> filtered using ANIMFILTER_CHANNELS only, since if we took VISIBLE too,
443  *                then the channels under closed expanders get ignored...
444  *      - ale_setting: the anim channel (not in the anim_data list directly, though occurring there)
445  *              with the new state of the setting that we want flushed up/down the hierarchy 
446  *      - setting: type of setting to set
447  *      - on: whether the visibility setting has been enabled or disabled 
448  */
449 void ANIM_flush_setting_anim_channels(bAnimContext *ac, ListBase *anim_data, bAnimListElem *ale_setting, int setting, short on);
450
451
452 /* Deselect all animation channels */
453 void ANIM_deselect_anim_channels(bAnimContext *ac, void *data, short datatype, short test, short sel);
454
455 /* Set the 'active' channel of type channel_type, in the given action */
456 void ANIM_set_active_channel(bAnimContext *ac, void *data, short datatype, int filter, void *channel_data, short channel_type);
457
458
459 /* Delete the F-Curve from the given AnimData block (if possible), as appropriate according to animation context */
460 void ANIM_fcurve_delete_from_animdata(bAnimContext *ac, struct AnimData *adt, struct FCurve *fcu);
461
462 /* ************************************************ */
463 /* DRAWING API */
464 /* anim_draw.c */
465
466 /* Get string representing the given frame number as an appropriately represented frame or timecode */
467 void ANIM_timecode_string_from_frame(char *str, struct Scene *scene, int power, short timecodes, float cfra);
468
469 /* ---------- Current Frame Drawing ---------------- */
470
471 /* flags for Current Frame Drawing */
472 enum {
473         /* plain time indicator with no special indicators */
474         DRAWCFRA_PLAIN          = 0,
475         /* draw box indicating current frame number */
476         DRAWCFRA_SHOW_NUMBOX    = (1 << 0),
477         /* time indication in seconds or frames */
478         DRAWCFRA_UNIT_SECONDS   = (1 << 1),
479         /* draw indicator extra wide (for timeline) */
480         DRAWCFRA_WIDE           = (1 << 2)
481 } eAnimEditDraw_CurrentFrame; 
482
483 /* main call to draw current-frame indicator in an Animation Editor */
484 void ANIM_draw_cfra(const struct bContext *C, struct View2D *v2d, short flag);
485
486 /* ------------- Preview Range Drawing -------------- */
487
488 /* main call to draw preview range curtains */
489 void ANIM_draw_previewrange(const struct bContext *C, struct View2D *v2d);
490
491 /* ************************************************* */
492 /* F-MODIFIER TOOLS */
493
494 /* ------------- UI Panel Drawing -------------- */
495
496 /* draw a given F-Modifier for some layout/UI-Block */
497 void ANIM_uiTemplate_fmodifier_draw(struct uiLayout *layout, struct ID *id, ListBase *modifiers, struct FModifier *fcm);
498
499 /* ------------- Copy/Paste Buffer -------------- */
500
501
502 /* free the copy/paste buffer */
503 void free_fmodifiers_copybuf(void);
504
505 /* copy the given F-Modifiers to the buffer, returning whether anything was copied or not
506  * assuming that the buffer has been cleared already with free_fmodifiers_copybuf()
507  *      - active: only copy the active modifier
508  */
509 short ANIM_fmodifiers_copy_to_buf(ListBase *modifiers, short active);
510
511 /* 'Paste' the F-Modifier(s) from the buffer to the specified list 
512  *      - replace: free all the existing modifiers to leave only the pasted ones 
513  */
514 short ANIM_fmodifiers_paste_from_buf(ListBase *modifiers, short replace);
515
516 /* ************************************************* */
517 /* ASSORTED TOOLS */
518
519 /* ------------ Animation F-Curves <-> Icons/Names Mapping ------------ */
520 /* anim_ipo_utils.c */
521
522 /* Get icon + name for channel-list displays for F-Curve */
523 int getname_anim_fcurve(char *name, struct ID *id, struct FCurve *fcu);
524
525 /* Automatically determine a color for the nth F-Curve */
526 void getcolor_fcurve_rainbow(int cur, int tot, float out[3]);
527
528 /* ----------------- NLA-Mapping ----------------------- */
529 /* anim_draw.c */
530
531 /* Obtain the AnimData block providing NLA-scaling for the given channel if applicable */
532 struct AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale);
533
534 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve */
535 void ANIM_nla_mapping_apply_fcurve(struct AnimData *adt, struct FCurve *fcu, short restore, short only_keys);
536
537 /* ..... */
538
539 /* Perform auto-blending/extend refreshes after some operations */
540 // NOTE: defined in space_nla/nla_edit.c, not in animation/
541 void ED_nla_postop_refresh(bAnimContext *ac);
542
543 /* ------------- Unit Conversion Mappings ------------- */
544 /* anim_draw.c */
545
546 /* flags for conversion mapping */
547 typedef enum eAnimUnitConv_Flags {
548         /* restore to original internal values */
549         ANIM_UNITCONV_RESTORE   = (1 << 0),
550         /* ignore handles (i.e. only touch main keyframes) */
551         ANIM_UNITCONV_ONLYKEYS  = (1 << 1),
552         /* only touch selected BezTriples */
553         ANIM_UNITCONV_ONLYSEL   = (1 << 2),
554         /* only touch selected vertices */
555         ANIM_UNITCONV_SELVERTS  = (1 << 3)
556 } eAnimUnitConv_Flags;
557
558 /* Get unit conversion factor for given ID + F-Curve */
559 float ANIM_unit_mapping_get_factor(struct Scene *scene, struct ID *id, struct FCurve *fcu, short restore);
560
561 /* Apply/Unapply units conversions to keyframes */
562 void ANIM_unit_mapping_apply_fcurve(struct Scene *scene, struct ID *id, struct FCurve *fcu, short flag);
563
564 /* ------------- Utility macros ----------------------- */
565
566 /* provide access to Keyframe Type info in BezTriple
567  * NOTE: this is so that we can change it from being stored in 'hide'
568  */
569 #define BEZKEYTYPE(bezt) ((bezt)->hide)
570
571 /* set/clear/toggle macro 
572  *      - channel - channel with a 'flag' member that we're setting
573  *      - smode - 0=clear, 1=set, 2=invert
574  *      - sflag - bitflag to set
575  */
576 #define ACHANNEL_SET_FLAG(channel, smode, sflag) \
577         { \
578                 if      (smode == ACHANNEL_SETFLAG_INVERT)  (channel)->flag ^=  (sflag); \
579                 else if (smode == ACHANNEL_SETFLAG_ADD)     (channel)->flag |=  (sflag); \
580                 else                                        (channel)->flag &= ~(sflag); \
581         }
582         
583 /* set/clear/toggle macro, where the flag is negative 
584  *      - channel - channel with a 'flag' member that we're setting
585  *      - smode - 0=clear, 1=set, 2=invert
586  *      - sflag - bitflag to set
587  */
588 #define ACHANNEL_SET_FLAG_NEG(channel, smode, sflag) \
589         { \
590                 if      (smode == ACHANNEL_SETFLAG_INVERT)  (channel)->flag ^=  (sflag); \
591                 else if (smode == ACHANNEL_SETFLAG_ADD)     (channel)->flag &= ~(sflag); \
592                 else                                        (channel)->flag |=  (sflag); \
593         }
594
595
596 /* --------- anim_deps.c, animation updates -------- */
597
598 void ANIM_id_update(struct Scene *scene, struct ID *id);
599 void ANIM_list_elem_update(struct Scene *scene, bAnimListElem *ale);
600
601 /* data -> channels syncing */
602 void ANIM_sync_animchannels_to_data(const struct bContext *C);
603
604 /* ************************************************* */
605 /* OPERATORS */
606         
607 /* generic animation channels */
608 void ED_operatortypes_animchannels(void);
609 void ED_keymap_animchannels(struct wmKeyConfig *keyconf);
610
611 /* generic time editing */
612 void ED_operatortypes_anim(void);
613 void ED_keymap_anim(struct wmKeyConfig *keyconf);
614         
615 /* space_graph */
616 void ED_operatormacros_graph(void);
617 /* space_action */
618 void ED_operatormacros_action(void);
619
620 /* ************************************************ */
621
622 #endif /* __ED_ANIM_API_H__ */
623