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