Merging r44140 through r44226 from trunk into soc-2011-tomato
[blender.git] / source / blender / makesdna / DNA_constraint_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): 2007, Joshua Leung, major recode
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * Constraint DNA data
27  */
28
29 /** \file DNA_constraint_types.h
30  *  \ingroup DNA
31  */
32
33 #ifndef __DNA_CONSTRAINT_TYPES_H__
34 #define __DNA_CONSTRAINT_TYPES_H__
35
36 #include "DNA_defs.h"
37 #include "DNA_ID.h"
38 #include "DNA_listBase.h"
39
40 struct Action;
41 struct Text;
42 struct Ipo;
43
44 /* channels reside in Object or Action (ListBase) constraintChannels */
45 // XXX depreceated... old AnimSys
46 typedef struct bConstraintChannel {
47         struct bConstraintChannel *next, *prev;
48         struct Ipo                      *ipo;
49         short           flag;
50         char            name[30];
51 } bConstraintChannel;
52
53 /* A Constraint */
54 typedef struct bConstraint {
55         struct bConstraint *next, *prev;
56         
57         void            *data;          /*      Constraint data (a valid constraint type) */
58         short           type;           /*      Constraint type */
59         short           flag;           /*      Flag - General Settings */
60         
61         char            ownspace;       /*      Space that owner should be evaluated in         */
62         char            tarspace;       /*      Space that target should be evaluated in (only used if 1 target) */
63         
64         char            name[64];       /*      Constraint name, MAX_NAME */
65         
66         short           pad;
67         
68         float           enforce;        /*      Amount of influence exherted by constraint (0.0-1.0) */
69         float           headtail;       /*      Point along subtarget bone where the actual target is. 0=head (default for all), 1=tail*/
70         
71         struct Ipo *ipo    DNA_DEPRECATED;              /* local influence ipo or driver */  /* old animation system, deprecated for 2.5 */
72         
73         /* below are readonly fields that are set at runtime by the solver for use in the GE (only IK atm) */
74         float       lin_error;          /* residual error on constraint expressed in blender unit*/
75         float       rot_error;          /* residual error on constraint expressed in radiant */
76 } bConstraint;
77
78
79 /* Multiple-target constraints ---------------------  */
80
81 /* This struct defines a constraint target.
82  * It is used during constraint solving regardless of how many targets the
83  * constraint has.
84  */
85 typedef struct bConstraintTarget {
86         struct bConstraintTarget *next, *prev;
87
88         struct Object *tar;                     /* object to use as target */
89         char subtarget[64];             /* subtarget - pchan or vgroup name, MAX_ID_NAME-2 */
90         
91         float matrix[4][4];             /* matrix used during constraint solving - should be cleared before each use */
92         
93         short space;                    /* space that target should be evaluated in (overrides bConstraint->tarspace) */
94         short flag;                             /* runtime settings (for editor, etc.) */
95         short type;                             /* type of target (B_CONSTRAINT_OB_TYPE) */
96         short rotOrder;                 /* rotation order for target (as defined in BLI_math.h) */
97 } bConstraintTarget;
98
99 /* bConstraintTarget -> flag */
100 typedef enum B_CONSTRAINT_TARGET_FLAG {
101         CONSTRAINT_TAR_TEMP = (1<<0)            /* temporary target-struct that needs to be freed after use */
102 } B_CONSTRAINT_TARGET_FLAG;
103
104 /* bConstraintTarget/bConstraintOb -> type */
105 typedef enum B_CONSTRAINT_OB_TYPE {
106         CONSTRAINT_OBTYPE_OBJECT = 1,   /*      string is ""                            */
107         CONSTRAINT_OBTYPE_BONE,                 /*      string is bone-name             */
108         CONSTRAINT_OBTYPE_VERT,                 /*      string is vertex-group name     */
109         CONSTRAINT_OBTYPE_CV                    /*      string is vertex-group name - is not available until curves get vgroups */
110 } B_CONSTRAINT_OB_TYPE;
111
112
113
114 /* Python Script Constraint */
115 typedef struct bPythonConstraint {      
116         struct Text *text;              /* text-buffer (containing script) to execute */
117         IDProperty *prop;               /* 'id-properties' used to store custom properties for constraint */
118         
119         int flag;                               /* general settings/state indicators accessed by bitmapping */
120         int tarnum;                             /* number of targets - usually only 1-3 are needed */
121         
122         ListBase targets;               /* a list of targets that this constraint has (bConstraintTarget-s) */
123         
124         struct Object *tar;             /* target from previous implementation (version-patch sets this to NULL on file-load) */
125         char subtarget[64];             /* subtarger from previous implentation (version-patch sets this to "" on file-load), MAX_ID_NAME-2 */
126 } bPythonConstraint;
127
128
129 /* Inverse-Kinematics (IK) constraint
130  * This constraint supports a variety of mode determine by the type field
131  * according to B_CONSTRAINT_IK_TYPE.
132  * Some fields are used by all types, some are specific to some types
133  * This is indicated in the comments for each field
134  */
135 typedef struct bKinematicConstraint {
136         struct Object           *tar;                   /* All: target object in case constraint needs a target */
137         short           iterations;             /* All: Maximum number of iterations to try */
138         short           flag;                   /* All & CopyPose: some options Like CONSTRAINT_IK_TIP */
139         short           rootbone;               /* All: index to rootbone, if zero go all the way to mother bone */
140         short           max_rootbone;   /* CopyPose: for auto-ik, maximum length of chain */
141         char            subtarget[64];  /* All: String to specify sub-object target, MAX_ID_NAME-2 */
142         struct Object           *poletar;                       /* All: Pole vector target */
143         char            polesubtarget[64];      /* All: Pole vector sub-object target, MAX_ID_NAME-2 */
144         float           poleangle;                      /* All: Pole vector rest angle */
145         float           weight;                 /* All: Weight of constraint in IK tree */
146         float           orientweight;   /* CopyPose: Amount of rotation a target applies on chain */
147         float           grabtarget[3];  /* CopyPose: for target-less IK */
148         short           type;                   /* subtype of IK constraint: B_CONSTRAINT_IK_TYPE */
149         short           mode;                   /* Distance: how to limit in relation to clamping sphere: LIMITDIST_.. */
150         float           dist;                   /* Distance: distance (radius of clamping sphere) from target */
151 } bKinematicConstraint;
152
153 typedef enum B_CONSTRAINT_IK_TYPE {
154         CONSTRAINT_IK_COPYPOSE = 0,             /* 'standard' IK constraint: match position and/or orientation of target */
155         CONSTRAINT_IK_DISTANCE                  /* maintain distance with target */
156 } B_CONSTRAINT_IK_TYPE;
157
158
159 /* Spline IK Constraint 
160  * Aligns 'n' bones to the curvature defined by the curve,
161  * with the chain ending on the bone that owns this constraint, 
162  * and starting on the nth parent.
163  */
164 typedef struct bSplineIKConstraint {
165                 /* target(s) */
166         struct Object *tar;             /* curve object (with follow path enabled) which drives the bone chain */
167         
168                 /* binding details */
169         float           *points;        /* array of numpoints items, denoting parametric positions along curve that joints should follow */
170         short           numpoints;      /* number of points to bound in points array */
171         short           chainlen;       /* number of bones ('n') that are in the chain */
172         
173                 /* settings */  
174         short flag;                             /* general settings for constraint */
175         short xzScaleMode;              /* method used for determining the x & z scaling of the bones */
176 } bSplineIKConstraint;
177
178
179 /* Single-target subobject constraints ---------------------  */
180
181 /* Track To Constraint */
182 typedef struct bTrackToConstraint {
183         struct Object           *tar;
184         int                     reserved1; /* I'll be using reserved1 and reserved2 as Track and Up flags,
185                                 * not sure if that's what they were intented for anyway.
186                                 * Not sure either if it would create backward incompatibility if I were to rename them.
187                                 * - theeth*/
188         int                     reserved2;
189         int                     flags;
190         int                     pad;
191         char            subtarget[64];  /* MAX_ID_NAME-2 */
192 } bTrackToConstraint;
193
194 /* Copy Rotation Constraint */
195 typedef struct bRotateLikeConstraint {
196         struct Object           *tar;
197         int                     flag;
198         int                     reserved1;
199         char            subtarget[64];  /* MAX_ID_NAME-2 */
200 } bRotateLikeConstraint;
201
202 /* Copy Location Constraint */
203 typedef struct bLocateLikeConstraint {
204         struct Object           *tar;
205         int                     flag;
206         int                     reserved1;
207         char            subtarget[64];  /* MAX_ID_NAME-2 */
208 } bLocateLikeConstraint;
209
210 /* Copy Scale Constraint */
211 typedef struct bSizeLikeConstraint {
212         struct Object           *tar;
213         int                     flag;
214         int                     reserved1;
215         char            subtarget[64];  /* MAX_ID_NAME-2 */
216 } bSizeLikeConstraint;
217
218 /* Maintain Volume Constraint */
219 typedef struct bSameVolumeConstraint {
220         int                     flag;
221         float           volume;
222 } bSameVolumeConstraint;
223
224 /* Copy Transform Constraint */
225 typedef struct bTransLikeConstraint {
226         struct Object *tar;
227         char            subtarget[64];  /* MAX_ID_NAME-2 */
228 } bTransLikeConstraint;
229
230 /* Floor Constraint */
231 typedef struct bMinMaxConstraint {
232         struct Object *tar;
233         int                     minmaxflag;
234         float           offset;
235         int                     flag;
236         short           sticky, stuck, pad1, pad2; /* for backward compatibility */
237         float           cache[3];
238         char            subtarget[64];  /* MAX_ID_NAME-2 */
239 } bMinMaxConstraint;
240
241 /* Action Constraint */
242 typedef struct bActionConstraint {
243         struct Object           *tar;
244         short           type;   /* what transform 'channel' drives the result */
245         short           local;  /* was used in versions prior to the Constraints recode */
246         int                     start;
247         int                     end;
248         float           min;
249         float           max;
250         int         pad;
251         struct bAction  *act;
252         char            subtarget[64];  /* MAX_ID_NAME-2 */
253 } bActionConstraint;
254
255 /* Locked Axis Tracking constraint */
256 typedef struct bLockTrackConstraint {
257         struct Object           *tar;
258         int                     trackflag;
259         int                     lockflag;
260         char            subtarget[64];  /* MAX_ID_NAME-2 */
261 } bLockTrackConstraint;
262
263 /* Damped Tracking constraint */
264 typedef struct bDampTrackConstraint {
265         struct Object           *tar;
266         int                     trackflag;
267         int                     pad;
268         char            subtarget[64];  /* MAX_ID_NAME-2 */
269 } bDampTrackConstraint;
270
271 /* Follow Path constraints */
272 typedef struct bFollowPathConstraint {
273         struct Object           *tar;           /* Must be path object */
274         
275         float           offset;                 /* Offset in time on the path (in frames), when NOT using 'fixed position' */
276         float           offset_fac;             /* Parametric offset factor defining position along path, when using 'fixed position' */
277         
278         int                     followflag;
279         
280         short           trackflag;
281         short           upflag;
282 } bFollowPathConstraint;
283
284 /* Stretch to constraint */
285 typedef struct bStretchToConstraint {
286         struct Object           *tar;
287         int                     volmode; 
288         int         plane;
289         float           orglength;
290         float           bulge;
291         char            subtarget[64];  /* MAX_ID_NAME-2 */
292 } bStretchToConstraint;
293
294 /* Rigid Body constraint */
295 typedef struct bRigidBodyJointConstraint {
296         struct Object           *tar;
297         struct Object           *child;
298         int         type;
299         float       pivX;
300         float       pivY;
301         float       pivZ;
302         float       axX;
303         float       axY;
304         float       axZ;
305         float       minLimit[6];
306         float       maxLimit[6];
307         float       extraFz;
308         short           flag;
309         short           pad;
310         short           pad1;
311         short           pad2;
312 } bRigidBodyJointConstraint;
313
314 /* Clamp-To Constraint */
315 typedef struct bClampToConstraint {
316         struct Object           *tar;                   /* 'target' must be a curve */
317         int                     flag;                   /* which axis/plane to compare owner's location on  */
318         int                     flag2;                  /* for legacy reasons, this is flag2. used for any extra settings */
319 } bClampToConstraint;
320
321 /* Child Of Constraint */
322 typedef struct bChildOfConstraint {
323         struct Object           *tar;                   /* object which will act as parent (or target comes from) */
324         int             flag;                   /* settings */
325         int                     pad;
326         float           invmat[4][4];   /* parent-inverse matrix to use */
327         char            subtarget[64];  /* string to specify a subobject target, MAX_ID_NAME-2 */
328 } bChildOfConstraint;
329
330 /* Generic Transform->Transform Constraint */
331 typedef struct bTransformConstraint {
332         struct Object           *tar;                   /* target (i.e. 'driver' object/bone) */
333         char            subtarget[64];          /* MAX_ID_NAME-2 */
334         
335         short           from, to;               /* can be loc(0) , rot(1),  or size(2) */
336         char            map[3];                 /* defines which target-axis deform is copied by each owner-axis */
337         char            expo;                   /* extrapolate motion? if 0, confine to ranges */
338         
339         float           from_min[3];    /* from_min/max defines range of target transform       */
340         float           from_max[3];    /*      to map on to to_min/max range.                  */
341         
342         float           to_min[3];              /* range of motion on owner caused by target  */
343         float           to_max[3];      
344 } bTransformConstraint;
345
346 /* Pivot Constraint */
347 typedef struct bPivotConstraint {
348         /* Pivot Point:
349          *      Either target object + offset, or just offset is used
350          */
351         struct Object           *tar;                   /* target object (optional) */
352         char            subtarget[64];          /* subtarget name (optional), MAX_ID_NAME-2 */
353         float           offset[3];              /* offset from the target to use, regardless of whether it exists */
354         
355         /* Rotation-driven activation:
356          *      This option provides easier one-stop setups for footrolls
357          */
358         short           rotAxis;                /* rotation axes to consider for this (ePivotConstraint_Axis) */
359         
360         /* General flags */
361         short           flag;                   /* ePivotConstraint_Flag */
362 } bPivotConstraint;
363
364 /* transform limiting constraints - zero target ----------------------------  */
365 /* Limit Location Constraint */
366 typedef struct bLocLimitConstraint {
367         float           xmin, xmax;
368         float           ymin, ymax;
369         float           zmin, zmax;
370         short           flag;
371         short           flag2;
372 } bLocLimitConstraint;
373
374 /* Limit Rotation Constraint */
375 typedef struct bRotLimitConstraint {
376         float           xmin, xmax;
377         float           ymin, ymax;
378         float           zmin, zmax;
379         short           flag;
380         short           flag2;
381 } bRotLimitConstraint;
382
383 /* Limit Scaling Constraint */
384 typedef struct bSizeLimitConstraint {
385         float           xmin, xmax;
386         float           ymin, ymax;
387         float           zmin, zmax;
388         short           flag;
389         short           flag2;
390 } bSizeLimitConstraint;
391
392 /* Limit Distance Constraint */
393 typedef struct bDistLimitConstraint {
394         struct Object           *tar;
395         char            subtarget[64];          /* MAX_ID_NAME-2 */
396         
397         float           dist;                   /* distance (radius of clamping sphere) from target */
398         float           soft;                   /* distance from clamping-sphere to start applying 'fade' */
399         
400         short           flag;                   /* settings */
401         short           mode;                   /* how to limit in relation to clamping sphere */
402         int             pad;
403 } bDistLimitConstraint;
404
405 /* ShrinkWrap Constraint */
406 typedef struct bShrinkwrapConstraint {
407         struct Object           *target;
408         float           dist;                   /* distance to kept from target */
409         short           shrinkType;             /* shrink type (look on MOD shrinkwrap for values) */
410         char            projAxis;               /* axis to project over UP_X, UP_Y, UP_Z */
411         char            pad[9];
412 } bShrinkwrapConstraint;
413
414 /* Follow Track constraints */
415 typedef struct bFollowTrackConstraint {
416         struct MovieClip        *clip;
417         char    track[64];      /* MAX_NAME */
418         int             flag, pad;
419         char            object[64];     /* MAX_NAME */
420         struct Object *camera;
421         struct Object *depth_ob;
422 } bFollowTrackConstraint;
423
424 /* Camera Solver constraints */
425 typedef struct bCameraSolverConstraint {
426         struct MovieClip        *clip;
427         int             flag, pad;
428 } bCameraSolverConstraint;
429
430 /* Camera Solver constraints */
431 typedef struct bObjectSolverConstraint {
432         struct MovieClip        *clip;
433         int             flag, pad;
434         char            object[64];     /* MAX_NAME */
435         float           invmat[4][4];   /* parent-inverse matrix to use */
436         struct Object *camera;
437 } bObjectSolverConstraint;
438
439 /* ------------------------------------------ */
440
441 /* bConstraint->type 
442  *      - Do not ever change the order of these, or else files could get
443  *        broken as their correct value cannot be resolved
444  */
445 typedef enum eBConstraint_Types {
446         CONSTRAINT_TYPE_NULL = 0,                       /* Invalid/legacy constraint */
447         CONSTRAINT_TYPE_CHILDOF,                        /* Unimplemented non longer :) - during constraints recode, Aligorith */
448         CONSTRAINT_TYPE_TRACKTO,
449         CONSTRAINT_TYPE_KINEMATIC,
450         CONSTRAINT_TYPE_FOLLOWPATH,
451         CONSTRAINT_TYPE_ROTLIMIT,                       /* Unimplemented no longer :) - Aligorith */
452         CONSTRAINT_TYPE_LOCLIMIT,                       /* Unimplemented no longer :) - Aligorith */
453         CONSTRAINT_TYPE_SIZELIMIT,                      /* Unimplemented no longer :) - Aligorith */
454         CONSTRAINT_TYPE_ROTLIKE,        
455         CONSTRAINT_TYPE_LOCLIKE,        
456         CONSTRAINT_TYPE_SIZELIKE,
457         CONSTRAINT_TYPE_PYTHON,                         /* Unimplemented no longer :) - Aligorith. Scripts */
458         CONSTRAINT_TYPE_ACTION,
459         CONSTRAINT_TYPE_LOCKTRACK,                      /* New Tracking constraint that locks an axis in place - theeth */
460         CONSTRAINT_TYPE_DISTLIMIT,                      /* limit distance */
461         CONSTRAINT_TYPE_STRETCHTO,                      /* claiming this to be mine :) is in tuhopuu bjornmose */ 
462         CONSTRAINT_TYPE_MINMAX,                         /* floor constraint */
463         CONSTRAINT_TYPE_RIGIDBODYJOINT,         /* rigidbody constraint */
464         CONSTRAINT_TYPE_CLAMPTO,                        /* clampto constraint */        
465         CONSTRAINT_TYPE_TRANSFORM,                      /* transformation (loc/rot/size -> loc/rot/size) constraint */  
466         CONSTRAINT_TYPE_SHRINKWRAP,                     /* shrinkwrap (loc/rot) constraint */
467         CONSTRAINT_TYPE_DAMPTRACK,                      /* New Tracking constraint that minimises twisting */
468         CONSTRAINT_TYPE_SPLINEIK,                       /* Spline-IK - Align 'n' bones to a curve */
469         CONSTRAINT_TYPE_TRANSLIKE,                      /* Copy transform matrix */
470         CONSTRAINT_TYPE_SAMEVOL,                        /* Maintain volume during scaling */
471         CONSTRAINT_TYPE_PIVOT,                          /* Pivot Constraint */
472         CONSTRAINT_TYPE_FOLLOWTRACK,            /* Follow Track Constraint */
473         CONSTRAINT_TYPE_CAMERASOLVER,           /* Camera Solver Constraint */
474         CONSTRAINT_TYPE_OBJECTSOLVER,           /* Object Solver Constraint */
475         
476         /* NOTE: no constraints are allowed to be added after this */
477         NUM_CONSTRAINT_TYPES
478 } eBConstraint_Types; 
479
480 /* bConstraint->flag */
481 /* flags 0x2 (1<<1) and 0x8 (1<<3) were used in past */
482 /* flag 0x20 (1<<5) was used to indicate that a constraint was evaluated using a 'local' hack for posebones only  */
483 typedef enum eBConstraint_Flags {
484                 /* expand for UI */
485         CONSTRAINT_EXPAND =             (1<<0), 
486                 /* pre-check for illegal object name or bone name */
487         CONSTRAINT_DISABLE =    (1<<2), 
488                 /* to indicate which Ipo should be shown, maybe for 3d access later too */      
489         CONSTRAINT_ACTIVE =     (1<<4), 
490                 /* to indicate that the owner's space should only be changed into ownspace, but not out of it */
491         CONSTRAINT_SPACEONCE =  (1<<6),
492                 /* influence ipo is on constraint itself, not in action channel */
493         CONSTRAINT_OWN_IPO      = (1<<7),
494                 /* indicates that constraint was added locally (i.e.  didn't come from the proxy-lib) */
495         CONSTRAINT_PROXY_LOCAL = (1<<8),
496                 /* indicates that constraint is temporarily disabled (only used in GE) */
497         CONSTRAINT_OFF = (1<<9)
498 } eBConstraint_Flags;
499
500 /* bConstraint->ownspace/tarspace */
501 typedef enum eBConstraint_SpaceTypes {
502                 /* default for all - worldspace */
503         CONSTRAINT_SPACE_WORLD = 0,
504                 /* for objects (relative to parent/without parent influence), 
505                  * for bones (along normals of bone, without parent/restpositions) 
506                  */
507         CONSTRAINT_SPACE_LOCAL, /* = 1 */
508                 /* for posechannels - pose space  */
509         CONSTRAINT_SPACE_POSE, /* = 2 */
510                  /* for posechannels - local with parent  */
511         CONSTRAINT_SPACE_PARLOCAL, /* = 3 */
512                 /* for files from between 2.43-2.46 (should have been parlocal) */
513         CONSTRAINT_SPACE_INVALID /* = 4. do not exchange for anything! */
514 } eBConstraint_SpaceTypes;
515
516 /* bConstraintChannel.flag */
517 // XXX depreceated... old AnimSys
518 typedef enum eConstraintChannel_Flags {
519         CONSTRAINT_CHANNEL_SELECT =             (1<<0),
520         CONSTRAINT_CHANNEL_PROTECTED =  (1<<1)
521 } eConstraintChannel_Flags;
522
523 /* -------------------------------------- */
524
525 /* bRotateLikeConstraint.flag */
526 typedef enum eCopyRotation_Flags {
527         ROTLIKE_X                       = (1<<0),
528         ROTLIKE_Y                       = (1<<1),
529         ROTLIKE_Z                       = (1<<2),
530         ROTLIKE_X_INVERT        = (1<<4),
531         ROTLIKE_Y_INVERT        = (1<<5),
532         ROTLIKE_Z_INVERT        = (1<<6),
533         ROTLIKE_OFFSET          = (1<<7)
534 } eCopyRotation_Flags;
535
536 /* bLocateLikeConstraint.flag */
537 typedef enum eCopyLocation_Flags {
538         LOCLIKE_X                       = (1<<0),
539         LOCLIKE_Y                       = (1<<1),
540         LOCLIKE_Z                       = (1<<2),
541                 /* LOCLIKE_TIP is a depreceated option... use headtail=1.0f instead */
542         LOCLIKE_TIP                     = (1<<3),
543         LOCLIKE_X_INVERT        = (1<<4),
544         LOCLIKE_Y_INVERT        = (1<<5),
545         LOCLIKE_Z_INVERT        = (1<<6),
546         LOCLIKE_OFFSET          = (1<<7)
547 } eCopyLocation_Flags;
548  
549 /* bSizeLikeConstraint.flag */
550 typedef enum eCopyScale_Flags {
551         SIZELIKE_X              = (1<<0),
552         SIZELIKE_Y              = (1<<1),
553         SIZELIKE_Z              = (1<<2), 
554         SIZELIKE_OFFSET = (1<<3)
555 } eCopyScale_Flags;
556
557 /* bSameVolumeConstraint.flag */
558 typedef enum eSameVolume_Modes {
559         SAMEVOL_X               = 0,
560         SAMEVOL_Y,
561         SAMEVOL_Z
562 } eSameVolume_Modes;
563
564 /* Locked-Axis Values (Locked Track) */
565 typedef enum eLockAxis_Modes {
566         LOCK_X  = 0,
567         LOCK_Y,
568         LOCK_Z
569 } eLockAxis_Modes;
570
571 /* Up-Axis Values (TrackTo and Locked Track) */
572 typedef enum eUpAxis_Modes {
573         UP_X    = 0,
574         UP_Y,
575         UP_Z
576 } eUpAxis_Modes;
577
578 /* Tracking axis (TrackTo, Locked Track, Damped Track) and minmax (floor) constraint */
579 typedef enum eTrackToAxis_Modes {
580         TRACK_X         = 0,
581         TRACK_Y,
582         TRACK_Z,
583         TRACK_nX,
584         TRACK_nY,
585         TRACK_nZ
586 } eTrackToAxis_Modes;
587
588 /* FollowPath flags */
589 typedef enum eFollowPath_Flags {
590         FOLLOWPATH_FOLLOW       = (1<<0),
591         FOLLOWPATH_STATIC       = (1<<1),
592         FOLLOWPATH_RADIUS       = (1<<2)
593 } eFollowPath_Flags;
594
595 /* bTrackToConstraint->flags */
596 typedef enum eTrackTo_Flags {
597         TARGET_Z_UP     = (1<<0)
598 } eTrackTo_Flags;
599
600 /* Strech To Constraint -> volmode */
601 typedef enum eStretchTo_VolMode {
602         VOLUME_XZ       = 0,
603         VOLUME_X,
604         VOLUME_Z,
605         NO_VOLUME
606 } eStretchTo_VolMode;
607
608 /* Stretch To Constraint -> plane mode */
609 typedef enum eStretchTo_PlaneMode {
610         PLANE_X         = 0,
611         PLANE_Y,
612         PLANE_Z
613 } eStretchTo_PlaneMode;
614
615 /* Clamp-To Constraint ->flag */
616 typedef enum eClampTo_Modes {
617         CLAMPTO_AUTO = 0,
618         CLAMPTO_X,
619         CLAMPTO_Y,
620         CLAMPTO_Z
621 } eClampTo_Modes;
622
623 /* ClampTo Constraint ->flag2 */
624 typedef enum eClampTo_Flags {
625         CLAMPTO_CYCLIC  = (1<<0)
626 } eClampTo_Flags;
627
628 /* bKinematicConstraint->flag */
629 typedef enum eKinematic_Flags {
630         CONSTRAINT_IK_TIP                       = (1<<0),
631         CONSTRAINT_IK_ROT                       = (1<<1),
632         /* targetless */
633         CONSTRAINT_IK_AUTO                      = (1<<2),
634         /* autoik */
635         CONSTRAINT_IK_TEMP                      = (1<<3),
636         CONSTRAINT_IK_STRETCH           = (1<<4),
637         CONSTRAINT_IK_POS                       = (1<<5),
638         CONSTRAINT_IK_SETANGLE          = (1<<6),
639         CONSTRAINT_IK_GETANGLE          = (1<<7),
640         /* limit axis */
641         CONSTRAINT_IK_NO_POS_X          = (1<<8),
642         CONSTRAINT_IK_NO_POS_Y          = (1<<9),
643         CONSTRAINT_IK_NO_POS_Z          = (1<<10),
644         CONSTRAINT_IK_NO_ROT_X          = (1<<11),
645         CONSTRAINT_IK_NO_ROT_Y          = (1<<12),
646         CONSTRAINT_IK_NO_ROT_Z          = (1<<13),
647         /* axis relative to target */
648         CONSTRAINT_IK_TARGETAXIS        = (1<<14)
649 } eKinematic_Flags;
650
651 /* bSplineIKConstraint->flag */
652 typedef enum eSplineIK_Flags {
653         /* chain has been attached to spline */
654         CONSTRAINT_SPLINEIK_BOUND                       = (1<<0),
655         /* root of chain is not influenced by the constraint */
656         CONSTRAINT_SPLINEIK_NO_ROOT                     = (1<<1),
657         /* bones in the chain should not scale to fit the curve */
658         CONSTRAINT_SPLINEIK_SCALE_LIMITED       = (1<<2),
659         /* evenly distribute the bones along the path regardless of length */
660         CONSTRAINT_SPLINEIK_EVENSPLITS          = (1<<3),       
661         /* don't adjust the x and z scaling of the bones by the curve radius */
662         CONSTRAINT_SPLINEIK_NO_CURVERAD = (1<<4)
663 } eSplineIK_Flags;
664
665 /* bSplineIKConstraint->xzScaleMode */
666 typedef enum eSplineIK_XZScaleModes {
667         /* no x/z scaling */
668         CONSTRAINT_SPLINEIK_XZS_NONE                    = 0,
669         /* bones in the chain should take their x/z scales from the original scaling */
670         CONSTRAINT_SPLINEIK_XZS_ORIGINAL,
671         /* x/z scales are the inverse of the y-scale */
672         CONSTRAINT_SPLINEIK_XZS_VOLUMETRIC
673 } eSplineIK_XZScaleModes;
674
675 /* MinMax (floor) flags */
676 typedef enum eFloor_Flags {
677         MINMAX_STICKY   = (1<<0),
678         MINMAX_STUCK    = (1<<1),
679         MINMAX_USEROT   = (1<<2)
680 } eFloor_Flags;
681
682 /* transform limiting constraints -> flag2 */
683 typedef enum eTransformLimits_Flags2 {
684         /* not used anymore - for older Limit Location constraints only */
685         LIMIT_NOPARENT  = (1<<0),
686         /* for all Limit constraints - allow to be used during transform? */
687         LIMIT_TRANSFORM = (1<<1)
688 } eTransformLimits_Flags2;
689
690 /* transform limiting constraints -> flag (own flags)  */
691 typedef enum eTransformLimits_Flags {
692         LIMIT_XMIN = (1<<0),
693         LIMIT_XMAX = (1<<1),
694         LIMIT_YMIN = (1<<2),
695         LIMIT_YMAX = (1<<3),
696         LIMIT_ZMIN = (1<<4),
697         LIMIT_ZMAX = (1<<5)
698 } eTransformLimits_Flags;
699
700 /* limit rotation constraint -> flag (own flags) */
701 typedef enum eRotLimit_Flags {
702         LIMIT_XROT = (1<<0),
703         LIMIT_YROT = (1<<1),
704         LIMIT_ZROT = (1<<2)
705 } eRotLimit_Flags;
706
707 /* distance limit constraint */
708         /* bDistLimitConstraint->flag */
709 typedef enum eDistLimit_Flag {
710         /* "soft" cushion effect when reaching the limit sphere */ // NOT IMPLEMENTED!
711         LIMITDIST_USESOFT       = (1<<0),
712         /* as for all Limit constraints - allow to be used during transform? */
713         LIMITDIST_TRANSFORM = (1<<1)
714 } eDistLimit_Flag;
715
716         /* bDistLimitConstraint->mode */
717 typedef enum eDistLimit_Modes {
718         LIMITDIST_INSIDE = 0,
719         LIMITDIST_OUTSIDE,
720         LIMITDIST_ONSURFACE
721 } eDistLimit_Modes;
722         
723 /* python constraint -> flag */
724 typedef enum ePyConstraint_Flags {
725         PYCON_USETARGETS        = (1<<0),
726         PYCON_SCRIPTERROR       = (1<<1)
727 } ePyConstraint_Flags;
728
729 /* ChildOf Constraint -> flag */
730 typedef enum eChildOf_Flags {
731         CHILDOF_LOCX    = (1<<0),
732         CHILDOF_LOCY    = (1<<1),
733         CHILDOF_LOCZ    = (1<<2),
734         CHILDOF_ROTX    = (1<<3),
735         CHILDOF_ROTY    = (1<<4),
736         CHILDOF_ROTZ    = (1<<5),
737         CHILDOF_SIZEX   = (1<<6),
738         CHILDOF_SIZEY   = (1<<7),
739         CHILDOF_SIZEZ   = (1<<8),
740         CHILDOF_ALL             = 511
741 } eChildOf_Flags;
742
743 /* Pivot Constraint */
744         /* Restrictions for Pivot Constraint axis to consider for enabling constraint */
745 typedef enum ePivotConstraint_Axis {
746         /* do not consider this activity-clamping */
747         PIVOTCON_AXIS_NONE = -1,        
748         
749         /* consider -ve x-axis rotations */
750         PIVOTCON_AXIS_X_NEG,
751         /* consider -ve y-axis rotations */
752         PIVOTCON_AXIS_Y_NEG,
753         /* consider -ve z-axis rotations */
754         PIVOTCON_AXIS_Z_NEG,
755         
756         /* consider +ve x-axis rotations */
757         PIVOTCON_AXIS_X,
758         /* consider +ve y-axis rotations */
759         PIVOTCON_AXIS_Y,
760         /* consider +ve z-axis rotations */
761         PIVOTCON_AXIS_Z
762 } ePivotConstraint_Axis;
763
764         /* settings for Pivot Constraint in general */
765 typedef enum ePivotConstraint_Flag {
766         /* offset is to be interpreted as being a fixed-point in space */
767         PIVOTCON_FLAG_OFFSET_ABS        = (1<<0),
768         /* rotation-based activation uses negative rotation to drive result */
769         PIVOTCON_FLAG_ROTACT_NEG        = (1<<1)
770 } ePivotConstraint_Flag;
771
772 typedef enum eFollowTrack_Flags {
773         FOLLOWTRACK_ACTIVECLIP  = (1<<0),
774         FOLLOWTRACK_USE_3D_POSITION     = (1<<1)
775 } eFollowTrack_Flags;
776
777 /* CameraSolver Constraint -> flag */
778 typedef enum eCameraSolver_Flags {
779         CAMERASOLVER_ACTIVECLIP = (1<<0)
780 } eCameraSolver_Flags;
781
782 /* ObjectSolver Constraint -> flag */
783 typedef enum eObjectSolver_Flags {
784         OBJECTSOLVER_ACTIVECLIP = (1<<0)
785 } eObjectSolver_Flags;
786
787 /* Rigid-Body Constraint */
788 #define CONSTRAINT_DRAW_PIVOT 0x40
789 #define         CONSTRAINT_DISABLE_LINKED_COLLISION 0x80
790
791 /* important: these defines need to match up with PHY_DynamicTypes headerfile */
792 #define         CONSTRAINT_RB_BALL              1
793 #define         CONSTRAINT_RB_HINGE             2
794 #define         CONSTRAINT_RB_CONETWIST 4
795 #define         CONSTRAINT_RB_VEHICLE   11
796 #define         CONSTRAINT_RB_GENERIC6DOF 12
797
798 #endif