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