BGE patch: add Debug button next to object state. The object state mask will be print...
[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 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.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33 #ifndef DNA_OBJECT_TYPES_H
34 #define DNA_OBJECT_TYPES_H
35
36 #include "DNA_listBase.h"
37 #include "DNA_ID.h"
38 #include "DNA_scriptlink_types.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 struct bPose;   
45 struct Object;
46 struct Ipo;
47 struct BoundBox;
48 struct Path;
49 struct Material;
50 struct bConstraintChannel;
51 struct PartDeflect;
52 struct SoftBody;
53 struct FluidsimSettings;
54 struct ParticleSystem;
55 struct DerivedMesh;
56
57 typedef struct bDeformGroup {
58         struct bDeformGroup *next, *prev;
59         char name[32];
60 } bDeformGroup;
61
62 /**
63  * The following illustrates the orientation of the 
64  * bounding box in local space
65  * 
66  *  
67  * Z  Y
68  * | /
69  * |/
70  * .-----X
71  * 
72  * 
73  *     2----------6
74  *    /|         /|
75  *   / |        / |
76  *  1----------5  |
77  *  |  |       |  |
78  *  |  3-------|--7
79  *  | /        | /
80  *  |/         |/
81  *  0----------4
82  */
83 typedef struct BoundBox {
84         float vec[8][3];
85         int flag, pad;
86 } BoundBox;
87
88 /* boundbox flag */
89 #define OB_BB_DISABLED  1
90
91 typedef struct Object {
92         ID id;
93
94         short type, partype;
95         int par1, par2, par3;   /* can be vertexnrs */
96         char parsubstr[32];     /* String describing subobject info */
97         struct Object *parent, *track;
98         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
99         /* proxy_from is set in target back to the proxy. */
100         struct Object *proxy, *proxy_group, *proxy_from;
101         struct Ipo *ipo;
102         struct Path *path;
103         struct BoundBox *bb;
104         struct bAction *action; 
105         struct bAction *poselib;
106         struct bPose *pose;     
107         void *data;
108         
109         ListBase constraintChannels;
110         ListBase effect;
111         ListBase disp;
112         ListBase defbase;
113         ListBase modifiers; /* list of ModifierData structures */
114         
115         struct Material **mat;
116         
117         /* rot en drot have to be together! (transform('r' en 's')) */
118         float loc[3], dloc[3], orig[3];
119         float size[3], dsize[3];
120         float rot[3], drot[3];
121         /* float quat[4], dquat[4]; (not used yet) */
122         float obmat[4][4];
123         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
124         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
125         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
126         
127         unsigned int lay;                               /* copy of Base */
128         
129         short flag;                     /* copy of Base */
130         short colbits;          /* when zero, from obdata */
131         
132         short transflag, ipoflag;       /* transformation and ipo settings */
133         short trackflag, upflag;
134         short nlaflag, protectflag;     /* nlaflag defines NLA override, protectflag is bits to lock transform */
135         short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
136         short scavisflag, boundtype;
137         
138         int dupon, dupoff, dupsta, dupend;
139
140         float sf, ctime; /* sf is time-offset, ctime is the objects current time */
141         
142         /* during realtime */
143
144         /* note that inertia is only called inertia for historical reasons
145          * and is not changed to avoid DNA surgery. It actually reflects the 
146          * Size value in the GameButtons (= radius) */
147
148         float mass, damping, inertia;
149         /* The form factor k is introduced to give the user more control
150          * and to fix incompatibility problems.
151      * For rotational symmetric objects, the inertia value can be
152          * expressed as: Theta = k * m * r^2
153          * where m = Mass, r = Radius
154          * For a Sphere, the form factor is by default = 0.4
155          */
156
157         float formfactor;
158         float rdamping, sizefac;
159         float margin;
160         /* for game engine soft body */
161         float linearStiffness;
162         float angularStiffness;
163         float volumePreservation;
164         int   gamesoftFlag;
165         int   pad3;
166
167
168
169         char dt, dtx;
170         char totcol;    /* copy of mesh or curve or meta */
171         char actcol;    /* currently selected material in the user interface */
172         char empty_drawtype, pad1[3];
173         float empty_drawsize;
174         float dupfacesca;       /* dupliface scale */
175         
176         ScriptLink scriptlink;
177         ListBase prop;
178         ListBase sensors;
179         ListBase controllers;
180         ListBase actuators;
181     
182         float bbsize[3];
183         short index;                    /* custom index, for renderpasses */
184         unsigned short actdef;  /* current deformation group */
185         float col[4];                   /* object color, adjusted via IPO's only */
186         /**
187          * Settings for game objects
188          * bit 0: Object has dynamic behaviour
189          * bit 2: Object is evaluated by the gameengine
190          * bit 6: Use Fh settings in Materials
191          * bit 7: Use face normal to rotate Object
192          * bit 8: Friction is anisotropic
193          * bit 9: Object is a ghost
194          * bit 10: Do rigid body dynamics.
195          * bit 11: Use bounding object for physics
196          */
197         int gameflag;
198         /**
199          * More settings
200          * bit 15: Always ignore activity culling 
201          */
202         int gameflag2;
203         short softflag;                 /* softboday settings */
204         short recalc;                   /* dependency flag */
205         float anisotropicFriction[3];
206
207         ListBase constraints;
208         ListBase nlastrips;
209         ListBase hooks;
210         ListBase particlesystem;        /* particle systems */
211         
212         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
213         struct SoftBody *soft;          /* if exists, saved in file */
214         struct Group *dup_group;        /* object duplicator for group */
215         
216         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
217         
218         short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
219
220         short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
221         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
222         short recalco;                          /* recalco for temp storage of ob->recalc, bad design warning */
223         short body_type;                        /* for now used to temporarily holds the type of collision object */
224         
225         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
226
227         struct DerivedMesh *derivedDeform, *derivedFinal;
228         int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
229         unsigned int state;                     /* bit masks of game controllers that are active */
230         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
231         int pad2;
232
233 /*#ifdef WITH_VERSE*/
234         void *vnode;                    /* pointer at object VerseNode */
235 /*#endif*/
236
237         ListBase gpulamp;               /* runtime, for lamps only */
238 } Object;
239
240 /* Warning, this is not used anymore because hooks are now modifiers */
241 typedef struct ObHook {
242         struct ObHook *next, *prev;
243         
244         struct Object *parent;
245         float parentinv[4][4];  /* matrix making current transform unmodified */
246         float mat[4][4];                /* temp matrix while hooking */
247         float cent[3];                  /* visualization of hook */
248         float falloff;                  /* if not zero, falloff is distance where influence zero */
249         
250         char name[32];
251
252         int *indexar;
253         int totindex, curindex; /* curindex is cache for fast lookup */
254         short type, active;             /* active is only first hook, for button menu */
255         float force;
256 } ObHook;
257
258
259 /* this work object is defined in object.c */
260 extern Object workob;
261
262
263 /* **************** OBJECT ********************* */
264
265 /* used many places... should be specialized  */
266 #define SELECT                  1
267
268 /* type */
269 #define OB_EMPTY                0
270 #define OB_MESH                 1
271 #define OB_CURVE                2
272 #define OB_SURF                 3
273 #define OB_FONT                 4
274 #define OB_MBALL                5
275
276 #define OB_LAMP                 10
277 #define OB_CAMERA               11
278
279 #define OB_WAVE                 21
280 #define OB_LATTICE              22
281
282 /* 23 and 24 are for life and sector (old file compat.) */
283 #define OB_ARMATURE             25
284
285 /* partype: first 4 bits: type */
286 #define PARTYPE                 15
287 #define PAROBJECT               0
288 #define PARCURVE                1
289 #define PARKEY                  2
290
291 #define PARSKEL                 4
292 #define PARVERT1                5
293 #define PARVERT3                6
294 #define PARBONE                 7
295 #define PARSLOW                 16
296
297 /* (short) transflag */
298 #define OB_OFFS_LOCAL           1
299 #define OB_QUAT                         2
300 #define OB_NEG_SCALE            4
301 #define OB_DUPLI                        (8+16+256+512+2048)
302 #define OB_DUPLIFRAMES          8
303 #define OB_DUPLIVERTS           16
304 #define OB_DUPLIROT                     32
305 #define OB_DUPLINOSPEED         64
306 #define OB_POWERTRACK           128
307 #define OB_DUPLIGROUP           256
308 #define OB_DUPLIFACES           512
309 #define OB_DUPLIFACES_SCALE     1024
310 #define OB_DUPLIPARTS           2048
311 #define OB_RENDER_DUPLI         4096
312
313 /* (short) ipoflag */
314 #define OB_DRAWKEY                      1
315 #define OB_DRAWKEYSEL           2
316 #define OB_OFFS_OB                      4
317 #define OB_OFFS_MAT                     8
318 #define OB_OFFS_VKEY            16
319 #define OB_OFFS_PATH            32
320 #define OB_OFFS_PARENT          64
321 #define OB_OFFS_PARTICLE        128
322         /* get ipo from from action or not? */
323 #define OB_ACTION_OB            256
324 #define OB_ACTION_KEY           512
325         /* for stride edit */
326 #define OB_DISABLE_PATH         1024
327
328 #define OB_OFFS_PARENTADD       2048
329
330
331 /* (short) trackflag / upflag */
332 #define OB_POSX                 0
333 #define OB_POSY                 1
334 #define OB_POSZ                 2
335 #define OB_NEGX                 3
336 #define OB_NEGY                 4
337 #define OB_NEGZ                 5
338
339 /* gameflag in game.h */
340
341 /* dt: no flags */
342 #define OB_BOUNDBOX             1
343 #define OB_WIRE                 2
344 #define OB_SOLID                3
345 #define OB_SHADED               4
346 #define OB_TEXTURE              5
347
348 /* this condition has been made more complex since editmode can draw textures */
349 #define CHECK_OB_DRAWTEXTURE(vd, dt) \
350         ((vd->drawtype==OB_TEXTURE && dt>OB_SOLID) || \
351         (vd->drawtype==OB_SOLID && vd->flag2 & V3D_SOLID_TEX))
352
353 #define CHECK_OB_DRAWFACEDOT(sce, vd, dt) \
354         (       (sce->selectmode & SCE_SELECT_FACE) && \
355                 (vd->drawtype<=OB_SOLID) && \
356                 (((vd->drawtype==OB_SOLID) && (dt>=OB_SOLID) && (vd->flag2 & V3D_SOLID_TEX) && (vd->flag & V3D_ZBUF_SELECT)) == 0) \
357         )
358
359
360 /* dtx: flags, char! */
361 #define OB_AXIS                 2
362 #define OB_TEXSPACE             4
363 #define OB_DRAWNAME             8
364 #define OB_DRAWIMAGE    16
365         /* for solid+wire display */
366 #define OB_DRAWWIRE             32
367         /* for overdraw */
368 #define OB_DRAWXRAY             64
369         /* enable transparent draw */
370 #define OB_DRAWTRANSP   128
371
372 /* empty_drawtype: no flags */
373 #define OB_ARROWS               1
374 #define OB_PLAINAXES    2
375 #define OB_CIRCLE               3
376 #define OB_SINGLE_ARROW 4
377 #define OB_CUBE                 5
378 #define OB_EMPTY_SPHERE 6
379 #define OB_EMPTY_CONE   7
380
381 /* boundtype */
382 #define OB_BOUND_BOX            0
383 #define OB_BOUND_SPHERE         1
384 #define OB_BOUND_CYLINDER       2
385 #define OB_BOUND_CONE           3
386 #define OB_BOUND_POLYH          4
387 #define OB_BOUND_POLYT          5
388 #define OB_BOUND_DYN_MESH   6
389
390
391 /* **************** BASE ********************* */
392
393 /* also needed for base!!!!! or rather, thy interfere....*/
394 /* base->flag and ob->flag */
395 #define BA_WAS_SEL                      2
396 #define BA_HAS_RECALC_OB        4
397 #define BA_HAS_RECALC_DATA      8
398
399 #define BA_DO_IPO                       32
400
401 #define BA_FROMSET                      128
402
403 /* an initial attempt as making selection more specific! */
404 #define BA_DESELECT     0
405 #define BA_SELECT               1
406
407
408 #define OB_FROMDUPLI            512
409 #define OB_DONE                         1024
410 #define OB_RADIO                        2048
411 #define OB_FROMGROUP            4096
412 #define OB_POSEMODE                     8192
413
414 /* ob->recalc (flag bits!) */
415 #define OB_RECALC_OB            1
416 #define OB_RECALC_DATA          2
417                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
418 #define OB_RECALC_TIME          4
419 #define OB_RECALC                       7
420
421 /* ob->gamesoftFlag */
422 #define OB_SOFT_SHAPE_MATCHING  1
423
424 /* ob->gameflag */
425 #define OB_DYNAMIC              1
426 #define OB_CHILD                2
427 #define OB_ACTOR                4
428 #define OB_INERTIA_LOCK_X       8
429 #define OB_INERTIA_LOCK_Y       16
430 #define OB_INERTIA_LOCK_Z       32
431 #define OB_DO_FH                        64
432 #define OB_ROT_FH                       128
433 #define OB_ANISOTROPIC_FRICTION 256
434 #define OB_GHOST                        512
435 #define OB_RIGID_BODY           1024
436 #define OB_BOUNDS               2048
437
438 #define OB_COLLISION_RESPONSE   4096
439 #define OB_SECTOR               8192
440 #define OB_PROP                 16384
441 #define OB_MAINACTOR    32768
442
443 #define OB_COLLISION    65536
444 #define OB_SOFT_BODY    0x20000
445
446 /* ob->gameflag2 */
447 #define OB_NEVER_DO_ACTIVITY_CULLING    1
448
449 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
450
451 /* ob->body_type */
452 #define OB_BODY_TYPE_NO_COLLISION       0
453 #define OB_BODY_TYPE_STATIC                     1
454 #define OB_BODY_TYPE_DYNAMIC            2
455 #define OB_BODY_TYPE_RIGID                      3
456 #define OB_BODY_TYPE_SOFT                       4
457
458 /* ob->scavisflag */
459 #define OB_VIS_SENS             1
460 #define OB_VIS_CONT             2
461 #define OB_VIS_ACT              4
462
463 /* ob->scaflag */
464 #define OB_SHOWSENS             64
465 #define OB_SHOWACT              128
466 #define OB_ADDSENS              256
467 #define OB_ADDCONT              512
468 #define OB_ADDACT               1024
469 #define OB_SHOWCONT             2048
470 #define OB_SETSTBIT             4096
471 #define OB_INITSTBIT    8192
472 #define OB_DEBUGSTATE   16384
473
474 /* ob->restrictflag */
475 #define OB_RESTRICT_VIEW        1
476 #define OB_RESTRICT_SELECT      2
477 #define OB_RESTRICT_RENDER      4
478
479 /* ob->shapeflag */
480 #define OB_SHAPE_LOCK           1
481 #define OB_SHAPE_TEMPLOCK       2
482
483 /* ob->nlaflag */
484 #define OB_NLA_OVERRIDE         1
485 #define OB_NLA_COLLAPSED        2
486
487 /* ob->protectflag */
488 #define OB_LOCK_LOCX    1
489 #define OB_LOCK_LOCY    2
490 #define OB_LOCK_LOCZ    4
491 #define OB_LOCK_LOC             7
492 #define OB_LOCK_ROTX    8
493 #define OB_LOCK_ROTY    16
494 #define OB_LOCK_ROTZ    32
495 #define OB_LOCK_ROT             56
496 #define OB_LOCK_SCALEX  64
497 #define OB_LOCK_SCALEY  128
498 #define OB_LOCK_SCALEZ  256
499 #define OB_LOCK_SCALE   448
500
501 /* ob->softflag in DNA_object_force.h */
502
503 #ifdef __cplusplus
504 }
505 #endif
506
507 #endif
508
509