fixed spacing in the headers to get rid of some warnings and some other
[blender-staging.git] / source / blender / makesdna / DNA_object_types.h
1 /**
2  * blenlib/DNA_object_types.h (mar-2001 nzc)
3  *      
4  * Object is a sort of wrapper for general info.
5  *
6  * $Id$ 
7  *
8  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version. The Blender
14  * Foundation also sells licenses for use in proprietary software under
15  * the Blender License.  See http://www.blender.org/BL/ for information
16  * about this.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  *
27  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
28  * All rights reserved.
29  *
30  * The Original Code is: all of this file.
31  *
32  * Contributor(s): none yet.
33  *
34  * ***** END GPL/BL DUAL LICENSE BLOCK *****
35  */
36 #ifndef DNA_OBJECT_TYPES_H
37 #define DNA_OBJECT_TYPES_H
38
39 #include "DNA_listBase.h"
40 #include "DNA_ID.h"
41 #include "DNA_scriptlink_types.h"
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 struct bPose;   
48 struct Object;
49 struct Ipo;
50 struct BoundBox;
51 struct Path;
52 struct Material;
53 struct bConstraintChannel;
54
55 typedef struct bDeformGroup {
56         struct bDeformGroup *next, *prev;
57         char name[32];
58         void *data;     /* Temporary data, most likely a pointer to the bone - no need to delete */
59 } bDeformGroup;
60
61 #
62 #
63 typedef struct BoundBox {
64         float vec[8][3];
65 } BoundBox;
66
67
68 typedef struct Object {
69         ID id;
70
71         short type, partype;
72         int par1, par2, par3;   /* kunnen vertexnrs zijn */
73         char parsubstr[32];     /* String describing subobject info */
74         void *pardata;
75         struct Object *parent, *track;
76         struct Ipo *ipo;
77         struct Path *path;
78         struct BoundBox *bb;
79         struct bAction *action; 
80         struct bPose *pose;     
81         void *data;
82         
83         struct bConstraintChannel *activecon;           
84         ListBase constraintChannels;
85
86         ListBase effect;
87         ListBase network;
88         ListBase disp;
89         ListBase defbase;
90         struct Material **mat;
91         
92         /* rot en drot moeten achterelkaar! (transform('r' en 's')) */
93         float loc[3], dloc[3], orig[3];
94         float size[3], dsize[3];
95         float rot[3], drot[3];
96         float quat[4], dquat[4];
97         float obmat[4][4];
98         float parentinv[4][4];
99         float imat[4][4];       /* voor bij render, tijdens simulate, tijdelijk: ipokeys van transform  */
100         
101         unsigned int lay;                               /* kopie van Base */
102         short flag;                     /* kopie van Base */
103         short colbits;          /* nul==van obdata */
104         char transflag, ipoflag;
105         char trackflag, upflag;
106         short ipowin, scaflag;  /* ipowin: blocktype laatste ipowindow */
107         short scavisflag, boundtype;
108         
109         short dupon, dupoff, dupsta, dupend;
110
111         float sf, ctime;
112         
113         /* tijdens realtime */
114
115         /* note that inertia is only called inertia for historical reasons
116          * and is not changed to avoid DNA surgery. It actually reflects the 
117          * Size value in the GameButtons (= radius) */
118
119         float mass, damping, inertia;
120         /* The form factor k is introduced to give the user more control
121          * and to fix incompatibility problems.
122      * For rotational symmetric objects, the inertia value can be
123          * expressed as: Theta = k * m * r^2
124          * where m = Mass, r = Radius
125          * For a Sphere, the form factor is by default = 0.4
126          */
127
128         float formfactor, dummy_1;      
129         float rdamping, sizefac;
130         
131         char dt, dtx;
132         char totcol;    /* kopie van mesh of curve of meta */
133         char actcol;
134         
135         ScriptLink scriptlink;
136         ListBase prop;
137         ListBase sensors;
138         ListBase controllers;
139         ListBase actuators;
140
141     void *sumohandle;
142     
143         float bbsize[3];
144         short dfras;
145         unsigned short actdef;  /* current deformation group */
146         float col[4];
147         /**
148          * Settings for game objects
149          * bit 0: Object has dynamic behaviour
150          * bit 2: Object is evaluated by the gameengine
151          * bit 6: Use Fh settings in Materials
152          * bit 7: Use face normal to rotate Object
153          * bit 8: Friction is anisotropic
154          * bit 9: Object is a ghost
155          * bit 10: Do rigid body dynamics.
156          */
157         int gameflag;
158         /**
159          * More settings
160          * bit 15: Always ignore activity culling 
161          */
162         int gameflag2;
163         int pad;
164         float anisotropicFriction[3];
165
166         ListBase constraints;
167         ListBase nlastrips;
168 } Object;
169
170 /* this work object is defined in object.c */
171 extern Object workob;
172
173
174 /* **************** OBJECT ********************* */
175
176 /* used many places... should be specialized */
177 #define SELECT                  1
178 #define ACTIVE                  2
179
180 /* type */
181 #define OB_EMPTY                0
182 #define OB_MESH                 1
183 #define OB_CURVE                2
184 #define OB_SURF                 3
185 #define OB_FONT                 4
186 #define OB_MBALL                5
187
188 #define OB_LAMP                 10
189 #define OB_CAMERA               11
190
191 #define OB_IKA                  20
192 #define OB_WAVE                 21
193 #define OB_LATTICE              22
194
195 /* 23 and 24 are for life and sector (old file compat.) */
196 #define OB_ARMATURE             25
197
198 /* partype: eerste 5 bits: type */
199 #define PARTYPE                 15
200 #define PAROBJECT               0
201 #define PARCURVE                1
202 #define PARKEY                  2
203 #define PARLIMB                 3
204 #define PARSKEL                 4
205 #define PARVERT1                5
206 #define PARVERT3                6
207 #define PARBONE                 7
208 #define PARSLOW                 16
209
210 /* char! transflag */
211 #define OB_OFFS_LOCAL   1
212 #define OB_QUAT                 2
213 #define OB_DUPLI                (8+16)
214 #define OB_DUPLIFRAMES  8
215 #define OB_DUPLIVERTS   16
216 #define OB_DUPLIROT             32
217 #define OB_DUPLINOSPEED 64
218
219 #define OB_POWERTRACK   128
220
221 /* char! ipoflag */
222 #define OB_DRAWKEY                      1
223 #define OB_DRAWKEYSEL           2
224 #define OB_OFFS_OB                      4
225 #define OB_OFFS_MAT                     8
226 #define OB_OFFS_VKEY            16
227 #define OB_OFFS_PATH            32
228 #define OB_OFFS_PARENT          64
229 #define OB_OFFS_PARTICLE        128
230
231
232 /* trackflag / upflag */
233 #define OB_POSX                 0
234 #define OB_POSY                 1
235 #define OB_POSZ                 2
236 #define OB_NEGX                 3
237 #define OB_NEGY                 4
238 #define OB_NEGZ                 5
239
240 /* gameflag in game.h */
241
242 /* dt: nummers */
243 #define OB_BOUNDBOX             1
244 #define OB_WIRE                 2
245 #define OB_SOLID                3
246 #define OB_SHADED               4
247 #define OB_TEXTURE              5
248
249 /* dtx: flags */
250 #define OB_AXIS                 2
251 #define OB_TEXSPACE             4
252 #define OB_DRAWNAME             8
253 #define OB_DRAWIMAGE    16
254
255 /* boundtype */
256 #define OB_BOUND_BOX            0
257 #define OB_BOUND_SPHERE         1
258 #define OB_BOUND_CYLINDER       2
259 #define OB_BOUND_CONE           3
260 #define OB_BOUND_POLYH          4
261
262 /* also needed for base!!!!! or rather, thy interfere....*/
263 /* base->flag en ob->flag */
264 #define BA_WASSEL                       2
265 #define BA_PARSEL                       4
266 #define BA_WHERE_UPDATE         8
267 #define BA_DISP_UPDATE          16
268 #define BA_DO_IPO                       32
269 #define BA_FROMSET                      128
270 #define OB_DO_IMAT                      256
271 #define OB_FROMDUPLI            512
272 #define OB_DONE                         1024
273 #define OB_RADIO                        2048
274 #define OB_FROMGROUP            4096
275
276 /* ob->gameflag */
277 #define OB_DYNAMIC              1
278 #define OB_CHILD                2
279 #define OB_ACTOR                4
280 #define OB_INERTIA_LOCK_X       8
281 #define OB_INERTIA_LOCK_Y       16
282 #define OB_INERTIA_LOCK_Z       32
283 #define OB_DO_FH                        64
284 #define OB_ROT_FH                       128
285 #define OB_ANISOTROPIC_FRICTION 256
286 #define OB_GHOST                        512
287 #define OB_RIGID_BODY           1024
288
289 #define OB_COLLISION_RESPONSE   4096
290 #define OB_SECTOR               8192
291 #define OB_PROP                 16384
292 #define OB_MAINACTOR    32768
293
294 /* ob->gameflag2 */
295 #define OB_NEVER_DO_ACTIVITY_CULLING    1
296
297 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
298
299 /* ob->scavisflag */
300 #define OB_VIS_SENS             1
301 #define OB_VIS_CONT             2
302 #define OB_VIS_ACT              4
303
304 /* ob->scaflag */
305 #define OB_SHOWSENS             64
306 #define OB_SHOWACT              128
307 #define OB_ADDSENS              256
308 #define OB_ADDCONT              512
309 #define OB_ADDACT               1024
310 #define OB_SHOWCONT             2048
311
312 #ifdef __cplusplus
313 }
314 #endif
315
316 #endif
317