73a20512470e9ffd1fd6f0c288872ebcbc6663e6
[blender.git] / source / blender / makesdna / DNA_action_types.h
1 /*  
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Original design: Reevan McKay
24  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29
30 #ifndef DNA_ACTION_TYPES_H
31 #define DNA_ACTION_TYPES_H
32
33 #include "DNA_listBase.h"
34 #include "DNA_ID.h"
35 #include "DNA_gpencil_types.h"
36 #include "DNA_view2d_types.h"
37 #include "DNA_userdef_types.h"
38
39 struct SpaceLink;
40 struct Object;
41
42 /* -------------- Poses ----------------- */
43
44 /* PoseChannel stores the results of Actions (ipos) and transform information 
45    with respect to the restposition of Armature bones */
46 typedef struct bPoseChannel {
47         struct bPoseChannel     *next, *prev;
48         ListBase                        constraints;/* Constraints that act on this PoseChannel */
49         char                            name[32];       /* Channels need longer names than normal blender objects */
50         
51         short                           flag;           /* dynamic, for detecting transform changes */
52         short                           constflag;  /* for quick detecting which constraints affect this channel */
53         short                           ikflag;         /* settings for IK bones */
54         short               selectflag; /* copy of bone flag, so you can work with library armatures */
55         short                           protectflag; /* protect channels from being transformed */
56         short                           agrp_index; /* index of action-group this bone belongs to (0 = default/no group) */
57         
58         int                                 pathlen;    /* for drawing paths, the amount of frames */
59         int                             pathsf;         /* for drawing paths, the start frame number */
60         int                                     pathef;         /* for drawing paths, the end frame number */
61         
62         struct Bone                     *bone;          /* set on read file or rebuild pose */
63         struct bPoseChannel *parent;    /* set on read file or rebuild pose */
64         struct bPoseChannel *child;             /* set on read file or rebuild pose, the 'ik' child, for b-bones */
65         struct ListBase          iktree;                /* only while evaluating pose */
66         
67         /* only while deform, stores precalculated b_bone deform mats,
68            dual quaternions */
69         void                            *b_bone_mats;   
70         void                            *dual_quat;
71         void                            *b_bone_dual_quats;
72         
73         float           loc[3];                         /* written in by actions or transform */
74         float           size[3];
75         float           quat[4];
76         
77         float           chan_mat[4][4];         /* matrix result of loc/quat/size , and where we put deform in, see next line */
78         float           pose_mat[4][4];         /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat */
79         float           constinv[4][4];         /* inverse result of constraints. doesn't include effect of restposition, parent, and local transform*/
80         
81         float           pose_head[3];           /* actually pose_mat[3] */
82         float           pose_tail[3];           /* also used for drawing help lines... */
83         
84         float           limitmin[3], limitmax[3];       /* DOF constraint */
85         float           stiffness[3];                           /* DOF stiffness */
86         float           ikstretch;
87         
88         float           *path;                          /* totpath x 3 x float */
89         struct Object *custom;                  /* draws custom object instead of this channel */
90 } bPoseChannel;
91
92 /* Pose-Object. It is only found under ob->pose. It is not library data, even
93  * though there is a define for it (hack for the outliner).
94  */
95 typedef struct bPose {
96         ListBase chanbase;                      /* list of pose channels */
97         
98         short flag, proxy_layer;        /* proxy layer: copy from armature, gets synced */
99         
100         float ctime;                            /* local action time of this pose */
101         float stride_offset[3];         /* applied to object */
102         float cyclic_offset[3];         /* result of match and cycles, applied in where_is_pose() */
103         
104         
105         ListBase agroups;                       /* list of bActionGroups */
106         
107         int active_group;                       /* index of active group (starts from 1) */
108         int pad;
109 } bPose;
110
111
112 /* ------------- Action  ---------------- */
113
114 /* Action-Channel Group. These are stored as a list per-Action, and are only used to 
115  * group that Action's Action-Channels when displayed in the Action Editor. 
116  *
117  * Even though all Action-Channels live in a big list per Action, each group they are in also
118  * holds references to the achans within that list which belong to it. Care must be taken to
119  * ensure that action-groups never end up being the sole 'owner' of a channel.
120  *
121  * 
122  * This is also exploited for bone-groups. Bone-Groups are stored per bPose, and are used 
123  * primarily to colour bones in the 3d-view. There are other benefits too, but those are mostly related
124  * to Action-Groups.
125  */
126 typedef struct bActionGroup {
127         struct bActionGroup *next, *prev;
128         
129         ListBase channels;                      /* Note: this must not be touched by standard listbase functions */
130         
131         int flag;                                       /* settings for this action-group */
132         int customCol;                          /* index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set) */                          
133         char name[32];                          /* name of the group */
134         
135         ThemeWireColor cs;                      /* color set to use when customCol == -1 */
136 } bActionGroup;
137
138 /* Action Channels belong to Actions. They are linked with an IPO block, and can also own 
139  * Constraint Channels in certain situations. 
140  *
141  * Action-Channels can only belong to one group at a time, but they still live the Action's
142  * list of achans (to preserve backwards compatability, and also minimise the code
143  * that would need to be recoded). Grouped achans are stored at the start of the list, according
144  * to the position of the group in the list, and their position within the group. 
145  */
146 typedef struct bActionChannel {
147         struct bActionChannel   *next, *prev;
148         bActionGroup                    *grp;                                   /* Action Group this Action Channel belongs to */
149         
150         struct Ipo                              *ipo;                                   /* IPO block this action channel references */
151         ListBase                                constraintChannels;             /* Constraint Channels (when Action Channel represents an Object or Bone) */
152         
153         int             flag;                   /* settings accessed via bitmapping */
154         char    name[32];               /* channel name */
155         int             reserved1;
156 } bActionChannel;
157
158 /* Action. A recyclable block that contains a series of Action Channels (ipo), which define 
159  * a clip of reusable animation for use in the NLA.
160  */
161 typedef struct bAction {
162         ID                              id;
163         
164         ListBase                chanbase;       /* Action Channels in this Action */
165         ListBase                groups;         /* Action Groups in the Action */
166         ListBase                markers;        /* TimeMarkers local to this Action for labelling 'poses' */
167         
168         int active_marker;                      /* Index of active-marker (first marker = 1) */
169         int pad;
170 } bAction;
171
172
173 /* ------------- Action Editor --------------------- */
174
175 /* Action Editor Space. This is defined here instead of in DNA_space_types.h */
176 typedef struct SpaceAction {
177         struct SpaceLink *next, *prev;
178         ListBase regionbase;            /* storage of regions for inactive spaces */
179         int spacetype;
180         float blockscale;
181         struct ScrArea *area;
182
183         short blockhandler[8];
184
185         View2D v2d;     
186         
187         bAction         *action;                /* the currently active action */
188         
189         char  mode, autosnap;           /* mode: editing context; autosnap: automatic keyframe snapping mode   */
190         short flag, actnr;                      /* flag: bitmapped settings; */
191         short pin, lock;                        /* pin: keep showing current action; actnr: used for finding chosen action from menu; lock: lock time to other windows */
192         short actwidth;                         /* width of the left-hand side name panel (in pixels?) */
193         float timeslide;                        /* for Time-Slide transform mode drawing - current frame? */
194 } SpaceAction;
195
196
197 /* -------------- Action Flags -------------- */
198
199 /* Action Channel flags */
200 typedef enum ACHAN_FLAG {
201         ACHAN_SELECTED  = (1<<0),
202         ACHAN_HILIGHTED = (1<<1),
203         ACHAN_HIDDEN    = (1<<2),
204         ACHAN_PROTECTED = (1<<3),
205         ACHAN_EXPANDED  = (1<<4),
206         ACHAN_SHOWIPO   = (1<<5),
207         ACHAN_SHOWCONS  = (1<<6),
208         ACHAN_MOVED     = (1<<31),
209 } ACHAN_FLAG; 
210
211
212 /* Action Group flags */
213 typedef enum AGRP_FLAG {
214         AGRP_SELECTED   = (1<<0),
215         AGRP_ACTIVE     = (1<<1),
216         AGRP_PROTECTED  = (1<<2),
217         AGRP_EXPANDED   = (1<<3),
218         
219         AGRP_TEMP               = (1<<30),
220         AGRP_MOVED              = (1<<31)
221 } AGRP_FLAG;
222
223 /* ------------ Action Editor Flags -------------- */
224
225 /* SpaceAction flag */
226 typedef enum SACTION_FLAG {
227                 /* during transform (only set for TimeSlide) */
228         SACTION_MOVING  = (1<<0),       
229                 /* show sliders (if relevant) */
230         SACTION_SLIDERS = (1<<1),       
231                 /* draw time in seconds instead of time in frames */
232         SACTION_DRAWTIME = (1<<2),
233                 /* don't filter action channels according to visibility */
234         SACTION_NOHIDE = (1<<3),
235                 /* don't kill overlapping keyframes after transform */
236         SACTION_NOTRANSKEYCULL = (1<<4),
237                 /* don't include keyframes that are out of view */
238         SACTION_HORIZOPTIMISEON = (1<<5),
239                 /* hack for moving pose-markers (temp flag)  */
240         SACTION_POSEMARKERS_MOVE = (1<<6),
241                 /* don't draw action channels using group colours (where applicable) */
242         SACTION_NODRAWGCOLORS = (1<<7)
243 } SACTION_FLAG; 
244
245 /* SpaceAction Mode Settings */
246 typedef enum SACTCONT_MODES {
247                 /* action (default) */
248         SACTCONT_ACTION = 0,
249                 /* editing of shapekey's IPO block */
250         SACTCONT_SHAPEKEY,
251                 /* editing of gpencil data */
252         SACTCONT_GPENCIL,
253                 /* dopesheet (unimplemented... future idea?) */
254         SACTCONT_DOPESHEET
255 } SACTCONTEXT_MODES;
256
257 /* SpaceAction AutoSnap Settings (also used by SpaceNLA) */
258 typedef enum SACTSNAP_MODES {
259                 /* no auto-snap */
260         SACTSNAP_OFF = 0,       
261                 /* snap to 1.0 frame/second intervals */
262         SACTSNAP_STEP,
263                 /* snap to actual frames/seconds (nla-action time) */
264         SACTSNAP_FRAME,
265                 /* snap to nearest marker */
266         SACTSNAP_MARKER,
267 } SACTSNAP_MODES;       
268  
269  
270 /* --------- Pose Flags --------------- */
271
272 /* Pose->flag */
273 typedef enum POSE_FLAG {
274                 /* results in armature_rebuild_pose being called */
275         POSE_RECALC = (1<<0),
276                 /* prevents any channel from getting overridden by anim from IPO */
277         POSE_LOCKED     = (1<<1),
278                 /* clears the POSE_LOCKED flag for the next time the pose is evaluated */
279         POSE_DO_UNLOCK  = (1<<2),
280                 /* pose has constraints which depend on time (used when depsgraph updates for a new frame) */
281         POSE_CONSTRAINTS_TIMEDEPEND = (1<<3),
282                 /* recalculate bone paths */
283         POSE_RECALCPATHS = (1<<4),
284 } POSE_FLAG;
285
286 /* PoseChannel (transform) flags */
287 enum    {
288         POSE_LOC                =       0x0001,
289         POSE_ROT                =       0x0002,
290         POSE_SIZE               =       0x0004,
291         POSE_IK_MAT             =       0x0008,
292         POSE_UNUSED2    =       0x0010,
293         POSE_UNUSED3    =       0x0020,
294         POSE_UNUSED4    =       0x0040,
295         POSE_UNUSED5    =       0x0080,
296         POSE_HAS_IK             =       0x0100,
297         POSE_CHAIN              =       0x0200,
298         POSE_DONE               =   0x0400,
299         POSE_KEY                =       0x1000,
300         POSE_STRIDE             =       0x2000
301 };
302
303 /* PoseChannel constflag (constraint detection) */
304 typedef enum PCHAN_CONSTFLAG {
305         PCHAN_HAS_IK            = (1<<0),
306         PCHAN_HAS_CONST         = (1<<1),
307                 /* only used for drawing Posemode, not stored in channel */
308         PCHAN_HAS_ACTION        = (1<<2),
309         PCHAN_HAS_TARGET        = (1<<3),
310                 /* only for drawing Posemode too */
311         PCHAN_HAS_STRIDE        = (1<<4)
312 } PCHAN_CONSTFLAG;
313
314 /* PoseChannel->ikflag */
315 typedef enum PCHAN_IKFLAG {
316         BONE_IK_NO_XDOF = (1<<0),
317         BONE_IK_NO_YDOF = (1<<1),
318         BONE_IK_NO_ZDOF = (1<<2),
319
320         BONE_IK_XLIMIT  = (1<<3),
321         BONE_IK_YLIMIT  = (1<<4),
322         BONE_IK_ZLIMIT  = (1<<5),
323         
324         BONE_IK_NO_XDOF_TEMP = (1<<10),
325         BONE_IK_NO_YDOF_TEMP = (1<<11),
326         BONE_IK_NO_ZDOF_TEMP = (1<<12)
327 } PCHAN_IKFLAG;
328
329
330 #endif
331