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