ea145e7ef79a230842b1bf6331e97dddee26d451
[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_view2d_types.h"
36
37 struct SpaceLink;
38 struct Object;
39
40 /* -------------- Poses ----------------- */
41
42 /* PoseChannel stores the results of Actions (ipos) and transform information 
43    with respect to the restposition of Armature bones */
44 typedef struct bPoseChannel {
45         struct bPoseChannel     *next, *prev;
46         ListBase                        constraints;/* Constraints that act on this PoseChannel */
47         char                            name[32];       /* Channels need longer names than normal blender objects */
48         
49         short                           flag;           /* dynamic, for detecting transform changes */
50         short                           constflag;  /* for quick detecting which constraints affect this channel */
51         short                           ikflag;         /* settings for IK bones */
52         short               selectflag; /* copy of bone flag, so you can work with library armatures */
53         short                           protectflag; /* protect channels from being transformed */
54         short                           customCol;      /* index of custom color set to use (0=default - used for all old files) */
55         
56         int                                 pathlen;    /* for drawing paths, the amount of frames */
57         int                             pathsf;         /* for drawing paths, the start frame number */
58         int                                     pathef;         /* for drawing paths, the end frame number */
59         
60         struct Bone                     *bone;          /* set on read file or rebuild pose */
61         struct bPoseChannel *parent;    /* set on read file or rebuild pose */
62         struct bPoseChannel *child;             /* set on read file or rebuild pose, the 'ik' child, for b-bones */
63         struct ListBase          iktree;                /* only while evaluating pose */
64         
65         /* only while deform, stores precalculated b_bone deform mats,
66            dual quaternions */
67         void                            *b_bone_mats;   
68         void                            *dual_quat;
69         void                            *b_bone_dual_quats;
70         
71         float           loc[3];                         /* written in by actions or transform */
72         float           size[3];
73         float           quat[4];
74         
75         float           chan_mat[4][4];         /* matrix result of loc/quat/size , and where we put deform in, see next line */
76         float           pose_mat[4][4];         /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat */
77         float           constinv[4][4];         /* inverse result of constraints. doesn't include effect of restposition, parent, and local transform*/
78         
79         float           pose_head[3];           /* actually pose_mat[3] */
80         float           pose_tail[3];           /* also used for drawing help lines... */
81         
82         float           limitmin[3], limitmax[3];       /* DOF constraint */
83         float           stiffness[3];                           /* DOF stiffness */
84         float           ikstretch;
85         
86         float           *path;                          /* totpath x 3 x float */
87         struct Object *custom;                  /* draws custom object instead of this channel */
88 } bPoseChannel;
89
90 /* Pose-Object. It is only found under ob->pose. It is not library data, even
91  * though there is a define for it (hack for the outliner).
92  */
93 typedef struct bPose {
94         ListBase chanbase;                      /* list of pose channels */
95         
96         short flag, proxy_layer;        /* proxy layer: copy from armature, gets synced */
97         
98         float ctime;                            /* local action time of this pose */
99         float stride_offset[3];         /* applied to object */
100         float cyclic_offset[3];         /* result of match and cycles, applied in where_is_pose() */
101 } bPose;
102
103
104 /* ------------- Action  ---------------- */
105
106 /* Action-Channel Group. These are stored as a list per-Action, and are only used to 
107  * group that Action's Action-Channels when displayed in the Action Editor. 
108  *
109  * Even though all Action-Channels live in a big list per Action, each group they are in also
110  * holds references to the achans within that list which belong to it. Care must be taken to
111  * ensure that action-groups never end up being the sole 'owner' of a channel.
112  */
113 typedef struct bActionGroup {
114         struct bActionGroup *next, *prev;
115         
116         int flag;                               /* settings for this action-group */
117         int pad;                                
118         char name[32];                  /* name of the group */
119         
120         ListBase channels;              /* Note: this must not be touched by standard listbase functions */
121 } bActionGroup;
122
123 /* Action Channels belong to Actions. They are linked with an IPO block, and can also own 
124  * Constraint Channels in certain situations. 
125  *
126  * Action-Channels can only belong to one group at a time, but they still live the Action's
127  * list of achans (to preserve backwards compatability, and also minimise the code
128  * that would need to be recoded). Grouped achans are stored at the start of the list, according
129  * to the position of the group in the list, and their position within the group. 
130  */
131 typedef struct bActionChannel {
132         struct bActionChannel   *next, *prev;
133         bActionGroup                    *grp;                                   /* Action Group this Action Channel belongs to */
134         
135         struct Ipo                              *ipo;                                   /* IPO block this action channel references */
136         ListBase                                constraintChannels;             /* Constraint Channels (when Action Channel represents an Object or Bone) */
137         
138         int             flag;                   /* settings accessed via bitmapping */
139         char    name[32];               /* channel name */
140         int             reserved1;
141 } bActionChannel;
142
143 /* Action. A recyclable block that contains a series of Action Channels (ipo), which define 
144  * a clip of reusable animation for use in the NLA.
145  */
146 typedef struct bAction {
147         ID                              id;
148         
149         ListBase                chanbase;       /* Action Channels in this Action */
150         ListBase                groups;         /* Action Groups in the Action */
151         ListBase                markers;        /* TimeMarkers local to this Action for labelling 'poses' */
152         
153         int active_marker;                      /* Index of active-marker (first marker = 1) */
154         int pad;
155 } bAction;
156
157
158 /* ------------- Action Editor --------------------- */
159
160 /* Action Editor Space. This is defined here instead of in DNA_space_types.h */
161 typedef struct SpaceAction {
162         struct SpaceLink *next, *prev;
163         int spacetype;
164         float blockscale;
165         struct ScrArea *area;
166
167         short blockhandler[8];
168
169         View2D v2d;     
170         
171         bAction         *action;                /* the currently active action */
172         short flag, autosnap;           /* flag: bitmapped settings; autosnap: automatic keyframe snapping mode */
173         short pin, actnr, lock;         /* pin: keep showing current action; actnr: used for finding chosen action from menu; lock: lock time to other windows */
174         short actwidth;                         /* width of the left-hand side name panel (in pixels?) */
175         float timeslide;                        /* for Time-Slide transform mode drawing - current frame? */
176 } SpaceAction;
177
178
179 /* -------------- Action Flags -------------- */
180
181 /* Action Channel flags */
182 typedef enum ACHAN_FLAG {
183         ACHAN_SELECTED  = (1<<0),
184         ACHAN_HILIGHTED = (1<<1),
185         ACHAN_HIDDEN    = (1<<2),
186         ACHAN_PROTECTED = (1<<3),
187         ACHAN_EXPANDED  = (1<<4),
188         ACHAN_SHOWIPO   = (1<<5),
189         ACHAN_SHOWCONS  = (1<<6),
190         ACHAN_MOVED     = (1<<31),
191 } ACHAN_FLAG; 
192
193
194 /* Action Group flags */
195 typedef enum AGRP_FLAG {
196         AGRP_SELECTED   = (1<<0),
197         AGRP_ACTIVE     = (1<<1),
198         AGRP_PROTECTED  = (1<<2),
199         AGRP_EXPANDED   = (1<<3),
200         AGRP_TEMP               = (1<<30),
201         AGRP_MOVED              = (1<<31)
202 } AGRP_FLAG;
203
204 /* ------------ Action Editor Flags -------------- */
205
206 /* SpaceAction flag */
207 typedef enum SACTION_FLAG {
208                 /* during transform */
209         SACTION_MOVING  = (1<<0),       
210                 /* show sliders (if relevant) */
211         SACTION_SLIDERS = (1<<1),       
212                 /* draw time in seconds instead of time in frames */
213         SACTION_DRAWTIME = (1<<2),
214                 /* don't filter action channels according to visibility */
215         SACTION_NOHIDE = (1<<3)
216 } SACTION_FLAG; 
217
218 /* SpaceAction AutoSnap Settings (also used by SpaceNLA) */
219 typedef enum SACTSNAP_MODES {
220                 /* no auto-snap */
221         SACTSNAP_OFF = 0,       
222                 /* snap to 1.0 frame/second intervals */
223         SACTSNAP_STEP,
224                 /* snap to actual frames/seconds (nla-action time) */
225         SACTSNAP_FRAME,
226                 /* snap to nearest marker */
227         SACTSNAP_MARKER,
228 } SACTSNAP_MODES;       
229  
230  
231 /* --------- Pose Flags --------------- */
232
233 /* Pose->flag */
234 typedef enum POSE_FLAG {
235                 /* results in armature_rebuild_pose being called */
236         POSE_RECALC = (1<<0),
237                 /* prevents any channel from getting overridden by anim from IPO */
238         POSE_LOCKED     = (1<<1),
239                 /* clears the POSE_LOCKED flag for the next time the pose is evaluated */
240         POSE_DO_UNLOCK  = (1<<2)
241 } POSE_FLAG;
242
243 /* PoseChannel (transform) flags */
244 enum    {
245         POSE_LOC                =       0x0001,
246         POSE_ROT                =       0x0002,
247         POSE_SIZE               =       0x0004,
248         POSE_IK_MAT             =       0x0008,
249         POSE_UNUSED2    =       0x0010,
250         POSE_UNUSED3    =       0x0020,
251         POSE_UNUSED4    =       0x0040,
252         POSE_UNUSED5    =       0x0080,
253         POSE_HAS_IK             =       0x0100,
254         POSE_CHAIN              =       0x0200,
255         POSE_DONE               =   0x0400,
256         POSE_KEY                =       0x1000,
257         POSE_STRIDE             =       0x2000
258 };
259
260 /* PoseChannel constflag (constraint detection) */
261 typedef enum PCHAN_CONSTFLAG {
262         PCHAN_HAS_IK            = (1<<0),
263         PCHAN_HAS_CONST         = (1<<1),
264                 /* only used for drawing Posemode, not stored in channel */
265         PCHAN_HAS_ACTION        = (1<<2),
266         PCHAN_HAS_TARGET        = (1<<3),
267                 /* only for drawing Posemode too */
268         PCHAN_HAS_STRIDE        = (1<<4)
269 } PCHAN_CONSTFLAG;
270
271 /* PoseChannel->ikflag */
272 typedef enum PCHAN_IKFLAG {
273         BONE_IK_NO_XDOF = (1<<0),
274         BONE_IK_NO_YDOF = (1<<1),
275         BONE_IK_NO_ZDOF = (1<<2),
276
277         BONE_IK_XLIMIT  = (1<<3),
278         BONE_IK_YLIMIT  = (1<<4),
279         BONE_IK_ZLIMIT  = (1<<5),
280         
281         BONE_IK_NO_XDOF_TEMP = (1<<10),
282         BONE_IK_NO_YDOF_TEMP = (1<<11),
283         BONE_IK_NO_ZDOF_TEMP = (1<<12)
284 } PCHAN_IKFLAG;
285
286
287 #endif
288