New Constraint option for Pose: "Local" Copy Location/Rotation.
[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): none yet.
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_object_types.h"
40
41 struct Action;
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 typedef struct bConstraint{
52         struct bConstraint *next, *prev;
53         void            *data;          /*      Constraint data (a valid constraint type) */
54         short           type;           /*      Constraint type */
55         short           flag;           /*      Flag */
56         short           reserved1;      
57         char            name[30];       /*      Constraint name */
58
59         float           enforce;
60 } bConstraint;
61
62 /* Single-target subobject constraints */
63 typedef struct bKinematicConstraint{
64         Object          *tar;
65         float           tolerance;              /* Acceptable distance from target */
66         short           iterations;             /* Maximum number of iterations to try */
67         short           flag;                   /* Like CONSTRAINT_IK_TIP */
68         int                     rootbone, pad;  /* index to rootbone, if zero go all the way to mother bone */
69         char            subtarget[32];  /* String to specify sub-object target */
70
71         float           weight;                 /* Weight of goal in IK tree */
72         float           orientweight;   /* Amount of rotation a target applies on chain */
73         float           grabtarget[3];  /* for target-less IK */
74         float           pad2;
75 } bKinematicConstraint;
76
77 typedef struct bTrackToConstraint{
78         Object          *tar;
79         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*/
80         int                     reserved2;
81         char            subtarget[32];
82 } bTrackToConstraint;
83
84 typedef struct bRotateLikeConstraint{
85         Object          *tar;
86         int                     flag;
87         int                     reserved1;
88         char            subtarget[32];
89 } bRotateLikeConstraint;
90
91 typedef struct bLocateLikeConstraint{
92         Object          *tar;
93         int                     flag;
94         int                     reserved1;
95         char            subtarget[32];
96 } bLocateLikeConstraint;
97
98 typedef struct bMinMaxConstraint{
99         Object          *tar;
100         int                     minmaxflag;
101         float                   offset;
102         short                   sticky;
103         short                   stuck;
104         float                   cache[3];
105         char            subtarget[32];
106 } bMinMaxConstraint;
107
108 typedef struct bActionConstraint{
109         Object          *tar;
110         short           type;
111         short           local;
112         short           start;
113         short           end;
114         float           min;
115         float           max;
116         struct bAction  *act;
117         char            subtarget[32];
118 } bActionConstraint;
119
120 /* Locked Axis Tracking constraint */
121 typedef struct bLockTrackConstraint{
122         Object          *tar;
123         int                     trackflag;
124         int                     lockflag;
125         char            subtarget[32];
126 } bLockTrackConstraint;
127
128 /* Follow Path constraints */
129 typedef struct bFollowPathConstraint{
130         Object          *tar;   /* Must be path object */
131         float           offset; /* Offset in time on the path (in frame) */
132         int                     followflag;
133         int                     trackflag;
134         int                     upflag;
135 } bFollowPathConstraint;
136
137 /* Distance Limiting constraints */
138 typedef struct bDistanceLimitConstraint{
139         Object  *tar;
140         char            subtarget[32];
141         float           pad1;
142         float           pad2;
143         float           distance;
144         float           offset[3];
145 } bDistanceLimitConstraint;     
146
147
148 /* Zero-target constraints */
149 typedef struct bRotationConstraint{
150         float xmin, xmax;
151         float ymin, ymax;
152         float zmin, zmax;
153 } bRotationConstraint;
154
155 /* Stretch to constraint */
156 typedef struct bStretchToConstraint{
157         Object          *tar;
158         int                     volmode; 
159         int         plane;
160         float           orglength;
161         float           bulge;
162         char            subtarget[32];
163 } bStretchToConstraint;
164
165
166 /* bConstraint.type */
167 #define CONSTRAINT_TYPE_NULL            0
168 #define CONSTRAINT_TYPE_CHILDOF         1       /* Unimplemented */
169 #define CONSTRAINT_TYPE_TRACKTO         2       
170 #define CONSTRAINT_TYPE_KINEMATIC       3       
171 #define CONSTRAINT_TYPE_FOLLOWPATH      4
172 #define CONSTRAINT_TYPE_ROTLIMIT        5       /* Unimplemented */
173 #define CONSTRAINT_TYPE_LOCLIMIT        6       /* Unimplemented */
174 #define CONSTRAINT_TYPE_SIZELIMIT       7       /* Unimplemented */
175 #define CONSTRAINT_TYPE_ROTLIKE         8       
176 #define CONSTRAINT_TYPE_LOCLIKE         9       
177 #define CONSTRAINT_TYPE_SIZELIKE        10      /* Unimplemented */
178 #define CONSTRAINT_TYPE_PYTHON          11      /* Unimplemented */
179 #define CONSTRAINT_TYPE_ACTION          12
180 #define CONSTRAINT_TYPE_LOCKTRACK       13      /* New Tracking constraint that locks an axis in place - theeth */
181 #define CONSTRAINT_TYPE_DISTANCELIMIT   14 
182 #define CONSTRAINT_TYPE_STRETCHTO       15  /* claiming this to be mine :) is in tuhopuu bjornmose */ 
183 #define CONSTRAINT_TYPE_MINMAX      16  /* floor constraint */
184
185
186 /* bConstraint.flag */
187                 /* expand for UI */
188 #define CONSTRAINT_EXPAND               0x01
189                 /* pre-check for illegal object name or bone name */
190 #define CONSTRAINT_DISABLE              0x04
191                 /* flags 0x2 and 0x8 were used in past, skip this */
192                 /* to indicate which Ipo should be shown, maybe for 3d access later too */
193 #define CONSTRAINT_ACTIVE               0x10
194                 /* only for Pose, evaluates constraints in posechannel local space */
195 #define CONSTRAINT_LOCAL                0x20
196
197
198 /* bConstraintChannel.flag */
199 #define CONSTRAINT_CHANNEL_SELECT       0x01
200
201 /* bR\12otateLikeConstraint.flag */
202 #define ROTLIKE_X               0x01
203 #define ROTLIKE_Y               0x02
204 #define ROTLIKE_Z               0x04
205
206 /* bLocateLikeConstraint.flag */
207 #define LOCLIKE_X               0x01
208 #define LOCLIKE_Y               0x02
209 #define LOCLIKE_Z               0x04
210 #define LOCSPACE                0x08
211
212 /* Axis flags */
213 #define LOCK_X          0x00
214 #define LOCK_Y          0x01
215 #define LOCK_Z          0x02
216
217 #define UP_X            0x00
218 #define UP_Y            0x01
219 #define UP_Z            0x02
220
221 #define TRACK_X         0x00
222 #define TRACK_Y         0x01
223 #define TRACK_Z         0x02
224 #define TRACK_nX        0x03
225 #define TRACK_nY        0x04
226 #define TRACK_nZ        0x05
227
228 #define VOLUME_XZ       0x00
229 #define VOLUME_X        0x01
230 #define VOLUME_Z        0x02
231 #define NO_VOLUME       0x03
232
233 #define PLANE_X         0x00
234 #define PLANE_Y         0x01
235 #define PLANE_Z         0x02
236
237 /* bKinematicConstraint->flag */
238 #define CONSTRAINT_IK_TIP               1
239 #define CONSTRAINT_IK_ROT               2
240 #define CONSTRAINT_IK_AUTO              4
241 #define CONSTRAINT_IK_TEMP              8
242
243 #endif
244