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