== file browser ==
[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         
193         short rotmode;          /* rotation mode - uses defines set out in DNA_action_types.h for PoseChannel rotations... */
194         
195         char dt, dtx;
196         char empty_drawtype, pad1[3];
197         float empty_drawsize;
198         float dupfacesca;       /* dupliface scale */
199         
200         ListBase prop;
201         ListBase sensors;
202         ListBase controllers;
203         ListBase actuators;
204     
205         float bbsize[3];
206         short index;                    /* custom index, for renderpasses */
207         unsigned short actdef;  /* current deformation group, note: index starts at 1 */
208         float col[4];                   /* object color */
209         /**
210          * Settings for game objects
211          * bit 0: Object has dynamic behaviour
212          * bit 2: Object is evaluated by the gameengine
213          * bit 6: Use Fh settings in Materials
214          * bit 7: Use face normal to rotate Object
215          * bit 8: Friction is anisotropic
216          * bit 9: Object is a ghost
217          * bit 10: Do rigid body dynamics.
218          * bit 11: Use bounding object for physics
219          */
220         int gameflag;
221         /**
222          * More settings
223          * bit 15: Always ignore activity culling 
224          */
225         int gameflag2;
226         struct BulletSoftBody *bsoft;   /* settings for game engine bullet soft body */
227
228         short softflag;                 /* softbody settings */
229         short recalc;                   /* dependency flag */
230         float anisotropicFriction[3];
231
232         ListBase constraints;           /* object constraints */
233         ListBase nlastrips;                     // XXX depreceated... old animation system
234         ListBase hooks;
235         ListBase particlesystem;        /* particle systems */
236         
237         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
238         struct SoftBody *soft;          /* if exists, saved in file */
239         struct Group *dup_group;        /* object duplicator for group */
240         
241         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
242         
243         short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
244
245         short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
246         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
247         short recalco;                          /* recalco for temp storage of ob->recalc, bad design warning */
248         short body_type;                        /* for now used to temporarily holds the type of collision object */
249         
250         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
251
252         struct DerivedMesh *derivedDeform, *derivedFinal;
253         int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
254         unsigned int state;                     /* bit masks of game controllers that are active */
255         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
256
257         int pad2;
258
259         ListBase gpulamp;               /* runtime, for lamps only */
260         ListBase pc_ids;
261         ListBase *duplilist;    /* for temporary dupli list storage, only for use by RNA API */
262 } Object;
263
264 /* Warning, this is not used anymore because hooks are now modifiers */
265 typedef struct ObHook {
266         struct ObHook *next, *prev;
267         
268         struct Object *parent;
269         float parentinv[4][4];  /* matrix making current transform unmodified */
270         float mat[4][4];                /* temp matrix while hooking */
271         float cent[3];                  /* visualization of hook */
272         float falloff;                  /* if not zero, falloff is distance where influence zero */
273         
274         char name[32];
275
276         int *indexar;
277         int totindex, curindex; /* curindex is cache for fast lookup */
278         short type, active;             /* active is only first hook, for button menu */
279         float force;
280 } ObHook;
281
282 typedef struct DupliObject {
283         struct DupliObject *next, *prev;
284         struct Object *ob;
285         unsigned int origlay;
286         int index, no_draw, type, animated;
287         float mat[4][4], omat[4][4];
288         float orco[3], uv[2];
289 } DupliObject;
290
291 /* this work object is defined in object.c */
292 extern Object workob;
293
294
295 /* **************** OBJECT ********************* */
296
297 /* used many places... should be specialized  */
298 #define SELECT                  1
299
300 /* type */
301 #define OB_EMPTY                0
302 #define OB_MESH                 1
303 #define OB_CURVE                2
304 #define OB_SURF                 3
305 #define OB_FONT                 4
306 #define OB_MBALL                5
307
308 #define OB_LAMP                 10
309 #define OB_CAMERA               11
310
311 // #define OB_WAVE                      21
312 #define OB_LATTICE              22
313
314 /* 23 and 24 are for life and sector (old file compat.) */
315 #define OB_ARMATURE             25
316
317 /* partype: first 4 bits: type */
318 #define PARTYPE                 15
319 #define PAROBJECT               0
320 #define PARCURVE                1
321 #define PARKEY                  2
322
323 #define PARSKEL                 4
324 #define PARVERT1                5
325 #define PARVERT3                6
326 #define PARBONE                 7
327 #define PARSLOW                 16
328
329 /* (short) transflag */
330 /*#define OB_OFFS_LOCAL         1*/ /*UNUSED*/
331 /* #define OB_QUAT                              2 */ /* never used, free flag */
332 #define OB_NEG_SCALE            4
333 #define OB_DUPLI                        (8+16+256+512+2048)
334 #define OB_DUPLIFRAMES          8
335 #define OB_DUPLIVERTS           16
336 #define OB_DUPLIROT                     32
337 #define OB_DUPLINOSPEED         64
338 /*#define OB_POWERTRACK         128*/ /*UNUSED*/
339 #define OB_DUPLIGROUP           256
340 #define OB_DUPLIFACES           512
341 #define OB_DUPLIFACES_SCALE     1024
342 #define OB_DUPLIPARTS           2048
343 #define OB_RENDER_DUPLI         4096
344 #define OB_NO_CONSTRAINTS       8192 /* runtime constraints disable */
345
346 /* (short) ipoflag */
347         // XXX depreceated - old animation system crap
348 #define OB_DRAWKEY                      1
349 #define OB_DRAWKEYSEL           2
350 #define OB_OFFS_OB                      4
351 /* #define OB_OFFS_MAT          8 */ /*UNUSED*/
352 /* #define OB_OFFS_VKEY         16 */ /*UNUSED*/
353 /* #define OB_OFFS_PATH         32 */ /*UNUSED*/
354 #define OB_OFFS_PARENT          64
355 #define OB_OFFS_PARTICLE        128
356         /* get ipo from from action or not? */
357 #define OB_ACTION_OB            256
358 #define OB_ACTION_KEY           512
359         /* for stride edit */
360 #define OB_DISABLE_PATH         1024
361
362 #define OB_OFFS_PARENTADD       2048
363
364
365 /* (short) trackflag / upflag */
366 #define OB_POSX                 0
367 #define OB_POSY                 1
368 #define OB_POSZ                 2
369 #define OB_NEGX                 3
370 #define OB_NEGY                 4
371 #define OB_NEGZ                 5
372
373 /* gameflag in game.h */
374
375 /* dt: no flags */
376 #define OB_BOUNDBOX             1
377 #define OB_WIRE                 2
378 #define OB_SOLID                3
379 #define OB_SHADED               4
380 #define OB_TEXTURE              5
381
382 /* dtx: flags, char! */
383 #define OB_AXIS                 2
384 #define OB_TEXSPACE             4
385 #define OB_DRAWNAME             8
386 #define OB_DRAWIMAGE    16
387         /* for solid+wire display */
388 #define OB_DRAWWIRE             32
389         /* for overdraw */
390 #define OB_DRAWXRAY             64
391         /* enable transparent draw */
392 #define OB_DRAWTRANSP   128
393
394 /* empty_drawtype: no flags */
395 #define OB_ARROWS               1
396 #define OB_PLAINAXES    2
397 #define OB_CIRCLE               3
398 #define OB_SINGLE_ARROW 4
399 #define OB_CUBE                 5
400 #define OB_EMPTY_SPHERE 6
401 #define OB_EMPTY_CONE   7
402
403 /* boundtype */
404 #define OB_BOUND_BOX            0
405 #define OB_BOUND_SPHERE         1
406 #define OB_BOUND_CYLINDER       2
407 #define OB_BOUND_CONE           3
408 #define OB_BOUND_POLYH          4
409 #define OB_BOUND_POLYT          5
410 /* #define OB_BOUND_DYN_MESH   6 */ /*UNUSED*/
411 #define OB_BOUND_CAPSULE        7
412
413
414 /* **************** BASE ********************* */
415
416 /* also needed for base!!!!! or rather, thy interfere....*/
417 /* base->flag and ob->flag */
418 #define BA_WAS_SEL                      2
419 #define BA_HAS_RECALC_OB        4
420 #define BA_HAS_RECALC_DATA      8
421
422         /* NOTE: this was used as a proper setting in past, so nullify before using */
423 #define BA_TEMP_TAG                     32
424
425 /* #define BA_FROMSET                   128 */ /*UNUSED*/
426
427 #define BA_TRANSFORM_CHILD      256 /* child of a transformed object */
428 #define BA_TRANSFORM_PARENT     8192 /* parent of a transformed object */
429
430
431 /* an initial attempt as making selection more specific! */
432 #define BA_DESELECT             0
433 #define BA_SELECT               1
434
435
436 #define OB_FROMDUPLI            512
437 #define OB_DONE                         1024
438 // #define OB_RADIO                     2048    /* deprecated */
439 #define OB_FROMGROUP            4096
440
441 /* ob->recalc (flag bits!) */
442 #define OB_RECALC_OB            1
443 #define OB_RECALC_DATA          2
444                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
445 #define OB_RECALC_TIME          4
446                 /* only use for matching any flag, NOT as an argument since more flags may be added. */
447 #define OB_RECALC_ALL           (OB_RECALC_OB|OB_RECALC_DATA|OB_RECALC_TIME)
448
449 /* controller state */
450 #define OB_MAX_STATES           30
451
452 /* ob->gameflag */
453 #define OB_DYNAMIC              1
454 #define OB_CHILD                2
455 #define OB_ACTOR                4
456 #define OB_INERTIA_LOCK_X       8
457 #define OB_INERTIA_LOCK_Y       16
458 #define OB_INERTIA_LOCK_Z       32
459 #define OB_DO_FH                        64
460 #define OB_ROT_FH                       128
461 #define OB_ANISOTROPIC_FRICTION 256
462 #define OB_GHOST                        512
463 #define OB_RIGID_BODY           1024
464 #define OB_BOUNDS               2048
465
466 #define OB_COLLISION_RESPONSE   4096
467 #define OB_SECTOR               8192
468 #define OB_PROP                 16384
469 #define OB_MAINACTOR    32768
470
471 #define OB_COLLISION    65536
472 #define OB_SOFT_BODY    0x20000
473 #define OB_OCCLUDER             0x40000
474 #define OB_SENSOR               0x80000
475
476 /* ob->gameflag2 */
477 #define OB_NEVER_DO_ACTIVITY_CULLING    1
478 #define OB_LOCK_RIGID_BODY_X_AXIS       4
479 #define OB_LOCK_RIGID_BODY_Y_AXIS       8
480 #define OB_LOCK_RIGID_BODY_Z_AXIS       16
481 #define OB_LOCK_RIGID_BODY_X_ROT_AXIS   32
482 #define OB_LOCK_RIGID_BODY_Y_ROT_AXIS   64
483 #define OB_LOCK_RIGID_BODY_Z_ROT_AXIS   128
484
485 /* #define OB_LIFE                      (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD) */
486
487 /* ob->body_type */
488 #define OB_BODY_TYPE_NO_COLLISION       0
489 #define OB_BODY_TYPE_STATIC                     1
490 #define OB_BODY_TYPE_DYNAMIC            2
491 #define OB_BODY_TYPE_RIGID                      3
492 #define OB_BODY_TYPE_SOFT                       4
493 #define OB_BODY_TYPE_OCCLUDER           5
494 #define OB_BODY_TYPE_SENSOR                     6
495
496 /* ob->scavisflag */
497 #define OB_VIS_SENS             1
498 #define OB_VIS_CONT             2
499 #define OB_VIS_ACT              4
500
501 /* ob->scaflag */
502 #define OB_SHOWSENS             64
503 #define OB_SHOWACT              128
504 #define OB_ADDSENS              256
505 #define OB_ADDCONT              512
506 #define OB_ADDACT               1024
507 #define OB_SHOWCONT             2048
508 #define OB_ALLSTATE             4096
509 #define OB_INITSTBIT    8192
510 #define OB_DEBUGSTATE   16384
511 #define OB_SHOWSTATE    32768
512
513 /* ob->restrictflag */
514 #define OB_RESTRICT_VIEW        1
515 #define OB_RESTRICT_SELECT      2
516 #define OB_RESTRICT_RENDER      4
517
518 /* ob->shapeflag */
519 #define OB_SHAPE_LOCK           1
520 #define OB_SHAPE_TEMPLOCK       2               // deprecated
521 #define OB_SHAPE_EDIT_MODE      4
522
523 /* ob->nlaflag */
524         // XXX depreceated - old animation system
525 #define OB_NLA_OVERRIDE         (1<<0)
526 #define OB_NLA_COLLAPSED        (1<<1)
527
528         /* object-channel expanded status */
529 #define OB_ADS_COLLAPSED        (1<<10)
530         /* object's ipo-block */
531 #define OB_ADS_SHOWIPO          (1<<11)
532         /* object's constraint channels */
533 #define OB_ADS_SHOWCONS         (1<<12)
534         /* object's material channels */
535 #define OB_ADS_SHOWMATS         (1<<13)
536         /* object's marticle channels */
537 #define OB_ADS_SHOWPARTS        (1<<14)
538
539 /* ob->protectflag */
540 #define OB_LOCK_LOCX    1
541 #define OB_LOCK_LOCY    2
542 #define OB_LOCK_LOCZ    4
543 #define OB_LOCK_LOC             7
544 #define OB_LOCK_ROTX    8
545 #define OB_LOCK_ROTY    16
546 #define OB_LOCK_ROTZ    32
547 #define OB_LOCK_ROT             56
548 #define OB_LOCK_SCALEX  64
549 #define OB_LOCK_SCALEY  128
550 #define OB_LOCK_SCALEZ  256
551 #define OB_LOCK_SCALE   448
552 #define OB_LOCK_ROTW    512
553 #define OB_LOCK_ROT4D   1024
554
555 /* ob->mode */
556 typedef enum ObjectMode {
557         OB_MODE_OBJECT = 0,
558         OB_MODE_EDIT = 1,
559         OB_MODE_SCULPT = 2,
560         OB_MODE_VERTEX_PAINT = 4,
561         OB_MODE_WEIGHT_PAINT = 8,
562         OB_MODE_TEXTURE_PAINT = 16,
563         OB_MODE_PARTICLE_EDIT = 32,
564         OB_MODE_POSE = 64
565 } ObjectMode;
566
567 /* any mode where the brush system is used */
568 #define OB_MODE_ALL_PAINT (OB_MODE_SCULPT|OB_MODE_VERTEX_PAINT|OB_MODE_WEIGHT_PAINT|OB_MODE_TEXTURE_PAINT)
569
570 #define MAX_DUPLI_RECUR 8
571
572 #ifdef __cplusplus
573 }
574 #endif
575
576 #endif
577