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