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