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