Orange branch: Revived hidden treasure, the Groups!
[blender.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 struct PartDeflect;
55 struct SoftBody;
56 struct FluidsimSettings;
57 struct DerivedMesh;
58
59 typedef struct bDeformGroup {
60         struct bDeformGroup *next, *prev;
61         char name[32];
62 } bDeformGroup;
63
64 typedef struct BoundBox {
65         float vec[8][3];
66 } BoundBox;
67
68 /* OcInfo and LBuf structs are for the Enji gameengine */
69
70 typedef struct OcInfo {
71         float dvec[3];
72         float size[3];
73 } OcInfo;
74
75 typedef struct LBuf {
76         short tot, max;
77         int pad;
78         struct Object **ob;
79 } LBuf;
80
81
82 typedef struct Object {
83         ID id;
84
85         short type, partype;
86         int par1, par2, par3;   /* can be vertexnrs */
87         char parsubstr[32];     /* String describing subobject info */
88         void *pardata;
89         struct Object *parent, *track;
90         struct Ipo *ipo;
91         struct Path *path;
92         struct BoundBox *bb;
93         struct bAction *action; 
94         struct bPose *pose;     
95         void *data;
96         
97         ListBase constraintChannels;
98         ListBase effect;
99         ListBase network;
100         ListBase disp;
101         ListBase defbase;
102         ListBase modifiers; /* list of ModifierData structures */
103         
104         struct Material **mat;
105         
106         /* rot en drot have to be together! (transform('r' en 's')) */
107         float loc[3], dloc[3], orig[3];
108         float size[3], dsize[3];
109         float rot[3], drot[3];
110         float quat[4], dquat[4];
111         float obmat[4][4];
112         float parentinv[4][4];
113         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
114         
115         unsigned int lay;                               /* copy of Base */
116         
117         short flag;                     /* copy of Base */
118         short colbits;          /* when zero, from obdata */
119         
120         short transflag, ipoflag;       /* transformation and ipo settings */
121         short trackflag, upflag;
122         short nlaflag, protectflag;     /* nlaflag defines NLA override, protectflag is bits to lock transform */
123         short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
124         short scavisflag, boundtype;
125         
126         short dupon, dupoff, dupsta, dupend;
127
128         float sf, ctime;
129         
130         /* during realtime */
131
132         /* note that inertia is only called inertia for historical reasons
133          * and is not changed to avoid DNA surgery. It actually reflects the 
134          * Size value in the GameButtons (= radius) */
135
136         float mass, damping, inertia;
137         /* The form factor k is introduced to give the user more control
138          * and to fix incompatibility problems.
139      * For rotational symmetric objects, the inertia value can be
140          * expressed as: Theta = k * m * r^2
141          * where m = Mass, r = Radius
142          * For a Sphere, the form factor is by default = 0.4
143          */
144
145         float formfactor, softtime;             /* softtime temp for softbody, remove it before release! */
146         float rdamping, sizefac;
147         
148         char dt, dtx;
149         char totcol;    /* copy of mesh or curve or meta */
150         char actcol;
151         
152         ScriptLink scriptlink;
153         ListBase prop;
154         ListBase sensors;
155         ListBase controllers;
156         ListBase actuators;
157
158     void *sumohandle;
159     
160         float bbsize[3];
161         short dfras;
162         unsigned short actdef;  /* current deformation group */
163         float col[4];
164         /**
165          * Settings for game objects
166          * bit 0: Object has dynamic behaviour
167          * bit 2: Object is evaluated by the gameengine
168          * bit 6: Use Fh settings in Materials
169          * bit 7: Use face normal to rotate Object
170          * bit 8: Friction is anisotropic
171          * bit 9: Object is a ghost
172          * bit 10: Do rigid body dynamics.
173          * bit 11: Use bounding object for physics
174          */
175         int gameflag;
176         /**
177          * More settings
178          * bit 15: Always ignore activity culling 
179          */
180         int gameflag2;
181         short softflag;                 /* softboday settings */
182         short recalc;                   /* dependency flag */
183         float anisotropicFriction[3];
184
185         ListBase constraints;
186         ListBase nlastrips;
187         ListBase hooks;
188         
189         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
190         struct SoftBody *soft;          /* if exists, saved in file */
191         struct Group *dup_group;        /* object duplicator for group */
192         
193         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
194         char shapenr, shapeflag;        /* current shape key for menu or pinned, flag for pinning */
195         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
196
197         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
198   
199         struct DerivedMesh *derivedDeform, *derivedFinal;
200 } Object;
201
202 typedef struct ObHook {
203         struct ObHook *next, *prev;
204         
205         struct Object *parent;
206         float parentinv[4][4];  /* matrix making current transform unmodified */
207         float mat[4][4];                /* temp matrix while hooking */
208         float cent[3];                  /* visualization of hook */
209         float falloff;                  /* if not zero, falloff is distance where influence zero */
210         
211         char name[32];
212
213         int *indexar;
214         int totindex, curindex; /* curindex is cache for fast lookup */
215         short type, active;             /* active is only first hook, for button menu */
216         float force;
217 } ObHook;
218
219
220 /* this work object is defined in object.c */
221 extern Object workob;
222
223
224 /* **************** OBJECT ********************* */
225
226 /* used many places... should be specialized  */
227 #define SELECT                  1
228
229 /* type */
230 #define OB_EMPTY                0
231 #define OB_MESH                 1
232 #define OB_CURVE                2
233 #define OB_SURF                 3
234 #define OB_FONT                 4
235 #define OB_MBALL                5
236
237 #define OB_LAMP                 10
238 #define OB_CAMERA               11
239
240 #define OB_WAVE                 21
241 #define OB_LATTICE              22
242
243 /* 23 and 24 are for life and sector (old file compat.) */
244 #define OB_ARMATURE             25
245
246 /* partype: first 4 bits: type */
247 #define PARTYPE                 15
248 #define PAROBJECT               0
249 #define PARCURVE                1
250 #define PARKEY                  2
251
252 #define PARSKEL                 4
253 #define PARVERT1                5
254 #define PARVERT3                6
255 #define PARBONE                 7
256 #define PARSLOW                 16
257
258 /* (short) transflag */
259 #define OB_OFFS_LOCAL   1
260 #define OB_QUAT                 2
261 #define OB_NEG_SCALE    4
262 #define OB_DUPLI                (8+16+256)
263 #define OB_DUPLIFRAMES  8
264 #define OB_DUPLIVERTS   16
265 #define OB_DUPLIROT             32
266 #define OB_DUPLINOSPEED 64
267 #define OB_POWERTRACK   128
268 #define OB_DUPLIGROUP   256
269
270 /* (short) ipoflag */
271 #define OB_DRAWKEY                      1
272 #define OB_DRAWKEYSEL           2
273 #define OB_OFFS_OB                      4
274 #define OB_OFFS_MAT                     8
275 #define OB_OFFS_VKEY            16
276 #define OB_OFFS_PATH            32
277 #define OB_OFFS_PARENT          64
278 #define OB_OFFS_PARTICLE        128
279         /* get ipo from from action or not? */
280 #define OB_ACTION_OB            256
281 #define OB_ACTION_KEY           512
282         /* for stride edit */
283 #define OB_DISABLE_PATH         1024
284
285 /* (short) trackflag / upflag */
286 #define OB_POSX                 0
287 #define OB_POSY                 1
288 #define OB_POSZ                 2
289 #define OB_NEGX                 3
290 #define OB_NEGY                 4
291 #define OB_NEGZ                 5
292
293 /* gameflag in game.h */
294
295 /* dt: no flags */
296 #define OB_BOUNDBOX             1
297 #define OB_WIRE                 2
298 #define OB_SOLID                3
299 #define OB_SHADED               4
300 #define OB_TEXTURE              5
301
302 /* dtx: flags, char! */
303 #define OB_AXIS                 2
304 #define OB_TEXSPACE             4
305 #define OB_DRAWNAME             8
306 #define OB_DRAWIMAGE    16
307         /* for solid+wire display */
308 #define OB_DRAWWIRE             32
309         /* for overdraw */
310 #define OB_DRAWXRAY             64
311         /* enable transparent draw */
312 #define OB_DRAWTRANSP   128
313
314 /* boundtype */
315 #define OB_BOUND_BOX            0
316 #define OB_BOUND_SPHERE         1
317 #define OB_BOUND_CYLINDER       2
318 #define OB_BOUND_CONE           3
319 #define OB_BOUND_POLYH          4
320 #define OB_BOUND_POLYT          5
321
322 /* also needed for base!!!!! or rather, thy interfere....*/
323 /* base->flag and ob->flag */
324 #define BA_WAS_SEL                      2
325 #define BA_HAS_RECALC_OB        4
326 #define BA_HAS_RECALC_DATA      8
327
328 #define BA_DO_IPO                       32
329 #define OB_GONNA_MOVE           32
330
331 #define BA_FROMSET                      128
332 #define OB_DO_IMAT                      256
333 #define OB_FROMDUPLI            512
334 #define OB_DONE                         1024
335 #define OB_RADIO                        2048
336 #define OB_FROMGROUP            4096
337 #define OB_POSEMODE                     8192
338
339 /* ob->recalc (flag bits!) */
340 #define OB_RECALC_OB            1
341 #define OB_RECALC_DATA          2
342 #define OB_RECALC                       3
343
344
345 /* ob->gameflag */
346 #define OB_DYNAMIC              1
347 #define OB_CHILD                2
348 #define OB_ACTOR                4
349 #define OB_INERTIA_LOCK_X       8
350 #define OB_INERTIA_LOCK_Y       16
351 #define OB_INERTIA_LOCK_Z       32
352 #define OB_DO_FH                        64
353 #define OB_ROT_FH                       128
354 #define OB_ANISOTROPIC_FRICTION 256
355 #define OB_GHOST                        512
356 #define OB_RIGID_BODY           1024
357 #define OB_BOUNDS               2048
358
359 #define OB_COLLISION_RESPONSE   4096
360 #define OB_SECTOR               8192
361 #define OB_PROP                 16384
362 #define OB_MAINACTOR    32768
363
364 /* ob->gameflag2 */
365 #define OB_NEVER_DO_ACTIVITY_CULLING    1
366
367 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
368
369 /* ob->scavisflag */
370 #define OB_VIS_SENS             1
371 #define OB_VIS_CONT             2
372 #define OB_VIS_ACT              4
373
374 /* ob->scaflag */
375 #define OB_SHOWSENS             64
376 #define OB_SHOWACT              128
377 #define OB_ADDSENS              256
378 #define OB_ADDCONT              512
379 #define OB_ADDACT               1024
380 #define OB_SHOWCONT             2048
381
382 /* ob->shapeflag */
383 #define OB_SHAPE_LOCK           1
384 #define OB_SHAPE_TEMPLOCK       2
385
386 /* ob->nlaflag */
387 #define OB_NLA_OVERRIDE         1
388
389 /* ob->protectflag */
390 #define OB_LOCK_LOCX    1
391 #define OB_LOCK_LOCY    2
392 #define OB_LOCK_LOCZ    4
393 #define OB_LOCK_LOC             7
394 #define OB_LOCK_ROTX    8
395 #define OB_LOCK_ROTY    16
396 #define OB_LOCK_ROTZ    32
397 #define OB_LOCK_SIZEX   64
398 #define OB_LOCK_SIZEY   128
399 #define OB_LOCK_SIZEZ   256
400
401 /* ob->softflag in DNA_object_force.h */
402
403 #ifdef __cplusplus
404 }
405 #endif
406
407 #endif
408