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