style cleanyp
[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
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 corresponding 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 in fact */
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                             /* note: this isn't assured to be valid as with 'obmat',
157                              *       before using this value you should do...
158                              *       invert_m4_m4(ob->imat, ob->obmat); */
159         
160         /* Previously 'imat' was used at render time, but as other places use it too
161          * the interactive ui of 2.5 creates problems. So now only 'imat_ren' should
162          * be used when ever the inverse of ob->obmat * re->viewmat is needed! - jahka
163          */
164         float imat_ren[4][4];
165         
166         unsigned int lay;       /* copy of Base's layer in the scene */
167         
168         float sf; /* sf is time-offset */
169
170         short flag;                     /* copy of Base */
171         short colbits DNA_DEPRECATED;           /* deprecated */
172         
173         short transflag, protectflag;   /* transformation settings and transform locks  */
174         short trackflag, upflag;
175         short nlaflag;                          /* used for DopeSheet filtering settings (expanded/collapsed) */
176         short ipoflag;                          // xxx depreceated... old animation system
177         short scaflag;                          /* ui state for game logic */
178         char scavisflag;                        /* more display settings for game logic */
179         char pad5;
180
181         int dupon, dupoff, dupsta, dupend;
182
183         /* during realtime */
184
185         /* note that inertia is only called inertia for historical reasons
186          * and is not changed to avoid DNA surgery. It actually reflects the 
187          * Size value in the GameButtons (= radius) */
188
189         float mass, damping, inertia;
190         /* The form factor k is introduced to give the user more control
191          * and to fix incompatibility problems.
192          * For rotational symmetric objects, the inertia value can be
193          * expressed as: Theta = k * m * r^2
194          * where m = Mass, r = Radius
195          * For a Sphere, the form factor is by default = 0.4
196          */
197
198         float formfactor;
199         float rdamping, sizefac;
200         float margin;
201         float max_vel; /* clamp the maximum velocity 0.0 is disabled */
202         float min_vel; /* clamp the minimum velocity 0.0 is disabled */
203         float m_contactProcessingThreshold;
204         float obstacleRad;
205         
206         /* "Character" physics properties */
207         float step_height;
208         float jump_speed;
209         float fall_speed;
210         char pad1[4];
211
212         short rotmode;          /* rotation mode - uses defines set out in DNA_action_types.h for PoseChannel rotations... */
213
214         char boundtype;            /* bounding box use for drawing */
215         char collision_boundtype;  /* bounding box type used for collision */
216
217         char  restrictflag;     /* for restricting view, select, render etc. accessible in outliner */
218
219         char dt;                        /* viewport draw type */
220         char dtx;                       /* viewport draw extra settings */
221         char empty_drawtype;
222         float empty_drawsize;
223         float dupfacesca;       /* dupliface scale */
224         
225         ListBase prop;                  /* game logic property list (not to be confused with IDProperties) */
226         ListBase sensors;               /* game logic sensors */
227         ListBase controllers;   /* game logic controllers */
228         ListBase actuators;             /* game logic actuators */
229
230         float bbsize[3]  DNA_DEPRECATED;
231         short index;                    /* custom index, for renderpasses */
232         unsigned short actdef;  /* current deformation group, note: index starts at 1 */
233         float col[4];                   /* object color */
234
235         int gameflag;
236         int gameflag2;
237
238         struct BulletSoftBody *bsoft;   /* settings for game engine bullet soft body */
239
240         short softflag;                 /* softbody settings */
241         short recalc;                   /* dependency flag */
242         float anisotropicFriction[3];
243
244         ListBase constraints;           /* object constraints */
245         ListBase nlastrips  DNA_DEPRECATED;                     // XXX depreceated... old animation system
246         ListBase hooks  DNA_DEPRECATED;                         // XXX depreceated... old animation system
247         ListBase particlesystem;        /* particle systems */
248         
249         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
250         struct SoftBody *soft;          /* if exists, saved in file */
251         struct Group *dup_group;        /* object duplicator for group */
252
253         char  body_type;                        /* for now used to temporarily holds the type of collision object */
254         char  shapeflag;                        /* flag for pinning */
255         short shapenr;                          /* current shape key for menu or pinned */
256         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
257
258         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
259
260         struct DerivedMesh *derivedDeform, *derivedFinal;
261         int *pad;
262         uint64_t lastDataMask;   /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
263         uint64_t customdata_mask; /* (extra) custom data layer mask to use for creating derivedmesh, set by depsgraph */
264         unsigned int state;                     /* bit masks of game controllers that are active */
265         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
266
267         ListBase gpulamp;               /* runtime, for glsl lamp display only */
268         ListBase pc_ids;
269         ListBase *duplilist;    /* for temporary dupli list storage, only for use by RNA API */
270
271         float ima_ofs[2];               /* offset for image empties */
272 } Object;
273
274 /* Warning, this is not used anymore because hooks are now modifiers */
275 typedef struct ObHook {
276         struct ObHook *next, *prev;
277         
278         struct Object *parent;
279         float parentinv[4][4];  /* matrix making current transform unmodified */
280         float mat[4][4];                /* temp matrix while hooking */
281         float cent[3];                  /* visualization of hook */
282         float falloff;                  /* if not zero, falloff is distance where influence zero */
283         
284         char name[64];  /* MAX_NAME */
285
286         int *indexar;
287         int totindex, curindex; /* curindex is cache for fast lookup */
288         short type, active;             /* active is only first hook, for button menu */
289         float force;
290 } ObHook;
291
292 /* runtime only, but include here for rna access */
293 typedef struct DupliObject {
294         struct DupliObject *next, *prev;
295         struct Object *ob;
296         unsigned int origlay;
297         int index;
298         float mat[4][4], omat[4][4];
299         float orco[3], uv[2];
300
301         short type; /* from Object.transflag */
302         char no_draw, animated;
303
304         /* Lowest-level particle index.
305          * Note: This is needed for particle info in shaders.
306          * Otherwise dupli groups in particle systems would override the
307          * index value from higher dupli levels. Would be nice to have full generic access
308          * to all dupli levels somehow, but for now this should cover most use-cases.
309          */
310         int particle_index;
311         int pad;
312 } DupliObject;
313
314 /* **************** OBJECT ********************* */
315
316 /* used many places... should be specialized  */
317 #define SELECT                  1
318
319 /* type */
320 #define OB_EMPTY                0
321 #define OB_MESH                 1
322 #define OB_CURVE                2
323 #define OB_SURF                 3
324 #define OB_FONT                 4
325 #define OB_MBALL                5
326
327 #define OB_LAMP                 10
328 #define OB_CAMERA               11
329
330 #define OB_SPEAKER              12
331
332 // #define OB_WAVE                      21
333 #define OB_LATTICE              22
334
335 /* 23 and 24 are for life and sector (old file compat.) */
336 #define OB_ARMATURE             25
337
338 /* check if the object type supports materials */
339 #define OB_TYPE_SUPPORT_MATERIAL(_type) \
340         ((_type) >= OB_MESH && (_type) <= OB_MBALL)
341 #define OB_TYPE_SUPPORT_VGROUP(_type) \
342         (ELEM(_type, OB_MESH, OB_LATTICE))
343 #define OB_TYPE_SUPPORT_EDITMODE(_type) \
344         (ELEM7(_type, OB_MESH, OB_FONT, OB_CURVE, OB_SURF, OB_MBALL, OB_LATTICE, OB_ARMATURE))
345
346 /* partype: first 4 bits: type */
347 #define PARTYPE                 15
348 #define PAROBJECT               0
349 #define PARCURVE                1
350 #define PARKEY                  2
351
352 #define PARSKEL                 4
353 #define PARVERT1                5
354 #define PARVERT3                6
355 #define PARBONE                 7
356
357         /* slow parenting - is not threadsafe and/or may give errors after jumping  */
358 #define PARSLOW                 16
359
360 /* (short) transflag */
361 /* flags 1 and 2 were unused or relics from past features */
362 #define OB_NEG_SCALE            4
363 #define OB_DUPLI                        (8+16+256+512+2048)
364 #define OB_DUPLIFRAMES          8
365 #define OB_DUPLIVERTS           16
366 #define OB_DUPLIROT                     32
367 #define OB_DUPLINOSPEED         64
368 /*#define OB_POWERTRACK         128*/ /*UNUSED*/
369 #define OB_DUPLIGROUP           256
370 #define OB_DUPLIFACES           512
371 #define OB_DUPLIFACES_SCALE     1024
372 #define OB_DUPLIPARTS           2048
373 #define OB_RENDER_DUPLI         4096
374 #define OB_NO_CONSTRAINTS       8192 /* runtime constraints disable */
375
376 /* (short) ipoflag */
377 /* XXX: many old flags for features removed due to incompatibility
378  * with new system and/or other design issues were here 
379  */
380         /* for stride/path editing (XXX: NEEDS REVIEW) */
381 #define OB_DISABLE_PATH         1024
382
383 /* (short) trackflag / upflag */
384 #define OB_POSX                 0
385 #define OB_POSY                 1
386 #define OB_POSZ                 2
387 #define OB_NEGX                 3
388 #define OB_NEGY                 4
389 #define OB_NEGZ                 5
390
391 /* gameflag in game.h */
392
393 /* dt: no flags */
394 #define OB_BOUNDBOX             1
395 #define OB_WIRE                 2
396 #define OB_SOLID                3
397 #define OB_MATERIAL             4
398 #define OB_TEXTURE              5
399 #define OB_RENDER               6
400
401 #define OB_PAINT                100     /* temporary used in draw code */
402
403 /* dtx: flags, char! */
404 #define OB_AXIS                 2
405 #define OB_TEXSPACE             4
406 #define OB_DRAWNAME             8
407 #define OB_DRAWIMAGE    16
408         /* for solid+wire display */
409 #define OB_DRAWWIRE             32
410         /* for overdraw */
411 #define OB_DRAWXRAY             64
412         /* enable transparent draw */
413 #define OB_DRAWTRANSP   128
414
415 /* empty_drawtype: no flags */
416 #define OB_ARROWS               1
417 #define OB_PLAINAXES    2
418 #define OB_CIRCLE               3
419 #define OB_SINGLE_ARROW 4
420 #define OB_CUBE                 5
421 #define OB_EMPTY_SPHERE 6
422 #define OB_EMPTY_CONE   7
423 #define OB_EMPTY_IMAGE  8
424
425 /* boundtype */
426 #define OB_BOUND_BOX           0
427 #define OB_BOUND_SPHERE        1
428 #define OB_BOUND_CYLINDER      2
429 #define OB_BOUND_CONE          3
430 #define OB_BOUND_TRIANGLE_MESH 4
431 #define OB_BOUND_CONVEX_HULL   5
432 /* #define OB_BOUND_DYN_MESH   6 */ /*UNUSED*/
433 #define OB_BOUND_CAPSULE       7
434
435
436 /* **************** BASE ********************* */
437
438 /* also needed for base!!!!! or rather, thy interfere....*/
439 /* base->flag and ob->flag */
440 #define BA_WAS_SEL                      2
441 #define BA_HAS_RECALC_OB        4
442 #define BA_HAS_RECALC_DATA      8
443
444         /* NOTE: this was used as a proper setting in past, so nullify before using */
445 #define BA_TEMP_TAG                     32
446
447 /* #define BA_FROMSET                   128 */ /*UNUSED*/
448
449 #define BA_TRANSFORM_CHILD      256 /* child of a transformed object */
450 #define BA_TRANSFORM_PARENT     8192 /* parent of a transformed object */
451
452
453 /* an initial attempt as making selection more specific! */
454 #define BA_DESELECT             0
455 #define BA_SELECT               1
456
457
458 #define OB_FROMDUPLI            512
459 #define OB_DONE                         1024
460 // #define OB_RADIO                     2048    /* deprecated */
461 #define OB_FROMGROUP            4096
462
463 /* WARNING - when adding flags check on PSYS_RECALC */
464 /* ob->recalc (flag bits!) */
465 #define OB_RECALC_OB        (1 << 0)
466 #define OB_RECALC_DATA      (1 << 1)
467 /* time flag is set when time changes need recalc, so baked systems can ignore it */
468 #define OB_RECALC_TIME      (1 << 2)
469 /* only use for matching any flag, NOT as an argument since more flags may be added. */
470 #define OB_RECALC_ALL       (OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME)
471
472 /* controller state */
473 #define OB_MAX_STATES           30
474
475 /* ob->gameflag */
476 #define OB_DYNAMIC              1
477 #define OB_CHILD                2
478 #define OB_ACTOR                4
479 #define OB_INERTIA_LOCK_X       8
480 #define OB_INERTIA_LOCK_Y       16
481 #define OB_INERTIA_LOCK_Z       32
482 #define OB_DO_FH                        64
483 #define OB_ROT_FH                       128
484 #define OB_ANISOTROPIC_FRICTION 256
485 #define OB_GHOST                        512
486 #define OB_RIGID_BODY           1024
487 #define OB_BOUNDS               2048
488
489 #define OB_COLLISION_RESPONSE   4096
490 #define OB_SECTOR               8192
491 #define OB_PROP                 16384
492 #define OB_MAINACTOR    32768
493
494 #define OB_COLLISION    65536
495 #define OB_SOFT_BODY    0x20000
496 #define OB_OCCLUDER             0x40000
497 #define OB_SENSOR               0x80000
498 #define OB_NAVMESH              0x100000
499 #define OB_HASOBSTACLE  0x200000
500 #define OB_CHARACTER            0x400000
501
502 /* ob->gameflag2 */
503 #define OB_NEVER_DO_ACTIVITY_CULLING    1
504 #define OB_LOCK_RIGID_BODY_X_AXIS       4
505 #define OB_LOCK_RIGID_BODY_Y_AXIS       8
506 #define OB_LOCK_RIGID_BODY_Z_AXIS       16
507 #define OB_LOCK_RIGID_BODY_X_ROT_AXIS   32
508 #define OB_LOCK_RIGID_BODY_Y_ROT_AXIS   64
509 #define OB_LOCK_RIGID_BODY_Z_ROT_AXIS   128
510
511 /* #define OB_LIFE                      (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD) */
512
513 /* ob->body_type */
514 #define OB_BODY_TYPE_NO_COLLISION       0
515 #define OB_BODY_TYPE_STATIC                     1
516 #define OB_BODY_TYPE_DYNAMIC            2
517 #define OB_BODY_TYPE_RIGID                      3
518 #define OB_BODY_TYPE_SOFT                       4
519 #define OB_BODY_TYPE_OCCLUDER           5
520 #define OB_BODY_TYPE_SENSOR                     6
521 #define OB_BODY_TYPE_NAVMESH            7
522 #define OB_BODY_TYPE_CHARACTER                  8
523
524 /* ob->scavisflag */
525 #define OB_VIS_SENS             1
526 #define OB_VIS_CONT             2
527 #define OB_VIS_ACT              4
528
529 /* ob->scaflag */
530 #define OB_SHOWSENS             64
531 #define OB_SHOWACT              128
532 #define OB_ADDSENS              256
533 #define OB_ADDCONT              512
534 #define OB_ADDACT               1024
535 #define OB_SHOWCONT             2048
536 #define OB_ALLSTATE             4096
537 #define OB_INITSTBIT    8192
538 #define OB_DEBUGSTATE   16384
539 #define OB_SHOWSTATE    32768
540
541 /* ob->restrictflag */
542 #define OB_RESTRICT_VIEW        1
543 #define OB_RESTRICT_SELECT      2
544 #define OB_RESTRICT_RENDER      4
545
546 /* ob->shapeflag */
547 #define OB_SHAPE_LOCK           1
548 #define OB_SHAPE_TEMPLOCK       2               // deprecated
549 #define OB_SHAPE_EDIT_MODE      4
550
551 /* ob->nlaflag */
552         /* WARNING: flags (1<<0) and (1<<1) were from old animsys */
553         /* object-channel expanded status */
554 #define OB_ADS_COLLAPSED        (1<<10)
555         /* object's ipo-block */
556 #define OB_ADS_SHOWIPO          (1<<11)
557         /* object's constraint channels */
558 #define OB_ADS_SHOWCONS         (1<<12)
559         /* object's material channels */
560 #define OB_ADS_SHOWMATS         (1<<13)
561         /* object's marticle channels */
562 #define OB_ADS_SHOWPARTS        (1<<14)
563
564 /* ob->protectflag */
565 #define OB_LOCK_LOCX    1
566 #define OB_LOCK_LOCY    2
567 #define OB_LOCK_LOCZ    4
568 #define OB_LOCK_LOC             7
569 #define OB_LOCK_ROTX    8
570 #define OB_LOCK_ROTY    16
571 #define OB_LOCK_ROTZ    32
572 #define OB_LOCK_ROT             56
573 #define OB_LOCK_SCALEX  64
574 #define OB_LOCK_SCALEY  128
575 #define OB_LOCK_SCALEZ  256
576 #define OB_LOCK_SCALE   448
577 #define OB_LOCK_ROTW    512
578 #define OB_LOCK_ROT4D   1024
579
580 /* ob->mode */
581 typedef enum ObjectMode {
582         OB_MODE_OBJECT = 0,
583         OB_MODE_EDIT = 1,
584         OB_MODE_SCULPT = 2,
585         OB_MODE_VERTEX_PAINT = 4,
586         OB_MODE_WEIGHT_PAINT = 8,
587         OB_MODE_TEXTURE_PAINT = 16,
588         OB_MODE_PARTICLE_EDIT = 32,
589         OB_MODE_POSE = 64
590 } ObjectMode;
591
592 /* any mode where the brush system is used */
593 #define OB_MODE_ALL_PAINT (OB_MODE_SCULPT|OB_MODE_VERTEX_PAINT|OB_MODE_WEIGHT_PAINT|OB_MODE_TEXTURE_PAINT)
594
595 #define MAX_DUPLI_RECUR 8
596
597 #ifdef __cplusplus
598 }
599 #endif
600
601 #endif
602