claiming this to be mine .. to remain compatible to tuhopuu development
[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 typedef struct bConstraintChannel{
44         struct bConstraintChannel *next, *prev;
45         Ipo                     *ipo;
46         short           flag;
47         char            name[30];
48 } bConstraintChannel;
49
50 typedef struct bConstraint{
51         struct bConstraint *next, *prev;
52         void            *data;          /*      Constraint data (a valid constraint type) */
53         Ipo                     *ipo;           /*      Constraint ipo  */
54         char            type;           /*      Constraint type */
55         char            otype;          /*      Old type - for menu callbacks */
56         short           flag;           /*      Flag */
57         short           reserved1;      
58         char            name[30];       /*      Constraint name */
59
60         float           enforce;
61         float           time;           
62         float           offset[3];      /* Target location offset */
63         float           orient[3];      /* Target orientation offset */
64         float           roll[3];        /* Target roll offset (needed?) */
65 } bConstraint;
66
67 /* Single-target subobject constraints */
68 typedef struct bKinematicConstraint{
69         Object          *tar;
70         float           tolerance;              /* Acceptable distance from target */
71         int                     iterations;             /* Maximum number of iterations to try */
72         char            subtarget[32];  /* String to specify sub-object target */
73
74         float           cacheeff[3];    /* Target location cache */
75         int                     reserved1;
76
77         float           cachemat[4][4]; /* Result cache */
78 } bKinematicConstraint;
79
80 typedef struct bTrackToConstraint{
81         Object          *tar;
82         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*/
83         int                     reserved2;
84         char            subtarget[32];
85 } bTrackToConstraint;
86
87 typedef struct bRotateLikeConstraint{
88         Object          *tar;
89         int                     flag;
90         int                     reserved1;
91         char            subtarget[32];
92 } bRotateLikeConstraint;
93
94 typedef struct bLocateLikeConstraint{
95         Object          *tar;
96         int                     flag;
97         int                     reserved1;
98         char            subtarget[32];
99 } bLocateLikeConstraint;
100
101 typedef struct bActionConstraint{
102         Object          *tar;
103         int                     type;
104         short           start;
105         short           end;
106         float           min;
107         float           max;
108         struct bAction  *act;
109         char            subtarget[32];
110 } bActionConstraint;
111
112 /* Locked Axis Tracking constraint */
113 typedef struct bLockTrackConstraint{
114         Object          *tar;
115         int                     trackflag;
116         int                     lockflag;
117         char            subtarget[32];
118 } bLockTrackConstraint;
119
120 /* Follow Path constraints */
121 typedef struct bFollowPathConstraint{
122         Object          *tar;   /* Must be path object */
123         float           offset; /* Offset in time on the path (in frame) */
124         int                     followflag;
125         int                     trackflag;
126         int                     upflag;
127 } bFollowPathConstraint;
128
129 /* Distance Limiting constraints */
130 typedef struct bDistanceLimitConstraint{
131         Object  *tar;
132         char            subtarget[32];
133         float           pad1;
134         float           pad2;
135         float           distance;
136         float           offset[3];
137 } bDistanceLimitConstraint;     
138
139
140 /* Zero-target constraints */
141 typedef struct bRotationConstraint{
142         float xmin, xmax;
143         float ymin, ymax;
144         float zmin, zmax;
145 } bRotationConstraint;
146
147
148
149 /* bConstraint.type */
150 #define CONSTRAINT_TYPE_NULL            0
151 #define CONSTRAINT_TYPE_CHILDOF         1       /* Unimplemented */
152 #define CONSTRAINT_TYPE_TRACKTO         2       
153 #define CONSTRAINT_TYPE_KINEMATIC       3       
154 #define CONSTRAINT_TYPE_FOLLOWPATH      4
155 #define CONSTRAINT_TYPE_ROTLIMIT        5       /* Unimplemented */
156 #define CONSTRAINT_TYPE_LOCLIMIT        6       /* Unimplemented */
157 #define CONSTRAINT_TYPE_SIZELIMIT       7       /* Unimplemented */
158 #define CONSTRAINT_TYPE_ROTLIKE         8       
159 #define CONSTRAINT_TYPE_LOCLIKE         9       
160 #define CONSTRAINT_TYPE_SIZELIKE        10      /* Unimplemented */
161 #define CONSTRAINT_TYPE_PYTHON          11      /* Unimplemented */
162 #define CONSTRAINT_TYPE_ACTION          12
163 #define CONSTRAINT_TYPE_LOCKTRACK       13      /* New Tracking constraint that locks an axis in place - theeth */
164 #define CONSTRAINT_TYPE_DISTANCELIMIT   14 
165 #define CONSTRAINT_TYPE_STRETCHTO       15  /* claiming this to be mine :) is in tuhopuu bjornmose */ 
166
167
168 /* bConstraint.flag */
169 #define CONSTRAINT_EXPAND               0x00000001
170 #define CONSTRAINT_DONE                 0x00000002
171 #define CONSTRAINT_DISABLE              0x00000004
172 #define CONSTRAINT_LOOPTESTED   0x00000008
173 #define CONSTRAINT_NOREFRESH    0x00000010
174
175 #define CONSTRAINT_EXPAND_BIT   0
176 #define CONSTRAINT_DONE_BIT             1
177 #define CONSTRAINT_DISABLE_BIT  2
178
179 /* bConstraintChannel.flag */
180 #define CONSTRAINT_CHANNEL_SELECT       0x00000001
181
182 /* bLocateLikeConstraint.flag */
183 #define LOCLIKE_X               0x00000001
184 #define LOCLIKE_Y               0x00000002
185 #define LOCLIKE_Z               0x00000004
186 #define LOCSPACE                0x00000008
187
188 /* Tracking flags */
189 #define LOCK_X          0x00000000
190 #define LOCK_Y          0x00000001
191 #define LOCK_Z          0x00000002
192
193 #define UP_X            0x00000000
194 #define UP_Y            0x00000001
195 #define UP_Z            0x00000002
196
197 #define TRACK_X         0x00000000
198 #define TRACK_Y         0x00000001
199 #define TRACK_Z         0x00000002
200 #define TRACK_nX        0x00000003
201 #define TRACK_nY        0x00000004
202 #define TRACK_nZ        0x00000005
203
204 /* Tracking flags */
205 #define LOCK_X          0x00000000
206 #define LOCK_Y          0x00000001
207 #define LOCK_Z          0x00000002
208
209 #define UP_X            0x00000000
210 #define UP_Y            0x00000001
211 #define UP_Z            0x00000002
212
213 #define TRACK_X         0x00000000
214 #define TRACK_Y         0x00000001
215 #define TRACK_Z         0x00000002
216 #define TRACK_nX        0x00000003
217 #define TRACK_nY        0x00000004
218 #define TRACK_nZ        0x00000005
219
220 /* Tracking flags */
221 #define LOCK_X          0x00000000
222 #define LOCK_Y          0x00000001
223 #define LOCK_Z          0x00000002
224
225 #define UP_X            0x00000000
226 #define UP_Y            0x00000001
227 #define UP_Z            0x00000002
228
229 #define TRACK_X         0x00000000
230 #define TRACK_Y         0x00000001
231 #define TRACK_Z         0x00000002
232 #define TRACK_nX        0x00000003
233 #define TRACK_nY        0x00000004
234 #define TRACK_nZ        0x00000005
235
236 #endif
237