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