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