Merge branch 'master' into blender2.8
[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 bAction;
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;           /* (eAnim_ChannelType) 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 its collection */
116         
117         char    update;         /* (eAnim_Update_Flags)  tag the element for updating */
118         char    tag;            /* tag the included data. Temporary always */
119
120         short   datatype;       /* (eAnim_KeyType) type of motion data to expect */
121         void   *key_data;       /* motion data - mostly F-Curves, but can be other types too */
122         
123         
124         struct ID *id;          /* ID block that channel is attached to */
125         struct AnimData *adt;   /* source of the animation data attached to ID block (for convenience) */
126         
127         void   *owner;          /* for per-element F-Curves (e.g. NLA Control Curves), the element that this represents (e.g. NlaStrip) */
128 } bAnimListElem;
129
130
131 /* Some types for easier type-testing 
132  * NOTE: need to keep the order of these synchronized with the channels define code
133  *      which is used for drawing and handling channel lists for
134  */
135 typedef enum eAnim_ChannelType {
136         ANIMTYPE_NONE = 0,
137         ANIMTYPE_ANIMDATA,
138         ANIMTYPE_SPECIALDATA,
139         
140         ANIMTYPE_SUMMARY,
141         
142         ANIMTYPE_SCENE,
143         ANIMTYPE_OBJECT,
144         ANIMTYPE_GROUP,
145         ANIMTYPE_FCURVE,
146         
147         ANIMTYPE_NLACONTROLS,
148         ANIMTYPE_NLACURVE,
149         
150         ANIMTYPE_FILLACTD,
151         ANIMTYPE_FILLDRIVERS,
152         
153         ANIMTYPE_DSMAT,
154         ANIMTYPE_DSLAM,
155         ANIMTYPE_DSCAM,
156         ANIMTYPE_DSCUR,
157         ANIMTYPE_DSSKEY,
158         ANIMTYPE_DSWOR,
159         ANIMTYPE_DSNTREE,
160         ANIMTYPE_DSMBALL,
161         ANIMTYPE_DSARM,
162         ANIMTYPE_DSMESH,
163         ANIMTYPE_DSTEX,
164         ANIMTYPE_DSLAT,
165         ANIMTYPE_DSLINESTYLE,
166         ANIMTYPE_DSSPK,
167         ANIMTYPE_DSGPENCIL,
168         
169         ANIMTYPE_SHAPEKEY,
170         
171         ANIMTYPE_GPDATABLOCK,
172         ANIMTYPE_GPLAYER,
173         
174         ANIMTYPE_MASKDATABLOCK,
175         ANIMTYPE_MASKLAYER,
176         
177         ANIMTYPE_NLATRACK,
178         ANIMTYPE_NLAACTION,
179         
180         /* always as last item, the total number of channel types... */
181         ANIMTYPE_NUM_TYPES
182 } eAnim_ChannelType;
183
184 /* types of keyframe data in bAnimListElem */
185 typedef enum eAnim_KeyType {
186         ALE_NONE = 0,       /* no keyframe data */
187         ALE_FCURVE,         /* F-Curve */
188         ALE_GPFRAME,        /* Grease Pencil Frames */
189         ALE_MASKLAY,        /* Mask */
190         ALE_NLASTRIP,       /* NLA Strips */
191
192         ALE_ALL,            /* All channels summary */
193         ALE_SCE,            /* Scene summary */
194         ALE_OB,             /* Object summary */
195         ALE_ACT,            /* Action summary */
196         ALE_GROUP           /* Action Group summary */
197 } eAnim_KeyType;
198
199 /* Flags for specifying the types of updates (i.e. recalculation/refreshing) that
200  * needs to be performed to the data contained in a channel following editing.
201  * For use with ANIM_animdata_update()
202  */
203 typedef enum eAnim_Update_Flags {
204         ANIM_UPDATE_DEPS        = (1 << 0),  /* referenced data and dependencies get refreshed */
205         ANIM_UPDATE_ORDER       = (1 << 1),  /* keyframes need to be sorted */
206         ANIM_UPDATE_HANDLES     = (1 << 2),  /* recalculate handles */
207 } eAnim_Update_Flags;
208
209 /* used for most tools which change keyframes (flushed by ANIM_animdata_update) */
210 #define ANIM_UPDATE_DEFAULT (ANIM_UPDATE_DEPS | ANIM_UPDATE_ORDER | ANIM_UPDATE_HANDLES)
211 #define ANIM_UPDATE_DEFAULT_NOHANDLES (ANIM_UPDATE_DEFAULT & ~ANIM_UPDATE_HANDLES)
212
213 /* ----------------- Filtering -------------------- */
214
215 /* filtering flags  - under what circumstances should a channel be returned */
216 typedef enum eAnimFilter_Flags {
217         /* data which channel represents is fits the dopesheet filters (i.e. scene visibility criteria) */
218         // XXX: it's hard to think of any examples where this *ISN'T* the case... perhaps becomes implicit?
219         ANIMFILTER_DATA_VISIBLE   = (1 << 0),
220         /* channel is visible within the channel-list hierarchy (i.e. F-Curves within Groups in ActEdit) */
221         ANIMFILTER_LIST_VISIBLE   = (1 << 1),
222         /* channel has specifically been tagged as visible in Graph Editor (* Graph Editor Only) */
223         ANIMFILTER_CURVE_VISIBLE  = (1 << 2),
224         
225         /* include summary channels and "expanders" (for drawing/mouse-selection in channel list) */
226         ANIMFILTER_LIST_CHANNELS  = (1 << 3),
227         
228         /* for its type, channel should be "active" one */
229         ANIMFILTER_ACTIVE         = (1 << 4),
230         /* channel is a child of the active group (* Actions speciality) */
231         ANIMFILTER_ACTGROUPED     = (1 << 5),
232         
233         /* channel must be selected/not-selected, but both must not be set together */
234         ANIMFILTER_SEL            = (1 << 6),
235         ANIMFILTER_UNSEL          = (1 << 7),
236         
237         /* editability status - must be editable to be included */
238         ANIMFILTER_FOREDIT        = (1 << 8),
239         /* only selected animchannels should be considerable as editable - mainly for Graph Editor's option for keys on select curves only */
240         ANIMFILTER_SELEDIT        = (1 << 9),
241         
242         /* flags used to enforce certain data types */
243         // NOTE: the ones for curves and NLA tracks were redundant and have been removed for now...
244         ANIMFILTER_ANIMDATA       = (1 << 10),
245         
246         /* duplicate entries for animation data attached to multi-user blocks must not occur */
247         ANIMFILTER_NODUPLIS       = (1 << 11),
248         
249         /* for checking if we should keep some collapsed channel around (internal use only!) */
250         ANIMFILTER_TMP_PEEK       = (1 << 30),
251
252         /* ignore ONLYSEL flag from filterflag, (internal use only!) */
253         ANIMFILTER_TMP_IGNORE_ONLYSEL = (1 << 31)
254 } eAnimFilter_Flags;
255
256 /* ---------- Flag Checking Macros ------------ */
257 // xxx check on all of these flags again...
258
259 /* Dopesheet only */
260 /* 'Scene' channels */
261 #define SEL_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene *), ((sce->flag & SCE_DS_SELECTED)))
262 #define EXPANDED_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene *), ((sce->flag & SCE_DS_COLLAPSED) == 0))
263 /* 'Sub-Scene' channels (flags stored in Data block) */
264 #define FILTER_WOR_SCED(wo) (CHECK_TYPE_INLINE(wo, World *), (wo->flag & WO_DS_EXPAND))
265 #define FILTER_LS_SCED(linestyle) ((linestyle->flag & LS_DS_EXPAND))
266 /* 'Object' channels */
267 #define SEL_OBJC(base)          (CHECK_TYPE_INLINE(base, Base *), ((base->flag & SELECT)))
268 #define EXPANDED_OBJC(ob)       (CHECK_TYPE_INLINE(ob, Object *), ((ob->nlaflag & OB_ADS_COLLAPSED) == 0))
269 /* 'Sub-object' channels (flags stored in Data block) */
270 #define FILTER_SKE_OBJD(key)    (CHECK_TYPE_INLINE(key, Key *), ((key->flag & KEY_DS_EXPAND)))
271 #define FILTER_MAT_OBJD(ma)     (CHECK_TYPE_INLINE(ma, Material *), ((ma->flag & MA_DS_EXPAND)))
272 #define FILTER_LAM_OBJD(la)     (CHECK_TYPE_INLINE(la, Lamp *), ((la->flag & LA_DS_EXPAND)))
273 #define FILTER_CAM_OBJD(ca)     (CHECK_TYPE_INLINE(ca, Camera *), ((ca->flag & CAM_DS_EXPAND)))
274 #define FILTER_CUR_OBJD(cu)     (CHECK_TYPE_INLINE(cu, Curve *), ((cu->flag & CU_DS_EXPAND)))
275 #define FILTER_MBALL_OBJD(mb)   (CHECK_TYPE_INLINE(mb, MetaBall *), ((mb->flag2 & MB_DS_EXPAND)))
276 #define FILTER_ARM_OBJD(arm)    (CHECK_TYPE_INLINE(arm, bArmature *), ((arm->flag & ARM_DS_EXPAND)))
277 #define FILTER_MESH_OBJD(me)    (CHECK_TYPE_INLINE(me, Mesh *), ((me->flag & ME_DS_EXPAND)))
278 #define FILTER_LATTICE_OBJD(lt) (CHECK_TYPE_INLINE(lt, Lattice *), ((lt->flag & LT_DS_EXPAND)))
279 #define FILTER_SPK_OBJD(spk)    (CHECK_TYPE_INLINE(spk, Speaker *), ((spk->flag & SPK_DS_EXPAND)))
280 /* Variable use expanders */
281 #define FILTER_NTREE_DATA(ntree) (CHECK_TYPE_INLINE(ntree, bNodeTree *), ((ntree->flag & NTREE_DS_EXPAND)))
282 #define FILTER_TEX_DATA(tex)     (CHECK_TYPE_INLINE(tex, Tex *), ((tex->flag & TEX_DS_EXPAND)))
283
284 /* 'Sub-object/Action' channels (flags stored in Action) */
285 #define SEL_ACTC(actc) ((actc->flag & ACT_SELECTED))
286 #define EXPANDED_ACTC(actc) ((actc->flag & ACT_COLLAPSED) == 0)
287 /* 'Sub-AnimData' channels */
288 #define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED) == 0)
289
290
291 /* Actions (also used for Dopesheet) */
292 /* Action Channel Group */
293 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED) == 0)
294 #define EXPANDED_AGRP(ac, agrp) \
295         ( ((!(ac) || ((ac)->spacetype != SPACE_IPO)) && (agrp->flag & AGRP_EXPANDED)) || \
296           (( (ac) && ((ac)->spacetype == SPACE_IPO)) && (agrp->flag & AGRP_EXPANDED_G)) )
297 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
298 /* F-Curve Channels */
299 #define EDITABLE_FCU(fcu) ((fcu->flag & FCURVE_PROTECTED) == 0)
300 #define SEL_FCU(fcu) (fcu->flag & FCURVE_SELECTED)
301
302 /* ShapeKey mode only */
303 #define EDITABLE_SHAPEKEY(kb) ((kb->flag & KEYBLOCK_LOCKED) == 0)
304 #define SEL_SHAPEKEY(kb) (kb->flag & KEYBLOCK_SEL)
305
306 /* Grease Pencil only */
307 /* Grease Pencil datablock settings */
308 #define EXPANDED_GPD(gpd) (gpd->flag & GP_DATA_EXPAND) 
309 /* Grease Pencil Layer settings */
310 #define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED) == 0)
311 #define SEL_GPL(gpl) (gpl->flag & GP_LAYER_SELECT)
312
313 /* Mask Only */
314 /* Grease Pencil datablock settings */
315 #define EXPANDED_MASK(mask) (mask->flag & MASK_ANIMF_EXPAND)
316 /* Grease Pencil Layer settings */
317 #define EDITABLE_MASK(masklay) ((masklay->flag & MASK_LAYERFLAG_LOCKED) == 0)
318 #define SEL_MASKLAY(masklay) (masklay->flag & SELECT)
319
320
321 /* NLA only */
322 #define SEL_NLT(nlt) (nlt->flag & NLATRACK_SELECTED)
323 #define EDITABLE_NLT(nlt) ((nlt->flag & NLATRACK_PROTECTED) == 0)
324
325
326 /* AnimData - NLA mostly... */
327 #define SEL_ANIMDATA(adt) (adt->flag & ADT_UI_SELECTED)
328
329 /* -------------- Channel Defines -------------- */
330
331 /* channel heights */
332 #define ACHANNEL_FIRST          (-0.8f * U.widget_unit)
333 #define ACHANNEL_HEIGHT         (0.8f * U.widget_unit)
334 #define ACHANNEL_HEIGHT_HALF    (0.4f * U.widget_unit)
335 #define ACHANNEL_SKIP           (0.1f * U.widget_unit)
336 #define ACHANNEL_STEP           (ACHANNEL_HEIGHT + ACHANNEL_SKIP)
337
338 /* channel widths */
339 #define ACHANNEL_NAMEWIDTH      (10 * U.widget_unit)
340
341 /* channel toggle-buttons */
342 #define ACHANNEL_BUTTON_WIDTH   (0.8f * U.widget_unit)
343
344
345 /* -------------- NLA Channel Defines -------------- */
346
347 /* NLA channel heights */
348 // XXX: NLACHANNEL_FIRST isn't used?
349 #define NLACHANNEL_FIRST                (-0.8f * U.widget_unit)
350 #define NLACHANNEL_HEIGHT(snla)         ((snla && (snla->flag & SNLA_NOSTRIPCURVES)) ? (0.8f * U.widget_unit) : (1.2f * U.widget_unit))
351 #define NLACHANNEL_HEIGHT_HALF(snla)    ((snla && (snla->flag & SNLA_NOSTRIPCURVES)) ? (0.4f * U.widget_unit) : (0.6f * U.widget_unit))
352 #define NLACHANNEL_SKIP                 (0.1f * U.widget_unit)
353 #define NLACHANNEL_STEP(snla)           (NLACHANNEL_HEIGHT(snla) + NLACHANNEL_SKIP)
354
355 /* channel widths */
356 #define NLACHANNEL_NAMEWIDTH                    (10 * U.widget_unit)
357
358 /* channel toggle-buttons */
359 #define NLACHANNEL_BUTTON_WIDTH                 (0.8f * U.widget_unit)
360
361 /* ---------------- API  -------------------- */
362
363 /* Obtain list of filtered Animation channels to operate on.
364  * Returns the number of channels in the list
365  */
366 size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, eAnimFilter_Flags filter_mode, void *data, eAnimCont_Types datatype);
367
368 /* Obtain current anim-data context from Blender Context info.
369  * Returns whether the operation was successful. 
370  */
371 bool ANIM_animdata_get_context(const struct bContext *C, bAnimContext *ac);
372
373 /* Obtain current anim-data context (from Animation Editor) given 
374  * that Blender Context info has already been set. 
375  * Returns whether the operation was successful.
376  */
377 bool ANIM_animdata_context_getdata(bAnimContext *ac);
378
379 /* Acts on bAnimListElem eAnim_Update_Flags */
380 void ANIM_animdata_update(bAnimContext *ac, ListBase *anim_data);
381
382 void ANIM_animdata_freelist(ListBase *anim_data);
383
384 /* ************************************************ */
385 /* ANIMATION CHANNELS LIST */
386 /* anim_channels_*.c */
387
388 /* ------------------------ Drawing TypeInfo -------------------------- */
389
390 /* role or level of animchannel in the hierarchy */
391 typedef enum eAnimChannel_Role {
392         ACHANNEL_ROLE_EXPANDER = -1,    /* datablock expander - a "composite" channel type */
393         ACHANNEL_ROLE_SPECIAL  = 0,     /* special purposes - not generally for hierarchy processing */
394         ACHANNEL_ROLE_CHANNEL  = 1      /* data channel - a channel representing one of the actual building blocks of channels */
395 } eAnimChannel_Role;
396
397 /* flag-setting behavior */
398 typedef enum eAnimChannels_SetFlag {
399         ACHANNEL_SETFLAG_CLEAR  = 0,     /* turn off */
400         ACHANNEL_SETFLAG_ADD    = 1,     /* turn on */
401         ACHANNEL_SETFLAG_INVERT = 2,     /* on->off, off->on */
402         ACHANNEL_SETFLAG_TOGGLE = 3      /* some on -> all off // all on */
403 } eAnimChannels_SetFlag;
404
405 /* types of settings for AnimChannels */
406 typedef enum eAnimChannel_Settings {
407         ACHANNEL_SETTING_SELECT   = 0,
408         ACHANNEL_SETTING_PROTECT  = 1, /* warning: for drawing UI's, need to check if this is off (maybe inverse this later) */
409         ACHANNEL_SETTING_MUTE     = 2,
410         ACHANNEL_SETTING_EXPAND   = 3,
411         ACHANNEL_SETTING_VISIBLE  = 4,  /* only for Graph Editor */
412         ACHANNEL_SETTING_SOLO     = 5,  /* only for NLA Tracks */
413         ACHANNEL_SETTING_PINNED   = 6,  /* only for NLA Actions */
414         ACHANNEL_SETTING_MOD_OFF  = 7
415 } eAnimChannel_Settings;
416
417
418 /* Drawing, mouse handling, and flag setting behavior... */
419 typedef struct bAnimChannelType {
420         /* -- Type data -- */
421         /* name of the channel type, for debugging */
422         const char *channel_type_name;
423         /* "level" or role in hierarchy - for finding the active channel */
424         eAnimChannel_Role channel_role;
425         
426         /* -- Drawing -- */
427         /* get RGB color that is used to draw the majority of the backdrop */
428         void (*get_backdrop_color)(bAnimContext *ac, bAnimListElem *ale, float r_color[3]);
429         /* draw backdrop strip for channel */
430         void (*draw_backdrop)(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
431         /* get depth of indention (relative to the depth channel is nested at) */
432         short (*get_indent_level)(bAnimContext *ac, bAnimListElem *ale);
433         /* get offset in pixels for the start of the channel (in addition to the indent depth) */
434         short (*get_offset)(bAnimContext *ac, bAnimListElem *ale);
435         
436         /* get name (for channel lists) */
437         void (*name)(bAnimListElem *ale, char *name);
438         /* get RNA property+pointer for editing the name */
439         bool (*name_prop)(bAnimListElem *ale, struct PointerRNA *ptr, struct PropertyRNA **prop);
440         /* get icon (for channel lists) */
441         int (*icon)(bAnimListElem *ale);
442         
443         /* -- Settings -- */
444         /* check if the given setting is valid in the current context */
445         bool (*has_setting)(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting);
446         /* get the flag used for this setting */
447         int (*setting_flag)(bAnimContext *ac, eAnimChannel_Settings setting, bool *neg);
448         /* get the pointer to int/short where data is stored,
449          * with type being  sizeof(ptr_data) which should be fine for runtime use...
450          *      - assume that setting has been checked to be valid for current context
451          */
452         void *(*setting_ptr)(bAnimListElem *ale, eAnimChannel_Settings setting, short *type);
453 } bAnimChannelType;
454
455 /* ------------------------ Drawing API -------------------------- */
456
457 /* Get typeinfo for the given channel */
458 const bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
459
460 /* Print debugging info about a given channel */
461 void ANIM_channel_debug_print_info(bAnimListElem *ale, short indent_level);
462
463 /* Draw the given channel */
464 void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc, size_t channel_index);
465 /* Draw the widgets for the given channel */
466 void ANIM_channel_draw_widgets(const struct bContext *C, bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc, size_t channel_index);
467
468
469 /* ------------------------ Editing API -------------------------- */
470
471 /* Check if some setting for a channel is enabled 
472  * Returns: 1 = On, 0 = Off, -1 = Invalid
473  *
474  *  - setting: eAnimChannel_Settings
475  */
476 short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting);
477
478 /* Change value of some setting for a channel 
479  *      - setting: eAnimChannel_Settings
480  *      - mode: eAnimChannels_SetFlag
481  */
482 void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting, eAnimChannels_SetFlag mode);
483
484
485 /* Flush visibility (for Graph Editor) changes up/down hierarchy for changes in the given setting 
486  *      - anim_data: list of the all the anim channels that can be chosen
487  *              -> filtered using ANIMFILTER_CHANNELS only, since if we took VISIBLE too,
488  *                then the channels under closed expanders get ignored...
489  *      - ale_setting: the anim channel (not in the anim_data list directly, though occurring there)
490  *              with the new state of the setting that we want flushed up/down the hierarchy 
491  *      - setting: type of setting to set
492  *      - on: whether the visibility setting has been enabled or disabled 
493  */
494 void ANIM_flush_setting_anim_channels(bAnimContext *ac, ListBase *anim_data, bAnimListElem *ale_setting, eAnimChannel_Settings setting, eAnimChannels_SetFlag mode);
495
496
497 /* Deselect all animation channels */
498 void ANIM_deselect_anim_channels(bAnimContext *ac, void *data, eAnimCont_Types datatype, bool test, eAnimChannels_SetFlag sel);
499
500 /* Set the 'active' channel of type channel_type, in the given action */
501 void ANIM_set_active_channel(bAnimContext *ac, void *data, eAnimCont_Types datatype, eAnimFilter_Flags filter, void *channel_data, eAnim_ChannelType channel_type);
502
503
504 /* Delete the F-Curve from the given AnimData block (if possible), as appropriate according to animation context */
505 void ANIM_fcurve_delete_from_animdata(bAnimContext *ac, struct AnimData *adt, struct FCurve *fcu);
506
507 /* ************************************************ */
508 /* DRAWING API */
509 /* anim_draw.c */
510
511 /* ---------- Current Frame Drawing ---------------- */
512
513 /* flags for Current Frame Drawing */
514 enum eAnimEditDraw_CurrentFrame {
515         /* plain time indicator with no special indicators */
516         DRAWCFRA_PLAIN          = 0,
517         /* draw box indicating current frame number */
518         DRAWCFRA_SHOW_NUMBOX    = (1 << 0),
519         /* time indication in seconds or frames */
520         DRAWCFRA_UNIT_SECONDS   = (1 << 1),
521         /* draw indicator extra wide (for timeline) */
522         DRAWCFRA_WIDE           = (1 << 2)
523 };
524
525 /* main call to draw current-frame indicator in an Animation Editor */
526 void ANIM_draw_cfra(const struct bContext *C, struct View2D *v2d, short flag);
527
528 /* ------------- Preview Range Drawing -------------- */
529
530 /* main call to draw preview range curtains */
531 void ANIM_draw_previewrange(const struct bContext *C, struct View2D *v2d, int end_frame_width);
532
533 /* ************************************************* */
534 /* F-MODIFIER TOOLS */
535
536 /* ------------- UI Panel Drawing -------------- */
537
538 /* draw a given F-Modifier for some layout/UI-Block */
539 void ANIM_uiTemplate_fmodifier_draw(struct uiLayout *layout, struct ID *id, ListBase *modifiers, struct FModifier *fcm);
540
541 /* ------------- Copy/Paste Buffer -------------- */
542
543
544 /* free the copy/paste buffer */
545 void ANIM_fmodifiers_copybuf_free(void);
546
547 /* copy the given F-Modifiers to the buffer, returning whether anything was copied or not
548  * assuming that the buffer has been cleared already with ANIM_fmodifiers_copybuf_free()
549  *      - active: only copy the active modifier
550  */
551 bool ANIM_fmodifiers_copy_to_buf(ListBase *modifiers, bool active);
552
553 /* 'Paste' the F-Modifier(s) from the buffer to the specified list 
554  *      - replace: free all the existing modifiers to leave only the pasted ones 
555  */
556 bool ANIM_fmodifiers_paste_from_buf(ListBase *modifiers, bool replace);
557
558 /* ************************************************* */
559 /* ASSORTED TOOLS */
560
561 /* ------------ Animation F-Curves <-> Icons/Names Mapping ------------ */
562 /* anim_ipo_utils.c */
563
564 /* Get icon + name for channel-list displays for F-Curve */
565 int getname_anim_fcurve(char *name, struct ID *id, struct FCurve *fcu);
566
567 /* Automatically determine a color for the nth F-Curve */
568 void getcolor_fcurve_rainbow(int cur, int tot, float out[3]);
569
570 /* ----------------- NLA Drawing ----------------------- */
571 /* NOTE: Technically, this is not in the animation module (it's in space_nla)
572  * but these are sometimes needed by various animation apis.
573  */
574
575 /* Get color to use for NLA Action channel's background */
576 void nla_action_get_color(struct AnimData *adt, struct bAction *act, float color[4]);
577
578 /* ----------------- NLA-Mapping ----------------------- */
579 /* anim_draw.c */
580
581 /* Obtain the AnimData block providing NLA-scaling for the given channel if applicable */
582 struct AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale);
583
584 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve */
585 void ANIM_nla_mapping_apply_fcurve(struct AnimData *adt, struct FCurve *fcu, bool restore, bool only_keys);
586
587 /* ..... */
588
589 /* Perform auto-blending/extend refreshes after some operations */
590 // NOTE: defined in space_nla/nla_edit.c, not in animation/
591 void ED_nla_postop_refresh(bAnimContext *ac);
592
593 /* ------------- Unit Conversion Mappings ------------- */
594 /* anim_draw.c */
595
596 /* flags for conversion mapping */
597 typedef enum eAnimUnitConv_Flags {
598         /* restore to original internal values */
599         ANIM_UNITCONV_RESTORE   = (1 << 0),
600         /* ignore handles (i.e. only touch main keyframes) */
601         ANIM_UNITCONV_ONLYKEYS  = (1 << 1),
602         /* only touch selected BezTriples */
603         ANIM_UNITCONV_ONLYSEL   = (1 << 2),
604         /* only touch selected vertices */
605         ANIM_UNITCONV_SELVERTS  = (1 << 3),
606         ANIM_UNITCONV_SKIPKNOTS  = (1 << 4),
607         /* Scale FCurve i a way it fits to -1..1 space */
608         ANIM_UNITCONV_NORMALIZE  = (1 << 5),
609         /* Only when normalization is used: use scale factor from previous run,
610          * prevents curves from jumping all over the place when tweaking them.
611          */
612         ANIM_UNITCONV_NORMALIZE_FREEZE  = (1 << 6),
613 } eAnimUnitConv_Flags;
614
615 /* Normalization flags from Space Graph passing to ANIM_unit_mapping_get_factor */
616 short ANIM_get_normalization_flags(bAnimContext *ac);
617
618 /* Get unit conversion factor for given ID + F-Curve */
619 float ANIM_unit_mapping_get_factor(struct Scene *scene, struct ID *id, struct FCurve *fcu, short flag, float *r_offset);
620
621 /* ------------- Utility macros ----------------------- */
622
623 /* provide access to Keyframe Type info in BezTriple
624  * NOTE: this is so that we can change it from being stored in 'hide'
625  */
626 #define BEZKEYTYPE(bezt) ((bezt)->hide)
627
628 /* set/clear/toggle macro 
629  *      - channel - channel with a 'flag' member that we're setting
630  *      - smode - 0=clear, 1=set, 2=invert
631  *      - sflag - bitflag to set
632  */
633 #define ACHANNEL_SET_FLAG(channel, smode, sflag) \
634         { \
635                 if      (smode == ACHANNEL_SETFLAG_INVERT)  (channel)->flag ^=  (sflag); \
636                 else if (smode == ACHANNEL_SETFLAG_ADD)     (channel)->flag |=  (sflag); \
637                 else                                        (channel)->flag &= ~(sflag); \
638         }
639         
640 /* set/clear/toggle macro, where the flag is negative 
641  *      - channel - channel with a 'flag' member that we're setting
642  *      - smode - 0=clear, 1=set, 2=invert
643  *      - sflag - bitflag to set
644  */
645 #define ACHANNEL_SET_FLAG_NEG(channel, smode, sflag) \
646         { \
647                 if      (smode == ACHANNEL_SETFLAG_INVERT)  (channel)->flag ^=  (sflag); \
648                 else if (smode == ACHANNEL_SETFLAG_ADD)     (channel)->flag &= ~(sflag); \
649                 else                                        (channel)->flag |=  (sflag); \
650         }
651
652
653 /* --------- anim_deps.c, animation updates -------- */
654
655 void ANIM_id_update(struct Scene *scene, struct ID *id);
656 void ANIM_list_elem_update(struct Scene *scene, bAnimListElem *ale);
657
658 /* data -> channels syncing */
659 void ANIM_sync_animchannels_to_data(const struct bContext *C);
660
661 void ANIM_center_frame(struct bContext *C, int smooth_viewtx);
662 /* ************************************************* */
663 /* OPERATORS */
664         
665 /* generic animation channels */
666 void ED_operatortypes_animchannels(void);
667 void ED_keymap_animchannels(struct wmKeyConfig *keyconf);
668
669 /* generic time editing */
670 void ED_operatortypes_anim(void);
671 void ED_keymap_anim(struct wmKeyConfig *keyconf);
672         
673 /* space_graph */
674 void ED_operatormacros_graph(void);
675 /* space_action */
676 void ED_operatormacros_action(void);
677
678 /* ************************************************ */
679 /* Animation Editor Exports */
680 /* XXX: Should we be doing these here, or at all? */
681
682 /* Action Editor - Action Management */
683 struct AnimData *ED_actedit_animdata_from_context(struct bContext *C);
684 void ED_animedit_unlink_action(struct bContext *C, struct ID *id, 
685                                struct AnimData *adt, struct bAction *act,
686                                struct ReportList *reports, bool force_delete);
687
688 /* ************************************************ */
689
690 #endif /* __ED_ANIM_API_H__ */
691