271827c2aba9bac6fcb43deaae005cf062fc2ad7
[blender.git] / source / blender / editors / include / ED_anim_api.h
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef ED_ANIM_API_H
30 #define ED_ANIM_API_H
31
32 struct ID;
33 struct ListBase;
34 struct AnimData;
35
36 struct bContext;
37 struct wmKeyConfig;
38 struct ScrArea;
39 struct ARegion;
40 struct View2D;
41
42 struct Scene;
43 struct Object;
44
45 struct bDopeSheet;
46
47 struct bActionGroup;
48 struct FCurve;
49 struct FModifier;
50
51 struct uiBlock;
52 struct uiLayout;
53
54 /* ************************************************ */
55 /* ANIMATION CHANNEL FILTERING */
56 /* anim_filter.c */
57
58 /* --------------- Context --------------------- */
59
60 /* This struct defines a structure used for animation-specific 
61  * 'context' information
62  */
63 typedef struct bAnimContext {
64         void *data;                             /* data to be filtered for use in animation editor */
65         short datatype;                 /* type of data eAnimCont_Types */
66         
67         short mode;                             /* editor->mode */
68         short spacetype;                /* sa->spacetype */
69         short regiontype;               /* active region -> type (channels or main) */
70         struct ScrArea *sa;             /* editor */ 
71         struct ARegion *ar;             /* region within editor */
72         
73         struct Scene *scene;    /* active scene */
74         struct Object *obact;   /* active object */
75         ListBase *markers;              /* active set of markers */
76 } bAnimContext;
77
78 /* Main Data container types */
79 // XXX was ACTCONT_*
80 typedef enum eAnimCont_Types {
81         ANIMCONT_NONE = 0,              /* invalid or no data */
82         ANIMCONT_ACTION,                /* action (bAction) */
83         ANIMCONT_SHAPEKEY,              /* shapekey (Key) */
84         ANIMCONT_GPENCIL,               /* grease pencil (screen) */
85         ANIMCONT_DOPESHEET,             /* dopesheet (bDopesheet) */
86         ANIMCONT_FCURVES,               /* animation F-Curves (bDopesheet) */
87         ANIMCONT_DRIVERS,               /* drivers (bDopesheet) */
88         ANIMCONT_NLA,                   /* nla (bDopesheet) */
89 } eAnimCont_Types;
90
91 /* --------------- Channels -------------------- */
92
93 /* This struct defines a structure used for quick and uniform access for 
94  * channels of animation data
95  */
96 typedef struct bAnimListElem {
97         struct bAnimListElem *next, *prev;
98         
99         void    *data;                  /* source data this elem represents */
100         int     type;                   /* one of the ANIMTYPE_* values */
101         int             flag;                   /* copy of elem's flags for quick access */
102         int     index;                  /* copy of adrcode where applicable */
103         
104         void    *key_data;              /* motion data - mostly F-Curves, but can be other types too */
105         short   datatype;               /* type of motion data to expect */
106         
107         struct ID *id;                  /* ID block that channel is attached to */
108         struct AnimData *adt;   /* source of the animation data attached to ID block (for convenience) */
109         
110         void    *owner;                 /* group or channel which acts as this channel's owner */
111         short   ownertype;              /* type of owner */
112 } bAnimListElem;
113
114
115 /* Some types for easier type-testing 
116  * NOTE: need to keep the order of these synchronised with the channels define code
117  *              which is used for drawing and handling channel lists for 
118  */
119 // XXX was ACTTYPE_*
120 typedef enum eAnim_ChannelType {
121         ANIMTYPE_NONE= 0,
122         ANIMTYPE_ANIMDATA,
123         ANIMTYPE_SPECIALDATA,
124         
125         ANIMTYPE_SUMMARY,
126         
127         ANIMTYPE_SCENE,
128         ANIMTYPE_OBJECT,
129         ANIMTYPE_GROUP,
130         ANIMTYPE_FCURVE,
131         
132         ANIMTYPE_FILLACTD,
133         ANIMTYPE_FILLDRIVERS,
134         ANIMTYPE_FILLMATD,
135         ANIMTYPE_FILLPARTD,
136         
137         ANIMTYPE_DSMAT,
138         ANIMTYPE_DSLAM,
139         ANIMTYPE_DSCAM,
140         ANIMTYPE_DSCUR,
141         ANIMTYPE_DSSKEY,
142         ANIMTYPE_DSWOR,
143         ANIMTYPE_DSPART,
144         ANIMTYPE_DSMBALL,
145         ANIMTYPE_DSARM,
146         
147         ANIMTYPE_SHAPEKEY,              // XXX probably can become depreceated???
148         
149         ANIMTYPE_GPDATABLOCK,
150         ANIMTYPE_GPLAYER,
151         
152         ANIMTYPE_NLATRACK,
153         ANIMTYPE_NLAACTION,
154         
155                 /* always as last item, the total number of channel types... */
156         ANIMTYPE_NUM_TYPES,
157 } eAnim_ChannelType;
158
159 /* types of keyframe data in bAnimListElem */
160 typedef enum eAnim_KeyType {
161         ALE_NONE = 0,           /* no keyframe data */
162         ALE_FCURVE,                     /* F-Curve */
163         ALE_GPFRAME,            /* Grease Pencil Frames */
164         ALE_NLASTRIP,           /* NLA Strips */
165         
166         ALE_ALL,                        /* All channels summary */
167         ALE_SCE,                        /* Scene summary */
168         ALE_OB,                         /* Object summary */
169         ALE_ACT,                        /* Action summary */
170         ALE_GROUP,                      /* Action Group summary */
171 } eAnim_KeyType;
172
173 /* ----------------- Filtering -------------------- */
174
175 /* filtering flags  - under what circumstances should a channel be added */
176 // XXX was ACTFILTER_*
177 typedef enum eAnimFilter_Flags {
178         ANIMFILTER_VISIBLE              = (1<<0),       /* should channels be visible (in terms of hierarchy only) */
179         ANIMFILTER_SEL                  = (1<<1),       /* should channels be selected */
180         ANIMFILTER_UNSEL                = (1<<2),       /* should channels be NOT selected */
181         ANIMFILTER_FOREDIT              = (1<<3),       /* does editable status matter */
182         ANIMFILTER_CURVESONLY   = (1<<4),       /* don't include summary-channels, etc. */
183         ANIMFILTER_CHANNELS             = (1<<5),       /* make list for interface drawing */
184         ANIMFILTER_ACTGROUPED   = (1<<6),       /* belongs to the active actiongroup */
185         ANIMFILTER_CURVEVISIBLE = (1<<7),       /* F-Curve is visible for editing/viewing in Graph Editor */
186         ANIMFILTER_ACTIVE               = (1<<8),       /* channel should be 'active' */
187         ANIMFILTER_ANIMDATA             = (1<<9),       /* only return the underlying AnimData blocks (not the tracks, etc.) data comes from */
188         ANIMFILTER_NLATRACKS    = (1<<10),      /* only include NLA-tracks */
189         ANIMFILTER_SELEDIT              = (1<<11),      /* link editability with selected status */
190         
191         /* all filters - the power inside the bracket must be the last power for left-shifts + 1 */
192         ANIMFILTER_ALLFILTERS   = ((1<<12) - 1)
193 } eAnimFilter_Flags;
194
195
196 /* ---------- Flag Checking Macros ------------ */
197 // xxx check on all of these flags again...
198
199 /* Dopesheet only */
200         /* 'Scene' channels */
201 #define SEL_SCEC(sce) ((sce->flag & SCE_DS_SELECTED))
202 #define EXPANDED_SCEC(sce) ((sce->flag & SCE_DS_COLLAPSED)==0)
203         /* 'Sub-Scene' channels (flags stored in Data block) */
204 #define FILTER_WOR_SCED(wo) ((wo->flag & WO_DS_EXPAND))
205         /* 'Object' channels */
206 #define SEL_OBJC(base) ((base->flag & SELECT))
207 #define EXPANDED_OBJC(ob) ((ob->nlaflag & OB_ADS_COLLAPSED)==0)
208         /* 'Sub-object' channels (flags stored in Object block) */
209 #define FILTER_MAT_OBJC(ob) ((ob->nlaflag & OB_ADS_SHOWMATS))
210 #define FILTER_PART_OBJC(ob) ((ob->nlaflag & OB_ADS_SHOWPARTS))
211         /* 'Sub-object' channels (flags stored in Data block) */
212 #define FILTER_SKE_OBJD(key) ((key->flag & KEYBLOCK_DS_EXPAND))
213 #define FILTER_MAT_OBJD(ma) ((ma->flag & MA_DS_EXPAND))
214 #define FILTER_LAM_OBJD(la) ((la->flag & LA_DS_EXPAND))
215 #define FILTER_CAM_OBJD(ca) ((ca->flag & CAM_DS_EXPAND))
216 #define FILTER_CUR_OBJD(cu) ((cu->flag & CU_DS_EXPAND))
217 #define FILTER_PART_OBJD(part) ((part->flag & PART_DS_EXPAND))
218 #define FILTER_MBALL_OBJD(mb) ((mb->flag2 & MB_DS_EXPAND))
219 #define FILTER_ARM_OBJD(arm) ((arm->flag & ARM_DS_EXPAND))
220         /* 'Sub-object/Action' channels (flags stored in Action) */
221 #define SEL_ACTC(actc) ((actc->flag & ACT_SELECTED))
222 #define EXPANDED_ACTC(actc) ((actc->flag & ACT_COLLAPSED)==0)
223         /* 'Sub-AnimData' chanenls */
224 #define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED)==0)
225
226 /* Actions (also used for Dopesheet) */
227         /* Action Channel Group */
228 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED)==0)
229 #define EXPANDED_AGRP(agrp) (agrp->flag & AGRP_EXPANDED)
230 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
231         /* F-Curve Channels */
232 #define EDITABLE_FCU(fcu) ((fcu->flag & FCURVE_PROTECTED)==0)
233 #define SEL_FCU(fcu) (fcu->flag & (FCURVE_ACTIVE|FCURVE_SELECTED))
234
235 /* Grease Pencil only */
236         /* Grease Pencil datablock settings */
237 #define EXPANDED_GPD(gpd) (gpd->flag & GP_DATA_EXPAND) 
238         /* Grease Pencil Layer settings */
239 #define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED)==0)
240 #define SEL_GPL(gpl) ((gpl->flag & GP_LAYER_ACTIVE) || (gpl->flag & GP_LAYER_SELECT))
241
242 /* NLA only */
243 #define SEL_NLT(nlt) (nlt->flag & NLATRACK_SELECTED)
244 #define EDITABLE_NLT(nlt) ((nlt->flag & NLATRACK_PROTECTED)==0)
245
246 /* -------------- Channel Defines -------------- */
247
248 /* channel heights */
249 #define ACHANNEL_FIRST                  -16
250 #define ACHANNEL_HEIGHT                 16
251 #define ACHANNEL_HEIGHT_HALF    8
252 #define ACHANNEL_SKIP                   2
253 #define ACHANNEL_STEP                   (ACHANNEL_HEIGHT + ACHANNEL_SKIP)
254
255 /* channel widths */
256 #define ACHANNEL_NAMEWIDTH              200
257
258 /* channel toggle-buttons */
259 #define ACHANNEL_BUTTON_WIDTH   16
260
261
262 /* -------------- NLA Channel Defines -------------- */
263
264 /* NLA channel heights */
265 #define NLACHANNEL_FIRST                        -16
266 #define NLACHANNEL_HEIGHT                       24
267 #define NLACHANNEL_HEIGHT_HALF  12
268 #define NLACHANNEL_SKIP                 2
269 #define NLACHANNEL_STEP                 (NLACHANNEL_HEIGHT + NLACHANNEL_SKIP)
270
271 /* channel widths */
272 #define NLACHANNEL_NAMEWIDTH            200
273
274 /* channel toggle-buttons */
275 #define NLACHANNEL_BUTTON_WIDTH 16
276
277 /* ---------------- API  -------------------- */
278
279 /* Obtain list of filtered Animation channels to operate on.
280  * Returns the number of channels in the list
281  */
282 int ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype);
283
284 /* Obtain current anim-data context from Blender Context info.
285  * Returns whether the operation was successful. 
286  */
287 short ANIM_animdata_get_context(const struct bContext *C, bAnimContext *ac);
288
289 /* Obtain current anim-data context (from Animation Editor) given 
290  * that Blender Context info has already been set. 
291  * Returns whether the operation was successful.
292  */
293 short ANIM_animdata_context_getdata(bAnimContext *ac);
294
295 /* ************************************************ */
296 /* ANIMATION CHANNELS LIST */
297 /* anim_channels_*.c */
298
299 /* ------------------------ Drawing TypeInfo -------------------------- */
300
301 /* flag-setting behaviour */
302 typedef enum eAnimChannels_SetFlag {
303         ACHANNEL_SETFLAG_CLEAR = 0,
304         ACHANNEL_SETFLAG_ADD,
305         ACHANNEL_SETFLAG_TOGGLE
306 } eAnimChannels_SetFlag;
307
308 /* types of settings for AnimChanels */
309 typedef enum eAnimChannel_Settings {
310         ACHANNEL_SETTING_SELECT = 0,
311         ACHANNEL_SETTING_PROTECT,                       // warning: for drawing UI's, need to check if this is off (maybe inverse this later)
312         ACHANNEL_SETTING_MUTE,
313         ACHANNEL_SETTING_EXPAND,
314         ACHANNEL_SETTING_VISIBLE,                       /* only for Graph Editor */
315         ACHANNEL_SETTING_SOLO,                          /* only for NLA Tracks */
316 } eAnimChannel_Settings;
317
318
319 /* Drawing, mouse handling, and flag setting behaviour... */
320 typedef struct bAnimChannelType {
321         /* drawing */
322                 /* draw backdrop strip for channel */
323         void (*draw_backdrop)(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
324                 /* get depth of indention (relative to the depth channel is nested at) */
325         short (*get_indent_level)(bAnimContext *ac, bAnimListElem *ale);
326                 /* get offset in pixels for the start of the channel (in addition to the indent depth) */
327         short (*get_offset)(bAnimContext *ac, bAnimListElem *ale);
328         
329         
330         /* get name (for channel lists) */
331         void (*name)(bAnimListElem *ale, char *name);
332         /* get icon (for channel lists) */
333         int (*icon)(bAnimListElem *ale);
334         
335         /* settings */
336                 /* check if the given setting is valid in the current context */
337         short (*has_setting)(bAnimContext *ac, bAnimListElem *ale, int setting);
338                 /* get the flag used for this setting */
339         int (*setting_flag)(int setting, short *neg);
340                 /* get the pointer to int/short where data is stored, 
341                  * with type being  sizeof(ptr_data) which should be fine for runtime use...
342                  *      - assume that setting has been checked to be valid for current context
343                  */
344         void *(*setting_ptr)(bAnimListElem *ale, int setting, short *type);
345 } bAnimChannelType;
346
347 /* ------------------------ Drawing API -------------------------- */
348
349 /* Get typeinfo for the given channel */
350 bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
351
352 /* Draw the given channel */
353 void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
354 /* Draw the widgets for the given channel */
355 void ANIM_channel_draw_widgets(bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc);
356
357
358 /* ------------------------ Editing API -------------------------- */
359
360 /* Check if some setting for a channel is enabled 
361  * Returns: 1 = On, 0 = Off, -1 = Invalid
362  *
363  *      - setting: eAnimChannel_Settings
364  */
365 short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, int setting);
366
367 /* Change value of some setting for a channel 
368  *      - setting: eAnimChannel_Settings
369  *      - mode: eAnimChannels_SetFlag
370  */
371 void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, short mode);
372
373
374 /* Deselect all animation channels */
375 void ANIM_deselect_anim_channels(void *data, short datatype, short test, short sel);
376
377 /* Set the 'active' channel of type channel_type, in the given action */
378 void ANIM_set_active_channel(bAnimContext *ac, void *data, short datatype, int filter, void *channel_data, short channel_type);
379
380 /* ************************************************ */
381 /* DRAWING API */
382 /* anim_draw.c */
383
384 /* ---------- Current Frame Drawing ---------------- */
385
386 /* flags for Current Frame Drawing */
387 enum {
388                 /* plain time indicator with no special indicators */
389         DRAWCFRA_PLAIN                  = 0,
390                 /* draw box indicating current frame number */
391         DRAWCFRA_SHOW_NUMBOX    = (1<<0),
392                 /* time indication in seconds or frames */
393         DRAWCFRA_UNIT_SECONDS   = (1<<1),
394                 /* show time-offset line */
395         DRAWCFRA_SHOW_TIMEOFS   = (1<<2),
396 } eAnimEditDraw_CurrentFrame; 
397
398 /* main call to draw current-frame indicator in an Animation Editor */
399 void ANIM_draw_cfra(const struct bContext *C, struct View2D *v2d, short flag);
400
401 /* ------------- Preview Range Drawing -------------- */
402
403 /* main call to draw preview range curtains */
404 void ANIM_draw_previewrange(const struct bContext *C, struct View2D *v2d);
405
406 /* ------------- Preview Range Drawing -------------- */
407
408 /* standard header buttons for Animation Editors */
409 short ANIM_headerUI_standard_buttons(const struct bContext *C, struct bDopeSheet *ads, struct uiBlock *block, short xco, short yco);
410
411 /* ************************************************* */
412 /* F-MODIFIER TOOLS */
413
414 /* draw a given F-Modifier for some layout/UI-Block */
415 void ANIM_uiTemplate_fmodifier_draw(struct uiLayout *layout, struct ID *id, ListBase *modifiers, struct FModifier *fcm);
416
417 /* ************************************************* */
418 /* ASSORTED TOOLS */
419
420 /* ------------ Animation F-Curves <-> Icons/Names Mapping ------------ */
421 /* anim_ipo_utils.c */
422
423 /* Get icon for type of setting F-Curve is for */
424 // XXX include this in the getname() method via RNA?
425 int geticon_anim_blocktype(short blocktype);
426
427 /* Get name for channel-list displays for F-Curve */
428 void getname_anim_fcurve(char *name, struct ID *id, struct FCurve *fcu);
429
430 /* Automatically determine a color for the nth F-Curve */
431 void ipo_rainbow(int cur, int tot, float *out);
432
433 /* ------------- NLA-Mapping ----------------------- */
434 /* anim_draw.c */
435
436 /* Obtain the AnimData block providing NLA-scaling for the given channel if applicable */
437 struct AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale);
438
439 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve */
440 void ANIM_nla_mapping_apply_fcurve(struct AnimData *adt, struct FCurve *fcu, short restore, short only_keys);
441
442 /* ..... */
443
444 /* Perform auto-blending/extend refreshes after some operations */
445 // NOTE: defined in space_nla/nla_edit.c, not in animation/
446 void ED_nla_postop_refresh(bAnimContext *ac);
447
448 /* ------------- Utility macros ----------------------- */
449
450 /* provide access to Keyframe Type info in BezTriple
451  * NOTE: this is so that we can change it from being stored in 'hide'
452  */
453 #define BEZKEYTYPE(bezt) ((bezt)->hide)
454
455 /* set/clear/toggle macro 
456  *      - channel - channel with a 'flag' member that we're setting
457  *      - smode - 0=clear, 1=set, 2=toggle
458  *      - sflag - bitflag to set
459  */
460 #define ACHANNEL_SET_FLAG(channel, smode, sflag) \
461         { \
462                 if (smode == ACHANNEL_SETFLAG_TOGGLE)   (channel)->flag ^= (sflag); \
463                 else if (smode == ACHANNEL_SETFLAG_ADD) (channel)->flag |= (sflag); \
464                 else                                                                    (channel)->flag &= ~(sflag); \
465         }
466         
467 /* set/clear/toggle macro, where the flag is negative 
468  *      - channel - channel with a 'flag' member that we're setting
469  *      - smode - 0=clear, 1=set, 2=toggle
470  *      - sflag - bitflag to set
471  */
472 #define ACHANNEL_SET_FLAG_NEG(channel, smode, sflag) \
473         { \
474                 if (smode == ACHANNEL_SETFLAG_TOGGLE)   (channel)->flag ^= (sflag); \
475                 else if (smode == ACHANNEL_SETFLAG_ADD) (channel)->flag &= ~(sflag); \
476                 else                                                                    (channel)->flag |= (sflag); \
477         }
478
479
480 /* --------- anim_deps.c, animation updates -------- */
481
482         /* generic update flush, does tagged objects only, reads from Context screen (layers) and scene */
483 void ED_anim_dag_flush_update(const struct bContext *C);
484         /* only flush object */
485 void ED_anim_object_flush_update(const struct bContext *C, struct Object *ob);
486
487 /* pose <-> action syncing */
488 void ANIM_action_to_pose_sync(struct Object *ob);
489 void ANIM_pose_to_action_sync(struct Object *ob, struct ScrArea *sa);
490
491 /* ************************************************* */
492 /* OPERATORS */
493         
494         /* generic animation channels */
495 void ED_operatortypes_animchannels(void);
496 void ED_keymap_animchannels(struct wmKeyConfig *keyconf);
497
498         /* generic time editing */
499 void ED_operatortypes_anim(void);
500 void ED_keymap_anim(struct wmKeyConfig *keyconf);
501
502 /* ************************************************ */
503
504 #endif /* ED_ANIM_API_H */
505