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