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