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