a820e59779f6cb51461628b253b5fbc36a4287b9
[blender.git] / source / blender / makesdna / DNA_action_types.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Original design: Reevan McKay
22  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
23  * Contributor(s): Animation recode, Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_action_types.h
29  *  \ingroup DNA
30  */
31
32
33 #ifndef DNA_ACTION_TYPES_H
34 #define DNA_ACTION_TYPES_H
35
36 #include "DNA_listBase.h"
37 #include "DNA_ID.h"
38 #include "DNA_view2d_types.h"
39 #include "DNA_userdef_types.h" /* ThemeWireColor */
40
41 struct SpaceLink;
42 struct Object;
43 struct Group;
44 struct GHash;
45
46 /* ************************************************ */
47 /* Visualisation */
48
49 /* Motion Paths ------------------------------------ */
50 /* (used for Pose Channels and Objects) */
51
52 /* Data point for motion path (mpv) */
53 typedef struct bMotionPathVert {
54         float co[3];                            /* coordinates of point in 3D-space */
55         int flag;                                       /* quick settings */
56 } bMotionPathVert;
57
58 /* bMotionPathVert->flag */
59 typedef enum eMotionPathVert_Flag {
60                 /* vert is selected */
61         MOTIONPATH_VERT_SEL             = (1<<0)
62 } eMotionPathVert_Flag;
63
64 /* ........ */
65
66 /* Motion Path data cache (mpath)
67  *      - for elements providing transforms (i.e. Objects or PoseChannels) 
68  */
69 typedef struct bMotionPath {
70         bMotionPathVert *points;        /* path samples */
71         int     length;                                 /* the number of cached verts */
72         
73         int start_frame;                        /* for drawing paths, the start frame number */
74         int     end_frame;                              /* for drawing paths, the end frame number */
75         
76         int flag;                                       /* baking settings - eMotionPath_Flag */ 
77 } bMotionPath;
78
79 /* bMotionPath->flag */
80 typedef enum eMotionPath_Flag {
81                 /* (for bones) path represents the head of the bone */
82         MOTIONPATH_FLAG_BHEAD           = (1<<0),
83                 /* motion path is being edited */
84         MOTIONPATH_FLAG_EDIT            = (1<<1)
85 } eMotionPath_Flag;
86
87 /* Visualisation General --------------------------- */
88 /* for Objects or Poses (but NOT PoseChannels) */
89
90 /* Animation Visualisation Settings (avs) */
91 typedef struct bAnimVizSettings {
92         /* Onion-Skinning Settings ----------------- */
93         int     ghost_sf, ghost_ef;                     /* start and end frames of ghost-drawing range (only used for GHOST_TYPE_RANGE) */
94         int ghost_bc, ghost_ac;                 /* number of frames before/after current frame to show */
95         
96         short ghost_type;                               /* eOnionSkin_Types */
97         short ghost_step;                               /* number of frames between each ghost shown (not for GHOST_TYPE_KEYS) */
98         
99         short ghost_flag;                               /* eOnionSkin_Flag */
100         
101         /* General Settings ------------------------ */
102         short recalc;                                   /* eAnimViz_RecalcFlags */
103         
104         /* Motion Path Settings ------------------- */
105         short path_type;                                /* eMotionPath_Types */
106         short path_step;                                /* number of frames between points indicated on the paths */
107         
108         short path_viewflag;                    /* eMotionPaths_ViewFlag */
109         short path_bakeflag;                    /* eMotionPaths_BakeFlag */
110         
111         int path_sf, path_ef;                   /* start and end frames of path-calculation range */
112         int     path_bc, path_ac;                       /* number of frames before/after current frame to show */
113 } bAnimVizSettings;
114
115
116 /* bAnimVizSettings->recalc */
117 typedef enum eAnimViz_RecalcFlags {
118                 /* motionpaths need recalculating */
119         ANIMVIZ_RECALC_PATHS    = (1<<0)
120 } eAnimViz_RecalcFlags;
121
122
123 /* bAnimVizSettings->ghost_type */
124 typedef enum eOnionSkin_Types {
125                 /* no ghosts at all */
126         GHOST_TYPE_NONE = 0,
127                 /* around current frame */
128         GHOST_TYPE_ACFRA,
129                 /* show ghosts within the specified frame range */
130         GHOST_TYPE_RANGE,
131                 /* show ghosts on keyframes within the specified range only */
132         GHOST_TYPE_KEYS
133 } eOnionSkin_Types;
134
135 /* bAnimVizSettings->ghost_flag */
136 typedef enum eOnionSkin_Flag {
137                 /* only show selected bones in ghosts */
138         GHOST_FLAG_ONLYSEL      = (1<<0)
139 } eOnionSkin_Flag;
140
141
142 /* bAnimVizSettings->path_type */
143 typedef enum eMotionPaths_Types {
144                 /* show the paths along their entire ranges */
145         MOTIONPATH_TYPE_RANGE = 0,
146                 /* only show the parts of the paths around the current frame */
147         MOTIONPATH_TYPE_ACFRA
148 } eMotionPath_Types;
149
150 /* bAnimVizSettings->path_viewflag */
151 typedef enum eMotionPaths_ViewFlag {
152                 /* show frames on path */
153         MOTIONPATH_VIEW_FNUMS           = (1<<0),
154                 /* show keyframes on path */
155         MOTIONPATH_VIEW_KFRAS           = (1<<1),
156                 /* show keyframe/frame numbers */
157         MOTIONPATH_VIEW_KFNOS           = (1<<2),
158                 /* find keyframes in whole action (instead of just in matching group name) */
159         MOTIONPATH_VIEW_KFACT           = (1<<3)
160 } eMotionPath_ViewFlag;
161
162 /* bAnimVizSettings->path_bakeflag */
163 typedef enum eMotionPaths_BakeFlag {
164                 /* motion paths directly associated with this block of settings needs updating */
165         MOTIONPATH_BAKE_NEEDS_RECALC    = (1<<0),
166                 /* for bones - calculate head-points for curves instead of tips */
167         MOTIONPATH_BAKE_HEADS                   = (1<<1),
168                 /* motion paths exist for AnimVizSettings instance - set when calc for first time, and unset when clearing */
169         MOTIONPATH_BAKE_HAS_PATHS               = (1<<2)
170 } eMotionPath_BakeFlag;
171
172 /* ************************************************ */
173 /* Poses */
174
175 /* PoseChannel ------------------------------------ */
176
177 /* PoseChannel 
178  *
179  * A PoseChannel stores the results of Actions and transform information 
180  * with respect to the restposition of Armature bones 
181  */
182 typedef struct bPoseChannel {
183         struct bPoseChannel     *next, *prev;
184         
185         IDProperty                      *prop;          /* User-Defined Properties on this PoseChannel */                       
186         
187         ListBase                        constraints;/* Constraints that act on this PoseChannel */
188         char                            name[32];       /* Channels need longer names than normal blender objects */
189         
190         short                           flag;           /* dynamic, for detecting transform changes */
191         short                           constflag;  /* for quick detecting which constraints affect this channel */
192         short                           ikflag;         /* settings for IK bones */
193         short               selectflag; /* copy of bone flag, so you can work with library armatures, not for runtime use */
194         short                           protectflag; /* protect channels from being transformed */
195         short                           agrp_index; /* index of action-group this bone belongs to (0 = default/no group) */
196         
197 // XXX depreceated.... old animation system (armature only viz) ----
198         int                                 pathlen;    /* for drawing paths, the amount of frames */
199         int                             pathsf;         /* for drawing paths, the start frame number */
200         int                                     pathef;         /* for drawing paths, the end frame number */
201 // XXX end of depreceated code -------------------------------------
202         
203         struct Bone                     *bone;          /* set on read file or rebuild pose */
204         struct bPoseChannel *parent;    /* set on read file or rebuild pose */
205         struct bPoseChannel *child;             /* set on read file or rebuild pose, the 'ik' child, for b-bones */
206         struct ListBase          iktree;                /* only while evaluating pose */
207         
208         bMotionPath *mpath;                             /* motion path cache for this bone */
209         struct Object *custom;                  /* draws custom object instead of default bone shape */
210         struct bPoseChannel *custom_tx; /* odd feature, display with another bones transform. needed in rare cases for advanced rigs, since the alternative is highly complicated - campbell */
211
212                 /* transforms - written in by actions or transform */
213         float           loc[3];                         
214         float           size[3];
215         
216                 /* rotations - written in by actions or transform (but only one representation gets used at any time) */
217         float           eul[3];                                 /* euler rotation */
218         float           quat[4];                                /* quaternion rotation */
219         float           rotAxis[3], rotAngle;   /* axis-angle rotation */
220         short           rotmode;                                /* eRotationModes - rotation representation to use */
221         short           pad;
222         
223         float           chan_mat[4][4];         /* matrix result of loc/quat/size , and where we put deform in, see next line */
224         float           pose_mat[4][4];         /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat */
225         float           constinv[4][4];         /* inverse result of constraints. doesn't include effect of restposition, parent, and local transform*/
226         
227         float           pose_head[3];           /* actually pose_mat[3] */
228         float           pose_tail[3];           /* also used for drawing help lines... */
229         
230         float           limitmin[3], limitmax[3];       /* DOF constraint */
231         float           stiffness[3];                           /* DOF stiffness */
232         float           ikstretch;
233         float           ikrotweight;            /* weight of joint rotation constraint */
234         float           iklinweight;            /* weight of joint stretch constraint */
235
236         float           *path;                          /* totpath x 3 x float */               // XXX depreceated... old animation system (armature only viz)
237 } bPoseChannel;
238
239
240 /* PoseChannel (transform) flags */
241 typedef enum ePchan_Flag {
242                 /* has transforms */
243         POSE_LOC                =       (1<<0),
244         POSE_ROT                =       (1<<1),
245         POSE_SIZE               =       (1<<2),
246                 /* old IK/cache stuff... */
247         POSE_IK_MAT             =       (1<<3),
248         POSE_UNUSED2    =       (1<<4),
249         POSE_UNUSED3    =       (1<<5),
250         POSE_UNUSED4    =       (1<<6),
251         POSE_UNUSED5    =       (1<<7),
252                 /* has Standard IK */
253         POSE_HAS_IK             =       (1<<8),
254                 /* IK/Pose solving*/
255         POSE_CHAIN              =       (1<<9),
256         POSE_DONE               =   (1<<10),
257                 /* visualisation */
258         POSE_KEY                =       (1<<11),
259         POSE_STRIDE             =       (1<<12),
260                 /* standard IK solving */
261         POSE_IKTREE             =   (1<<13),
262                 /* has Spline IK */
263         POSE_HAS_IKS    =       (1<<14),
264                 /* spline IK solving */
265         POSE_IKSPLINE   =       (1<<15)
266 } ePchan_Flag;
267
268 /* PoseChannel constflag (constraint detection) */
269 typedef enum ePchan_ConstFlag {
270         PCHAN_HAS_IK            = (1<<0),
271         PCHAN_HAS_CONST         = (1<<1),
272                 /* only used for drawing Posemode, not stored in channel */
273         PCHAN_HAS_ACTION        = (1<<2),
274         PCHAN_HAS_TARGET        = (1<<3),
275                 /* only for drawing Posemode too */
276         PCHAN_HAS_STRIDE        = (1<<4),
277                 /* spline IK */
278         PCHAN_HAS_SPLINEIK      = (1<<5)
279 } ePchan_ConstFlag;
280
281 /* PoseChannel->ikflag */
282 typedef enum ePchan_IkFlag {
283         BONE_IK_NO_XDOF = (1<<0),
284         BONE_IK_NO_YDOF = (1<<1),
285         BONE_IK_NO_ZDOF = (1<<2),
286
287         BONE_IK_XLIMIT  = (1<<3),
288         BONE_IK_YLIMIT  = (1<<4),
289         BONE_IK_ZLIMIT  = (1<<5),
290         
291         BONE_IK_ROTCTL  = (1<<6),
292         BONE_IK_LINCTL  = (1<<7),
293
294         BONE_IK_NO_XDOF_TEMP = (1<<10),
295         BONE_IK_NO_YDOF_TEMP = (1<<11),
296         BONE_IK_NO_ZDOF_TEMP = (1<<12)
297 } ePchan_IkFlag;
298
299 /* PoseChannel->rotmode and Object->rotmode */
300 typedef enum eRotationModes {
301                 /* quaternion rotations (default, and for older Blender versions) */
302         ROT_MODE_QUAT   = 0,
303                 /* euler rotations - keep in sync with enum in BLI_math.h */
304         ROT_MODE_EUL = 1,               /* Blender 'default' (classic) - must be as 1 to sync with BLI_math_rotation.h defines */
305         ROT_MODE_XYZ = 1,
306         ROT_MODE_XZY,
307         ROT_MODE_YXZ,
308         ROT_MODE_YZX,
309         ROT_MODE_ZXY,
310         ROT_MODE_ZYX,
311         /* NOTE: space is reserved here for 18 other possible 
312          * euler rotation orders not implemented 
313          */
314                 /* axis angle rotations */
315         ROT_MODE_AXISANGLE = -1,
316
317         ROT_MODE_MIN = ROT_MODE_AXISANGLE,      /* sentinel for Py API */
318         ROT_MODE_MAX = ROT_MODE_ZYX
319 } eRotationModes;
320
321 /* Pose ------------------------------------ */
322
323 /* Pose-Object. 
324  *
325  * It is only found under ob->pose. It is not library data, even
326  * though there is a define for it (hack for the outliner).
327  */
328 typedef struct bPose {
329         ListBase chanbase;                      /* list of pose channels, PoseBones in RNA */
330         struct GHash *chanhash;         /* ghash for quicker string lookups */
331         
332         short flag, pad;
333         unsigned int proxy_layer;       /* proxy layer: copy from armature, gets synced */
334         int pad1;
335         
336         float ctime;                            /* local action time of this pose */
337         float stride_offset[3];         /* applied to object */
338         float cyclic_offset[3];         /* result of match and cycles, applied in where_is_pose() */
339         
340         
341         ListBase agroups;                       /* list of bActionGroups */
342         
343         int active_group;                       /* index of active group (starts from 1) */
344         int     iksolver;                               /* ik solver to use, see ePose_IKSolverType */
345         void *ikdata;                           /* temporary IK data, depends on the IK solver. Not saved in file */
346         void *ikparam;                          /* IK solver parameters, structure depends on iksolver */ 
347         
348         bAnimVizSettings avs;           /* settings for visualisation of bone animation */
349         char proxy_act_bone[32];           /*proxy active bone name*/
350 } bPose;
351
352
353 /* Pose->flag */
354 typedef enum ePose_Flags {
355                 /* results in armature_rebuild_pose being called */
356         POSE_RECALC = (1<<0),
357                 /* prevents any channel from getting overridden by anim from IPO */
358         POSE_LOCKED     = (1<<1),
359                 /* clears the POSE_LOCKED flag for the next time the pose is evaluated */
360         POSE_DO_UNLOCK  = (1<<2),
361                 /* pose has constraints which depend on time (used when depsgraph updates for a new frame) */
362         POSE_CONSTRAINTS_TIMEDEPEND = (1<<3),
363                 /* recalculate bone paths */
364         POSE_RECALCPATHS = (1<<4),
365                 /* set by armature_rebuild_pose to give a chance to the IK solver to rebuild IK tree */
366         POSE_WAS_REBUILT = (1<<5),
367                 /* set by game_copy_pose to indicate that this pose is used in the game engine */
368         POSE_GAME_ENGINE = (1<<6)
369 } ePose_Flags;
370
371 /* IK Solvers ------------------------------------ */
372
373 /* bPose->iksolver and bPose->ikparam->iksolver */
374 typedef enum ePose_IKSolverType {
375         IKSOLVER_LEGACY = 0,
376         IKSOLVER_ITASC
377 } ePose_IKSolverType;
378
379 /* header for all bPose->ikparam structures */
380 typedef struct bIKParam {
381         int   iksolver;
382 } bIKParam;
383
384 /* bPose->ikparam when bPose->iksolver=1 */
385 typedef struct bItasc {
386         int   iksolver;
387         float precision;
388         short numiter;
389         short numstep;
390         float minstep;
391         float maxstep;
392         short solver;   
393         short flag;
394         float feedback;
395         float maxvel;   /* max velocity to SDLS solver */
396         float dampmax;  /* maximum damping for DLS solver */
397         float dampeps;  /* threshold of singular value from which the damping start progressively */
398 } bItasc;
399
400 /* bItasc->flag */
401 typedef enum eItasc_Flags {
402         ITASC_AUTO_STEP = (1<<0),
403         ITASC_INITIAL_REITERATION = (1<<1),
404         ITASC_REITERATION = (1<<2),
405         ITASC_SIMULATION = (1<<3)
406 } eItasc_Flags;
407
408 /* bItasc->solver */
409 typedef enum eItasc_Solver {
410         ITASC_SOLVER_SDLS = 0,  /* selective damped least square, suitable for CopyPose constraint */
411         ITASC_SOLVER_DLS                /* damped least square with numerical filtering of damping */
412 } eItasc_Solver;
413
414 /* ************************************************ */
415 /* Action */
416
417 /* Groups -------------------------------------- */
418
419 /* Action-Channel Group (agrp)
420
421  * These are stored as a list per-Action, and are only used to 
422  * group that Action's channels in an Animation Editor. 
423  *
424  * Even though all FCurves live in a big list per Action, each group they are in also
425  * holds references to the achans within that list which belong to it. Care must be taken to
426  * ensure that action-groups never end up being the sole 'owner' of a channel.
427  * 
428  * This is also exploited for bone-groups. Bone-Groups are stored per bPose, and are used 
429  * primarily to color bones in the 3d-view. There are other benefits too, but those are mostly related
430  * to Action-Groups.
431  */
432 typedef struct bActionGroup {
433         struct bActionGroup *next, *prev;
434         
435         ListBase channels;                      /* Note: this must not be touched by standard listbase functions which would clear links to other channels */
436         
437         int flag;                                       /* settings for this action-group */
438         int customCol;                          /* index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set) */                          
439         char name[64];                          /* name of the group */
440         
441         ThemeWireColor cs;                      /* color set to use when customCol == -1 */
442 } bActionGroup;
443
444 /* Action Group flags */
445 typedef enum eActionGroup_Flag {
446                 /* group is selected */
447         AGRP_SELECTED   = (1<<0),
448                 /* group is 'active' / last selected one */
449         AGRP_ACTIVE     = (1<<1),
450                 /* keyframes/channels belonging to it cannot be edited */
451         AGRP_PROTECTED  = (1<<2),
452                 /* for UI (DopeSheet), sub-channels are shown */
453         AGRP_EXPANDED   = (1<<3),
454                 /* sub-channels are not evaluated */
455         AGRP_MUTED              = (1<<4),
456                 /* sub-channels are not visible in Graph Editor */
457         AGRP_NOTVISIBLE = (1<<5),
458                 /* for UI (Graph Editor), sub-channels are shown */
459         AGRP_EXPANDED_G = (1<<6),
460         
461         AGRP_TEMP               = (1<<30),
462         AGRP_MOVED              = (1<<31)
463 } eActionGroup_Flag;
464
465
466 /* Actions -------------------------------------- */
467
468 /* Action - reusable F-Curve 'bag'  (act) 
469  *
470  * This contains F-Curves that may affect settings from more than one ID blocktype and/or 
471  * datablock (i.e. sub-data linked/used directly to the ID block that the animation data is linked to), 
472  * but with the restriction that the other unrelated data (i.e. data that is not directly used or linked to
473  * by the source ID block).
474  *
475  * It serves as a 'unit' of reusable animation information (i.e. keyframes/motion data), that 
476  * affects a group of related settings (as defined by the user). 
477  */
478 typedef struct bAction {
479         ID      id;                             /* ID-serialisation for relinking */
480         
481         ListBase curves;        /* function-curves (FCurve) */
482         ListBase chanbase;      /* legacy data - Action Channels (bActionChannel) in pre-2.5 animation system */
483         ListBase groups;        /* groups of function-curves (bActionGroup) */
484         ListBase markers;       /* markers local to the Action (used to provide Pose-Libraries) */
485         
486         int flag;                       /* settings for this action */
487         int active_marker;      /* index of the active marker */
488         
489         int idroot;                     /* type of ID-blocks that action can be assigned to (if 0, will be set to whatever ID first evaluates it) */
490         int pad;
491 } bAction;
492
493
494 /* Flags for the action */
495 typedef enum eAction_Flags {
496                 /* flags for displaying in UI */
497         ACT_COLLAPSED   = (1<<0),
498         ACT_SELECTED    = (1<<1),
499         
500                 /* flags for evaluation/editing */
501         ACT_MUTED               = (1<<9),
502         ACT_PROTECTED   = (1<<10),
503         ACT_DISABLED    = (1<<11)
504 } eAction_Flags;
505
506
507 /* ************************************************ */
508 /* Action/Dopesheet Editor */
509
510 /* Storage for Dopesheet/Grease-Pencil Editor data */
511 typedef struct bDopeSheet {
512         ID              *source;                        /* currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil) */
513         ListBase chanbase;                      /* cache for channels (only initialised when pinned) */  // XXX not used!
514         
515         struct Group *filter_grp;       /* object group for ADS_FILTER_ONLYOBGROUP filtering option */
516         char searchstr[64];                     /* string to search for in displayed names of F-Curves for ADS_FILTER_BY_FCU_NAME filtering option */
517         
518         int filterflag;                         /* flags to use for filtering data */
519         int flag;                                       /* standard flags */
520         
521         int renameIndex;                        /* index+1 of channel to rename - only gets set by renaming operator */
522         int pad;
523 } bDopeSheet;
524
525
526 /* DopeSheet filter-flag */
527 typedef enum eDopeSheet_FilterFlag {
528                 /* general filtering */
529         ADS_FILTER_ONLYSEL                      = (1<<0),       /* only include channels relating to selected data */
530         
531                 /* temporary filters */
532         ADS_FILTER_ONLYDRIVERS          = (1<<1),       /* for 'Drivers' editor - only include Driver data from AnimData */
533         ADS_FILTER_ONLYNLA                      = (1<<2),       /* for 'NLA' editor - only include NLA data from AnimData */
534         ADS_FILTER_SELEDIT                      = (1<<3),       /* for Graph Editor - used to indicate whether to include a filtering flag or not */
535         
536                 /* general filtering 2 */
537         ADS_FILTER_SUMMARY                      = (1<<4),       /* for 'DopeSheet' Editors - include 'summary' line */
538         ADS_FILTER_ONLYOBGROUP          = (1<<5),       /* only the objects in the specified object group get used */
539         
540                 /* datatype-based filtering */
541         ADS_FILTER_NOSHAPEKEYS          = (1<<6),
542         ADS_FILTER_NOMESH                       = (1<<7),
543         ADS_FILTER_NOOBJ                        = (1<<8),       /* for animdata on object level, if we only want to concentrate on materials/etc. */
544         ADS_FILTER_NOLAT                        = (1<<9),
545         ADS_FILTER_NOCAM                        = (1<<10),
546         ADS_FILTER_NOMAT                        = (1<<11),
547         ADS_FILTER_NOLAM                        = (1<<12),
548         ADS_FILTER_NOCUR                        = (1<<13),
549         ADS_FILTER_NOWOR                        = (1<<14),
550         ADS_FILTER_NOSCE                        = (1<<15),
551         ADS_FILTER_NOPART                       = (1<<16),
552         ADS_FILTER_NOMBA                        = (1<<17),
553         ADS_FILTER_NOARM                        = (1<<18),
554         ADS_FILTER_NONTREE                      = (1<<19),
555         ADS_FILTER_NOTEX                        = (1<<20),
556         ADS_FILTER_NOSPK                        = (1<<21),
557         
558                 /* NLA-specific filters */
559         ADS_FILTER_NLA_NOACT            = (1<<25),      /* if the AnimData block has no NLA data, don't include to just show Action-line */
560         
561                 /* general filtering 3 */
562         ADS_FILTER_INCL_HIDDEN          = (1<<26),      /* include 'hidden' channels too (i.e. those from hidden Objects/Bones) */
563         ADS_FILTER_BY_FCU_NAME          = (1<<27),      /* for F-Curves, filter by the displayed name (i.e. to isolate all Location curves only) */
564         
565                 /* combination filters (some only used at runtime) */
566         ADS_FILTER_NOOBDATA = (ADS_FILTER_NOCAM|ADS_FILTER_NOMAT|ADS_FILTER_NOLAM|ADS_FILTER_NOCUR|ADS_FILTER_NOPART|ADS_FILTER_NOARM|ADS_FILTER_NOSPK)
567 } eDopeSheet_FilterFlag;        
568
569 /* DopeSheet general flags */
570 typedef enum eDopeSheet_Flag {
571         ADS_FLAG_SUMMARY_COLLAPSED      = (1<<0),       /* when summary is shown, it is collapsed, so all other channels get hidden */
572         ADS_FLAG_SHOW_DBFILTERS         = (1<<1)        /* show filters for datablocks */
573 } eDopeSheet_Flag;
574
575
576
577 /* Action Editor Space. This is defined here instead of in DNA_space_types.h */
578 typedef struct SpaceAction {
579         struct SpaceLink *next, *prev;
580         ListBase regionbase;            /* storage of regions for inactive spaces */
581         int spacetype;
582         float blockscale;
583
584         short blockhandler[8];
585
586         View2D v2d;                                     /* depricated, copied to region */
587         
588         bAction         *action;                /* the currently active action */
589         bDopeSheet      ads;                    /* the currently active context (when not showing action) */
590         
591         char  mode, autosnap;           /* mode: editing context; autosnap: automatic keyframe snapping mode   */
592         short flag;                             /* flag: bitmapped settings; */
593         float timeslide;                        /* for Time-Slide transform mode drawing - current frame? */
594 } SpaceAction;
595
596 /* SpaceAction flag */
597 typedef enum eSAction_Flag {
598                 /* during transform (only set for TimeSlide) */
599         SACTION_MOVING  = (1<<0),       
600                 /* show sliders */
601         SACTION_SLIDERS = (1<<1),       
602                 /* draw time in seconds instead of time in frames */
603         SACTION_DRAWTIME = (1<<2),
604                 /* don't filter action channels according to visibility */
605         //SACTION_NOHIDE = (1<<3), // XXX depreceated... old animation system
606                 /* don't kill overlapping keyframes after transform */
607         SACTION_NOTRANSKEYCULL = (1<<4),
608                 /* don't include keyframes that are out of view */
609         //SACTION_HORIZOPTIMISEON = (1<<5), // XXX depreceated... old irrelevant trick
610                 /* show pose-markers (local to action) in Action Editor mode  */
611         SACTION_POSEMARKERS_SHOW = (1<<6),
612                 /* don't draw action channels using group colors (where applicable) */
613         SACTION_NODRAWGCOLORS = (1<<7), // XXX depreceated... irrelevant for current groups implementation
614                 /* don't draw current frame number beside frame indicator */
615         SACTION_NODRAWCFRANUM = (1<<8),
616                 /* temporary flag to force channel selections to be synced with main */
617         SACTION_TEMP_NEEDCHANSYNC = (1<<9),
618                 /* don't perform realtime updates */
619         SACTION_NOREALTIMEUPDATES =     (1<<10),
620                 /* move markers as well as keyframes */
621         SACTION_MARKERS_MOVE = (1<<11)
622 } eSAction_Flag;        
623
624 /* SpaceAction Mode Settings */
625 typedef enum eAnimEdit_Context {
626                 /* action on the active object */
627         SACTCONT_ACTION = 0,
628                 /* list of all shapekeys on the active object, linked with their F-Curves */
629         SACTCONT_SHAPEKEY,
630                 /* editing of gpencil data */
631         SACTCONT_GPENCIL,
632                 /* dopesheet (default) */
633         SACTCONT_DOPESHEET
634 } eAnimEdit_Context;
635
636 /* SpaceAction AutoSnap Settings (also used by other Animation Editors) */
637 typedef enum eAnimEdit_AutoSnap {
638                 /* no auto-snap */
639         SACTSNAP_OFF = 0,       
640                 /* snap to 1.0 frame/second intervals */
641         SACTSNAP_STEP,
642                 /* snap to actual frames/seconds (nla-action time) */
643         SACTSNAP_FRAME,
644                 /* snap to nearest marker */
645         SACTSNAP_MARKER
646 } eAnimEdit_AutoSnap;
647
648
649 /* ************************************************ */
650 /* Legacy Data */
651
652 /* WARNING: Action Channels are now depreceated... they were part of the old animation system!
653  *                (ONLY USED FOR DO_VERSIONS...)
654  * 
655  * Action Channels belong to Actions. They are linked with an IPO block, and can also own 
656  * Constraint Channels in certain situations. 
657  *
658  * Action-Channels can only belong to one group at a time, but they still live the Action's
659  * list of achans (to preserve backwards compatability, and also minimise the code
660  * that would need to be recoded). Grouped achans are stored at the start of the list, according
661  * to the position of the group in the list, and their position within the group. 
662  */
663 typedef struct bActionChannel {
664         struct bActionChannel   *next, *prev;
665         bActionGroup                    *grp;                                   /* Action Group this Action Channel belongs to */
666         
667         struct Ipo                              *ipo;                                   /* IPO block this action channel references */
668         ListBase                                constraintChannels;             /* Constraint Channels (when Action Channel represents an Object or Bone) */
669         
670         int             flag;                   /* settings accessed via bitmapping */
671         char    name[32];               /* channel name */
672         int             temp;                   /* temporary setting - may be used to indicate group that channel belongs to during syncing  */
673 } bActionChannel;
674
675 /* Action Channel flags (ONLY USED FOR DO_VERSIONS...) */
676 typedef enum ACHAN_FLAG {
677         ACHAN_SELECTED  = (1<<0),
678         ACHAN_HILIGHTED = (1<<1),
679         ACHAN_HIDDEN    = (1<<2),
680         ACHAN_PROTECTED = (1<<3),
681         ACHAN_EXPANDED  = (1<<4),
682         ACHAN_SHOWIPO   = (1<<5),
683         ACHAN_SHOWCONS  = (1<<6),
684         ACHAN_MOVED     = (1<<31)
685 } ACHAN_FLAG; 
686
687 #endif