Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[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  * Contributor(s): Animation recode, Joshua Leung
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30
31 #ifndef DNA_ACTION_TYPES_H
32 #define DNA_ACTION_TYPES_H
33
34 #include "DNA_listBase.h"
35 #include "DNA_ID.h"
36 #include "DNA_gpencil_types.h"
37 #include "DNA_view2d_types.h"
38 #include "DNA_userdef_types.h"
39
40 struct SpaceLink;
41 struct Object;
42
43 /* ************************************************ */
44 /* Visualisation */
45
46 /* Motion Paths ------------------------------------ */
47 /* (used for Pose Channels and Objects) */
48
49 /* Data point for motion path */
50 typedef struct bMotionPathVert {
51         float co[3];                            /* coordinates of point in 3D-space */
52         int flag;                                       /* quick settings */
53 } bMotionPathVert;
54
55 /* Motion Path data cache - for elements providing transforms (i.e. Objects or PoseChannels) */
56 typedef struct bMotionPath {
57         bMotionPathVert *points;        /* path samples */
58         int     length;                                 /* the number of cached verts */
59         
60         int start_frame;                        /* for drawing paths, the start frame number */
61         int     end_frame;                              /* for drawing paths, the end frame number */
62         
63         int flag;                                       /* extra settings */
64 } bMotionPath;
65
66
67
68 /* Animation Visualisation Settings - for Objects or Armatures (not PoseChannels) */
69 typedef struct bAnimVizSettings {
70         int pad;
71         int pathflag;                           /* eMotionPath_Settings */
72         
73         int pathsf, pathef;                     /* start and end frames of path-calculation range */
74         int     pathbc, pathac;                 /* number of frames before/after current frame of path-calculation */
75 } bAnimVizSettings;
76
77 /* bMotionPathSettings->flag */
78 typedef enum eMotionPath_Settings {
79                 /* show frames on path */
80         MOTIONPATH_FLAG_FNUMS           = (1<<0),
81                 /* show keyframes on path */
82         MOTIONPATH_FLAG_KFRAS           = (1<<1),
83                 /* for bones - calculate head-points for curves instead of tips */
84         MOTIONPATH_FLAG_HEADS           = (1<<2),
85                 /* show path around current frame */
86         MOTIONPATH_FLAG_ACFRA           = (1<<3),
87                 /* show keyframe/frame numbers */
88         MOTIONPATH_FLAG_KFNOS           = (1<<4)
89 } eMotionPath_Settings;
90
91 /* ************************************************ */
92 /* Poses */
93
94 /* PoseChannel ------------------------------------ */
95
96 /* PoseChannel 
97  *
98  * A PoseChannel stores the results of Actions and transform information 
99  * with respect to the restposition of Armature bones 
100  */
101 typedef struct bPoseChannel {
102         struct bPoseChannel     *next, *prev;
103         
104         IDProperty                      *prop;          /* User-Defined Properties on this PoseChannel */                       
105         
106         ListBase                        constraints;/* Constraints that act on this PoseChannel */
107         char                            name[32];       /* Channels need longer names than normal blender objects */
108         
109         short                           flag;           /* dynamic, for detecting transform changes */
110         short                           constflag;  /* for quick detecting which constraints affect this channel */
111         short                           ikflag;         /* settings for IK bones */
112         short               selectflag; /* copy of bone flag, so you can work with library armatures */
113         short                           protectflag; /* protect channels from being transformed */
114         short                           agrp_index; /* index of action-group this bone belongs to (0 = default/no group) */
115         
116         int                                 pathlen;    /* for drawing paths, the amount of frames */
117         int                             pathsf;         /* for drawing paths, the start frame number */
118         int                                     pathef;         /* for drawing paths, the end frame number */
119         
120         struct Bone                     *bone;          /* set on read file or rebuild pose */
121         struct bPoseChannel *parent;    /* set on read file or rebuild pose */
122         struct bPoseChannel *child;             /* set on read file or rebuild pose, the 'ik' child, for b-bones */
123         struct ListBase          iktree;                /* only while evaluating pose */
124         
125         /* only while deform, stores precalculated b_bone deform mats,
126            dual quaternions */
127         void                            *b_bone_mats;   
128         void                            *dual_quat;
129         void                            *b_bone_dual_quats;
130         
131         float           loc[3];                         /* transforms - written in by actions or transform */
132         float           size[3];
133         
134         float           eul[3];                         /* rotations - written in by actions or transform (but only euler/quat in use at any one time!) */
135         float           quat[4];
136         short           rotmode;                        /* for now either quat (0), or xyz-euler (1) */
137         short           pad;
138         
139         float           chan_mat[4][4];         /* matrix result of loc/quat/size , and where we put deform in, see next line */
140         float           pose_mat[4][4];         /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat */
141         float           constinv[4][4];         /* inverse result of constraints. doesn't include effect of restposition, parent, and local transform*/
142         
143         float           pose_head[3];           /* actually pose_mat[3] */
144         float           pose_tail[3];           /* also used for drawing help lines... */
145         
146         float           limitmin[3], limitmax[3];       /* DOF constraint */
147         float           stiffness[3];                           /* DOF stiffness */
148         float           ikstretch;
149         float           ikrotweight;            /* weight of joint rotation constraint */
150         float           iklinweight;            /* weight of joint stretch constraint */
151
152         float           *path;                          /* totpath x 3 x float */
153         struct Object *custom;                  /* draws custom object instead of this channel */
154 } bPoseChannel;
155
156
157 /* PoseChannel (transform) flags */
158 typedef enum ePchan_Flag {
159         POSE_LOC                =       0x0001,
160         POSE_ROT                =       0x0002,
161         POSE_SIZE               =       0x0004,
162         POSE_IK_MAT             =       0x0008,
163         POSE_UNUSED2    =       0x0010,
164         POSE_UNUSED3    =       0x0020,
165         POSE_UNUSED4    =       0x0040,
166         POSE_UNUSED5    =       0x0080,
167         POSE_HAS_IK             =       0x0100,
168         POSE_CHAIN              =       0x0200,
169         POSE_DONE               =   0x0400,
170         POSE_KEY                =       0x1000,
171         POSE_STRIDE             =       0x2000,
172         POSE_IKTREE             =   0x4000,
173 } ePchan_Flag;
174
175 /* PoseChannel constflag (constraint detection) */
176 typedef enum ePchan_ConstFlag {
177         PCHAN_HAS_IK            = (1<<0),
178         PCHAN_HAS_CONST         = (1<<1),
179                 /* only used for drawing Posemode, not stored in channel */
180         PCHAN_HAS_ACTION        = (1<<2),
181         PCHAN_HAS_TARGET        = (1<<3),
182                 /* only for drawing Posemode too */
183         PCHAN_HAS_STRIDE        = (1<<4)
184 } ePchan_ConstFlag;
185
186 /* PoseChannel->ikflag */
187 typedef enum ePchan_IkFlag {
188         BONE_IK_NO_XDOF = (1<<0),
189         BONE_IK_NO_YDOF = (1<<1),
190         BONE_IK_NO_ZDOF = (1<<2),
191
192         BONE_IK_XLIMIT  = (1<<3),
193         BONE_IK_YLIMIT  = (1<<4),
194         BONE_IK_ZLIMIT  = (1<<5),
195         
196         BONE_IK_ROTCTL  = (1<<6),
197         BONE_IK_LINCTL  = (1<<7),
198
199         BONE_IK_NO_XDOF_TEMP = (1<<10),
200         BONE_IK_NO_YDOF_TEMP = (1<<11),
201         BONE_IK_NO_ZDOF_TEMP = (1<<12),
202
203 } ePchan_IkFlag;
204
205 /* PoseChannel->rotmode */
206 typedef enum ePchan_RotMode {
207                 /* quaternion rotations (default, and for older Blender versions) */
208         PCHAN_ROT_QUAT  = 0,
209                 /* euler rotations - keep in sync with enum in BLI_arithb.h */
210         PCHAN_ROT_XYZ = 1,              /* Blender 'default' (classic) - must be as 1 to sync with PoseChannel rotmode */
211         PCHAN_ROT_XZY,
212         PCHAN_ROT_YXZ,
213         PCHAN_ROT_YZX,
214         PCHAN_ROT_ZXY,
215         PCHAN_ROT_ZYX,
216         /* NOTE: space is reserved here for 18 other possible 
217          * euler rotation orders not implemented 
218          */
219         PCHAN_ROT_MAX,  /* sentinel for Py API*/
220                 /* axis angle rotations */
221         PCHAN_ROT_AXISANGLE = -1
222 } ePchan_RotMode;
223
224 /* Pose ------------------------------------ */
225
226 /* Pose-Object. 
227  *
228  * It is only found under ob->pose. It is not library data, even
229  * though there is a define for it (hack for the outliner).
230  */
231 typedef struct bPose {
232         ListBase chanbase;                      /* list of pose channels */
233         
234         short flag, proxy_layer;        /* proxy layer: copy from armature, gets synced */
235         
236         float ctime;                            /* local action time of this pose */
237         float stride_offset[3];         /* applied to object */
238         float cyclic_offset[3];         /* result of match and cycles, applied in where_is_pose() */
239         
240         
241         ListBase agroups;                       /* list of bActionGroups */
242         
243         int active_group;                       /* index of active group (starts from 1) */
244         int     iksolver;                               /* ik solver to use, see ePose_IKSolverType */
245         void *ikdata;                           /* temporary IK data, depends on the IK solver. Not saved in file */
246         void *ikparam;                          /* IK solver parameters, structure depends on iksolver */ 
247 } bPose;
248
249
250 /* Pose->flag */
251 typedef enum ePose_Flags {
252                 /* results in armature_rebuild_pose being called */
253         POSE_RECALC = (1<<0),
254                 /* prevents any channel from getting overridden by anim from IPO */
255         POSE_LOCKED     = (1<<1),
256                 /* clears the POSE_LOCKED flag for the next time the pose is evaluated */
257         POSE_DO_UNLOCK  = (1<<2),
258                 /* pose has constraints which depend on time (used when depsgraph updates for a new frame) */
259         POSE_CONSTRAINTS_TIMEDEPEND = (1<<3),
260                 /* recalculate bone paths */
261         POSE_RECALCPATHS = (1<<4),
262             /* set by armature_rebuild_pose to give a chance to the IK solver to rebuild IK tree */
263         POSE_WAS_REBUILT = (1<<5),
264             /* set by game_copy_pose to indicate that this pose is used in the game engine */
265         POSE_GAME_ENGINE = (1<<6),
266 } ePose_Flags;
267
268 /* bPose->iksolver and bPose->ikparam->iksolver */
269 typedef enum {
270         IKSOLVER_LEGACY = 0,
271         IKSOLVER_ITASC,
272 } ePose_IKSolverType;
273
274 /* header for all bPose->ikparam structures */
275 typedef struct bIKParam {
276         int   iksolver;
277 } bIKParam;
278
279 /* bPose->ikparam when bPose->iksolver=1 */
280 typedef struct bItasc {
281         int   iksolver;
282         float precision;
283         short numiter;
284         short numstep;
285         float minstep;
286         float maxstep;
287         short solver;   
288         short flag;
289         float feedback;
290         float maxvel;   /* max velocity to SDLS solver */
291         float dampmax;  /* maximum damping for DLS solver */
292         float dampeps;  /* threshold of singular value from which the damping start progressively */
293 } bItasc;
294
295 /* bItasc->flag */
296 typedef enum {
297         ITASC_AUTO_STEP = (1<<0),
298         ITASC_INITIAL_REITERATION = (1<<1),
299         ITASC_REITERATION = (1<<2),
300         ITASC_SIMULATION = (1<<3),
301 } eItasc_Flags;
302
303 /* bItasc->solver */
304 typedef enum {
305         ITASC_SOLVER_SDLS = 0,  /* selective damped least square, suitable for CopyPose constraint */
306         ITASC_SOLVER_DLS                /* damped least square with numerical filtering of damping */
307 } eItasc_Solver;
308
309 /* ************************************************ */
310 /* Action */
311
312 /* Groups -------------------------------------- */
313
314 /* Action-Channel Group (agrp)
315
316  * These are stored as a list per-Action, and are only used to 
317  * group that Action's channels in an Animation Editor. 
318  *
319  * Even though all FCurves live in a big list per Action, each group they are in also
320  * holds references to the achans within that list which belong to it. Care must be taken to
321  * ensure that action-groups never end up being the sole 'owner' of a channel.
322  * 
323  * This is also exploited for bone-groups. Bone-Groups are stored per bPose, and are used 
324  * primarily to colour bones in the 3d-view. There are other benefits too, but those are mostly related
325  * to Action-Groups.
326  */
327 typedef struct bActionGroup {
328         struct bActionGroup *next, *prev;
329         
330         ListBase channels;                      /* Note: this must not be touched by standard listbase functions which would clear links to other channels */
331         
332         int flag;                                       /* settings for this action-group */
333         int customCol;                          /* index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set) */                          
334         char name[64];                          /* name of the group */
335         
336         ThemeWireColor cs;                      /* color set to use when customCol == -1 */
337 } bActionGroup;
338
339 /* Action Group flags */
340 typedef enum eActionGroup_Flag {
341                 /* group is selected */
342         AGRP_SELECTED   = (1<<0),
343                 /* group is 'active' / last selected one */
344         AGRP_ACTIVE     = (1<<1),
345                 /* keyframes/channels belonging to it cannot be edited */
346         AGRP_PROTECTED  = (1<<2),
347                 /* for UI, sub-channels are shown */
348         AGRP_EXPANDED   = (1<<3),
349                 /* sub-channels are not evaluated */
350         AGRP_MUTED              = (1<<4),
351                 /* sub-channels are not visible in Graph Editor */
352         AGRP_NOTVISIBLE = (1<<5),
353         
354         AGRP_TEMP               = (1<<30),
355         AGRP_MOVED              = (1<<31)
356 } eActionGroup_Flag;
357
358
359 /* Actions -------------------------------------- */
360
361 /* Action - reusable F-Curve 'bag'  (act) 
362  *
363  * This contains F-Curves that may affect settings from more than one ID blocktype and/or 
364  * datablock (i.e. sub-data linked/used directly to the ID block that the animation data is linked to), 
365  * but with the restriction that the other unrelated data (i.e. data that is not directly used or linked to
366  * by the source ID block).
367  *
368  * It serves as a 'unit' of reusable animation information (i.e. keyframes/motion data), that 
369  * affects a group of related settings (as defined by the user). 
370  */
371 typedef struct bAction {
372         ID      id;                             /* ID-serialisation for relinking */
373         
374         ListBase curves;        /* function-curves (FCurve) */
375         ListBase chanbase;      /* legacy data - Action Channels (bActionChannel) in pre-2.5 animation system */
376         ListBase groups;        /* groups of function-curves (bActionGroup) */
377         ListBase markers;       /* markers local to the Action (used to provide Pose-Libraries) */
378         
379         int flag;                       /* settings for this action */
380         int active_marker;      /* index of the active marker */
381 } bAction;
382
383
384 /* Flags for the action */
385 typedef enum eAction_Flags {
386                 /* flags for displaying in UI */
387         ACT_COLLAPSED   = (1<<0),
388         ACT_SELECTED    = (1<<1),
389         
390                 /* flags for evaluation/editing */
391         ACT_MUTED               = (1<<9),
392         ACT_PROTECTED   = (1<<10),
393         ACT_DISABLED    = (1<<11),
394 } eAction_Flags;
395
396
397 /* ************************************************ */
398 /* Action/Dopesheet Editor */
399
400 /* Storage for Dopesheet/Grease-Pencil Editor data */
401 typedef struct bDopeSheet {
402         ID              *source;                /* currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil) */
403         ListBase chanbase;              /* cache for channels (only initialised when pinned) */  // XXX not used!
404         
405         int filterflag;                 /* flags to use for filtering data */
406         int flag;                               /* standard flags */
407 } bDopeSheet;
408
409
410 /* DopeSheet filter-flag */
411 typedef enum DOPESHEET_FILTERFLAG {
412                 /* general filtering */
413         ADS_FILTER_ONLYSEL                      = (1<<0),       /* only include channels relating to selected data */
414         
415                 /* temporary (runtime flags) */
416         ADS_FILTER_ONLYDRIVERS          = (1<<1),       /* for 'Drivers' editor - only include Driver data from AnimData */
417         ADS_FILTER_ONLYNLA                      = (1<<2),       /* for 'NLA' editor - only include NLA data from AnimData */
418         ADS_FILTER_SELEDIT                      = (1<<3),       /* for Graph Editor - used to indicate whether to include a filtering flag or not */
419         
420                 /* datatype-based filtering */
421         ADS_FILTER_NOSHAPEKEYS          = (1<<6),
422         ADS_FILTER_NOCAM                        = (1<<10),
423         ADS_FILTER_NOMAT                        = (1<<11),
424         ADS_FILTER_NOLAM                        = (1<<12),
425         ADS_FILTER_NOCUR                        = (1<<13),
426         ADS_FILTER_NOWOR                        = (1<<14),
427         ADS_FILTER_NOSCE                        = (1<<15),
428         ADS_FILTER_NOPART                       = (1<<16),
429         ADS_FILTER_NOMBA                        = (1<<17),
430         ADS_FILTER_NOARM                        = (1<<18),
431         
432                 /* NLA-specific filters */
433         ADS_FILTER_NLA_NOACT            = (1<<20),      /* if the AnimData block has no NLA data, don't include to just show Action-line */
434         
435                 /* combination filters (some only used at runtime) */
436         ADS_FILTER_NOOBDATA = (ADS_FILTER_NOCAM|ADS_FILTER_NOMAT|ADS_FILTER_NOLAM|ADS_FILTER_NOCUR|ADS_FILTER_NOPART),
437 } DOPESHEET_FILTERFLAG; 
438
439 /* DopeSheet general flags */
440 //typedef enum DOPESHEET_FLAG {
441         
442 //} DOPESHEET_FLAG;
443
444
445
446 /* Action Editor Space. This is defined here instead of in DNA_space_types.h */
447 typedef struct SpaceAction {
448         struct SpaceLink *next, *prev;
449         ListBase regionbase;            /* storage of regions for inactive spaces */
450         int spacetype;
451         float blockscale;
452
453         short blockhandler[8];
454
455         View2D v2d;                                     /* depricated, copied to region */
456         
457         bAction         *action;                /* the currently active action */
458         bDopeSheet      ads;                    /* the currently active context (when not showing action) */
459         
460         char  mode, autosnap;           /* mode: editing context; autosnap: automatic keyframe snapping mode   */
461         short flag, actnr;                      /* flag: bitmapped settings; */
462         short pin, lock;                        /* pin: keep showing current action; actnr: used for finding chosen action from menu; lock: lock time to other windows */
463         short actwidth;                         /* width of the left-hand side name panel (in pixels?) */  // XXX depreceated!
464         float timeslide;                        /* for Time-Slide transform mode drawing - current frame? */
465 } SpaceAction;
466
467 /* SpaceAction flag */
468 typedef enum eSAction_Flag {
469                 /* during transform (only set for TimeSlide) */
470         SACTION_MOVING  = (1<<0),       
471                 /* show sliders (if relevant) */
472         SACTION_SLIDERS = (1<<1),       
473                 /* draw time in seconds instead of time in frames */
474         SACTION_DRAWTIME = (1<<2),
475                 /* don't filter action channels according to visibility */
476         SACTION_NOHIDE = (1<<3),
477                 /* don't kill overlapping keyframes after transform */
478         SACTION_NOTRANSKEYCULL = (1<<4),
479                 /* don't include keyframes that are out of view */
480         SACTION_HORIZOPTIMISEON = (1<<5),
481                 /* hack for moving pose-markers (temp flag)  */
482         SACTION_POSEMARKERS_MOVE = (1<<6),
483                 /* don't draw action channels using group colours (where applicable) */
484         SACTION_NODRAWGCOLORS = (1<<7),
485                 /* don't draw current frame number beside frame indicator */
486         SACTION_NODRAWCFRANUM = (1<<8),
487 } eSAction_Flag;        
488
489 /* SpaceAction Mode Settings */
490 // XXX should this be used by other editors too?
491 typedef enum eAnimEdit_Context {
492                 /* action (default) */
493         SACTCONT_ACTION = 0,
494                 /* editing of shapekey's IPO block */
495         SACTCONT_SHAPEKEY,
496                 /* editing of gpencil data */
497         SACTCONT_GPENCIL,
498                 /* dopesheet */
499         SACTCONT_DOPESHEET,
500 } eAnimEdit_Context;
501
502 /* SpaceAction AutoSnap Settings (also used by other Animation Editors) */
503 typedef enum eAnimEdit_AutoSnap {
504                 /* no auto-snap */
505         SACTSNAP_OFF = 0,       
506                 /* snap to 1.0 frame/second intervals */
507         SACTSNAP_STEP,
508                 /* snap to actual frames/seconds (nla-action time) */
509         SACTSNAP_FRAME,
510                 /* snap to nearest marker */
511         SACTSNAP_MARKER,
512 } eAnimEdit_AutoSnap;
513
514
515 /* ************************************************ */
516 /* Legacy Data */
517
518 /* WARNING: Action Channels are now depreceated... they were part of the old animation system!
519  *                (ONLY USED FOR DO_VERSIONS...)
520  * 
521  * Action Channels belong to Actions. They are linked with an IPO block, and can also own 
522  * Constraint Channels in certain situations. 
523  *
524  * Action-Channels can only belong to one group at a time, but they still live the Action's
525  * list of achans (to preserve backwards compatability, and also minimise the code
526  * that would need to be recoded). Grouped achans are stored at the start of the list, according
527  * to the position of the group in the list, and their position within the group. 
528  */
529 typedef struct bActionChannel {
530         struct bActionChannel   *next, *prev;
531         bActionGroup                    *grp;                                   /* Action Group this Action Channel belongs to */
532         
533         struct Ipo                              *ipo;                                   /* IPO block this action channel references */
534         ListBase                                constraintChannels;             /* Constraint Channels (when Action Channel represents an Object or Bone) */
535         
536         int             flag;                   /* settings accessed via bitmapping */
537         char    name[32];               /* channel name */
538         int             temp;                   /* temporary setting - may be used to indicate group that channel belongs to during syncing  */
539 } bActionChannel;
540
541 /* Action Channel flags (ONLY USED FOR DO_VERSIONS...) */
542 typedef enum ACHAN_FLAG {
543         ACHAN_SELECTED  = (1<<0),
544         ACHAN_HILIGHTED = (1<<1),
545         ACHAN_HIDDEN    = (1<<2),
546         ACHAN_PROTECTED = (1<<3),
547         ACHAN_EXPANDED  = (1<<4),
548         ACHAN_SHOWIPO   = (1<<5),
549         ACHAN_SHOWCONS  = (1<<6),
550         ACHAN_MOVED     = (1<<31),
551 } ACHAN_FLAG; 
552
553
554 #endif