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