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