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