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