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