soc-2008-mxcurioni: merged changes to revision 23516
[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 wmWindowManager;
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_SCENE,
126         ANIMTYPE_OBJECT,
127         ANIMTYPE_GROUP,
128         ANIMTYPE_FCURVE,
129         
130         ANIMTYPE_FILLACTD,
131         ANIMTYPE_FILLDRIVERS,
132         ANIMTYPE_FILLMATD,
133         ANIMTYPE_FILLPARTD,
134         
135         ANIMTYPE_DSMAT,
136         ANIMTYPE_DSLAM,
137         ANIMTYPE_DSCAM,
138         ANIMTYPE_DSCUR,
139         ANIMTYPE_DSSKEY,
140         ANIMTYPE_DSWOR,
141         ANIMTYPE_DSPART,
142         ANIMTYPE_DSMBALL,
143         ANIMTYPE_DSARM,
144         
145         ANIMTYPE_SHAPEKEY,              // XXX probably can become depreceated???
146         
147         ANIMTYPE_GPDATABLOCK,
148         ANIMTYPE_GPLAYER,
149         
150         ANIMTYPE_NLATRACK,
151         ANIMTYPE_NLAACTION,
152         
153                 /* always as last item, the total number of channel types... */
154         ANIMTYPE_NUM_TYPES,
155 } eAnim_ChannelType;
156
157 /* types of keyframe data in bAnimListElem */
158 typedef enum eAnim_KeyType {
159         ALE_NONE = 0,           /* no keyframe data */
160         ALE_FCURVE,                     /* F-Curve */
161         ALE_GPFRAME,            /* Grease Pencil Frames */
162         ALE_NLASTRIP,           /* NLA Strips */
163         
164         ALE_SCE,                        /* Scene summary */
165         ALE_OB,                         /* Object summary */
166         ALE_ACT,                        /* Action summary */
167         ALE_GROUP,                      /* Action Group summary */
168 } eAnim_KeyType;
169
170 /* ----------------- Filtering -------------------- */
171
172 /* filtering flags  - under what circumstances should a channel be added */
173 // XXX was ACTFILTER_*
174 typedef enum eAnimFilter_Flags {
175         ANIMFILTER_VISIBLE              = (1<<0),       /* should channels be visible (in terms of hierarchy only) */
176         ANIMFILTER_SEL                  = (1<<1),       /* should channels be selected */
177         ANIMFILTER_UNSEL                = (1<<2),       /* should channels be NOT selected */
178         ANIMFILTER_FOREDIT              = (1<<3),       /* does editable status matter */
179         ANIMFILTER_CURVESONLY   = (1<<4),       /* don't include summary-channels, etc. */
180         ANIMFILTER_CHANNELS             = (1<<5),       /* make list for interface drawing */
181         ANIMFILTER_ACTGROUPED   = (1<<6),       /* belongs to the active actiongroup */
182         ANIMFILTER_CURVEVISIBLE = (1<<7),       /* F-Curve is visible for editing/viewing in Graph Editor */
183         ANIMFILTER_ACTIVE               = (1<<8),       /* channel should be 'active' */
184         ANIMFILTER_ANIMDATA             = (1<<9),       /* only return the underlying AnimData blocks (not the tracks, etc.) data comes from */
185         ANIMFILTER_NLATRACKS    = (1<<10),      /* only include NLA-tracks */
186         ANIMFILTER_SELEDIT              = (1<<11),      /* link editability with selected status */
187 } eAnimFilter_Flags;
188
189
190 /* ---------- Flag Checking Macros ------------ */
191 // xxx check on all of these flags again...
192
193 /* Dopesheet only */
194         /* 'Scene' channels */
195 #define SEL_SCEC(sce) ((sce->flag & SCE_DS_SELECTED))
196 #define EXPANDED_SCEC(sce) ((sce->flag & SCE_DS_COLLAPSED)==0)
197         /* 'Sub-Scene' channels (flags stored in Data block) */
198 #define FILTER_WOR_SCED(wo) ((wo->flag & WO_DS_EXPAND))
199         /* 'Object' channels */
200 #define SEL_OBJC(base) ((base->flag & SELECT))
201 #define EXPANDED_OBJC(ob) ((ob->nlaflag & OB_ADS_COLLAPSED)==0)
202         /* 'Sub-object' channels (flags stored in Object block) */
203 #define FILTER_MAT_OBJC(ob) ((ob->nlaflag & OB_ADS_SHOWMATS))
204 #define FILTER_PART_OBJC(ob) ((ob->nlaflag & OB_ADS_SHOWPARTS))
205         /* 'Sub-object' channels (flags stored in Data block) */
206 #define FILTER_SKE_OBJD(key) ((key->flag & KEYBLOCK_DS_EXPAND))
207 #define FILTER_MAT_OBJD(ma) ((ma->flag & MA_DS_EXPAND))
208 #define FILTER_LAM_OBJD(la) ((la->flag & LA_DS_EXPAND))
209 #define FILTER_CAM_OBJD(ca) ((ca->flag & CAM_DS_EXPAND))
210 #define FILTER_CUR_OBJD(cu) ((cu->flag & CU_DS_EXPAND))
211 #define FILTER_PART_OBJD(part) ((part->flag & PART_DS_EXPAND))
212 #define FILTER_MBALL_OBJD(mb) ((mb->flag2 & MB_DS_EXPAND))
213 #define FILTER_ARM_OBJD(arm) ((arm->flag & ARM_DS_EXPAND))
214         /* 'Sub-object/Action' channels (flags stored in Action) */
215 #define SEL_ACTC(actc) ((actc->flag & ACT_SELECTED))
216 #define EXPANDED_ACTC(actc) ((actc->flag & ACT_COLLAPSED)==0)
217         /* 'Sub-AnimData' chanenls */
218 #define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED)==0)
219
220 /* Actions (also used for Dopesheet) */
221         /* Action Channel Group */
222 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED)==0)
223 #define EXPANDED_AGRP(agrp) (agrp->flag & AGRP_EXPANDED)
224 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
225         /* F-Curve Channels */
226 #define EDITABLE_FCU(fcu) ((fcu->flag & FCURVE_PROTECTED)==0)
227 #define SEL_FCU(fcu) (fcu->flag & (FCURVE_ACTIVE|FCURVE_SELECTED))
228
229 /* Grease Pencil only */
230         /* Grease Pencil datablock settings */
231 #define EXPANDED_GPD(gpd) (gpd->flag & GP_DATA_EXPAND) 
232         /* Grease Pencil Layer settings */
233 #define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED)==0)
234 #define SEL_GPL(gpl) ((gpl->flag & GP_LAYER_ACTIVE) || (gpl->flag & GP_LAYER_SELECT))
235
236 /* NLA only */
237 #define SEL_NLT(nlt) (nlt->flag & NLATRACK_SELECTED)
238 #define EDITABLE_NLT(nlt) ((nlt->flag & NLATRACK_PROTECTED)==0)
239
240 /* -------------- Channel Defines -------------- */
241
242 /* channel heights */
243 #define ACHANNEL_FIRST                  -16
244 #define ACHANNEL_HEIGHT                 16
245 #define ACHANNEL_HEIGHT_HALF    8
246 #define ACHANNEL_SKIP                   2
247 #define ACHANNEL_STEP                   (ACHANNEL_HEIGHT + ACHANNEL_SKIP)
248
249 /* channel widths */
250 #define ACHANNEL_NAMEWIDTH              200
251
252 /* channel toggle-buttons */
253 #define ACHANNEL_BUTTON_WIDTH   16
254
255
256 /* -------------- NLA Channel Defines -------------- */
257
258 /* NLA channel heights */
259 #define NLACHANNEL_FIRST                        -16
260 #define NLACHANNEL_HEIGHT                       24
261 #define NLACHANNEL_HEIGHT_HALF  12
262 #define NLACHANNEL_SKIP                 2
263 #define NLACHANNEL_STEP                 (NLACHANNEL_HEIGHT + NLACHANNEL_SKIP)
264
265 /* channel widths */
266 #define NLACHANNEL_NAMEWIDTH            200
267
268 /* channel toggle-buttons */
269 #define NLACHANNEL_BUTTON_WIDTH 16
270
271 /* ---------------- API  -------------------- */
272
273 /* Obtain list of filtered Animation channels to operate on.
274  * Returns the number of channels in the list
275  */
276 int ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype);
277
278 /* Obtain current anim-data context from Blender Context info.
279  * Returns whether the operation was successful. 
280  */
281 short ANIM_animdata_get_context(const struct bContext *C, bAnimContext *ac);
282
283 /* Obtain current anim-data context (from Animation Editor) given 
284  * that Blender Context info has already been set. 
285  * Returns whether the operation was successful.
286  */
287 short ANIM_animdata_context_getdata(bAnimContext *ac);
288
289 /* ************************************************ */
290 /* ANIMATION CHANNELS LIST */
291 /* anim_channels_*.c */
292
293 /* ------------------------ Drawing TypeInfo -------------------------- */
294
295 /* flag-setting behaviour */
296 typedef enum eAnimChannels_SetFlag {
297         ACHANNEL_SETFLAG_CLEAR = 0,
298         ACHANNEL_SETFLAG_ADD,
299         ACHANNEL_SETFLAG_TOGGLE
300 } eAnimChannels_SetFlag;
301
302 /* types of settings for AnimChanels */
303 typedef enum eAnimChannel_Settings {
304         ACHANNEL_SETTING_SELECT = 0,
305         ACHANNEL_SETTING_PROTECT,                       // warning: for drawing UI's, need to check if this is off (maybe inverse this later)
306         ACHANNEL_SETTING_MUTE,
307         ACHANNEL_SETTING_EXPAND,
308         ACHANNEL_SETTING_VISIBLE,                       /* only for Graph Editor */
309         ACHANNEL_SETTING_SOLO,                          /* only for NLA Tracks */
310 } eAnimChannel_Settings;
311
312
313 /* Drawing, mouse handling, and flag setting behaviour... */
314 typedef struct bAnimChannelType {
315         /* drawing */
316                 /* draw backdrop strip for channel */
317         void (*draw_backdrop)(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
318                 /* get depth of indention (relative to the depth channel is nested at) */
319         short (*get_indent_level)(bAnimContext *ac, bAnimListElem *ale);
320                 /* get offset in pixels for the start of the channel (in addition to the indent depth) */
321         short (*get_offset)(bAnimContext *ac, bAnimListElem *ale);
322         
323         
324         /* get name (for channel lists) */
325         void (*name)(bAnimListElem *ale, char *name);
326         /* get icon (for channel lists) */
327         int (*icon)(bAnimListElem *ale);
328         
329         /* settings */
330                 /* check if the given setting is valid in the current context */
331         short (*has_setting)(bAnimContext *ac, bAnimListElem *ale, int setting);
332                 /* get the flag used for this setting */
333         int (*setting_flag)(int setting, short *neg);
334                 /* get the pointer to int/short where data is stored, 
335                  * with type being  sizeof(ptr_data) which should be fine for runtime use...
336                  *      - assume that setting has been checked to be valid for current context
337                  */
338         void *(*setting_ptr)(bAnimListElem *ale, int setting, short *type);
339 } bAnimChannelType;
340
341 /* ------------------------ Drawing API -------------------------- */
342
343 /* Get typeinfo for the given channel */
344 bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
345
346 /* Draw the given channel */
347 void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
348 /* Draw the widgets for the given channel */
349 void ANIM_channel_draw_widgets(bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc);
350
351
352 /* ------------------------ Editing API -------------------------- */
353
354 /* Check if some setting for a channel is enabled 
355  * Returns: 1 = On, 0 = Off, -1 = Invalid
356  *
357  *      - setting: eAnimChannel_Settings
358  */
359 short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, int setting);
360
361 /* Change value of some setting for a channel 
362  *      - setting: eAnimChannel_Settings
363  *      - mode: eAnimChannels_SetFlag
364  */
365 void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, short mode);
366
367
368 /* Deselect all animation channels */
369 void ANIM_deselect_anim_channels(void *data, short datatype, short test, short sel);
370
371 /* Set the 'active' channel of type channel_type, in the given action */
372 void ANIM_set_active_channel(bAnimContext *ac, void *data, short datatype, int filter, void *channel_data, short channel_type);
373
374 /* ************************************************ */
375 /* DRAWING API */
376 /* anim_draw.c */
377
378 /* ---------- Current Frame Drawing ---------------- */
379
380 /* flags for Current Frame Drawing */
381 enum {
382                 /* plain time indicator with no special indicators */
383         DRAWCFRA_PLAIN                  = 0,
384                 /* draw box indicating current frame number */
385         DRAWCFRA_SHOW_NUMBOX    = (1<<0),
386                 /* time indication in seconds or frames */
387         DRAWCFRA_UNIT_SECONDS   = (1<<1),
388                 /* show time-offset line */
389         DRAWCFRA_SHOW_TIMEOFS   = (1<<2),
390 } eAnimEditDraw_CurrentFrame; 
391
392 /* main call to draw current-frame indicator in an Animation Editor */
393 void ANIM_draw_cfra(const struct bContext *C, struct View2D *v2d, short flag);
394
395 /* ------------- Preview Range Drawing -------------- */
396
397 /* main call to draw preview range curtains */
398 void ANIM_draw_previewrange(const struct bContext *C, struct View2D *v2d);
399
400 /* ------------- Preview Range Drawing -------------- */
401
402 /* standard header buttons for Animation Editors */
403 short ANIM_headerUI_standard_buttons(const struct bContext *C, struct bDopeSheet *ads, struct uiBlock *block, short xco, short yco);
404
405 /* ************************************************* */
406 /* F-MODIFIER TOOLS */
407
408 /* draw a given F-Modifier for some layout/UI-Block */
409 void ANIM_uiTemplate_fmodifier_draw(struct uiLayout *layout, struct ID *id, ListBase *modifiers, struct FModifier *fcm);
410
411 /* ************************************************* */
412 /* ASSORTED TOOLS */
413
414 /* ------------ Animation F-Curves <-> Icons/Names Mapping ------------ */
415 /* anim_ipo_utils.c */
416
417 /* Get icon for type of setting F-Curve is for */
418 // XXX include this in the getname() method via RNA?
419 int geticon_anim_blocktype(short blocktype);
420
421 /* Get name for channel-list displays for F-Curve */
422 void getname_anim_fcurve(char *name, struct ID *id, struct FCurve *fcu);
423
424 /* Automatically determine a color for the nth F-Curve */
425 void ipo_rainbow(int cur, int tot, float *out);
426
427 /* ------------- NLA-Mapping ----------------------- */
428 /* anim_draw.c */
429
430 /* Obtain the AnimData block providing NLA-scaling for the given channel if applicable */
431 struct AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale);
432
433 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve */
434 void ANIM_nla_mapping_apply_fcurve(struct AnimData *adt, struct FCurve *fcu, short restore, short only_keys);
435
436 /* ..... */
437
438 /* Perform auto-blending/extend refreshes after some operations */
439 // NOTE: defined in space_nla/nla_edit.c, not in animation/
440 void ED_nla_postop_refresh(bAnimContext *ac);
441
442 /* ------------- Utility macros ----------------------- */
443
444 /* provide access to Keyframe Type info in BezTriple
445  * NOTE: this is so that we can change it from being stored in 'hide'
446  */
447 #define BEZKEYTYPE(bezt) ((bezt)->hide)
448
449 /* set/clear/toggle macro 
450  *      - channel - channel with a 'flag' member that we're setting
451  *      - smode - 0=clear, 1=set, 2=toggle
452  *      - sflag - bitflag to set
453  */
454 #define ACHANNEL_SET_FLAG(channel, smode, sflag) \
455         { \
456                 if (smode == ACHANNEL_SETFLAG_TOGGLE)   (channel)->flag ^= (sflag); \
457                 else if (smode == ACHANNEL_SETFLAG_ADD) (channel)->flag |= (sflag); \
458                 else                                                                    (channel)->flag &= ~(sflag); \
459         }
460         
461 /* set/clear/toggle macro, where the flag is negative 
462  *      - channel - channel with a 'flag' member that we're setting
463  *      - smode - 0=clear, 1=set, 2=toggle
464  *      - sflag - bitflag to set
465  */
466 #define ACHANNEL_SET_FLAG_NEG(channel, smode, sflag) \
467         { \
468                 if (smode == ACHANNEL_SETFLAG_TOGGLE)   (channel)->flag ^= (sflag); \
469                 else if (smode == ACHANNEL_SETFLAG_ADD) (channel)->flag &= ~(sflag); \
470                 else                                                                    (channel)->flag |= (sflag); \
471         }
472
473
474 /* --------- anim_deps.c, animation updates -------- */
475
476         /* generic update flush, does tagged objects only, reads from Context screen (layers) and scene */
477 void ED_anim_dag_flush_update(const struct bContext *C);
478         /* only flush object */
479 void ED_anim_object_flush_update(const struct bContext *C, struct Object *ob);
480
481 /* pose <-> action syncing */
482 void ANIM_action_to_pose_sync(struct Object *ob);
483 void ANIM_pose_to_action_sync(struct Object *ob, struct ScrArea *sa);
484
485 /* ************************************************* */
486 /* OPERATORS */
487         
488         /* generic animation channels */
489 void ED_operatortypes_animchannels(void);
490 void ED_keymap_animchannels(struct wmWindowManager *wm);
491
492         /* generic time editing */
493 void ED_operatortypes_anim(void);
494 void ED_keymap_anim(struct wmWindowManager *wm);
495
496 /* ************************************************ */
497
498 #endif /* ED_ANIM_API_H */
499