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