- remove deprecated pose channel members
[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                           ikflag;         /* settings for IK bones */
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         char                            constflag;  /* for quick detecting which constraints affect this channel */
195         char                selectflag; /* copy of bone flag, so you can work with library armatures, not for runtime use */
196         char                            pad0[6];
197
198         struct Bone                     *bone;          /* set on read file or rebuild pose */
199         struct bPoseChannel *parent;    /* set on read file or rebuild pose */
200         struct bPoseChannel *child;             /* set on read file or rebuild pose, the 'ik' child, for b-bones */
201         struct ListBase          iktree;                /* only while evaluating pose */
202         
203         bMotionPath *mpath;                             /* motion path cache for this bone */
204         struct Object *custom;                  /* draws custom object instead of default bone shape */
205         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 */
206
207                 /* transforms - written in by actions or transform */
208         float           loc[3];                         
209         float           size[3];
210         
211                 /* rotations - written in by actions or transform (but only one representation gets used at any time) */
212         float           eul[3];                                 /* euler rotation */
213         float           quat[4];                                /* quaternion rotation */
214         float           rotAxis[3], rotAngle;   /* axis-angle rotation */
215         short           rotmode;                                /* eRotationModes - rotation representation to use */
216         short           pad;
217         
218         float           chan_mat[4][4];         /* matrix result of loc/quat/size , and where we put deform in, see next line */
219         float           pose_mat[4][4];         /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat */
220         float           constinv[4][4];         /* inverse result of constraints. doesn't include effect of restposition, parent, and local transform*/
221         
222         float           pose_head[3];           /* actually pose_mat[3] */
223         float           pose_tail[3];           /* also used for drawing help lines... */
224         
225         float           limitmin[3], limitmax[3];       /* DOF constraint */
226         float           stiffness[3];                           /* DOF stiffness */
227         float           ikstretch;
228         float           ikrotweight;            /* weight of joint rotation constraint */
229         float           iklinweight;            /* weight of joint stretch constraint */
230
231         void            *temp;                          /* use for outliner */
232 } bPoseChannel;
233
234
235 /* PoseChannel (transform) flags */
236 typedef enum ePchan_Flag {
237                 /* has transforms */
238         POSE_LOC                =       (1<<0),
239         POSE_ROT                =       (1<<1),
240         POSE_SIZE               =       (1<<2),
241                 /* old IK/cache stuff... */
242         POSE_IK_MAT             =       (1<<3),
243         POSE_UNUSED2    =       (1<<4),
244         POSE_UNUSED3    =       (1<<5),
245         POSE_UNUSED4    =       (1<<6),
246         POSE_UNUSED5    =       (1<<7),
247                 /* has Standard IK */
248         POSE_HAS_IK             =       (1<<8),
249                 /* IK/Pose solving*/
250         POSE_CHAIN              =       (1<<9),
251         POSE_DONE               =   (1<<10),
252                 /* visualisation */
253         POSE_KEY                =       (1<<11),
254         POSE_STRIDE             =       (1<<12),
255                 /* standard IK solving */
256         POSE_IKTREE             =   (1<<13),
257                 /* has Spline IK */
258         POSE_HAS_IKS    =       (1<<14),
259                 /* spline IK solving */
260         POSE_IKSPLINE   =       (1<<15)
261 } ePchan_Flag;
262
263 /* PoseChannel constflag (constraint detection) */
264 typedef enum ePchan_ConstFlag {
265         PCHAN_HAS_IK            = (1<<0),
266         PCHAN_HAS_CONST         = (1<<1),
267                 /* only used for drawing Posemode, not stored in channel */
268         PCHAN_HAS_ACTION        = (1<<2),
269         PCHAN_HAS_TARGET        = (1<<3),
270                 /* only for drawing Posemode too */
271         PCHAN_HAS_STRIDE        = (1<<4),
272                 /* spline IK */
273         PCHAN_HAS_SPLINEIK      = (1<<5)
274 } ePchan_ConstFlag;
275
276 /* PoseChannel->ikflag */
277 typedef enum ePchan_IkFlag {
278         BONE_IK_NO_XDOF = (1<<0),
279         BONE_IK_NO_YDOF = (1<<1),
280         BONE_IK_NO_ZDOF = (1<<2),
281
282         BONE_IK_XLIMIT  = (1<<3),
283         BONE_IK_YLIMIT  = (1<<4),
284         BONE_IK_ZLIMIT  = (1<<5),
285         
286         BONE_IK_ROTCTL  = (1<<6),
287         BONE_IK_LINCTL  = (1<<7),
288
289         BONE_IK_NO_XDOF_TEMP = (1<<10),
290         BONE_IK_NO_YDOF_TEMP = (1<<11),
291         BONE_IK_NO_ZDOF_TEMP = (1<<12)
292 } ePchan_IkFlag;
293
294 /* PoseChannel->rotmode and Object->rotmode */
295 typedef enum eRotationModes {
296                 /* quaternion rotations (default, and for older Blender versions) */
297         ROT_MODE_QUAT   = 0,
298                 /* euler rotations - keep in sync with enum in BLI_math.h */
299         ROT_MODE_EUL = 1,               /* Blender 'default' (classic) - must be as 1 to sync with BLI_math_rotation.h defines */
300         ROT_MODE_XYZ = 1,
301         ROT_MODE_XZY,
302         ROT_MODE_YXZ,
303         ROT_MODE_YZX,
304         ROT_MODE_ZXY,
305         ROT_MODE_ZYX,
306         /* NOTE: space is reserved here for 18 other possible 
307          * euler rotation orders not implemented 
308          */
309                 /* axis angle rotations */
310         ROT_MODE_AXISANGLE = -1,
311
312         ROT_MODE_MIN = ROT_MODE_AXISANGLE,      /* sentinel for Py API */
313         ROT_MODE_MAX = ROT_MODE_ZYX
314 } eRotationModes;
315
316 /* Pose ------------------------------------ */
317
318 /* Pose-Object. 
319  *
320  * It is only found under ob->pose. It is not library data, even
321  * though there is a define for it (hack for the outliner).
322  */
323 typedef struct bPose {
324         ListBase chanbase;                      /* list of pose channels, PoseBones in RNA */
325         struct GHash *chanhash;         /* ghash for quicker string lookups */
326         
327         short flag, pad;
328         unsigned int proxy_layer;       /* proxy layer: copy from armature, gets synced */
329         int pad1;
330         
331         float ctime;                            /* local action time of this pose */
332         float stride_offset[3];         /* applied to object */
333         float cyclic_offset[3];         /* result of match and cycles, applied in where_is_pose() */
334         
335         
336         ListBase agroups;                       /* list of bActionGroups */
337         
338         int active_group;                       /* index of active group (starts from 1) */
339         int     iksolver;                               /* ik solver to use, see ePose_IKSolverType */
340         void *ikdata;                           /* temporary IK data, depends on the IK solver. Not saved in file */
341         void *ikparam;                          /* IK solver parameters, structure depends on iksolver */ 
342         
343         bAnimVizSettings avs;           /* settings for visualisation of bone animation */
344         char proxy_act_bone[32];           /*proxy active bone name*/
345 } bPose;
346
347
348 /* Pose->flag */
349 typedef enum ePose_Flags {
350                 /* results in armature_rebuild_pose being called */
351         POSE_RECALC = (1<<0),
352                 /* prevents any channel from getting overridden by anim from IPO */
353         POSE_LOCKED     = (1<<1),
354                 /* clears the POSE_LOCKED flag for the next time the pose is evaluated */
355         POSE_DO_UNLOCK  = (1<<2),
356                 /* pose has constraints which depend on time (used when depsgraph updates for a new frame) */
357         POSE_CONSTRAINTS_TIMEDEPEND = (1<<3),
358                 /* recalculate bone paths */
359         POSE_RECALCPATHS = (1<<4),
360                 /* set by armature_rebuild_pose to give a chance to the IK solver to rebuild IK tree */
361         POSE_WAS_REBUILT = (1<<5),
362                 /* set by game_copy_pose to indicate that this pose is used in the game engine */
363         POSE_GAME_ENGINE = (1<<6)
364 } ePose_Flags;
365
366 /* IK Solvers ------------------------------------ */
367
368 /* bPose->iksolver and bPose->ikparam->iksolver */
369 typedef enum ePose_IKSolverType {
370         IKSOLVER_LEGACY = 0,
371         IKSOLVER_ITASC
372 } ePose_IKSolverType;
373
374 /* header for all bPose->ikparam structures */
375 typedef struct bIKParam {
376         int   iksolver;
377 } bIKParam;
378
379 /* bPose->ikparam when bPose->iksolver=1 */
380 typedef struct bItasc {
381         int   iksolver;
382         float precision;
383         short numiter;
384         short numstep;
385         float minstep;
386         float maxstep;
387         short solver;   
388         short flag;
389         float feedback;
390         float maxvel;   /* max velocity to SDLS solver */
391         float dampmax;  /* maximum damping for DLS solver */
392         float dampeps;  /* threshold of singular value from which the damping start progressively */
393 } bItasc;
394
395 /* bItasc->flag */
396 typedef enum eItasc_Flags {
397         ITASC_AUTO_STEP = (1<<0),
398         ITASC_INITIAL_REITERATION = (1<<1),
399         ITASC_REITERATION = (1<<2),
400         ITASC_SIMULATION = (1<<3)
401 } eItasc_Flags;
402
403 /* bItasc->solver */
404 typedef enum eItasc_Solver {
405         ITASC_SOLVER_SDLS = 0,  /* selective damped least square, suitable for CopyPose constraint */
406         ITASC_SOLVER_DLS                /* damped least square with numerical filtering of damping */
407 } eItasc_Solver;
408
409 /* ************************************************ */
410 /* Action */
411
412 /* Groups -------------------------------------- */
413
414 /* Action-Channel Group (agrp)
415
416  * These are stored as a list per-Action, and are only used to 
417  * group that Action's channels in an Animation Editor. 
418  *
419  * Even though all FCurves live in a big list per Action, each group they are in also
420  * holds references to the achans within that list which belong to it. Care must be taken to
421  * ensure that action-groups never end up being the sole 'owner' of a channel.
422  * 
423  * This is also exploited for bone-groups. Bone-Groups are stored per bPose, and are used 
424  * primarily to color bones in the 3d-view. There are other benefits too, but those are mostly related
425  * to Action-Groups.
426  */
427 typedef struct bActionGroup {
428         struct bActionGroup *next, *prev;
429         
430         ListBase channels;                      /* Note: this must not be touched by standard listbase functions which would clear links to other channels */
431         
432         int flag;                                       /* settings for this action-group */
433         int customCol;                          /* index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set) */                          
434         char name[64];                          /* name of the group */
435         
436         ThemeWireColor cs;                      /* color set to use when customCol == -1 */
437 } bActionGroup;
438
439 /* Action Group flags */
440 typedef enum eActionGroup_Flag {
441                 /* group is selected */
442         AGRP_SELECTED   = (1<<0),
443                 /* group is 'active' / last selected one */
444         AGRP_ACTIVE     = (1<<1),
445                 /* keyframes/channels belonging to it cannot be edited */
446         AGRP_PROTECTED  = (1<<2),
447                 /* for UI (DopeSheet), sub-channels are shown */
448         AGRP_EXPANDED   = (1<<3),
449                 /* sub-channels are not evaluated */
450         AGRP_MUTED              = (1<<4),
451                 /* sub-channels are not visible in Graph Editor */
452         AGRP_NOTVISIBLE = (1<<5),
453                 /* for UI (Graph Editor), sub-channels are shown */
454         AGRP_EXPANDED_G = (1<<6),
455         
456         AGRP_TEMP               = (1<<30),
457         AGRP_MOVED              = (1<<31)
458 } eActionGroup_Flag;
459
460
461 /* Actions -------------------------------------- */
462
463 /* Action - reusable F-Curve 'bag'  (act) 
464  *
465  * This contains F-Curves that may affect settings from more than one ID blocktype and/or 
466  * datablock (i.e. sub-data linked/used directly to the ID block that the animation data is linked to), 
467  * but with the restriction that the other unrelated data (i.e. data that is not directly used or linked to
468  * by the source ID block).
469  *
470  * It serves as a 'unit' of reusable animation information (i.e. keyframes/motion data), that 
471  * affects a group of related settings (as defined by the user). 
472  */
473 typedef struct bAction {
474         ID      id;                             /* ID-serialisation for relinking */
475         
476         ListBase curves;        /* function-curves (FCurve) */
477         ListBase chanbase;      /* legacy data - Action Channels (bActionChannel) in pre-2.5 animation system */
478         ListBase groups;        /* groups of function-curves (bActionGroup) */
479         ListBase markers;       /* markers local to the Action (used to provide Pose-Libraries) */
480         
481         int flag;                       /* settings for this action */
482         int active_marker;      /* index of the active marker */
483         
484         int idroot;                     /* type of ID-blocks that action can be assigned to (if 0, will be set to whatever ID first evaluates it) */
485         int pad;
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         char searchstr[64];                     /* string to search for in displayed names of F-Curves for ADS_FILTER_BY_FCU_NAME filtering option */
512         
513         int filterflag;                         /* flags to use for filtering data */
514         int flag;                                       /* standard flags */
515         
516         int renameIndex;                        /* index+1 of channel to rename - only gets set by renaming operator */
517         int pad;
518 } bDopeSheet;
519
520
521 /* DopeSheet filter-flag */
522 typedef enum eDopeSheet_FilterFlag {
523                 /* general filtering */
524         ADS_FILTER_ONLYSEL                      = (1<<0),       /* only include channels relating to selected data */
525         
526                 /* temporary filters */
527         ADS_FILTER_ONLYDRIVERS          = (1<<1),       /* for 'Drivers' editor - only include Driver data from AnimData */
528         ADS_FILTER_ONLYNLA                      = (1<<2),       /* for 'NLA' editor - only include NLA data from AnimData */
529         ADS_FILTER_SELEDIT                      = (1<<3),       /* for Graph Editor - used to indicate whether to include a filtering flag or not */
530         
531                 /* general filtering 2 */
532         ADS_FILTER_SUMMARY                      = (1<<4),       /* for 'DopeSheet' Editors - include 'summary' line */
533         ADS_FILTER_ONLYOBGROUP          = (1<<5),       /* only the objects in the specified object group get used */
534         
535                 /* datatype-based filtering */
536         ADS_FILTER_NOSHAPEKEYS          = (1<<6),
537         ADS_FILTER_NOMESH                       = (1<<7),
538         ADS_FILTER_NOOBJ                        = (1<<8),       /* for animdata on object level, if we only want to concentrate on materials/etc. */
539         ADS_FILTER_NOLAT                        = (1<<9),
540         ADS_FILTER_NOCAM                        = (1<<10),
541         ADS_FILTER_NOMAT                        = (1<<11),
542         ADS_FILTER_NOLAM                        = (1<<12),
543         ADS_FILTER_NOCUR                        = (1<<13),
544         ADS_FILTER_NOWOR                        = (1<<14),
545         ADS_FILTER_NOSCE                        = (1<<15),
546         ADS_FILTER_NOPART                       = (1<<16),
547         ADS_FILTER_NOMBA                        = (1<<17),
548         ADS_FILTER_NOARM                        = (1<<18),
549         ADS_FILTER_NONTREE                      = (1<<19),
550         ADS_FILTER_NOTEX                        = (1<<20),
551         ADS_FILTER_NOSPK                        = (1<<21),
552         
553                 /* NLA-specific filters */
554         ADS_FILTER_NLA_NOACT            = (1<<25),      /* if the AnimData block has no NLA data, don't include to just show Action-line */
555         
556                 /* general filtering 3 */
557         ADS_FILTER_INCL_HIDDEN          = (1<<26),      /* include 'hidden' channels too (i.e. those from hidden Objects/Bones) */
558         ADS_FILTER_BY_FCU_NAME          = (1<<27),      /* for F-Curves, filter by the displayed name (i.e. to isolate all Location curves only) */
559         
560                 /* combination filters (some only used at runtime) */
561         ADS_FILTER_NOOBDATA = (ADS_FILTER_NOCAM|ADS_FILTER_NOMAT|ADS_FILTER_NOLAM|ADS_FILTER_NOCUR|ADS_FILTER_NOPART|ADS_FILTER_NOARM|ADS_FILTER_NOSPK)
562 } eDopeSheet_FilterFlag;        
563
564 /* DopeSheet general flags */
565 typedef enum eDopeSheet_Flag {
566         ADS_FLAG_SUMMARY_COLLAPSED      = (1<<0),       /* when summary is shown, it is collapsed, so all other channels get hidden */
567         ADS_FLAG_SHOW_DBFILTERS         = (1<<1)        /* show filters for datablocks */
568 } eDopeSheet_Flag;
569
570
571
572 /* Action Editor Space. This is defined here instead of in DNA_space_types.h */
573 typedef struct SpaceAction {
574         struct SpaceLink *next, *prev;
575         ListBase regionbase;            /* storage of regions for inactive spaces */
576         int spacetype;
577         float blockscale;
578
579         short blockhandler[8];
580
581         View2D v2d;                                     /* depricated, copied to region */
582         
583         bAction         *action;                /* the currently active action */
584         bDopeSheet      ads;                    /* the currently active context (when not showing action) */
585         
586         char  mode, autosnap;           /* mode: editing context; autosnap: automatic keyframe snapping mode   */
587         short flag;                             /* flag: bitmapped settings; */
588         float timeslide;                        /* for Time-Slide transform mode drawing - current frame? */
589 } SpaceAction;
590
591 /* SpaceAction flag */
592 typedef enum eSAction_Flag {
593                 /* during transform (only set for TimeSlide) */
594         SACTION_MOVING  = (1<<0),       
595                 /* show sliders */
596         SACTION_SLIDERS = (1<<1),       
597                 /* draw time in seconds instead of time in frames */
598         SACTION_DRAWTIME = (1<<2),
599                 /* don't filter action channels according to visibility */
600         //SACTION_NOHIDE = (1<<3), // XXX depreceated... old animation system
601                 /* don't kill overlapping keyframes after transform */
602         SACTION_NOTRANSKEYCULL = (1<<4),
603                 /* don't include keyframes that are out of view */
604         //SACTION_HORIZOPTIMISEON = (1<<5), // XXX depreceated... old irrelevant trick
605                 /* show pose-markers (local to action) in Action Editor mode  */
606         SACTION_POSEMARKERS_SHOW = (1<<6),
607                 /* don't draw action channels using group colors (where applicable) */
608         SACTION_NODRAWGCOLORS = (1<<7), // XXX depreceated... irrelevant for current groups implementation
609                 /* don't draw current frame number beside frame indicator */
610         SACTION_NODRAWCFRANUM = (1<<8),
611                 /* temporary flag to force channel selections to be synced with main */
612         SACTION_TEMP_NEEDCHANSYNC = (1<<9),
613                 /* don't perform realtime updates */
614         SACTION_NOREALTIMEUPDATES =     (1<<10),
615                 /* move markers as well as keyframes */
616         SACTION_MARKERS_MOVE = (1<<11)
617 } eSAction_Flag;        
618
619 /* SpaceAction Mode Settings */
620 typedef enum eAnimEdit_Context {
621                 /* action on the active object */
622         SACTCONT_ACTION = 0,
623                 /* list of all shapekeys on the active object, linked with their F-Curves */
624         SACTCONT_SHAPEKEY,
625                 /* editing of gpencil data */
626         SACTCONT_GPENCIL,
627                 /* dopesheet (default) */
628         SACTCONT_DOPESHEET
629 } eAnimEdit_Context;
630
631 /* SpaceAction AutoSnap Settings (also used by other Animation Editors) */
632 typedef enum eAnimEdit_AutoSnap {
633                 /* no auto-snap */
634         SACTSNAP_OFF = 0,       
635                 /* snap to 1.0 frame/second intervals */
636         SACTSNAP_STEP,
637                 /* snap to actual frames/seconds (nla-action time) */
638         SACTSNAP_FRAME,
639                 /* snap to nearest marker */
640         SACTSNAP_MARKER
641 } eAnimEdit_AutoSnap;
642
643
644 /* ************************************************ */
645 /* Legacy Data */
646
647 /* WARNING: Action Channels are now depreceated... they were part of the old animation system!
648  *                (ONLY USED FOR DO_VERSIONS...)
649  * 
650  * Action Channels belong to Actions. They are linked with an IPO block, and can also own 
651  * Constraint Channels in certain situations. 
652  *
653  * Action-Channels can only belong to one group at a time, but they still live the Action's
654  * list of achans (to preserve backwards compatability, and also minimise the code
655  * that would need to be recoded). Grouped achans are stored at the start of the list, according
656  * to the position of the group in the list, and their position within the group. 
657  */
658 typedef struct bActionChannel {
659         struct bActionChannel   *next, *prev;
660         bActionGroup                    *grp;                                   /* Action Group this Action Channel belongs to */
661         
662         struct Ipo                              *ipo;                                   /* IPO block this action channel references */
663         ListBase                                constraintChannels;             /* Constraint Channels (when Action Channel represents an Object or Bone) */
664         
665         int             flag;                   /* settings accessed via bitmapping */
666         char    name[32];               /* channel name */
667         int             temp;                   /* temporary setting - may be used to indicate group that channel belongs to during syncing  */
668 } bActionChannel;
669
670 /* Action Channel flags (ONLY USED FOR DO_VERSIONS...) */
671 typedef enum ACHAN_FLAG {
672         ACHAN_SELECTED  = (1<<0),
673         ACHAN_HILIGHTED = (1<<1),
674         ACHAN_HIDDEN    = (1<<2),
675         ACHAN_PROTECTED = (1<<3),
676         ACHAN_EXPANDED  = (1<<4),
677         ACHAN_SHOWIPO   = (1<<5),
678         ACHAN_SHOWCONS  = (1<<6),
679         ACHAN_MOVED     = (1<<31)
680 } ACHAN_FLAG; 
681
682 #endif