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