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