path: root/source/blender/makesdna/DNA_action_types.h

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * Contributor(s): Original design: Reevan McKay
 * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
 * Contributor(s): Animation recode, Joshua Leung
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file DNA_action_types.h
 *  \ingroup DNA
 *
 * Define actions data-block for the animation system.
 * A collection of animation curves and drivers to be assigned to data-blocks
 * or sequenced in the non-linear-editor (NLA).
 */

#ifndef __DNA_ACTION_TYPES_H__
#define __DNA_ACTION_TYPES_H__

#include "DNA_listBase.h"
#include "DNA_ID.h"
#include "DNA_view2d_types.h"
#include "DNA_userdef_types.h" /* ThemeWireColor */

struct SpaceLink;
struct Object;
struct Collection;
struct GHash;

/* ************************************************ */
/* Visualization */

/* Motion Paths ------------------------------------ */
/* (used for Pose Channels and Objects) */

/* Data point for motion path (mpv) */
typedef struct bMotionPathVert {
	float co[3];                /* coordinates of point in 3D-space */
	int flag;                   /* quick settings */
} bMotionPathVert;

/* bMotionPathVert->flag */
typedef enum eMotionPathVert_Flag {
	/* vert is selected */
	MOTIONPATH_VERT_SEL     = (1 << 0),
	MOTIONPATH_VERT_KEY     = (1 << 1),
} eMotionPathVert_Flag;

/* ........ */

/* Motion Path data cache (mpath)
 *  - for elements providing transforms (i.e. Objects or PoseChannels)
 */
typedef struct bMotionPath {
	bMotionPathVert *points;    /* path samples */
	int length;                 /* the number of cached verts */

	int start_frame;            /* for drawing paths, the start frame number */
	int end_frame;              /* for drawing paths, the end frame number */

	float color[3];	            /* optional custom color */
	int line_thickness;         /* line thickness */
	int flag;                   /* baking settings - eMotionPath_Flag */

	/* Used for drawing. */
	struct Gwn_VertBuf *points_vbo;
	struct Gwn_Batch *batch_line;
	struct Gwn_Batch *batch_points;
	void *pad;
} bMotionPath;

/* bMotionPath->flag */
typedef enum eMotionPath_Flag {
	/* (for bones) path represents the head of the bone */
	MOTIONPATH_FLAG_BHEAD       = (1 << 0),
	/* motion path is being edited */
	MOTIONPATH_FLAG_EDIT        = (1 << 1),
	/* Custom colors */
	MOTIONPATH_FLAG_CUSTOM      = (1 << 2),
	/* Draw lines or only points */
	MOTIONPATH_FLAG_LINES       = (1 << 3)
} eMotionPath_Flag;

/* Visualization General --------------------------- */
/* for Objects or Poses (but NOT PoseChannels) */

/* Animation Visualization Settings (avs) */
typedef struct bAnimVizSettings {
	/* Onion-Skinning Settings ----------------- */
	int ghost_sf, ghost_ef;         /* start and end frames of ghost-drawing range (only used for GHOST_TYPE_RANGE) */
	int ghost_bc, ghost_ac;         /* number of frames before/after current frame to show */

	short ghost_type;               /* eOnionSkin_Types */
	short ghost_step;               /* number of frames between each ghost shown (not for GHOST_TYPE_KEYS) */

	short ghost_flag;               /* eOnionSkin_Flag */

	/* General Settings ------------------------ */
	short recalc;                   /* eAnimViz_RecalcFlags */

	/* Motion Path Settings ------------------- */
	short path_type;                /* eMotionPath_Types */
	short path_step;                /* number of frames between points indicated on the paths */

	short path_viewflag;            /* eMotionPaths_ViewFlag */
	short path_bakeflag;            /* eMotionPaths_BakeFlag */

	int path_sf, path_ef;           /* start and end frames of path-calculation range */
	int path_bc, path_ac;           /* number of frames before/after current frame to show */
} bAnimVizSettings;


/* bAnimVizSettings->recalc */
typedef enum eAnimViz_RecalcFlags {
	/* motionpaths need recalculating */
	ANIMVIZ_RECALC_PATHS    = (1 << 0)
} eAnimViz_RecalcFlags;


/* bAnimVizSettings->ghost_type */
typedef enum eOnionSkin_Types {
	/* no ghosts at all */
	GHOST_TYPE_NONE = 0,
	/* around current frame */
	GHOST_TYPE_ACFRA = 1,
	/* show ghosts within the specified frame range */
	GHOST_TYPE_RANGE = 2,
	/* show ghosts on keyframes within the specified range only */
	GHOST_TYPE_KEYS = 3
} eOnionSkin_Types;

/* bAnimVizSettings->ghost_flag */
typedef enum eOnionSkin_Flag {
	/* only show selected bones in ghosts */
	GHOST_FLAG_ONLYSEL  = (1 << 0)
} eOnionSkin_Flag;


/* bAnimVizSettings->path_type */
typedef enum eMotionPaths_Types {
	/* show the paths along their entire ranges */
	MOTIONPATH_TYPE_RANGE = 0,
	/* only show the parts of the paths around the current frame */
	MOTIONPATH_TYPE_ACFRA = 1,
} eMotionPath_Types;

/* bAnimVizSettings->path_viewflag */
typedef enum eMotionPaths_ViewFlag {
	/* show frames on path */
	MOTIONPATH_VIEW_FNUMS       = (1 << 0),
	/* show keyframes on path */
	MOTIONPATH_VIEW_KFRAS       = (1 << 1),
	/* show keyframe/frame numbers */
	MOTIONPATH_VIEW_KFNOS       = (1 << 2),
	/* find keyframes in whole action (instead of just in matching group name) */
	MOTIONPATH_VIEW_KFACT       = (1 << 3),
	/* draw lines on path */
	MOTIONPATH_VIEW_LINES       = (1 << 4)
} eMotionPath_ViewFlag;

/* bAnimVizSettings->path_bakeflag */
typedef enum eMotionPaths_BakeFlag {
	/* motion paths directly associated with this block of settings needs updating */
	MOTIONPATH_BAKE_NEEDS_RECALC    = (1 << 0),
	/* for bones - calculate head-points for curves instead of tips */
	MOTIONPATH_BAKE_HEADS           = (1 << 1),
	/* motion paths exist for AnimVizSettings instance - set when calc for first time, and unset when clearing */
	MOTIONPATH_BAKE_HAS_PATHS       = (1 << 2)
} eMotionPath_BakeFlag;

/* runtime */
#
#
typedef struct bPoseChannelDrawData {
	float solid_color[4];
	float wire_color[4];

	int bbone_matrix_len;
	/* keep last */
	float bbone_matrix[0][4][4];
} bPoseChannelDrawData;

/* ************************************************ */
/* Poses */

/* PoseChannel ------------------------------------ */

/* PoseChannel
 *
 * A PoseChannel stores the results of Actions and transform information
 * with respect to the restposition of Armature bones
 */
typedef struct bPoseChannel {
	struct bPoseChannel *next, *prev;

	IDProperty          *prop;      /* User-Defined Properties on this PoseChannel */

	ListBase constraints;           /* Constraints that act on this PoseChannel */
	char name[64];                  /* need to match bone name length: MAXBONENAME */

	short flag;                     /* dynamic, for detecting transform changes */
	short ikflag;                   /* settings for IK bones */
	short protectflag;              /* protect channels from being transformed */
	short agrp_index;               /* index of action-group this bone belongs to (0 = default/no group) */
	char constflag;                 /* for quick detecting which constraints affect this channel */
	char selectflag;                /* copy of bone flag, so you can work with library armatures, not for runtime use */
	char drawflag;
	char bboneflag;
	char pad0[4];

	struct Bone         *bone;      /* set on read file or rebuild pose */
	struct bPoseChannel *parent;    /* set on read file or rebuild pose */
	struct bPoseChannel *child;     /* set on read file or rebuild pose, the 'ik' child, for b-bones */

	struct ListBase iktree;         /* "IK trees" - only while evaluating pose */
	struct ListBase siktree;        /* Spline-IK "trees" - only while evaluating pose */

	bMotionPath *mpath;             /* motion path cache for this bone */
	struct Object *custom;          /* draws custom object instead of default bone shape */
	struct bPoseChannel *custom_tx; /* odd feature, display with another bones transform.
	                                 * needed in rare cases for advanced rigs,
	                                 * since the alternative is highly complicated - campbell */
	float custom_scale;

	char pad1[4];

	/* transforms - written in by actions or transform */
	float loc[3];
	float size[3];

	/* rotations - written in by actions or transform (but only one representation gets used at any time) */
	float eul[3];                       /* euler rotation */
	float quat[4];                      /* quaternion rotation */
	float rotAxis[3], rotAngle;         /* axis-angle rotation */
	short rotmode;                      /* eRotationModes - rotation representation to use */
	short pad;

	float chan_mat[4][4];           /* matrix result of loc/quat/size, and where we put deform in, see next line */
	float pose_mat[4][4];           /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat
	                                 * this matrix is object space */
	float disp_mat[4][4];           /* for display, pose_mat with bone length applied */
	float disp_tail_mat[4][4];      /* for display, pose_mat with bone length applied and translated to tail*/
	float constinv[4][4];           /* inverse result of constraints.
	                                 * doesn't include effect of restposition, parent, and local transform*/

	float pose_head[3];             /* actually pose_mat[3] */
	float pose_tail[3];             /* also used for drawing help lines... */

	float limitmin[3], limitmax[3]; /* DOF constraint, note! - these are stored in degrees, not radians */
	float stiffness[3];             /* DOF stiffness */
	float ikstretch;
	float ikrotweight;              /* weight of joint rotation constraint */
	float iklinweight;              /* weight of joint stretch constraint */

	/* curved bones settings - these are for animating, and are applied on top of the copies in pchan->bone */
	float roll1, roll2;
	float curveInX, curveInY;
	float curveOutX, curveOutY;
	float ease1, ease2;
	float scaleIn, scaleOut;

	struct bPoseChannel *bbone_prev; /* next/prev bones to use as handle references when calculating bbones (optional) */
	struct bPoseChannel *bbone_next;

	void        *temp;              /* use for outliner */
	/* Runtime data for color and bbone segment matrix. */
	bPoseChannelDrawData *draw_data;

	/* Points to an original pose channel. */
	struct bPoseChannel *orig_pchan;
} bPoseChannel;


/* PoseChannel (transform) flags */
typedef enum ePchan_Flag {
	/* has transforms */
	POSE_LOC        =   (1 << 0),
	POSE_ROT        =   (1 << 1),
	POSE_SIZE       =   (1 << 2),

	/* old IK/cache stuff
	 * - used to be here from (1 << 3) to (1 << 8)
	 *   but has been repurposed since 2.77.2
	 *   as they haven't been used in over 10 years
	 */

	/* has BBone deforms */
	POSE_BBONE_SHAPE =  (1 << 3),

	/* IK/Pose solving */
	POSE_CHAIN      =   (1 << 9),
	POSE_DONE       =   (1 << 10),
	/* visualization */
	POSE_KEY        =   (1 << 11),
	POSE_STRIDE     =   (1 << 12),
	/* standard IK solving */
	POSE_IKTREE     =   (1 << 13),
#if 0
	/* has Spline IK */
	POSE_HAS_IKS    =   (1 << 14),
#endif
	/* spline IK solving */
	POSE_IKSPLINE   =   (1 << 15)
} ePchan_Flag;

/* PoseChannel constflag (constraint detection) */
typedef enum ePchan_ConstFlag {
	PCHAN_HAS_IK        = (1 << 0),
	PCHAN_HAS_CONST     = (1 << 1),
	/* only used for drawing Posemode, not stored in channel */
	PCHAN_HAS_ACTION    = (1 << 2),
	PCHAN_HAS_TARGET    = (1 << 3),
	/* only for drawing Posemode too */
	PCHAN_HAS_STRIDE    = (1 << 4),
	/* spline IK */
	PCHAN_HAS_SPLINEIK  = (1 << 5)
} ePchan_ConstFlag;

/* PoseChannel->ikflag */
typedef enum ePchan_IkFlag {
	BONE_IK_NO_XDOF = (1 << 0),
	BONE_IK_NO_YDOF = (1 << 1),
	BONE_IK_NO_ZDOF = (1 << 2),

	BONE_IK_XLIMIT  = (1 << 3),
	BONE_IK_YLIMIT  = (1 << 4),
	BONE_IK_ZLIMIT  = (1 << 5),

	BONE_IK_ROTCTL  = (1 << 6),
	BONE_IK_LINCTL  = (1 << 7),

	BONE_IK_NO_XDOF_TEMP = (1 << 10),
	BONE_IK_NO_YDOF_TEMP = (1 << 11),
	BONE_IK_NO_ZDOF_TEMP = (1 << 12)
} ePchan_IkFlag;

/* PoseChannel->drawflag */
typedef enum ePchan_DrawFlag {
	PCHAN_DRAW_NO_CUSTOM_BONE_SIZE = (1 << 0),
} ePchan_DrawFlag;

#define PCHAN_CUSTOM_DRAW_SIZE(pchan) \
	(pchan)->custom_scale * (((pchan)->drawflag & PCHAN_DRAW_NO_CUSTOM_BONE_SIZE) ? 1.0f : (pchan)->bone->length)

/* PoseChannel->bboneflag */
typedef enum ePchan_BBoneFlag {
	/* Use custom reference bones (for roll and handle alignment), instead of immediate neighbors */
	PCHAN_BBONE_CUSTOM_HANDLES    = (1 << 1),
	/* Evaluate start handle as being "relative" */
	PCHAN_BBONE_CUSTOM_START_REL  = (1 << 2),
	/* Evaluate end handle as being "relative" */
	PCHAN_BBONE_CUSTOM_END_REL    = (1 << 3),
} ePchan_BBoneFlag;

/* PoseChannel->rotmode and Object->rotmode */
typedef enum eRotationModes {
	/* quaternion rotations (default, and for older Blender versions) */
	ROT_MODE_QUAT   = 0,
	/* euler rotations - keep in sync with enum in BLI_math.h */
	ROT_MODE_EUL = 1,       /* Blender 'default' (classic) - must be as 1 to sync with BLI_math_rotation.h defines */
	ROT_MODE_XYZ = 1,
	ROT_MODE_XZY = 2,
	ROT_MODE_YXZ = 3,
	ROT_MODE_YZX = 4,
	ROT_MODE_ZXY = 5,
	ROT_MODE_ZYX = 6,
	/* NOTE: space is reserved here for 18 other possible
	 * euler rotation orders not implemented
	 */
	/* axis angle rotations */
	ROT_MODE_AXISANGLE = -1,

	ROT_MODE_MIN = ROT_MODE_AXISANGLE,  /* sentinel for Py API */
	ROT_MODE_MAX = ROT_MODE_ZYX
} eRotationModes;

/* Pose ------------------------------------ */

/* Pose-Object.
 *
 * It is only found under ob->pose. It is not library data, even
 * though there is a define for it (hack for the outliner).
 */
typedef struct bPose {
	ListBase chanbase;          /* list of pose channels, PoseBones in RNA */
	struct GHash *chanhash;     /* ghash for quicker string lookups */

	/* Flat array of pose channels. It references pointers from
	 * chanbase. Used for quick pose channel lookup from an index.
	 */
	bPoseChannel **chan_array;

	short flag, pad;
	unsigned int proxy_layer;   /* proxy layer: copy from armature, gets synced */
	int pad1;

	float ctime;                /* local action time of this pose */
	float stride_offset[3];     /* applied to object */
	float cyclic_offset[3];     /* result of match and cycles, applied in BKE_pose_where_is() */


	ListBase agroups;           /* list of bActionGroups */

	int active_group;           /* index of active group (starts from 1) */
	int iksolver;               /* ik solver to use, see ePose_IKSolverType */
	void *ikdata;               /* temporary IK data, depends on the IK solver. Not saved in file */
	void *ikparam;              /* IK solver parameters, structure depends on iksolver */

	bAnimVizSettings avs;       /* settings for visualization of bone animation */
	char proxy_act_bone[64];    /* proxy active bone name, MAXBONENAME */
} bPose;


/* Pose->flag */
typedef enum ePose_Flags {
	/* results in BKE_pose_rebuild being called */
	POSE_RECALC = (1 << 0),
	/* prevents any channel from getting overridden by anim from IPO */
	POSE_LOCKED = (1 << 1),
	/* clears the POSE_LOCKED flag for the next time the pose is evaluated */
	POSE_DO_UNLOCK  = (1 << 2),
	/* pose has constraints which depend on time (used when depsgraph updates for a new frame) */
	POSE_CONSTRAINTS_TIMEDEPEND = (1 << 3),
	/* recalculate bone paths */
	POSE_RECALCPATHS = (1 << 4),
	/* set by BKE_pose_rebuild to give a chance to the IK solver to rebuild IK tree */
	POSE_WAS_REBUILT = (1 << 5),
	POSE_FLAG_DEPRECATED = (1 << 6), /* deprecated. */
	/* pose constraint flags needs to be updated */
	POSE_CONSTRAINTS_NEED_UPDATE_FLAGS = (1 << 7),
} ePose_Flags;

/* IK Solvers ------------------------------------ */

/* bPose->iksolver and bPose->ikparam->iksolver */
typedef enum ePose_IKSolverType {
	IKSOLVER_STANDARD = 0,
	IKSOLVER_ITASC = 1
} ePose_IKSolverType;

/* header for all bPose->ikparam structures */
typedef struct bIKParam {
	int iksolver;
} bIKParam;

/* bPose->ikparam when bPose->iksolver=1 */
typedef struct bItasc {
	int iksolver;
	float precision;
	short numiter;
	short numstep;
	float minstep;
	float maxstep;
	short solver;
	short flag;
	float feedback;
	float maxvel;   /* max velocity to SDLS solver */
	float dampmax;  /* maximum damping for DLS solver */
	float dampeps;  /* threshold of singular value from which the damping start progressively */
} bItasc;

/* bItasc->flag */
typedef enum eItasc_Flags {
	ITASC_AUTO_STEP           = (1 << 0),
	ITASC_INITIAL_REITERATION = (1 << 1),
	ITASC_REITERATION         = (1 << 2),
	ITASC_SIMULATION          = (1 << 3)
} eItasc_Flags;

/* bItasc->solver */
typedef enum eItasc_Solver {
	ITASC_SOLVER_SDLS = 0,  /* selective damped least square, suitable for CopyPose constraint */
	ITASC_SOLVER_DLS  = 1,  /* damped least square with numerical filtering of damping */
} eItasc_Solver;

/* ************************************************ */
/* Action */

/* Groups -------------------------------------- */

/* Action-Channel Group (agrp)
 *
 * These are stored as a list per-Action, and are only used to
 * group that Action's channels in an Animation Editor.
 *
 * Even though all FCurves live in a big list per Action, each group they are in also
 * holds references to the achans within that list which belong to it. Care must be taken to
 * ensure that action-groups never end up being the sole 'owner' of a channel.
 *
 * This is also exploited for bone-groups. Bone-Groups are stored per bPose, and are used
 * primarily to color bones in the 3d-view. There are other benefits too, but those are mostly related
 * to Action-Groups.
 *
 * Note that these two uses each have their own RNA 'ActionGroup' and 'BoneGroup'.
 */
typedef struct bActionGroup {
	struct bActionGroup *next, *prev;

	ListBase channels;          /* Note: this must not be touched by standard listbase functions which would clear links to other channels */

	int flag;                   /* settings for this action-group */
	int customCol;              /* index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set) */
	char name[64];              /* name of the group */

	ThemeWireColor cs;          /* color set to use when customCol == -1 */
} bActionGroup;

/* Action Group flags */
typedef enum eActionGroup_Flag {
	/* group is selected */
	AGRP_SELECTED   = (1 << 0),
	/* group is 'active' / last selected one */
	AGRP_ACTIVE     = (1 << 1),
	/* keyframes/channels belonging to it cannot be edited */
	AGRP_PROTECTED  = (1 << 2),
	/* for UI (DopeSheet), sub-channels are shown */
	AGRP_EXPANDED   = (1 << 3),
	/* sub-channels are not evaluated */
	AGRP_MUTED      = (1 << 4),
	/* sub-channels are not visible in Graph Editor */
	AGRP_NOTVISIBLE = (1 << 5),
	/* for UI (Graph Editor), sub-channels are shown */
	AGRP_EXPANDED_G = (1 << 6),

	/* sub channel modifiers off */
	AGRP_MODIFIERS_OFF = (1 << 7),

	AGRP_TEMP       = (1 << 30),
	AGRP_MOVED      = (1u << 31)
} eActionGroup_Flag;


/* Actions -------------------------------------- */

/* Action - reusable F-Curve 'bag'  (act)
 *
 * This contains F-Curves that may affect settings from more than one ID blocktype and/or
 * datablock (i.e. sub-data linked/used directly to the ID block that the animation data is linked to),
 * but with the restriction that the other unrelated data (i.e. data that is not directly used or linked to
 * by the source ID block).
 *
 * It serves as a 'unit' of reusable animation information (i.e. keyframes/motion data), that
 * affects a group of related settings (as defined by the user).
 */
typedef struct bAction {
	ID id;              /* ID-serialisation for relinking */

	ListBase curves;    /* function-curves (FCurve) */
	ListBase chanbase DNA_DEPRECATED;  /* legacy data - Action Channels (bActionChannel) in pre-2.5 animation system */
	ListBase groups;    /* groups of function-curves (bActionGroup) */
	ListBase markers;   /* markers local to the Action (used to provide Pose-Libraries) */

	int flag;           /* settings for this action */
	int active_marker;  /* index of the active marker */

	int idroot;         /* type of ID-blocks that action can be assigned to (if 0, will be set to whatever ID first evaluates it) */
	int pad;
} bAction;


/* Flags for the action */
typedef enum eAction_Flags {
	/* flags for displaying in UI */
	ACT_COLLAPSED   = (1 << 0),
	ACT_SELECTED    = (1 << 1),

	/* flags for evaluation/editing */
	ACT_MUTED       = (1 << 9),
	ACT_PROTECTED   = (1 << 10),
	ACT_DISABLED    = (1 << 11)
} eAction_Flags;


/* ************************************************ */
/* Action/Dopesheet Editor */

/* Storage for Dopesheet/Grease-Pencil Editor data */
typedef struct bDopeSheet {
	ID      *source;            /* currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil) */
	ListBase chanbase; /* cache for channels (only initialized when pinned) */           // XXX not used!

	struct Collection *filter_grp;   /* object group for option to only include objects that belong to this Collection */
	char searchstr[64];         /* string to search for in displayed names of F-Curves, or NlaTracks/GP Layers/etc. */

	int filterflag;             /* flags to use for filtering data */
	int flag;                   /* standard flags */

	int renameIndex;            /* index+1 of channel to rename - only gets set by renaming operator */
	int pad;
} bDopeSheet;


/* DopeSheet filter-flag */
typedef enum eDopeSheet_FilterFlag {
	/* general filtering */
	ADS_FILTER_ONLYSEL          = (1 << 0),   /* only include channels relating to selected data */

	/* temporary filters */
	ADS_FILTER_ONLYDRIVERS      = (1 << 1),   /* for 'Drivers' editor - only include Driver data from AnimData */
	ADS_FILTER_ONLYNLA          = (1 << 2),   /* for 'NLA' editor - only include NLA data from AnimData */
	ADS_FILTER_SELEDIT          = (1 << 3),   /* for Graph Editor - used to indicate whether to include a filtering flag or not */

	/* general filtering */
	ADS_FILTER_SUMMARY          = (1 << 4),   /* for 'DopeSheet' Editors - include 'summary' line */

	/* datatype-based filtering */
	ADS_FILTER_NOSHAPEKEYS      = (1 << 6),
	ADS_FILTER_NOMESH           = (1 << 7),
	ADS_FILTER_NOOBJ            = (1 << 8),   /* for animdata on object level, if we only want to concentrate on materials/etc. */
	ADS_FILTER_NOLAT            = (1 << 9),
	ADS_FILTER_NOCAM            = (1 << 10),
	ADS_FILTER_NOMAT            = (1 << 11),
	ADS_FILTER_NOLAM            = (1 << 12),
	ADS_FILTER_NOCUR            = (1 << 13),
	ADS_FILTER_NOWOR            = (1 << 14),
	ADS_FILTER_NOSCE            = (1 << 15),
	ADS_FILTER_NOPART           = (1 << 16),
	ADS_FILTER_NOMBA            = (1 << 17),
	ADS_FILTER_NOARM            = (1 << 18),
	ADS_FILTER_NONTREE          = (1 << 19),
	ADS_FILTER_NOTEX            = (1 << 20),
	ADS_FILTER_NOSPK            = (1 << 21),
	ADS_FILTER_NOLINESTYLE      = (1 << 22),
	ADS_FILTER_NOMODIFIERS      = (1 << 23),
	ADS_FILTER_NOGPENCIL        = (1 << 24),
	/* NOTE: all new datablock filters will have to go in filterflag2 (see below) */

	/* NLA-specific filters */
	ADS_FILTER_NLA_NOACT        = (1 << 25),  /* if the AnimData block has no NLA data, don't include to just show Action-line */

	/* general filtering 3 */
	ADS_FILTER_INCL_HIDDEN      = (1 << 26),  /* include 'hidden' channels too (i.e. those from hidden Objects/Bones) */
	ADS_FILTER_ONLY_ERRORS		= (1 << 28),  /* show only F-Curves which are disabled/have errors - for debugging drivers */

	/* GPencil Mode */
	ADS_FILTER_GP_3DONLY        = (1 << 29),  /* GP Mode - Only show datablocks used in the scene */

	/* combination filters (some only used at runtime) */
	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)
} eDopeSheet_FilterFlag;

/* DopeSheet general flags */
typedef enum eDopeSheet_Flag {
	ADS_FLAG_SUMMARY_COLLAPSED  = (1 << 0),   /* when summary is shown, it is collapsed, so all other channels get hidden */
	ADS_FLAG_SHOW_DBFILTERS     = (1 << 1),   /* show filters for datablocks */

	ADS_FLAG_FUZZY_NAMES        = (1 << 2),   /* use fuzzy/partial string matches when ADS_FILTER_BY_FCU_NAME is enabled (WARNING: expensive operation) */
	ADS_FLAG_NO_DB_SORT         = (1 << 3),   /* do not sort datablocks (mostly objects) by name (NOTE: potentially expensive operation) */

	/* NOTE: datablock filter flags continued (1 << 10) onwards... */
} eDopeSheet_Flag;



/* Action Editor Space. This is defined here instead of in DNA_space_types.h */
typedef struct SpaceAction {
	struct SpaceLink *next, *prev;
	ListBase regionbase;        /* storage of regions for inactive spaces */
	char spacetype;
	char link_flag;
	char _pad0[6];
	/* End 'SpaceLink' header. */

	View2D v2d DNA_DEPRECATED;  /* copied to region */

	bAction     *action;        /* the currently active action */
	bDopeSheet ads;             /* the currently active context (when not showing action) */

	float timeslide;            /* for Time-Slide transform mode drawing - current frame? */

	short flag;
	/* Editing context */
	char mode;
	/* Storage for sub-space types. */
	char mode_prev;
	char autosnap;              /* automatic keyframe snapping mode   */
	char cache_display;         /* (eTimeline_Cache_Flag) */
	char _pad1[6];
} SpaceAction;

/* SpaceAction flag */
typedef enum eSAction_Flag {
	/* during transform (only set for TimeSlide) */
	SACTION_MOVING  = (1 << 0),
	/* show sliders */
	SACTION_SLIDERS = (1 << 1),
	/* draw time in seconds instead of time in frames */
	SACTION_DRAWTIME = (1 << 2),
	/* don't filter action channels according to visibility */
	//SACTION_NOHIDE = (1<<3), // XXX deprecated... old animation system
	/* don't kill overlapping keyframes after transform */
	SACTION_NOTRANSKEYCULL = (1 << 4),
	/* don't include keyframes that are out of view */
	//SACTION_HORIZOPTIMISEON = (1<<5), // XXX deprecated... old irrelevant trick
	/* show pose-markers (local to action) in Action Editor mode  */
	SACTION_POSEMARKERS_SHOW = (1 << 6),
	/* don't draw action channels using group colors (where applicable) */
	SACTION_NODRAWGCOLORS = (1 << 7),
	/* don't draw current frame number beside frame indicator */
	SACTION_NODRAWCFRANUM = (1 << 8),
	/* temporary flag to force channel selections to be synced with main */
	SACTION_TEMP_NEEDCHANSYNC = (1 << 9),
	/* don't perform realtime updates */
	SACTION_NOREALTIMEUPDATES = (1 << 10),
	/* move markers as well as keyframes */
	SACTION_MARKERS_MOVE = (1 << 11)
} eSAction_Flag;

/* SpaceAction Mode Settings */
typedef enum eAnimEdit_Context {
	/* action on the active object */
	SACTCONT_ACTION = 0,
	/* list of all shapekeys on the active object, linked with their F-Curves */
	SACTCONT_SHAPEKEY = 1,
	/* editing of gpencil data */
	SACTCONT_GPENCIL = 2,
	/* dopesheet (default) */
	SACTCONT_DOPESHEET = 3,
	/* mask */
	SACTCONT_MASK = 4,
	/* cache file */
	SACTCONT_CACHEFILE = 5,
	/* timeline - replacement for the standalone "timeline editor" */
	SACTCONT_TIMELINE = 6,
} eAnimEdit_Context;

/* SpaceAction AutoSnap Settings (also used by other Animation Editors) */
typedef enum eAnimEdit_AutoSnap {
	/* no auto-snap */
	SACTSNAP_OFF = 0,
	/* snap to 1.0 frame/second intervals */
	SACTSNAP_STEP = 1,
	/* snap to actual frames/seconds (nla-action time) */
	SACTSNAP_FRAME = 2,
	/* snap to nearest marker */
	SACTSNAP_MARKER = 3,
	/* snap to actual seconds (nla-action time) */
	SACTSNAP_SECOND = 4,
	/* snap to 1.0 second increments */
	SACTSNAP_TSTEP = 5
} eAnimEdit_AutoSnap;

/* SAction->cache_display */
typedef enum eTimeline_Cache_Flag {
	TIME_CACHE_DISPLAY       = (1 << 0),
	TIME_CACHE_SOFTBODY      = (1 << 1),
	TIME_CACHE_PARTICLES     = (1 << 2),
	TIME_CACHE_CLOTH         = (1 << 3),
	TIME_CACHE_SMOKE         = (1 << 4),
	TIME_CACHE_DYNAMICPAINT  = (1 << 5),
	TIME_CACHE_RIGIDBODY     = (1 << 6),
} eTimeline_Cache_Flag;


/* ************************************************ */
/* Legacy Data */

/* WARNING: Action Channels are now deprecated... they were part of the old animation system!
 *        (ONLY USED FOR DO_VERSIONS...)
 *
 * Action Channels belong to Actions. They are linked with an IPO block, and can also own
 * Constraint Channels in certain situations.
 *
 * Action-Channels can only belong to one group at a time, but they still live the Action's
 * list of achans (to preserve backwards compatibility, and also minimize the code
 * that would need to be recoded). Grouped achans are stored at the start of the list, according
 * to the position of the group in the list, and their position within the group.
 */
typedef struct bActionChannel {
	struct bActionChannel   *next, *prev;
	bActionGroup            *grp;           /* Action Group this Action Channel belongs to */

	struct Ipo              *ipo;           /* IPO block this action channel references */
	ListBase constraintChannels;            /* Constraint Channels (when Action Channel represents an Object or Bone) */

	int flag;               /* settings accessed via bitmapping */
	char name[64];          /* channel name, MAX_NAME */
	int temp;               /* temporary setting - may be used to indicate group that channel belongs to during syncing  */
} bActionChannel;

/* Action Channel flags (ONLY USED FOR DO_VERSIONS...) */
typedef enum eActionChannelFlag {
	ACHAN_SELECTED  = (1 << 0),
	ACHAN_HIGHLIGHTED = (1 << 1),
	ACHAN_HIDDEN    = (1 << 2),
	ACHAN_PROTECTED = (1 << 3),
	ACHAN_EXPANDED  = (1 << 4),
	ACHAN_SHOWIPO   = (1 << 5),
	ACHAN_SHOWCONS  = (1 << 6),
	ACHAN_MOVED     = (1u << 31)
} eActionChannelFlag;

#endif  /* __DNA_ACTION_TYPES_H__ */