unify include guard defines, __$FILENAME__
[blender-staging.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
28 /** \file DNA_object_types.h
29  *  \ingroup DNA
30  *  \brief Object is a sort of wrapper for general info.
31  */
32
33 #ifndef __DNA_OBJECT_TYPES_H__
34 #define __DNA_OBJECT_TYPES_H__
35
36 #include "DNA_defs.h"
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[64];  /* MAX_VGROUP_NAME */
65         /* need this flag for locking weights */
66         char flag, pad[7];
67 } bDeformGroup;
68 #define MAX_VGROUP_NAME 64
69
70 /* bDeformGroup->flag */
71 #define DG_LOCK_WEIGHT 1
72
73 /**
74  * The following illustrates the orientation of the 
75  * bounding box in local space
76  * 
77  *  
78  * Z  Y
79  * | /
80  * |/
81  * .-----X
82  * 
83  * 
84  *     2----------6
85  *    /|         /|
86  *   / |        / |
87  *  1----------5  |
88  *  |  |       |  |
89  *  |  3-------|--7
90  *  | /        | /
91  *  |/         |/
92  *  0----------4
93  */
94 typedef struct BoundBox {
95         float vec[8][3];
96         int flag, pad;
97 } BoundBox;
98
99 /* boundbox flag */
100 #define OB_BB_DISABLED  1
101
102 typedef struct Object {
103         ID id;
104         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
105
106         struct SculptSession *sculpt;
107         
108         short type, partype;
109         int par1, par2, par3;   /* can be vertexnrs */
110         char parsubstr[64];     /* String describing subobject info, MAX_ID_NAME-2 */
111         struct Object *parent, *track;
112         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
113         /* proxy_from is set in target back to the proxy. */
114         struct Object *proxy, *proxy_group, *proxy_from;
115         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
116         /* struct Path *path; */
117         struct BoundBox *bb;
118         struct bAction *action  DNA_DEPRECATED;  // XXX depreceated... old animation system
119         struct bAction *poselib;
120         struct bPose *pose;  /* pose data, armature objects only */
121         void *data;  /* pointer to objects data - an 'ID' or NULL */
122         
123         struct bGPdata *gpd;    /* Grease Pencil data */
124         
125         bAnimVizSettings avs;   /* settings for visualisation of object-transform animation */
126         bMotionPath *mpath;             /* motion path cache for this object */
127         
128         ListBase constraintChannels  DNA_DEPRECATED; // XXX depreceated... old animation system
129         ListBase effect  DNA_DEPRECATED;             // XXX depreceated... keep for readfile
130         ListBase disp;      /* list of DispList, used by lattice, metaballs curve & surfaces */
131         ListBase defbase;   /* list of bDeformGroup (vertex groups) names and flag only */
132         ListBase modifiers; /* list of ModifierData structures */
133
134         int mode;           /* Local object mode */
135         int restore_mode;   /* Keep track of what mode to return to after toggling a mode */
136
137         /* materials */
138         struct Material **mat;  /* material slots */
139         char *matbits;                  /* a boolean field, with each byte 1 if corrusponding material is linked to object */
140         int totcol;                             /* copy of mesh or curve or meta */
141         int actcol;                             /* currently selected material in the UI */
142         
143         /* rot en drot have to be together! (transform('r' en 's')) */
144         float loc[3], dloc[3], orig[3];
145         float size[3];              /* scale infact */
146         float dsize[3] DNA_DEPRECATED ; /* DEPRECATED, 2.60 and older only */
147         float dscale[3];            /* ack!, changing */
148         float rot[3], drot[3];          /* euler rotation */
149         float quat[4], dquat[4];        /* quaternion rotation */
150         float rotAxis[3], drotAxis[3];  /* axis angle rotation - axis part */
151         float rotAngle, drotAngle;      /* axis angle rotation - angle part */
152         float obmat[4][4];              /* final worldspace matrix with constraints & animsys applied */
153         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
154         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
155         float imat[4][4];       /* inverse matrix of 'obmat' for any other use than rendering! */
156         
157         /* Previously 'imat' was used at render time, but as other places use it too
158          * the interactive ui of 2.5 creates problems. So now only 'imat_ren' should
159          * be used when ever the inverse of ob->obmat * re->viewmat is needed! - jahka
160          */
161         float imat_ren[4][4];
162         
163         unsigned int lay;       /* copy of Base's layer in the scene */
164         
165         int pad6;
166
167         short flag;                     /* copy of Base */
168         short colbits DNA_DEPRECATED;           /* deprecated */
169         
170         short transflag, protectflag;   /* transformation settings and transform locks  */
171         short trackflag, upflag;
172         short nlaflag;                          /* used for DopeSheet filtering settings (expanded/collapsed) */
173         short ipoflag;                          // xxx depreceated... old animation system
174         short scaflag;                          /* ui state for game logic */
175         char scavisflag;                        /* more display settings for game logic */
176         char pad5;
177
178         int dupon, dupoff, dupsta, dupend;
179
180         float sf, ctime; /* sf is time-offset, ctime is the objects current time (XXX timing needs to be revised) */
181         
182         /* during realtime */
183
184         /* note that inertia is only called inertia for historical reasons
185          * and is not changed to avoid DNA surgery. It actually reflects the 
186          * Size value in the GameButtons (= radius) */
187
188         float mass, damping, inertia;
189         /* The form factor k is introduced to give the user more control
190          * and to fix incompatibility problems.
191          * For rotational symmetric objects, the inertia value can be
192          * expressed as: Theta = k * m * r^2
193          * where m = Mass, r = Radius
194          * For a Sphere, the form factor is by default = 0.4
195          */
196
197         float formfactor;
198         float rdamping, sizefac;
199         float margin;
200         float max_vel; /* clamp the maximum velocity 0.0 is disabled */
201         float min_vel; /* clamp the maximum velocity 0.0 is disabled */
202         float m_contactProcessingThreshold;
203         float obstacleRad;
204
205         short rotmode;          /* rotation mode - uses defines set out in DNA_action_types.h for PoseChannel rotations... */
206
207         char boundtype;            /* bounding box use for drawing */
208         char collision_boundtype;  /* bounding box type used for collision */
209
210         char  restrictflag;     /* for restricting view, select, render etc. accessible in outliner */
211
212         char dt;                        /* viewport draw type */
213         char dtx;                       /* viewport draw extra settings */
214         char empty_drawtype;
215         float empty_drawsize;
216         float dupfacesca;       /* dupliface scale */
217         
218         ListBase prop;                  /* game logic property list (not to be confused with IDProperties) */
219         ListBase sensors;               /* game logic sensors */
220         ListBase controllers;   /* game logic controllers */
221         ListBase actuators;             /* game logic actuators */
222
223         float bbsize[3]  DNA_DEPRECATED;
224         short index;                    /* custom index, for renderpasses */
225         unsigned short actdef;  /* current deformation group, note: index starts at 1 */
226         float col[4];                   /* object color */
227
228         int gameflag;
229         int gameflag2;
230
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  DNA_DEPRECATED;                     // XXX depreceated... old animation system
239         ListBase hooks  DNA_DEPRECATED;                         // XXX depreceated... old animation system
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         char  body_type;                        /* for now used to temporarily holds the type of collision object */
247         char  shapeflag;                        /* flag for pinning */
248         short shapenr;                          /* current shape key for menu or pinned */
249         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
250
251         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
252
253         struct DerivedMesh *derivedDeform, *derivedFinal;
254         uint64_t lastDataMask;   /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
255         uint64_t customdata_mask; /* (extra) custom data layer mask to use for creating derivedmesh, set by depsgraph */
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         ListBase gpulamp;               /* runtime, for glsl lamp display only */
260         ListBase pc_ids;
261         ListBase *duplilist;    /* for temporary dupli list storage, only for use by RNA API */
262
263         float ima_ofs[2];               /* offset for image empties */
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[64];  /* MAX_NAME */
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 /* runtime only, but include here for rna access */
285 typedef struct DupliObject {
286         struct DupliObject *next, *prev;
287         struct Object *ob;
288         unsigned int origlay;
289         int index;
290         float mat[4][4], omat[4][4];
291         float orco[3], uv[2];
292
293         short type; /* from Object.transflag */
294         char no_draw, animated;
295 } DupliObject;
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_SPEAKER              12
314
315 // #define OB_WAVE                      21
316 #define OB_LATTICE              22
317
318 /* 23 and 24 are for life and sector (old file compat.) */
319 #define OB_ARMATURE             25
320
321 /* check if the object type supports materials */
322 #define OB_TYPE_SUPPORT_MATERIAL(_type) ((_type)  >= OB_MESH && (_type) <= OB_MBALL)
323 #define OB_TYPE_SUPPORT_VGROUP(_type)   (ELEM(_type, OB_MESH, OB_LATTICE))
324
325 /* partype: first 4 bits: type */
326 #define PARTYPE                 15
327 #define PAROBJECT               0
328 #define PARCURVE                1
329 #define PARKEY                  2
330
331 #define PARSKEL                 4
332 #define PARVERT1                5
333 #define PARVERT3                6
334 #define PARBONE                 7
335
336         /* slow parenting - is not threadsafe and/or may give errors after jumping  */
337 #define PARSLOW                 16
338
339 /* (short) transflag */
340 /* flags 1 and 2 were unused or relics from past features */
341 #define OB_NEG_SCALE            4
342 #define OB_DUPLI                        (8+16+256+512+2048)
343 #define OB_DUPLIFRAMES          8
344 #define OB_DUPLIVERTS           16
345 #define OB_DUPLIROT                     32
346 #define OB_DUPLINOSPEED         64
347 /*#define OB_POWERTRACK         128*/ /*UNUSED*/
348 #define OB_DUPLIGROUP           256
349 #define OB_DUPLIFACES           512
350 #define OB_DUPLIFACES_SCALE     1024
351 #define OB_DUPLIPARTS           2048
352 #define OB_RENDER_DUPLI         4096
353 #define OB_NO_CONSTRAINTS       8192 /* runtime constraints disable */
354
355 /* (short) ipoflag */
356 /* XXX: many old flags for features removed due to incompatability 
357  * with new system and/or other design issues were here 
358  */
359         /* for stride/path editing (XXX: NEEDS REVIEW) */
360 #define OB_DISABLE_PATH         1024
361
362 /* (short) trackflag / upflag */
363 #define OB_POSX                 0
364 #define OB_POSY                 1
365 #define OB_POSZ                 2
366 #define OB_NEGX                 3
367 #define OB_NEGY                 4
368 #define OB_NEGZ                 5
369
370 /* gameflag in game.h */
371
372 /* dt: no flags */
373 #define OB_BOUNDBOX             1
374 #define OB_WIRE                 2
375 #define OB_SOLID                3
376 #define OB_MATERIAL             4
377 #define OB_TEXTURE              5
378 #define OB_RENDER               6
379
380 #define OB_PAINT                100     /* temporary used in draw code */
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 #define OB_EMPTY_IMAGE  8
403
404 /* boundtype */
405 #define OB_BOUND_BOX           0
406 #define OB_BOUND_SPHERE        1
407 #define OB_BOUND_CYLINDER      2
408 #define OB_BOUND_CONE          3
409 #define OB_BOUND_TRIANGLE_MESH 4
410 #define OB_BOUND_CONVEX_HULL   5
411 /* #define OB_BOUND_DYN_MESH   6 */ /*UNUSED*/
412 #define OB_BOUND_CAPSULE       7
413
414
415 /* **************** BASE ********************* */
416
417 /* also needed for base!!!!! or rather, thy interfere....*/
418 /* base->flag and ob->flag */
419 #define BA_WAS_SEL                      2
420 #define BA_HAS_RECALC_OB        4
421 #define BA_HAS_RECALC_DATA      8
422
423         /* NOTE: this was used as a proper setting in past, so nullify before using */
424 #define BA_TEMP_TAG                     32
425
426 /* #define BA_FROMSET                   128 */ /*UNUSED*/
427
428 #define BA_TRANSFORM_CHILD      256 /* child of a transformed object */
429 #define BA_TRANSFORM_PARENT     8192 /* parent of a transformed object */
430
431
432 /* an initial attempt as making selection more specific! */
433 #define BA_DESELECT             0
434 #define BA_SELECT               1
435
436
437 #define OB_FROMDUPLI            512
438 #define OB_DONE                         1024
439 // #define OB_RADIO                     2048    /* deprecated */
440 #define OB_FROMGROUP            4096
441
442 /* ob->recalc (flag bits!) */
443 #define OB_RECALC_OB            1
444 #define OB_RECALC_DATA          2
445                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
446 #define OB_RECALC_TIME          4
447                 /* only use for matching any flag, NOT as an argument since more flags may be added. */
448 #define OB_RECALC_ALL           (OB_RECALC_OB|OB_RECALC_DATA|OB_RECALC_TIME)
449
450 /* controller state */
451 #define OB_MAX_STATES           30
452
453 /* ob->gameflag */
454 #define OB_DYNAMIC              1
455 #define OB_CHILD                2
456 #define OB_ACTOR                4
457 #define OB_INERTIA_LOCK_X       8
458 #define OB_INERTIA_LOCK_Y       16
459 #define OB_INERTIA_LOCK_Z       32
460 #define OB_DO_FH                        64
461 #define OB_ROT_FH                       128
462 #define OB_ANISOTROPIC_FRICTION 256
463 #define OB_GHOST                        512
464 #define OB_RIGID_BODY           1024
465 #define OB_BOUNDS               2048
466
467 #define OB_COLLISION_RESPONSE   4096
468 #define OB_SECTOR               8192
469 #define OB_PROP                 16384
470 #define OB_MAINACTOR    32768
471
472 #define OB_COLLISION    65536
473 #define OB_SOFT_BODY    0x20000
474 #define OB_OCCLUDER             0x40000
475 #define OB_SENSOR               0x80000
476 #define OB_NAVMESH              0x100000
477 #define OB_HASOBSTACLE  0x200000
478
479 /* ob->gameflag2 */
480 #define OB_NEVER_DO_ACTIVITY_CULLING    1
481 #define OB_LOCK_RIGID_BODY_X_AXIS       4
482 #define OB_LOCK_RIGID_BODY_Y_AXIS       8
483 #define OB_LOCK_RIGID_BODY_Z_AXIS       16
484 #define OB_LOCK_RIGID_BODY_X_ROT_AXIS   32
485 #define OB_LOCK_RIGID_BODY_Y_ROT_AXIS   64
486 #define OB_LOCK_RIGID_BODY_Z_ROT_AXIS   128
487
488 /* #define OB_LIFE                      (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD) */
489
490 /* ob->body_type */
491 #define OB_BODY_TYPE_NO_COLLISION       0
492 #define OB_BODY_TYPE_STATIC                     1
493 #define OB_BODY_TYPE_DYNAMIC            2
494 #define OB_BODY_TYPE_RIGID                      3
495 #define OB_BODY_TYPE_SOFT                       4
496 #define OB_BODY_TYPE_OCCLUDER           5
497 #define OB_BODY_TYPE_SENSOR                     6
498 #define OB_BODY_TYPE_NAVMESH            7
499
500 /* ob->scavisflag */
501 #define OB_VIS_SENS             1
502 #define OB_VIS_CONT             2
503 #define OB_VIS_ACT              4
504
505 /* ob->scaflag */
506 #define OB_SHOWSENS             64
507 #define OB_SHOWACT              128
508 #define OB_ADDSENS              256
509 #define OB_ADDCONT              512
510 #define OB_ADDACT               1024
511 #define OB_SHOWCONT             2048
512 #define OB_ALLSTATE             4096
513 #define OB_INITSTBIT    8192
514 #define OB_DEBUGSTATE   16384
515 #define OB_SHOWSTATE    32768
516
517 /* ob->restrictflag */
518 #define OB_RESTRICT_VIEW        1
519 #define OB_RESTRICT_SELECT      2
520 #define OB_RESTRICT_RENDER      4
521
522 /* ob->shapeflag */
523 #define OB_SHAPE_LOCK           1
524 #define OB_SHAPE_TEMPLOCK       2               // deprecated
525 #define OB_SHAPE_EDIT_MODE      4
526
527 /* ob->nlaflag */
528         /* WARNING: flags (1<<0) and (1<<1) were from old animsys */
529         /* object-channel expanded status */
530 #define OB_ADS_COLLAPSED        (1<<10)
531         /* object's ipo-block */
532 #define OB_ADS_SHOWIPO          (1<<11)
533         /* object's constraint channels */
534 #define OB_ADS_SHOWCONS         (1<<12)
535         /* object's material channels */
536 #define OB_ADS_SHOWMATS         (1<<13)
537         /* object's marticle channels */
538 #define OB_ADS_SHOWPARTS        (1<<14)
539
540 /* ob->protectflag */
541 #define OB_LOCK_LOCX    1
542 #define OB_LOCK_LOCY    2
543 #define OB_LOCK_LOCZ    4
544 #define OB_LOCK_LOC             7
545 #define OB_LOCK_ROTX    8
546 #define OB_LOCK_ROTY    16
547 #define OB_LOCK_ROTZ    32
548 #define OB_LOCK_ROT             56
549 #define OB_LOCK_SCALEX  64
550 #define OB_LOCK_SCALEY  128
551 #define OB_LOCK_SCALEZ  256
552 #define OB_LOCK_SCALE   448
553 #define OB_LOCK_ROTW    512
554 #define OB_LOCK_ROT4D   1024
555
556 /* ob->mode */
557 typedef enum ObjectMode {
558         OB_MODE_OBJECT = 0,
559         OB_MODE_EDIT = 1,
560         OB_MODE_SCULPT = 2,
561         OB_MODE_VERTEX_PAINT = 4,
562         OB_MODE_WEIGHT_PAINT = 8,
563         OB_MODE_TEXTURE_PAINT = 16,
564         OB_MODE_PARTICLE_EDIT = 32,
565         OB_MODE_POSE = 64
566 } ObjectMode;
567
568 /* any mode where the brush system is used */
569 #define OB_MODE_ALL_PAINT (OB_MODE_SCULPT|OB_MODE_VERTEX_PAINT|OB_MODE_WEIGHT_PAINT|OB_MODE_TEXTURE_PAINT)
570
571 #define MAX_DUPLI_RECUR 8
572
573 #ifdef __cplusplus
574 }
575 #endif
576
577 #endif
578