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