Manual merge of soc-2009-kazanbas branch:
[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
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 struct bPose;   
44 struct Object;
45 struct AnimData;
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 struct SculptSession;
57 struct bGPdata;
58
59
60 /* Vertex Groups - Name Info */
61 typedef struct bDeformGroup {
62         struct bDeformGroup *next, *prev;
63         char name[32];
64 } bDeformGroup;
65
66 /**
67  * The following illustrates the orientation of the 
68  * bounding box in local space
69  * 
70  *  
71  * Z  Y
72  * | /
73  * |/
74  * .-----X
75  * 
76  * 
77  *     2----------6
78  *    /|         /|
79  *   / |        / |
80  *  1----------5  |
81  *  |  |       |  |
82  *  |  3-------|--7
83  *  | /        | /
84  *  |/         |/
85  *  0----------4
86  */
87 typedef struct BoundBox {
88         float vec[8][3];
89         int flag, pad;
90 } BoundBox;
91
92 /* boundbox flag */
93 #define OB_BB_DISABLED  1
94
95 typedef struct Object {
96         ID id;
97         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
98
99         struct SculptSession *sculpt;
100         
101         short type, partype;
102         int par1, par2, par3;   /* can be vertexnrs */
103         char parsubstr[32];     /* String describing subobject info */
104         struct Object *parent, *track;
105         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
106         /* proxy_from is set in target back to the proxy. */
107         struct Object *proxy, *proxy_group, *proxy_from;
108         struct Ipo *ipo;                // XXX depreceated... old animation system
109         struct Path *path;
110         struct BoundBox *bb;
111         struct bAction *action;  // XXX depreceated... old animation system
112         struct bAction *poselib;
113         struct bPose *pose;     
114         void *data;
115         
116         struct bGPdata *gpd;    /* Grease Pencil data */
117         
118         ListBase constraintChannels; // XXX depreceated... old animation system
119         ListBase effect;
120         ListBase disp;
121         ListBase defbase;
122         ListBase modifiers; /* list of ModifierData structures */
123
124         int mode;           /* Local object mode */
125         int restore_mode;   /* Keep track of what mode to return to after toggling a mode */
126
127         /* materials */
128         struct Material **mat;  /* material slots */
129         char *matbits;                  /* 1 if material linked to object */
130         int totcol;                             /* copy of mesh or curve or meta */
131         int actcol;                             /* currently selected material in the UI */
132         
133         /* rot en drot have to be together! (transform('r' en 's')) */
134         float loc[3], dloc[3], orig[3];
135         float size[3], dsize[3];
136         float rot[3], drot[3];
137         /* float quat[4], dquat[4]; (not used yet) */
138         float obmat[4][4];
139         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
140         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
141         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
142         
143         unsigned int lay;                               /* copy of Base */
144         
145         short flag;                     /* copy of Base */
146         short colbits;          /* deprecated */
147         
148         short transflag, protectflag;   /* transformation settings and transform locks  */
149         short trackflag, upflag;
150         short nlaflag, ipoflag;         // xxx depreceated... old animation system
151         short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
152         short scavisflag, boundtype;
153         
154         int dupon, dupoff, dupsta, dupend;
155
156         float sf, ctime; /* sf is time-offset, ctime is the objects current time (XXX timing needs to be revised) */
157         
158         /* during realtime */
159
160         /* note that inertia is only called inertia for historical reasons
161          * and is not changed to avoid DNA surgery. It actually reflects the 
162          * Size value in the GameButtons (= radius) */
163
164         float mass, damping, inertia;
165         /* The form factor k is introduced to give the user more control
166          * and to fix incompatibility problems.
167      * For rotational symmetric objects, the inertia value can be
168          * expressed as: Theta = k * m * r^2
169          * where m = Mass, r = Radius
170          * For a Sphere, the form factor is by default = 0.4
171          */
172
173         float formfactor;
174         float rdamping, sizefac;
175         float margin;
176         float max_vel; /* clamp the maximum velocity 0.0 is disabled */
177         float min_vel; /* clamp the maximum velocity 0.0 is disabled */
178         float m_contactProcessingThreshold;
179
180         char dt, dtx;
181         char empty_drawtype, pad1[5];
182         float empty_drawsize;
183         float dupfacesca;       /* dupliface scale */
184         
185         ListBase prop;
186         ListBase sensors;
187         ListBase controllers;
188         ListBase actuators;
189     
190         float bbsize[3];
191         short index;                    /* custom index, for renderpasses */
192         unsigned short actdef;  /* current deformation group */
193         float col[4];                   /* object color, adjusted via IPO's only */
194         /**
195          * Settings for game objects
196          * bit 0: Object has dynamic behaviour
197          * bit 2: Object is evaluated by the gameengine
198          * bit 6: Use Fh settings in Materials
199          * bit 7: Use face normal to rotate Object
200          * bit 8: Friction is anisotropic
201          * bit 9: Object is a ghost
202          * bit 10: Do rigid body dynamics.
203          * bit 11: Use bounding object for physics
204          */
205         int gameflag;
206         /**
207          * More settings
208          * bit 15: Always ignore activity culling 
209          */
210         int gameflag2;
211         struct BulletSoftBody *bsoft;   /* settings for game engine bullet soft body */
212
213         short softflag;                 /* softbody settings */
214         short recalc;                   /* dependency flag */
215         float anisotropicFriction[3];
216
217         ListBase constraints;           /* object constraints */
218         ListBase nlastrips;                     // XXX depreceated... old animation system
219         ListBase hooks;
220         ListBase particlesystem;        /* particle systems */
221         
222         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
223         struct SoftBody *soft;          /* if exists, saved in file */
224         struct Group *dup_group;        /* object duplicator for group */
225         
226         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
227         
228         short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
229
230         short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
231         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
232         short recalco;                          /* recalco for temp storage of ob->recalc, bad design warning */
233         short body_type;                        /* for now used to temporarily holds the type of collision object */
234         
235         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
236
237         struct DerivedMesh *derivedDeform, *derivedFinal;
238         int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
239         unsigned int state;                     /* bit masks of game controllers that are active */
240         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
241
242         int pad2;
243
244         ListBase gpulamp;               /* runtime, for lamps only */
245         ListBase pc_ids;
246         ListBase *duplilist;    /* for temporary dupli list storage, only for use by RNA API */
247 } Object;
248
249 /* Warning, this is not used anymore because hooks are now modifiers */
250 typedef struct ObHook {
251         struct ObHook *next, *prev;
252         
253         struct Object *parent;
254         float parentinv[4][4];  /* matrix making current transform unmodified */
255         float mat[4][4];                /* temp matrix while hooking */
256         float cent[3];                  /* visualization of hook */
257         float falloff;                  /* if not zero, falloff is distance where influence zero */
258         
259         char name[32];
260
261         int *indexar;
262         int totindex, curindex; /* curindex is cache for fast lookup */
263         short type, active;             /* active is only first hook, for button menu */
264         float force;
265 } ObHook;
266
267 typedef struct DupliObject {
268         struct DupliObject *next, *prev;
269         struct Object *ob;
270         unsigned int origlay;
271         int index, no_draw, type, animated;
272         float mat[4][4], omat[4][4];
273         float orco[3], uv[2];
274 } DupliObject;
275
276 /* this work object is defined in object.c */
277 extern Object workob;
278
279
280 /* **************** OBJECT ********************* */
281
282 /* used many places... should be specialized  */
283 #define SELECT                  1
284
285 /* type */
286 #define OB_EMPTY                0
287 #define OB_MESH                 1
288 #define OB_CURVE                2
289 #define OB_SURF                 3
290 #define OB_FONT                 4
291 #define OB_MBALL                5
292
293 #define OB_LAMP                 10
294 #define OB_CAMERA               11
295
296 #define OB_WAVE                 21
297 #define OB_LATTICE              22
298
299 /* 23 and 24 are for life and sector (old file compat.) */
300 #define OB_ARMATURE             25
301
302 /* partype: first 4 bits: type */
303 #define PARTYPE                 15
304 #define PAROBJECT               0
305 #define PARCURVE                1
306 #define PARKEY                  2
307
308 #define PARSKEL                 4
309 #define PARVERT1                5
310 #define PARVERT3                6
311 #define PARBONE                 7
312 #define PARSLOW                 16
313
314 /* (short) transflag */
315 #define OB_OFFS_LOCAL           1
316 #define OB_QUAT                         2
317 #define OB_NEG_SCALE            4
318 #define OB_DUPLI                        (8+16+256+512+2048)
319 #define OB_DUPLIFRAMES          8
320 #define OB_DUPLIVERTS           16
321 #define OB_DUPLIROT                     32
322 #define OB_DUPLINOSPEED         64
323 #define OB_POWERTRACK           128
324 #define OB_DUPLIGROUP           256
325 #define OB_DUPLIFACES           512
326 #define OB_DUPLIFACES_SCALE     1024
327 #define OB_DUPLIPARTS           2048
328 #define OB_RENDER_DUPLI         4096
329
330 /* (short) ipoflag */
331         // XXX depreceated - old animation system crap
332 #define OB_DRAWKEY                      1
333 #define OB_DRAWKEYSEL           2
334 #define OB_OFFS_OB                      4
335 #define OB_OFFS_MAT                     8
336 #define OB_OFFS_VKEY            16
337 #define OB_OFFS_PATH            32
338 #define OB_OFFS_PARENT          64
339 #define OB_OFFS_PARTICLE        128
340         /* get ipo from from action or not? */
341 #define OB_ACTION_OB            256
342 #define OB_ACTION_KEY           512
343         /* for stride edit */
344 #define OB_DISABLE_PATH         1024
345
346 #define OB_OFFS_PARENTADD       2048
347
348
349 /* (short) trackflag / upflag */
350 #define OB_POSX                 0
351 #define OB_POSY                 1
352 #define OB_POSZ                 2
353 #define OB_NEGX                 3
354 #define OB_NEGY                 4
355 #define OB_NEGZ                 5
356
357 /* gameflag in game.h */
358
359 /* dt: no flags */
360 #define OB_BOUNDBOX             1
361 #define OB_WIRE                 2
362 #define OB_SOLID                3
363 #define OB_SHADED               4
364 #define OB_TEXTURE              5
365
366 /* dtx: flags, char! */
367 #define OB_AXIS                 2
368 #define OB_TEXSPACE             4
369 #define OB_DRAWNAME             8
370 #define OB_DRAWIMAGE    16
371         /* for solid+wire display */
372 #define OB_DRAWWIRE             32
373         /* for overdraw */
374 #define OB_DRAWXRAY             64
375         /* enable transparent draw */
376 #define OB_DRAWTRANSP   128
377
378 /* empty_drawtype: no flags */
379 #define OB_ARROWS               1
380 #define OB_PLAINAXES    2
381 #define OB_CIRCLE               3
382 #define OB_SINGLE_ARROW 4
383 #define OB_CUBE                 5
384 #define OB_EMPTY_SPHERE 6
385 #define OB_EMPTY_CONE   7
386
387 /* boundtype */
388 #define OB_BOUND_BOX            0
389 #define OB_BOUND_SPHERE         1
390 #define OB_BOUND_CYLINDER       2
391 #define OB_BOUND_CONE           3
392 #define OB_BOUND_POLYH          4
393 #define OB_BOUND_POLYT          5
394 #define OB_BOUND_DYN_MESH   6
395
396
397 /* **************** BASE ********************* */
398
399 /* also needed for base!!!!! or rather, thy interfere....*/
400 /* base->flag and ob->flag */
401 #define BA_WAS_SEL                      2
402 #define BA_HAS_RECALC_OB        4
403 #define BA_HAS_RECALC_DATA      8
404
405 #define BA_DO_IPO                       32
406
407 #define BA_FROMSET                      128
408
409 #define BA_TRANSFORM_CHILD      256 /* child of a transformed object */
410
411 /* an initial attempt as making selection more specific! */
412 #define BA_DESELECT     0
413 #define BA_SELECT               1
414
415
416 #define OB_FROMDUPLI            512
417 #define OB_DONE                         1024
418 #define OB_RADIO                        2048
419 #define OB_FROMGROUP            4096
420
421 /* ob->recalc (flag bits!) */
422 #define OB_RECALC_OB            1
423 #define OB_RECALC_DATA          2
424                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
425 #define OB_RECALC_TIME          4
426 #define OB_RECALC                       7
427
428
429 /* ob->gameflag */
430 #define OB_DYNAMIC              1
431 #define OB_CHILD                2
432 #define OB_ACTOR                4
433 #define OB_INERTIA_LOCK_X       8
434 #define OB_INERTIA_LOCK_Y       16
435 #define OB_INERTIA_LOCK_Z       32
436 #define OB_DO_FH                        64
437 #define OB_ROT_FH                       128
438 #define OB_ANISOTROPIC_FRICTION 256
439 #define OB_GHOST                        512
440 #define OB_RIGID_BODY           1024
441 #define OB_BOUNDS               2048
442
443 #define OB_COLLISION_RESPONSE   4096
444 #define OB_SECTOR               8192
445 #define OB_PROP                 16384
446 #define OB_MAINACTOR    32768
447
448 #define OB_COLLISION    65536
449 #define OB_SOFT_BODY    0x20000
450 #define OB_OCCLUDER             0x40000
451 #define OB_SENSOR               0x80000
452
453 /* ob->gameflag2 */
454 #define OB_NEVER_DO_ACTIVITY_CULLING    1
455 #define OB_LOCK_RIGID_BODY_X_AXIS       4
456 #define OB_LOCK_RIGID_BODY_Y_AXIS       8
457 #define OB_LOCK_RIGID_BODY_Z_AXIS       16
458 #define OB_LOCK_RIGID_BODY_X_ROT_AXIS   32
459 #define OB_LOCK_RIGID_BODY_Y_ROT_AXIS   64
460 #define OB_LOCK_RIGID_BODY_Z_ROT_AXIS   128
461
462 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
463
464 /* ob->body_type */
465 #define OB_BODY_TYPE_NO_COLLISION       0
466 #define OB_BODY_TYPE_STATIC                     1
467 #define OB_BODY_TYPE_DYNAMIC            2
468 #define OB_BODY_TYPE_RIGID                      3
469 #define OB_BODY_TYPE_SOFT                       4
470 #define OB_BODY_TYPE_OCCLUDER           5
471 #define OB_BODY_TYPE_SENSOR                     6
472
473 /* ob->scavisflag */
474 #define OB_VIS_SENS             1
475 #define OB_VIS_CONT             2
476 #define OB_VIS_ACT              4
477
478 /* ob->scaflag */
479 #define OB_SHOWSENS             64
480 #define OB_SHOWACT              128
481 #define OB_ADDSENS              256
482 #define OB_ADDCONT              512
483 #define OB_ADDACT               1024
484 #define OB_SHOWCONT             2048
485 #define OB_SETSTBIT             4096
486 #define OB_INITSTBIT    8192
487 #define OB_DEBUGSTATE   16384
488
489 /* ob->restrictflag */
490 #define OB_RESTRICT_VIEW        1
491 #define OB_RESTRICT_SELECT      2
492 #define OB_RESTRICT_RENDER      4
493
494 /* ob->shapeflag */
495 #define OB_SHAPE_LOCK           1
496 #define OB_SHAPE_TEMPLOCK       2
497
498 /* ob->nlaflag */
499         // XXX depreceated - old animation system
500 #define OB_NLA_OVERRIDE         (1<<0)
501 #define OB_NLA_COLLAPSED        (1<<1)
502
503         /* object-channel expanded status */
504 #define OB_ADS_COLLAPSED        (1<<10)
505         /* object's ipo-block */
506 #define OB_ADS_SHOWIPO          (1<<11)
507         /* object's constraint channels */
508 #define OB_ADS_SHOWCONS         (1<<12)
509         /* object's material channels */
510 #define OB_ADS_SHOWMATS         (1<<13)
511         /* object's marticle channels */
512 #define OB_ADS_SHOWPARTS        (1<<14)
513
514 /* ob->protectflag */
515 #define OB_LOCK_LOCX    1
516 #define OB_LOCK_LOCY    2
517 #define OB_LOCK_LOCZ    4
518 #define OB_LOCK_LOC             7
519 #define OB_LOCK_ROTX    8
520 #define OB_LOCK_ROTY    16
521 #define OB_LOCK_ROTZ    32
522 #define OB_LOCK_ROT             56
523 #define OB_LOCK_SCALEX  64
524 #define OB_LOCK_SCALEY  128
525 #define OB_LOCK_SCALEZ  256
526 #define OB_LOCK_SCALE   448
527 #define OB_LOCK_ROTW    512
528 #define OB_LOCK_ROT4D   1024
529
530 /* ob->mode */
531 typedef enum ObjectMode {
532         OB_MODE_OBJECT = 0,
533         OB_MODE_EDIT = 1,
534         OB_MODE_SCULPT = 2,
535         OB_MODE_VERTEX_PAINT = 4,
536         OB_MODE_WEIGHT_PAINT = 8,
537         OB_MODE_TEXTURE_PAINT = 16,
538         OB_MODE_PARTICLE_EDIT = 32,
539         OB_MODE_POSE = 64
540 } ObjectMode;
541
542 #ifdef __cplusplus
543 }
544 #endif
545
546 #endif
547
548