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