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