svn merge -r 12691:12716 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender-staging.git] / source / blender / makesdna / DNA_constraint_types.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): 2007, Joshua Leung, major recode
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * Constraint DNA data
32  */
33
34 #ifndef DNA_CONSTRAINT_TYPES_H
35 #define DNA_CONSTRAINT_TYPES_H
36
37 #include "DNA_ID.h"
38 #include "DNA_ipo_types.h"
39 #include "DNA_listBase.h"
40 #include "DNA_object_types.h"
41
42 struct Action;
43 struct Text;
44 struct Ipo;
45
46 /* channels reside in Object or Action (ListBase) constraintChannels */
47 typedef struct bConstraintChannel {
48         struct bConstraintChannel *next, *prev;
49         Ipo                     *ipo;
50         short           flag;
51         char            name[30];
52 } bConstraintChannel;
53
54 /* A Constraint */
55 typedef struct bConstraint {
56         struct bConstraint *next, *prev;
57         
58         void            *data;          /*      Constraint data (a valid constraint type) */
59         short           type;           /*      Constraint type */
60         short           flag;           /*      Flag - General Settings */
61         
62         char            ownspace;       /*      Space that owner should be evaluated in         */
63         char            tarspace;       /*      Space that target should be evaluated in (only used if 1 target) */
64         
65         char            name[30];       /*      Constraint name */
66         
67         float           enforce;        /*      Amount of influence exherted by constraint (0.0-1.0) */
68         float           headtail;       /*      Point along subtarget bone where the actual target is. 0=head (default for all), 1=tail*/
69         int                     pad;
70         struct Ipo *ipo;                /* local influence ipo or driver */
71 } bConstraint;
72
73
74 /* Multiple-target constraints ---------------------  */
75
76 /* This struct defines a constraint target.
77  * It is used during constraint solving regardless of how many targets the
78  * constraint has.
79  */
80 typedef struct bConstraintTarget {
81         struct bConstraintTarget *next, *prev;
82
83         Object *tar;                    /* object to use as target */
84         char subtarget[32];             /* subtarget - pchan or vgroup name */
85         
86         float matrix[4][4];             /* matrix used during constraint solving - should be cleared before each use */
87         
88         short space;                    /* space that target should be evaluated in (overrides bConstraint->tarspace) */
89         short flag;                             /* runtime settings (for editor, etc.) */
90         short type;                             /* type of target (B_CONSTRAINT_OB_TYPE) */
91         short pad;
92 } bConstraintTarget;
93
94 /* bConstraintTarget -> flag */
95 typedef enum B_CONSTRAINT_TARGET_FLAG {
96         CONSTRAINT_TAR_TEMP = (1<<0),           /* temporary target-struct that needs to be freed after use */
97 } B_CONSTRAINT_TARGET_FLAG;
98
99 /* bConstraintTarget/bConstraintOb -> type */
100 typedef enum B_CONSTRAINT_OB_TYPE {
101         CONSTRAINT_OBTYPE_OBJECT = 1,   /*      string is ""                            */
102         CONSTRAINT_OBTYPE_BONE,                 /*      string is bone-name             */
103         CONSTRAINT_OBTYPE_VERT,                 /*      string is vertex-group name     */
104         CONSTRAINT_OBTYPE_CV                    /*      string is vertex-group name - is not available until curves get vgroups */
105 } B_CONSTRAINT_OB_TYPE;
106
107
108
109 /* Python Script Constraint */
110 typedef struct bPythonConstraint {      
111         struct Text *text;              /* text-buffer (containing script) to execute */
112         IDProperty *prop;               /* 'id-properties' used to store custom properties for constraint */
113         
114         int flag;                               /* general settings/state indicators accessed by bitmapping */
115         int tarnum;                             /* number of targets - usually only 1-3 are needed */
116         
117         ListBase targets;               /* a list of targets that this constraint has (bConstraintTarget-s) */
118         
119         Object *tar;                    /* target from previous implementation (version-patch sets this to NULL on file-load) */
120         char subtarget[32];             /* subtarger from previous implentation (version-patch sets this to "" on file-load) */
121 } bPythonConstraint;
122
123
124 /* Inverse-Kinematics (IK) constraint */
125 typedef struct bKinematicConstraint {
126         Object          *tar;
127         short           iterations;             /* Maximum number of iterations to try */
128         short           flag;                   /* Like CONSTRAINT_IK_TIP */
129         int                     rootbone;       /* index to rootbone, if zero go all the way to mother bone */
130         char            subtarget[32];  /* String to specify sub-object target */
131
132         Object          *poletar;                       /* Pole vector target */
133         char            polesubtarget[32];      /* Pole vector sub-object target */
134         float           poleangle;                      /* Pole vector rest angle */
135
136         float           weight;                 /* Weight of goal in IK tree */
137         float           orientweight;   /* Amount of rotation a target applies on chain */
138         float           grabtarget[3];  /* for target-less IK */
139 } bKinematicConstraint;
140
141
142 /* Single-target subobject constraints ---------------------  */
143 /* Track To Constraint */
144 typedef struct bTrackToConstraint {
145         Object          *tar;
146         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*/
147         int                     reserved2;
148         int                     flags;
149         int                     pad;
150         char            subtarget[32];
151 } bTrackToConstraint;
152
153 /* Copy Rotation Constraint */
154 typedef struct bRotateLikeConstraint {
155         Object          *tar;
156         int                     flag;
157         int                     reserved1;
158         char            subtarget[32];
159 } bRotateLikeConstraint;
160
161 /* Copy Location Constraint */
162 typedef struct bLocateLikeConstraint {
163         Object          *tar;
164         int                     flag;
165         int                     reserved1;
166         char            subtarget[32];
167 } bLocateLikeConstraint;
168
169 /* Floor Constraint */
170 typedef struct bMinMaxConstraint {
171         Object          *tar;
172         int                     minmaxflag;
173         float           offset;
174         int                     flag;
175         short           sticky, stuck, pad1, pad2; /* for backward compatability */
176         float           cache[3];
177         char            subtarget[32];
178 } bMinMaxConstraint;
179
180 /* Copy Scale Constraint */
181 typedef struct bSizeLikeConstraint {
182         Object          *tar;
183         int                     flag;
184         int                     reserved1;
185         char            subtarget[32];
186 } bSizeLikeConstraint;
187
188 /* Action Constraint */
189 typedef struct bActionConstraint {
190         Object          *tar;
191         short           type;   /* what transform 'channel' drives the result */
192         short           local;  /* was used in versions prior to the Constraints recode */
193         int                     start;
194         int                     end;
195         float           min;
196         float           max;
197         int         pad;
198         struct bAction  *act;
199         char            subtarget[32];
200 } bActionConstraint;
201
202 /* Locked Axis Tracking constraint */
203 typedef struct bLockTrackConstraint {
204         Object          *tar;
205         int                     trackflag;
206         int                     lockflag;
207         char            subtarget[32];
208 } bLockTrackConstraint;
209
210 /* Follow Path constraints */
211 typedef struct bFollowPathConstraint {
212         Object          *tar;   /* Must be path object */
213         float           offset; /* Offset in time on the path (in frame) */
214         int                     followflag;
215         int                     trackflag;
216         int                     upflag;
217 } bFollowPathConstraint;
218
219 /* Stretch to constraint */
220 typedef struct bStretchToConstraint {
221         Object          *tar;
222         int                     volmode; 
223         int         plane;
224         float           orglength;
225         float           bulge;
226         char            subtarget[32];
227 } bStretchToConstraint;
228
229 /* Rigid Body constraint */
230 typedef struct bRigidBodyJointConstraint {
231         Object          *tar;
232         Object          *child;
233         int         type;
234         float       pivX;
235         float       pivY;
236         float       pivZ;
237         float       axX;
238         float       axY;
239         float       axZ;
240         float       minLimit[6];
241         float       maxLimit[6];
242         float       extraFz;
243         short           flag;
244         short           pad;
245         short           pad1;
246         short           pad2;
247 } bRigidBodyJointConstraint;
248
249 /* Clamp-To Constraint */
250 typedef struct bClampToConstraint {
251         Object          *tar;                   /* 'target' must be a curve */
252         int                     flag;                   /* which axis/plane to compare owner's location on  */
253         int                     flag2;                  /* for legacy reasons, this is flag2. used for any extra settings */
254 } bClampToConstraint;
255
256 /* Child Of Constraint */
257 typedef struct bChildOfConstraint {
258         Object          *tar;                   /* object which will act as parent (or target comes from) */
259         int             flag;                   /* settings */
260         int                     pad;
261         float           invmat[4][4];   /* parent-inverse matrix to use */
262         char            subtarget[32];  /* string to specify a subobject target */
263 } bChildOfConstraint;
264
265 /* Generic Transform->Transform Constraint */
266 typedef struct bTransformConstraint {
267         Object          *tar;                   /* target (i.e. 'driver' object/bone) */
268         char            subtarget[32];  
269         
270         short           from, to;               /* can be loc(0) , rot(1),  or size(2) */
271         char            map[3];                 /* defines which target-axis deform is copied by each owner-axis */
272         char            expo;                   /* extrapolate motion? if 0, confine to ranges */
273         
274         float           from_min[3];    /* from_min/max defines range of target transform       */
275         float           from_max[3];    /*      to map on to to_min/max range.                  */
276         
277         float           to_min[3];              /* range of motion on owner caused by target  */
278         float           to_max[3];      
279 } bTransformConstraint;
280
281 /* transform limiting constraints - zero target ----------------------------  */
282 /* Limit Location Constraint */
283 typedef struct bLocLimitConstraint {
284         float           xmin, xmax;
285         float           ymin, ymax;
286         float           zmin, zmax;
287         short           flag;
288         short           flag2;
289 } bLocLimitConstraint;
290
291 /* Limit Rotation Constraint */
292 typedef struct bRotLimitConstraint {
293         float           xmin, xmax;
294         float           ymin, ymax;
295         float           zmin, zmax;
296         short           flag;
297         short           pad1;
298 } bRotLimitConstraint;
299
300 /* Limit Scaling Constraint */
301 typedef struct bSizeLimitConstraint {
302         float           xmin, xmax;
303         float           ymin, ymax;
304         float           zmin, zmax;
305         short           flag;
306         short           pad1;
307 } bSizeLimitConstraint;
308
309 /* ------------------------------------------ */
310
311 /* bConstraint->type 
312  *      - Do not ever change the order of these, or else files could get
313  *        broken as their correct value cannot be resolved
314  */
315 typedef enum B_CONSTAINT_TYPES {
316         CONSTRAINT_TYPE_NULL = 0,                       /* Invalid/legacy constraint */
317         CONSTRAINT_TYPE_CHILDOF,                        /* Unimplemented non longer :) - during constraints recode, Aligorith */
318         CONSTRAINT_TYPE_TRACKTO,
319         CONSTRAINT_TYPE_KINEMATIC,
320         CONSTRAINT_TYPE_FOLLOWPATH,
321         CONSTRAINT_TYPE_ROTLIMIT,                       /* Unimplemented no longer :) - Aligorith */
322         CONSTRAINT_TYPE_LOCLIMIT,                       /* Unimplemented no longer :) - Aligorith */
323         CONSTRAINT_TYPE_SIZELIMIT,                      /* Unimplemented no longer :) - Aligorith */
324         CONSTRAINT_TYPE_ROTLIKE,        
325         CONSTRAINT_TYPE_LOCLIKE,        
326         CONSTRAINT_TYPE_SIZELIKE,
327         CONSTRAINT_TYPE_PYTHON,                         /* Unimplemented no longer :) - Aligorith. Scripts */
328         CONSTRAINT_TYPE_ACTION,
329         CONSTRAINT_TYPE_LOCKTRACK,                      /* New Tracking constraint that locks an axis in place - theeth */
330         CONSTRAINT_TYPE_DISTANCELIMIT,          /* was never properly coded - removed! */
331         CONSTRAINT_TYPE_STRETCHTO,                      /* claiming this to be mine :) is in tuhopuu bjornmose */ 
332         CONSTRAINT_TYPE_MINMAX,                         /* floor constraint */
333         CONSTRAINT_TYPE_RIGIDBODYJOINT,         /* rigidbody constraint */
334         CONSTRAINT_TYPE_CLAMPTO,                        /* clampto constraint */        
335         CONSTRAINT_TYPE_TRANSFORM,                      /* transformation (loc/rot/size -> loc/rot/size) constraint */  
336         
337         /* NOTE: everytime a new constraint is added, update this */
338         NUM_CONSTRAINT_TYPES= CONSTRAINT_TYPE_TRANSFORM
339 } B_CONSTRAINT_TYPES; 
340
341 /* bConstraint->flag */
342 /* flags 0x2 (1<<1) and 0x8 (1<<3) were used in past */
343 /* flag 0x20 (1<<5) was used to indicate that a constraint was evaluated using a 'local' hack for posebones only  */
344 typedef enum B_CONSTRAINT_FLAG {
345                 /* expand for UI */
346         CONSTRAINT_EXPAND =             (1<<0), 
347                 /* pre-check for illegal object name or bone name */
348         CONSTRAINT_DISABLE =    (1<<2), 
349                 /* to indicate which Ipo should be shown, maybe for 3d access later too */      
350         CONSTRAINT_ACTIVE =     (1<<4), 
351                 /* to indicate that the owner's space should only be changed into ownspace, but not out of it */
352         CONSTRAINT_SPACEONCE =  (1<<6),
353                 /* influence ipo is on constraint itself, not in action channel */
354         CONSTRAINT_OWN_IPO      = (1<<7)
355 } B_CONSTRAINT_FLAG;
356
357 /* bConstraint->ownspace/tarspace */
358 typedef enum B_CONSTRAINT_SPACETYPES {
359                 /* default for all - worldspace */
360         CONSTRAINT_SPACE_WORLD = 0,
361                 /* for objects (relative to parent/without parent influence), 
362                  * for bones (along normals of bone, without parent/restpositions) 
363                  */
364         CONSTRAINT_SPACE_LOCAL,
365                 /* for posechannels - pose space  */
366         CONSTRAINT_SPACE_POSE,
367                 /* for posechannels - local with parent  */
368         CONSTRAINT_SPACE_PARLOCAL,
369 } B_CONSTRAINT_SPACETYPES;
370
371 /* bConstraintChannel.flag */
372 typedef enum B_CONSTRAINTCHANNEL_FLAG {
373         CONSTRAINT_CHANNEL_SELECT =             (1<<0),
374         CONSTRAINT_CHANNEL_PROTECTED =  (1<<1)
375 } B_CONSTRAINTCHANNEL_FLAG;
376
377 /* -------------------------------------- */
378
379 /**
380  * The flags for ROTLIKE, LOCLIKE and SIZELIKE should be kept identical
381  * (that is, same effect, different name). It simplifies the Python API access a lot.
382  */
383
384 /* bRotateLikeConstraint.flag */
385 #define ROTLIKE_X               0x01
386 #define ROTLIKE_Y               0x02
387 #define ROTLIKE_Z               0x04
388 #define ROTLIKE_X_INVERT        0x10
389 #define ROTLIKE_Y_INVERT        0x20
390 #define ROTLIKE_Z_INVERT        0x40
391 #define ROTLIKE_OFFSET  0x80
392
393 /* bLocateLikeConstraint.flag */
394 #define LOCLIKE_X                       0x01
395 #define LOCLIKE_Y                       0x02
396 #define LOCLIKE_Z                       0x04
397         /* LOCLIKE_TIP is a depreceated option... use headtail=1.0f instead */
398 #define LOCLIKE_TIP                     0x08
399 #define LOCLIKE_X_INVERT        0x10
400 #define LOCLIKE_Y_INVERT        0x20
401 #define LOCLIKE_Z_INVERT        0x40
402 #define LOCLIKE_OFFSET          0x80
403  
404 /* bSizeLikeConstraint.flag */
405 #define SIZELIKE_X              0x01
406 #define SIZELIKE_Y              0x02
407 #define SIZELIKE_Z              0x04
408 #define SIZELIKE_OFFSET 0x80
409
410 /* Axis flags */
411 #define LOCK_X          0x00
412 #define LOCK_Y          0x01
413 #define LOCK_Z          0x02
414
415 #define UP_X            0x00
416 #define UP_Y            0x01
417 #define UP_Z            0x02
418
419 #define TRACK_X         0x00
420 #define TRACK_Y         0x01
421 #define TRACK_Z         0x02
422 #define TRACK_nX        0x03
423 #define TRACK_nY        0x04
424 #define TRACK_nZ        0x05
425
426 /* bTrackToConstraint->flags */
427 #define TARGET_Z_UP 0x01
428
429 #define VOLUME_XZ       0x00
430 #define VOLUME_X        0x01
431 #define VOLUME_Z        0x02
432 #define NO_VOLUME       0x03
433
434 #define PLANE_X         0x00
435 #define PLANE_Y         0x01
436 #define PLANE_Z         0x02
437
438 /* Clamp-To Constraint ->flag */
439 #define CLAMPTO_AUTO    0
440 #define CLAMPTO_X               1
441 #define CLAMPTO_Y               2
442 #define CLAMPTO_Z               3
443
444 /* ClampTo Constraint ->flag2 */
445 #define CLAMPTO_CYCLIC  1
446
447 /* bKinematicConstraint->flag */
448 #define CONSTRAINT_IK_TIP               1
449 #define CONSTRAINT_IK_ROT               2
450 #define CONSTRAINT_IK_AUTO              4
451 #define CONSTRAINT_IK_TEMP              8
452 #define CONSTRAINT_IK_STRETCH   16
453 #define CONSTRAINT_IK_POS               32
454 #define CONSTRAINT_IK_SETANGLE  64
455 #define CONSTRAINT_IK_GETANGLE  128
456
457 /* MinMax (floor) flags */
458 #define MINMAX_STICKY   0x01
459 #define MINMAX_STUCK    0x02
460 #define MINMAX_USEROT   0x04
461
462 /* transform limiting constraints -> flag  */
463 #define LIMIT_XMIN 0x01
464 #define LIMIT_XMAX 0x02
465 #define LIMIT_YMIN 0x04
466 #define LIMIT_YMAX 0x08
467 #define LIMIT_ZMIN 0x10
468 #define LIMIT_ZMAX 0x20
469
470 #define LIMIT_XROT 0x01
471 #define LIMIT_YROT 0x02
472 #define LIMIT_ZROT 0x04
473
474 /* not used anymore - for older Limit Location constraints only */
475 #define LIMIT_NOPARENT 0x01
476
477 /* python constraint -> flag */
478 #define PYCON_USETARGETS        0x01
479 #define PYCON_SCRIPTERROR       0x02
480
481 /* ChildOf Constraint -> flag */
482 #define CHILDOF_LOCX    0x001
483 #define CHILDOF_LOCY    0x002
484 #define CHILDOF_LOCZ    0x004
485 #define CHILDOF_ROTX    0x008
486 #define CHILDOF_ROTY    0x010
487 #define CHILDOF_ROTZ    0x020
488 #define CHILDOF_SIZEX   0x040
489 #define CHILDOF_SIZEY   0x080
490 #define CHILDOF_SIZEZ   0x100
491
492 /* Rigid-Body Constraint */
493 #define CONSTRAINT_DRAW_PIVOT 0x40
494
495 /* important: these defines need to match up with PHY_DynamicTypes headerfile */
496 #define CONSTRAINT_RB_BALL              1
497 #define CONSTRAINT_RB_HINGE             2
498 #define CONSTRAINT_RB_CONETWIST 4
499 #define CONSTRAINT_RB_VEHICLE   11
500 #define CONSTRAINT_RB_GENERIC6DOF 12
501
502 #endif