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