syncing some minor formatting edits from bmesh branch.
[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_defs.h"
36 #include "DNA_listBase.h"
37 #include "DNA_ID.h"
38 #include "DNA_action_types.h" /* bAnimVizSettings */
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         /* need this flag for locking weights */
65         char flag, pad[7];
66 } bDeformGroup;
67 #define MAX_VGROUP_NAME 32
68
69 /* bDeformGroup->flag */
70 #define DG_LOCK_WEIGHT 1
71
72 /**
73  * The following illustrates the orientation of the 
74  * bounding box in local space
75  * 
76  *  
77  * Z  Y
78  * | /
79  * |/
80  * .-----X
81  * 
82  * 
83  *     2----------6
84  *    /|         /|
85  *   / |        / |
86  *  1----------5  |
87  *  |  |       |  |
88  *  |  3-------|--7
89  *  | /        | /
90  *  |/         |/
91  *  0----------4
92  */
93 typedef struct BoundBox {
94         float vec[8][3];
95         int flag, pad;
96 } BoundBox;
97
98 /* boundbox flag */
99 #define OB_BB_DISABLED  1
100
101 typedef struct Object {
102         ID id;
103         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
104
105         struct SculptSession *sculpt;
106         
107         short type, partype;
108         int par1, par2, par3;   /* can be vertexnrs */
109         char parsubstr[32];     /* String describing subobject info */
110         struct Object *parent, *track;
111         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
112         /* proxy_from is set in target back to the proxy. */
113         struct Object *proxy, *proxy_group, *proxy_from;
114         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
115         /* struct Path *path; */
116         struct BoundBox *bb;
117         struct bAction *action  DNA_DEPRECATED;  // XXX depreceated... old animation system
118         struct bAction *poselib;
119         struct bPose *pose;  /* pose data, armature objects only */
120         void *data;  /* pointer to objects data - an 'ID' or NULL */
121         
122         struct bGPdata *gpd;    /* Grease Pencil data */
123         
124         bAnimVizSettings avs;   /* settings for visualisation of object-transform animation */
125         bMotionPath *mpath;             /* motion path cache for this object */
126         
127         ListBase constraintChannels  DNA_DEPRECATED; // XXX depreceated... old animation system
128         ListBase effect  DNA_DEPRECATED;             // XXX depreceated... keep for readfile
129         ListBase disp;      /* list of DispList, used by lattice, metaballs curve & surfaces */
130         ListBase defbase;   /* list of bDeformGroup (vertex groups) names and flag only */
131         ListBase modifiers; /* list of ModifierData structures */
132
133         int mode;           /* Local object mode */
134         int restore_mode;   /* Keep track of what mode to return to after toggling a mode */
135
136         /* materials */
137         struct Material **mat;  /* material slots */
138         char *matbits;                  /* a boolean field, with each byte 1 if corrusponding material is linked to object */
139         int totcol;                             /* copy of mesh or curve or meta */
140         int actcol;                             /* currently selected material in the UI */
141         
142         /* rot en drot have to be together! (transform('r' en 's')) */
143         float loc[3], dloc[3], orig[3];
144         float size[3];              /* scale infact */
145         float dsize[3] DNA_DEPRECATED ; /* DEPRECATED, 2.60 and older only */
146         float dscale[3];            /* ack!, changing */
147         float rot[3], drot[3];          /* euler rotation */
148         float quat[4], dquat[4];        /* quaternion rotation */
149         float rotAxis[3], drotAxis[3];  /* axis angle rotation - axis part */
150         float rotAngle, drotAngle;      /* axis angle rotation - angle part */
151         float obmat[4][4];              /* final worldspace matrix with constraints & animsys applied */
152         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
153         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
154         float imat[4][4];       /* inverse matrix of 'obmat' for any other use than rendering! */
155         
156         /* Previously 'imat' was used at render time, but as other places use it too
157          * the interactive ui of 2.5 creates problems. So now only 'imat_ren' should
158          * be used when ever the inverse of ob->obmat * re->viewmat is needed! - jahka
159          */
160         float imat_ren[4][4];
161         
162         unsigned int lay;       /* copy of Base's layer in the scene */
163         
164         int pad6;
165
166         short flag;                     /* copy of Base */
167         short colbits DNA_DEPRECATED;           /* deprecated */
168         
169         short transflag, protectflag;   /* transformation settings and transform locks  */
170         short trackflag, upflag;
171         short nlaflag;                          /* used for DopeSheet filtering settings (expanded/collapsed) */
172         short ipoflag;                          // xxx depreceated... old animation system
173         short scaflag;                          /* ui state for game logic */
174         char scavisflag;                        /* more display settings for game logic */
175         char pad5;
176
177         int dupon, dupoff, dupsta, dupend;
178
179         float sf, ctime; /* sf is time-offset, ctime is the objects current time (XXX timing needs to be revised) */
180         
181         /* during realtime */
182
183         /* note that inertia is only called inertia for historical reasons
184          * and is not changed to avoid DNA surgery. It actually reflects the 
185          * Size value in the GameButtons (= radius) */
186
187         float mass, damping, inertia;
188         /* The form factor k is introduced to give the user more control
189          * and to fix incompatibility problems.
190          * For rotational symmetric objects, the inertia value can be
191          * expressed as: Theta = k * m * r^2
192          * where m = Mass, r = Radius
193          * For a Sphere, the form factor is by default = 0.4
194          */
195
196         float formfactor;
197         float rdamping, sizefac;
198         float margin;
199         float max_vel; /* clamp the maximum velocity 0.0 is disabled */
200         float min_vel; /* clamp the maximum velocity 0.0 is disabled */
201         float m_contactProcessingThreshold;
202         float obstacleRad;
203
204         short rotmode;          /* rotation mode - uses defines set out in DNA_action_types.h for PoseChannel rotations... */
205
206         char boundtype;            /* bounding box use for drawing */
207         char collision_boundtype;  /* bounding box type used for collision */
208
209         char  restrictflag;     /* for restricting view, select, render etc. accessible in outliner */
210
211         char dt;                        /* viewport draw type */
212         char dtx;                       /* viewport draw extra settings */
213         char empty_drawtype;
214         float empty_drawsize;
215         float dupfacesca;       /* dupliface scale */
216         
217         ListBase prop;                  /* game logic property list (not to be confused with IDProperties) */
218         ListBase sensors;               /* game logic sensors */
219         ListBase controllers;   /* game logic controllers */
220         ListBase actuators;             /* game logic actuators */
221
222         float bbsize[3];
223         short index;                    /* custom index, for renderpasses */
224         unsigned short actdef;  /* current deformation group, note: index starts at 1 */
225         float col[4];                   /* object color */
226
227         int gameflag;
228         int gameflag2;
229
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  DNA_DEPRECATED;                     // XXX depreceated... old animation system
238         ListBase hooks  DNA_DEPRECATED;                         // XXX depreceated... old animation system
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         char  body_type;                        /* for now used to temporarily holds the type of collision object */
246         char  shapeflag;                        /* flag for pinning */
247         short shapenr;                          /* current shape key for menu or pinned */
248         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
249
250         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
251
252         struct DerivedMesh *derivedDeform, *derivedFinal;
253         unsigned int lastDataMask;   /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
254         unsigned int customdata_mask; /* (extra) custom data layer mask to use for creating derivedmesh, set by depsgraph */
255         unsigned int state;                     /* bit masks of game controllers that are active */
256         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
257
258         ListBase gpulamp;               /* runtime, for glsl lamp display only */
259         ListBase pc_ids;
260         ListBase *duplilist;    /* for temporary dupli list storage, only for use by RNA API */
261
262         float ima_ofs[2];               /* offset for image empties */
263 } Object;
264
265 /* Warning, this is not used anymore because hooks are now modifiers */
266 typedef struct ObHook {
267         struct ObHook *next, *prev;
268         
269         struct Object *parent;
270         float parentinv[4][4];  /* matrix making current transform unmodified */
271         float mat[4][4];                /* temp matrix while hooking */
272         float cent[3];                  /* visualization of hook */
273         float falloff;                  /* if not zero, falloff is distance where influence zero */
274         
275         char name[32];
276
277         int *indexar;
278         int totindex, curindex; /* curindex is cache for fast lookup */
279         short type, active;             /* active is only first hook, for button menu */
280         float force;
281 } ObHook;
282
283 /* runtime only, but include here for rna access */
284 typedef struct DupliObject {
285         struct DupliObject *next, *prev;
286         struct Object *ob;
287         unsigned int origlay;
288         int index;
289         float mat[4][4], omat[4][4];
290         float orco[3], uv[2];
291
292         short type; /* from Object.transflag */
293         char no_draw, animated;
294 } DupliObject;
295
296 /* **************** OBJECT ********************* */
297
298 /* used many places... should be specialized  */
299 #define SELECT                  1
300
301 /* type */
302 #define OB_EMPTY                0
303 #define OB_MESH                 1
304 #define OB_CURVE                2
305 #define OB_SURF                 3
306 #define OB_FONT                 4
307 #define OB_MBALL                5
308
309 #define OB_LAMP                 10
310 #define OB_CAMERA               11
311
312 #define OB_SPEAKER              12
313
314 // #define OB_WAVE                      21
315 #define OB_LATTICE              22
316
317 /* 23 and 24 are for life and sector (old file compat.) */
318 #define OB_ARMATURE             25
319
320 /* check if the object type supports materials */
321 #define OB_TYPE_SUPPORT_MATERIAL(_type) ((_type)  >= OB_MESH && (_type) <= OB_MBALL)
322 #define OB_TYPE_SUPPORT_VGROUP(_type)   (ELEM(_type, OB_MESH, OB_LATTICE))
323
324 /* partype: first 4 bits: type */
325 #define PARTYPE                 15
326 #define PAROBJECT               0
327 #define PARCURVE                1
328 #define PARKEY                  2
329
330 #define PARSKEL                 4
331 #define PARVERT1                5
332 #define PARVERT3                6
333 #define PARBONE                 7
334
335         /* slow parenting - is not threadsafe and/or may give errors after jumping  */
336 #define PARSLOW                 16
337
338 /* (short) transflag */
339 /* flags 1 and 2 were unused or relics from past features */
340 #define OB_NEG_SCALE            4
341 #define OB_DUPLI                        (8+16+256+512+2048)
342 #define OB_DUPLIFRAMES          8
343 #define OB_DUPLIVERTS           16
344 #define OB_DUPLIROT                     32
345 #define OB_DUPLINOSPEED         64
346 /*#define OB_POWERTRACK         128*/ /*UNUSED*/
347 #define OB_DUPLIGROUP           256
348 #define OB_DUPLIFACES           512
349 #define OB_DUPLIFACES_SCALE     1024
350 #define OB_DUPLIPARTS           2048
351 #define OB_RENDER_DUPLI         4096
352 #define OB_NO_CONSTRAINTS       8192 /* runtime constraints disable */
353
354 /* (short) ipoflag */
355 /* XXX: many old flags for features removed due to incompatability 
356  * with new system and/or other design issues were here 
357  */
358         /* for stride/path editing (XXX: NEEDS REVIEW) */
359 #define OB_DISABLE_PATH         1024
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_MATERIAL             4
376 #define OB_TEXTURE              5
377 #define OB_RENDER               6
378
379 #define OB_PAINT                100     /* temporary used in draw code */
380
381 /* dtx: flags, char! */
382 #define OB_AXIS                 2
383 #define OB_TEXSPACE             4
384 #define OB_DRAWNAME             8
385 #define OB_DRAWIMAGE    16
386         /* for solid+wire display */
387 #define OB_DRAWWIRE             32
388         /* for overdraw */
389 #define OB_DRAWXRAY             64
390         /* enable transparent draw */
391 #define OB_DRAWTRANSP   128
392
393 /* empty_drawtype: no flags */
394 #define OB_ARROWS               1
395 #define OB_PLAINAXES    2
396 #define OB_CIRCLE               3
397 #define OB_SINGLE_ARROW 4
398 #define OB_CUBE                 5
399 #define OB_EMPTY_SPHERE 6
400 #define OB_EMPTY_CONE   7
401 #define OB_EMPTY_IMAGE  8
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_TRIANGLE_MESH 4
409 #define OB_BOUND_CONVEX_HULL   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 #define OB_NAVMESH              0x100000
476 #define OB_HASOBSTACLE  0x200000
477
478 /* ob->gameflag2 */
479 #define OB_NEVER_DO_ACTIVITY_CULLING    1
480 #define OB_LOCK_RIGID_BODY_X_AXIS       4
481 #define OB_LOCK_RIGID_BODY_Y_AXIS       8
482 #define OB_LOCK_RIGID_BODY_Z_AXIS       16
483 #define OB_LOCK_RIGID_BODY_X_ROT_AXIS   32
484 #define OB_LOCK_RIGID_BODY_Y_ROT_AXIS   64
485 #define OB_LOCK_RIGID_BODY_Z_ROT_AXIS   128
486
487 /* #define OB_LIFE                      (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD) */
488
489 /* ob->body_type */
490 #define OB_BODY_TYPE_NO_COLLISION       0
491 #define OB_BODY_TYPE_STATIC                     1
492 #define OB_BODY_TYPE_DYNAMIC            2
493 #define OB_BODY_TYPE_RIGID                      3
494 #define OB_BODY_TYPE_SOFT                       4
495 #define OB_BODY_TYPE_OCCLUDER           5
496 #define OB_BODY_TYPE_SENSOR                     6
497 #define OB_BODY_TYPE_NAVMESH            7
498
499 /* ob->scavisflag */
500 #define OB_VIS_SENS             1
501 #define OB_VIS_CONT             2
502 #define OB_VIS_ACT              4
503
504 /* ob->scaflag */
505 #define OB_SHOWSENS             64
506 #define OB_SHOWACT              128
507 #define OB_ADDSENS              256
508 #define OB_ADDCONT              512
509 #define OB_ADDACT               1024
510 #define OB_SHOWCONT             2048
511 #define OB_ALLSTATE             4096
512 #define OB_INITSTBIT    8192
513 #define OB_DEBUGSTATE   16384
514 #define OB_SHOWSTATE    32768
515
516 /* ob->restrictflag */
517 #define OB_RESTRICT_VIEW        1
518 #define OB_RESTRICT_SELECT      2
519 #define OB_RESTRICT_RENDER      4
520
521 /* ob->shapeflag */
522 #define OB_SHAPE_LOCK           1
523 #define OB_SHAPE_TEMPLOCK       2               // deprecated
524 #define OB_SHAPE_EDIT_MODE      4
525
526 /* ob->nlaflag */
527         /* WARNING: flags (1<<0) and (1<<1) were from old animsys */
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