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