Merge with -r 22620:23107.
[blender.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., 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  * 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_ipo_types.h"
36 #include "DNA_listBase.h"
37 #include "DNA_object_types.h"
38
39 struct Action;
40 struct Text;
41 struct Ipo;
42
43 /* channels reside in Object or Action (ListBase) constraintChannels */
44 typedef struct bConstraintChannel {
45         struct bConstraintChannel *next, *prev;
46         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 } bConstraint;
70
71
72 /* Multiple-target constraints ---------------------  */
73
74 /* This struct defines a constraint target.
75  * It is used during constraint solving regardless of how many targets the
76  * constraint has.
77  */
78 typedef struct bConstraintTarget {
79         struct bConstraintTarget *next, *prev;
80
81         Object *tar;                    /* object to use as target */
82         char subtarget[32];             /* subtarget - pchan or vgroup name */
83         
84         float matrix[4][4];             /* matrix used during constraint solving - should be cleared before each use */
85         
86         short space;                    /* space that target should be evaluated in (overrides bConstraint->tarspace) */
87         short flag;                             /* runtime settings (for editor, etc.) */
88         short type;                             /* type of target (B_CONSTRAINT_OB_TYPE) */
89         short rotOrder;                 /* rotation order for target (as defined in BLI_arithb.h) */
90 } bConstraintTarget;
91
92 /* bConstraintTarget -> flag */
93 typedef enum B_CONSTRAINT_TARGET_FLAG {
94         CONSTRAINT_TAR_TEMP = (1<<0),           /* temporary target-struct that needs to be freed after use */
95 } B_CONSTRAINT_TARGET_FLAG;
96
97 /* bConstraintTarget/bConstraintOb -> type */
98 typedef enum B_CONSTRAINT_OB_TYPE {
99         CONSTRAINT_OBTYPE_OBJECT = 1,   /*      string is ""                            */
100         CONSTRAINT_OBTYPE_BONE,                 /*      string is bone-name             */
101         CONSTRAINT_OBTYPE_VERT,                 /*      string is vertex-group name     */
102         CONSTRAINT_OBTYPE_CV                    /*      string is vertex-group name - is not available until curves get vgroups */
103 } B_CONSTRAINT_OB_TYPE;
104
105
106
107 /* Python Script Constraint */
108 typedef struct bPythonConstraint {      
109         struct Text *text;              /* text-buffer (containing script) to execute */
110         IDProperty *prop;               /* 'id-properties' used to store custom properties for constraint */
111         
112         int flag;                               /* general settings/state indicators accessed by bitmapping */
113         int tarnum;                             /* number of targets - usually only 1-3 are needed */
114         
115         ListBase targets;               /* a list of targets that this constraint has (bConstraintTarget-s) */
116         
117         Object *tar;                    /* target from previous implementation (version-patch sets this to NULL on file-load) */
118         char subtarget[32];             /* subtarger from previous implentation (version-patch sets this to "" on file-load) */
119 } bPythonConstraint;
120
121
122 /* Inverse-Kinematics (IK) constraint */
123 typedef struct bKinematicConstraint {
124         Object          *tar;
125         short           iterations;             /* Maximum number of iterations to try */
126         short           flag;                   /* Like CONSTRAINT_IK_TIP */
127         short           rootbone;               /* index to rootbone, if zero go all the way to mother bone */
128         short           max_rootbone;   /* for auto-ik, maximum length of chain */
129         char            subtarget[32];  /* String to specify sub-object target */
130
131         Object          *poletar;                       /* Pole vector target */
132         char            polesubtarget[32];      /* Pole vector sub-object target */
133         float           poleangle;                      /* Pole vector rest angle */
134
135         float           weight;                 /* Weight of goal in IK tree */
136         float           orientweight;   /* Amount of rotation a target applies on chain */
137         float           grabtarget[3];  /* for target-less IK */
138 } bKinematicConstraint;
139
140
141 /* Single-target subobject constraints ---------------------  */
142 /* Track To Constraint */
143 typedef struct bTrackToConstraint {
144         Object          *tar;
145         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*/
146         int                     reserved2;
147         int                     flags;
148         int                     pad;
149         char            subtarget[32];
150 } bTrackToConstraint;
151
152 /* Copy Rotation Constraint */
153 typedef struct bRotateLikeConstraint {
154         Object          *tar;
155         int                     flag;
156         int                     reserved1;
157         char            subtarget[32];
158 } bRotateLikeConstraint;
159
160 /* Copy Location Constraint */
161 typedef struct bLocateLikeConstraint {
162         Object          *tar;
163         int                     flag;
164         int                     reserved1;
165         char            subtarget[32];
166 } bLocateLikeConstraint;
167
168 /* Floor Constraint */
169 typedef struct bMinMaxConstraint {
170         Object          *tar;
171         int                     minmaxflag;
172         float           offset;
173         int                     flag;
174         short           sticky, stuck, pad1, pad2; /* for backward compatability */
175         float           cache[3];
176         char            subtarget[32];
177 } bMinMaxConstraint;
178
179 /* Copy Scale Constraint */
180 typedef struct bSizeLikeConstraint {
181         Object          *tar;
182         int                     flag;
183         int                     reserved1;
184         char            subtarget[32];
185 } bSizeLikeConstraint;
186
187 /* Action Constraint */
188 typedef struct bActionConstraint {
189         Object          *tar;
190         short           type;   /* what transform 'channel' drives the result */
191         short           local;  /* was used in versions prior to the Constraints recode */
192         int                     start;
193         int                     end;
194         float           min;
195         float           max;
196         int         pad;
197         struct bAction  *act;
198         char            subtarget[32];
199 } bActionConstraint;
200
201 /* Locked Axis Tracking constraint */
202 typedef struct bLockTrackConstraint {
203         Object          *tar;
204         int                     trackflag;
205         int                     lockflag;
206         char            subtarget[32];
207 } bLockTrackConstraint;
208
209 /* Follow Path constraints */
210 typedef struct bFollowPathConstraint {
211         Object          *tar;   /* Must be path object */
212         float           offset; /* Offset in time on the path (in frame) */
213         int                     followflag;
214         int                     trackflag;
215         int                     upflag;
216 } bFollowPathConstraint;
217
218 /* Stretch to constraint */
219 typedef struct bStretchToConstraint {
220         Object          *tar;
221         int                     volmode; 
222         int         plane;
223         float           orglength;
224         float           bulge;
225         char            subtarget[32];
226 } bStretchToConstraint;
227
228 /* Rigid Body constraint */
229 typedef struct bRigidBodyJointConstraint {
230         Object          *tar;
231         Object          *child;
232         int         type;
233         float       pivX;
234         float       pivY;
235         float       pivZ;
236         float       axX;
237         float       axY;
238         float       axZ;
239         float       minLimit[6];
240         float       maxLimit[6];
241         float       extraFz;
242         short           flag;
243         short           pad;
244         short           pad1;
245         short           pad2;
246 } bRigidBodyJointConstraint;
247
248 /* Clamp-To Constraint */
249 typedef struct bClampToConstraint {
250         Object          *tar;                   /* 'target' must be a curve */
251         int                     flag;                   /* which axis/plane to compare owner's location on  */
252         int                     flag2;                  /* for legacy reasons, this is flag2. used for any extra settings */
253 } bClampToConstraint;
254
255 /* Child Of Constraint */
256 typedef struct bChildOfConstraint {
257         Object          *tar;                   /* object which will act as parent (or target comes from) */
258         int             flag;                   /* settings */
259         int                     pad;
260         float           invmat[4][4];   /* parent-inverse matrix to use */
261         char            subtarget[32];  /* string to specify a subobject target */
262 } bChildOfConstraint;
263
264 /* Generic Transform->Transform Constraint */
265 typedef struct bTransformConstraint {
266         Object          *tar;                   /* target (i.e. 'driver' object/bone) */
267         char            subtarget[32];  
268         
269         short           from, to;               /* can be loc(0) , rot(1),  or size(2) */
270         char            map[3];                 /* defines which target-axis deform is copied by each owner-axis */
271         char            expo;                   /* extrapolate motion? if 0, confine to ranges */
272         
273         float           from_min[3];    /* from_min/max defines range of target transform       */
274         float           from_max[3];    /*      to map on to to_min/max range.                  */
275         
276         float           to_min[3];              /* range of motion on owner caused by target  */
277         float           to_max[3];      
278 } bTransformConstraint;
279
280 /* transform limiting constraints - zero target ----------------------------  */
281 /* Limit Location Constraint */
282 typedef struct bLocLimitConstraint {
283         float           xmin, xmax;
284         float           ymin, ymax;
285         float           zmin, zmax;
286         short           flag;
287         short           flag2;
288 } bLocLimitConstraint;
289
290 /* Limit Rotation Constraint */
291 typedef struct bRotLimitConstraint {
292         float           xmin, xmax;
293         float           ymin, ymax;
294         float           zmin, zmax;
295         short           flag;
296         short           flag2;
297 } bRotLimitConstraint;
298
299 /* Limit Scaling Constraint */
300 typedef struct bSizeLimitConstraint {
301         float           xmin, xmax;
302         float           ymin, ymax;
303         float           zmin, zmax;
304         short           flag;
305         short           flag2;
306 } bSizeLimitConstraint;
307
308 /* Limit Distance Constraint */
309 typedef struct bDistLimitConstraint {
310         Object          *tar;
311         char            subtarget[32];
312         
313         float           dist;                   /* distance (radius of clamping sphere) from target */
314         float           soft;                   /* distance from clamping-sphere to start applying 'fade' */
315         
316         short           flag;                   /* settings */
317         short           mode;                   /* how to limit in relation to clamping sphere */
318         int             pad;
319 } bDistLimitConstraint;
320
321 typedef struct bShrinkwrapConstraint {
322         Object          *target;
323         float           dist;                   /* distance to kept from target */
324         short           shrinkType;             /* shrink type (look on MOD shrinkwrap for values) */
325         char            projAxis;               /* axis to project over UP_X, UP_Y, UP_Z */
326         char            pad[9];
327 } bShrinkwrapConstraint;
328
329
330 /* ------------------------------------------ */
331
332 /* bConstraint->type 
333  *      - Do not ever change the order of these, or else files could get
334  *        broken as their correct value cannot be resolved
335  */
336 typedef enum B_CONSTAINT_TYPES {
337         CONSTRAINT_TYPE_NULL = 0,                       /* Invalid/legacy constraint */
338         CONSTRAINT_TYPE_CHILDOF,                        /* Unimplemented non longer :) - during constraints recode, Aligorith */
339         CONSTRAINT_TYPE_TRACKTO,
340         CONSTRAINT_TYPE_KINEMATIC,
341         CONSTRAINT_TYPE_FOLLOWPATH,
342         CONSTRAINT_TYPE_ROTLIMIT,                       /* Unimplemented no longer :) - Aligorith */
343         CONSTRAINT_TYPE_LOCLIMIT,                       /* Unimplemented no longer :) - Aligorith */
344         CONSTRAINT_TYPE_SIZELIMIT,                      /* Unimplemented no longer :) - Aligorith */
345         CONSTRAINT_TYPE_ROTLIKE,        
346         CONSTRAINT_TYPE_LOCLIKE,        
347         CONSTRAINT_TYPE_SIZELIKE,
348         CONSTRAINT_TYPE_PYTHON,                         /* Unimplemented no longer :) - Aligorith. Scripts */
349         CONSTRAINT_TYPE_ACTION,
350         CONSTRAINT_TYPE_LOCKTRACK,                      /* New Tracking constraint that locks an axis in place - theeth */
351         CONSTRAINT_TYPE_DISTLIMIT,                      /* limit distance */
352         CONSTRAINT_TYPE_STRETCHTO,                      /* claiming this to be mine :) is in tuhopuu bjornmose */ 
353         CONSTRAINT_TYPE_MINMAX,                         /* floor constraint */
354         CONSTRAINT_TYPE_RIGIDBODYJOINT,         /* rigidbody constraint */
355         CONSTRAINT_TYPE_CLAMPTO,                        /* clampto constraint */        
356         CONSTRAINT_TYPE_TRANSFORM,                      /* transformation (loc/rot/size -> loc/rot/size) constraint */  
357         CONSTRAINT_TYPE_SHRINKWRAP,                     /* shrinkwrap (loc/rot) constraint */
358         
359         
360         /* NOTE: everytime a new constraint is added, update this */
361         NUM_CONSTRAINT_TYPES= CONSTRAINT_TYPE_SHRINKWRAP
362 } B_CONSTRAINT_TYPES; 
363
364 /* bConstraint->flag */
365 /* flags 0x2 (1<<1) and 0x8 (1<<3) were used in past */
366 /* flag 0x20 (1<<5) was used to indicate that a constraint was evaluated using a 'local' hack for posebones only  */
367 typedef enum B_CONSTRAINT_FLAG {
368                 /* expand for UI */
369         CONSTRAINT_EXPAND =             (1<<0), 
370                 /* pre-check for illegal object name or bone name */
371         CONSTRAINT_DISABLE =    (1<<2), 
372                 /* to indicate which Ipo should be shown, maybe for 3d access later too */      
373         CONSTRAINT_ACTIVE =     (1<<4), 
374                 /* to indicate that the owner's space should only be changed into ownspace, but not out of it */
375         CONSTRAINT_SPACEONCE =  (1<<6),
376                 /* influence ipo is on constraint itself, not in action channel */
377         CONSTRAINT_OWN_IPO      = (1<<7),
378                 /* indicates that constraint was added locally (i.e.  didn't come from the proxy-lib) */
379         CONSTRAINT_PROXY_LOCAL = (1<<8)
380 } B_CONSTRAINT_FLAG;
381
382 /* bConstraint->ownspace/tarspace */
383 typedef enum B_CONSTRAINT_SPACETYPES {
384                 /* default for all - worldspace */
385         CONSTRAINT_SPACE_WORLD = 0,
386                 /* for objects (relative to parent/without parent influence), 
387                  * for bones (along normals of bone, without parent/restpositions) 
388                  */
389         CONSTRAINT_SPACE_LOCAL, /* = 1 */
390                 /* for posechannels - pose space  */
391         CONSTRAINT_SPACE_POSE, /* = 2 */
392                 /* for posechannels - local with parent  */
393         CONSTRAINT_SPACE_PARLOCAL, /* = 3 */
394                 /* for files from between 2.43-2.46 (should have been parlocal) */
395         CONSTRAINT_SPACE_INVALID, /* = 4. do not exchange for anything! */
396 } B_CONSTRAINT_SPACETYPES;
397
398 /* bConstraintChannel.flag */
399 typedef enum B_CONSTRAINTCHANNEL_FLAG {
400         CONSTRAINT_CHANNEL_SELECT =             (1<<0),
401         CONSTRAINT_CHANNEL_PROTECTED =  (1<<1)
402 } B_CONSTRAINTCHANNEL_FLAG;
403
404 /* -------------------------------------- */
405
406 /**
407  * The flags for ROTLIKE, LOCLIKE and SIZELIKE should be kept identical
408  * (that is, same effect, different name). It simplifies the Python API access a lot.
409  */
410
411 /* bRotateLikeConstraint.flag */
412 #define ROTLIKE_X               0x01
413 #define ROTLIKE_Y               0x02
414 #define ROTLIKE_Z               0x04
415 #define ROTLIKE_X_INVERT        0x10
416 #define ROTLIKE_Y_INVERT        0x20
417 #define ROTLIKE_Z_INVERT        0x40
418 #define ROTLIKE_OFFSET  0x80
419
420 /* bLocateLikeConstraint.flag */
421 #define LOCLIKE_X                       0x01
422 #define LOCLIKE_Y                       0x02
423 #define LOCLIKE_Z                       0x04
424         /* LOCLIKE_TIP is a depreceated option... use headtail=1.0f instead */
425 #define LOCLIKE_TIP                     0x08
426 #define LOCLIKE_X_INVERT        0x10
427 #define LOCLIKE_Y_INVERT        0x20
428 #define LOCLIKE_Z_INVERT        0x40
429 #define LOCLIKE_OFFSET          0x80
430  
431 /* bSizeLikeConstraint.flag */
432 #define SIZELIKE_X              0x01
433 #define SIZELIKE_Y              0x02
434 #define SIZELIKE_Z              0x04
435 #define SIZELIKE_OFFSET 0x80
436
437 /* Axis flags */
438 #define LOCK_X          0x00
439 #define LOCK_Y          0x01
440 #define LOCK_Z          0x02
441
442 #define UP_X            0x00
443 #define UP_Y            0x01
444 #define UP_Z            0x02
445
446 #define TRACK_X         0x00
447 #define TRACK_Y         0x01
448 #define TRACK_Z         0x02
449 #define TRACK_nX        0x03
450 #define TRACK_nY        0x04
451 #define TRACK_nZ        0x05
452
453 /* FollowPath flags */
454 #define FOLLOWPATH_FOLLOW       0x01
455 #define FOLLOWPATH_STATIC       0x02
456
457 /* bTrackToConstraint->flags */
458 #define TARGET_Z_UP 0x01
459
460 #define VOLUME_XZ       0x00
461 #define VOLUME_X        0x01
462 #define VOLUME_Z        0x02
463 #define NO_VOLUME       0x03
464
465 #define PLANE_X         0x00
466 #define PLANE_Y         0x01
467 #define PLANE_Z         0x02
468
469 /* Clamp-To Constraint ->flag */
470 #define CLAMPTO_AUTO    0
471 #define CLAMPTO_X               1
472 #define CLAMPTO_Y               2
473 #define CLAMPTO_Z               3
474
475 /* ClampTo Constraint ->flag2 */
476 #define CLAMPTO_CYCLIC  1
477
478 /* bKinematicConstraint->flag */
479 #define CONSTRAINT_IK_TIP               1
480 #define CONSTRAINT_IK_ROT               2
481         /* targetless */
482 #define CONSTRAINT_IK_AUTO              4
483         /* autoik */
484 #define CONSTRAINT_IK_TEMP              8
485 #define CONSTRAINT_IK_STRETCH   16
486 #define CONSTRAINT_IK_POS               32
487 #define CONSTRAINT_IK_SETANGLE  64
488 #define CONSTRAINT_IK_GETANGLE  128
489
490 /* MinMax (floor) flags */
491 #define MINMAX_STICKY   0x01
492 #define MINMAX_STUCK    0x02
493 #define MINMAX_USEROT   0x04
494
495 /* transform limiting constraints -> flag  */
496 #define LIMIT_XMIN 0x01
497 #define LIMIT_XMAX 0x02
498 #define LIMIT_YMIN 0x04
499 #define LIMIT_YMAX 0x08
500 #define LIMIT_ZMIN 0x10
501 #define LIMIT_ZMAX 0x20
502
503 #define LIMIT_XROT 0x01
504 #define LIMIT_YROT 0x02
505 #define LIMIT_ZROT 0x04
506
507         /* not used anymore - for older Limit Location constraints only */
508 #define LIMIT_NOPARENT 0x01
509         /* for all Limit constraints - allow to be used during transform? */
510 #define LIMIT_TRANSFORM 0x02
511
512 /* distance limit constraint */
513         /* bDistLimitConstraint->flag */
514 #define LIMITDIST_USESOFT               (1<<0)
515
516         /* bDistLimitConstraint->mode */
517 #define LIMITDIST_INSIDE                0
518 #define LIMITDIST_OUTSIDE               1
519 #define LIMITDIST_ONSURFACE             2
520         
521 /* python constraint -> flag */
522 #define PYCON_USETARGETS        0x01
523 #define PYCON_SCRIPTERROR       0x02
524
525 /* ChildOf Constraint -> flag */
526 #define CHILDOF_LOCX    0x001
527 #define CHILDOF_LOCY    0x002
528 #define CHILDOF_LOCZ    0x004
529 #define CHILDOF_ROTX    0x008
530 #define CHILDOF_ROTY    0x010
531 #define CHILDOF_ROTZ    0x020
532 #define CHILDOF_SIZEX   0x040
533 #define CHILDOF_SIZEY   0x080
534 #define CHILDOF_SIZEZ   0x100
535
536 /* Rigid-Body Constraint */
537 #define CONSTRAINT_DRAW_PIVOT 0x40
538 #define CONSTRAINT_DISABLE_LINKED_COLLISION 0x80
539
540 /* important: these defines need to match up with PHY_DynamicTypes headerfile */
541 #define CONSTRAINT_RB_BALL              1
542 #define CONSTRAINT_RB_HINGE             2
543 #define CONSTRAINT_RB_CONETWIST 4
544 #define CONSTRAINT_RB_VEHICLE   11
545 #define CONSTRAINT_RB_GENERIC6DOF 12
546
547 #endif