svn merge -r 23207:23528 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[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];
137         float quat[4], dquat[4];
138         float obmat[4][4];
139         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
140         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
141         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
142         
143         unsigned int lay;                               /* copy of Base */
144         
145         short flag;                     /* copy of Base */
146         short colbits;          /* deprecated */
147         
148         short transflag, protectflag;   /* transformation settings and transform locks  */
149         short trackflag, upflag;
150         short nlaflag, ipoflag;         // xxx depreceated... old animation system
151         short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
152         short scavisflag, boundtype;
153         
154         int dupon, dupoff, dupsta, dupend;
155
156         float sf, ctime; /* sf is time-offset, ctime is the objects current time (XXX timing needs to be revised) */
157         
158         /* during realtime */
159
160         /* note that inertia is only called inertia for historical reasons
161          * and is not changed to avoid DNA surgery. It actually reflects the 
162          * Size value in the GameButtons (= radius) */
163
164         float mass, damping, inertia;
165         /* The form factor k is introduced to give the user more control
166          * and to fix incompatibility problems.
167      * For rotational symmetric objects, the inertia value can be
168          * expressed as: Theta = k * m * r^2
169          * where m = Mass, r = Radius
170          * For a Sphere, the form factor is by default = 0.4
171          */
172
173         float formfactor;
174         float rdamping, sizefac;
175         float margin;
176         float max_vel; /* clamp the maximum velocity 0.0 is disabled */
177         float min_vel; /* clamp the maximum velocity 0.0 is disabled */
178         float m_contactProcessingThreshold;
179         
180         short rotmode;          /* rotation mode - uses defines set out in DNA_action_types.h for PoseChannel rotations... */
181         
182         char dt, dtx;
183         char empty_drawtype, pad1[3];
184         float empty_drawsize;
185         float dupfacesca;       /* dupliface scale */
186         
187         ListBase prop;
188         ListBase sensors;
189         ListBase controllers;
190         ListBase actuators;
191     
192         float bbsize[3];
193         short index;                    /* custom index, for renderpasses */
194         unsigned short actdef;  /* current deformation group */
195         float col[4];                   /* object color, adjusted via IPO's only */
196         /**
197          * Settings for game objects
198          * bit 0: Object has dynamic behaviour
199          * bit 2: Object is evaluated by the gameengine
200          * bit 6: Use Fh settings in Materials
201          * bit 7: Use face normal to rotate Object
202          * bit 8: Friction is anisotropic
203          * bit 9: Object is a ghost
204          * bit 10: Do rigid body dynamics.
205          * bit 11: Use bounding object for physics
206          */
207         int gameflag;
208         /**
209          * More settings
210          * bit 15: Always ignore activity culling 
211          */
212         int gameflag2;
213         struct BulletSoftBody *bsoft;   /* settings for game engine bullet soft body */
214
215         short softflag;                 /* softbody settings */
216         short recalc;                   /* dependency flag */
217         float anisotropicFriction[3];
218
219         ListBase constraints;           /* object constraints */
220         ListBase nlastrips;                     // XXX depreceated... old animation system
221         ListBase hooks;
222         ListBase particlesystem;        /* particle systems */
223         
224         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
225         struct SoftBody *soft;          /* if exists, saved in file */
226         struct Group *dup_group;        /* object duplicator for group */
227         
228         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
229         
230         short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
231
232         short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
233         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
234         short recalco;                          /* recalco for temp storage of ob->recalc, bad design warning */
235         short body_type;                        /* for now used to temporarily holds the type of collision object */
236         
237         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
238
239         struct DerivedMesh *derivedDeform, *derivedFinal;
240         int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
241         unsigned int state;                     /* bit masks of game controllers that are active */
242         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
243
244         int pad2;
245
246         ListBase gpulamp;               /* runtime, for lamps only */
247         ListBase pc_ids;
248         ListBase *duplilist;    /* for temporary dupli list storage, only for use by RNA API */
249 } Object;
250
251 /* Warning, this is not used anymore because hooks are now modifiers */
252 typedef struct ObHook {
253         struct ObHook *next, *prev;
254         
255         struct Object *parent;
256         float parentinv[4][4];  /* matrix making current transform unmodified */
257         float mat[4][4];                /* temp matrix while hooking */
258         float cent[3];                  /* visualization of hook */
259         float falloff;                  /* if not zero, falloff is distance where influence zero */
260         
261         char name[32];
262
263         int *indexar;
264         int totindex, curindex; /* curindex is cache for fast lookup */
265         short type, active;             /* active is only first hook, for button menu */
266         float force;
267 } ObHook;
268
269 typedef struct DupliObject {
270         struct DupliObject *next, *prev;
271         struct Object *ob;
272         unsigned int origlay;
273         int index, no_draw, type, animated;
274         float mat[4][4], omat[4][4];
275         float orco[3], uv[2];
276 } DupliObject;
277
278 /* this work object is defined in object.c */
279 extern Object workob;
280
281
282 /* **************** OBJECT ********************* */
283
284 /* used many places... should be specialized  */
285 #define SELECT                  1
286
287 /* type */
288 #define OB_EMPTY                0
289 #define OB_MESH                 1
290 #define OB_CURVE                2
291 #define OB_SURF                 3
292 #define OB_FONT                 4
293 #define OB_MBALL                5
294
295 #define OB_LAMP                 10
296 #define OB_CAMERA               11
297
298 #define OB_WAVE                 21
299 #define OB_LATTICE              22
300
301 /* 23 and 24 are for life and sector (old file compat.) */
302 #define OB_ARMATURE             25
303
304 /* partype: first 4 bits: type */
305 #define PARTYPE                 15
306 #define PAROBJECT               0
307 #define PARCURVE                1
308 #define PARKEY                  2
309
310 #define PARSKEL                 4
311 #define PARVERT1                5
312 #define PARVERT3                6
313 #define PARBONE                 7
314 #define PARSLOW                 16
315
316 /* (short) transflag */
317 #define OB_OFFS_LOCAL           1
318         // XXX OB_QUAT was never used, but is now depreceated in favour of standard rotation handling...
319 #define OB_QUAT                         2
320 #define OB_NEG_SCALE            4
321 #define OB_DUPLI                        (8+16+256+512+2048)
322 #define OB_DUPLIFRAMES          8
323 #define OB_DUPLIVERTS           16
324 #define OB_DUPLIROT                     32
325 #define OB_DUPLINOSPEED         64
326 #define OB_POWERTRACK           128
327 #define OB_DUPLIGROUP           256
328 #define OB_DUPLIFACES           512
329 #define OB_DUPLIFACES_SCALE     1024
330 #define OB_DUPLIPARTS           2048
331 #define OB_RENDER_DUPLI         4096
332
333 /* (short) ipoflag */
334         // XXX depreceated - old animation system crap
335 #define OB_DRAWKEY                      1
336 #define OB_DRAWKEYSEL           2
337 #define OB_OFFS_OB                      4
338 #define OB_OFFS_MAT                     8
339 #define OB_OFFS_VKEY            16
340 #define OB_OFFS_PATH            32
341 #define OB_OFFS_PARENT          64
342 #define OB_OFFS_PARTICLE        128
343         /* get ipo from from action or not? */
344 #define OB_ACTION_OB            256
345 #define OB_ACTION_KEY           512
346         /* for stride edit */
347 #define OB_DISABLE_PATH         1024
348
349 #define OB_OFFS_PARENTADD       2048
350
351
352 /* (short) trackflag / upflag */
353 #define OB_POSX                 0
354 #define OB_POSY                 1
355 #define OB_POSZ                 2
356 #define OB_NEGX                 3
357 #define OB_NEGY                 4
358 #define OB_NEGZ                 5
359
360 /* gameflag in game.h */
361
362 /* dt: no flags */
363 #define OB_BOUNDBOX             1
364 #define OB_WIRE                 2
365 #define OB_SOLID                3
366 #define OB_SHADED               4
367 #define OB_TEXTURE              5
368
369 /* dtx: flags, char! */
370 #define OB_AXIS                 2
371 #define OB_TEXSPACE             4
372 #define OB_DRAWNAME             8
373 #define OB_DRAWIMAGE    16
374         /* for solid+wire display */
375 #define OB_DRAWWIRE             32
376         /* for overdraw */
377 #define OB_DRAWXRAY             64
378         /* enable transparent draw */
379 #define OB_DRAWTRANSP   128
380
381 /* empty_drawtype: no flags */
382 #define OB_ARROWS               1
383 #define OB_PLAINAXES    2
384 #define OB_CIRCLE               3
385 #define OB_SINGLE_ARROW 4
386 #define OB_CUBE                 5
387 #define OB_EMPTY_SPHERE 6
388 #define OB_EMPTY_CONE   7
389
390 /* boundtype */
391 #define OB_BOUND_BOX            0
392 #define OB_BOUND_SPHERE         1
393 #define OB_BOUND_CYLINDER       2
394 #define OB_BOUND_CONE           3
395 #define OB_BOUND_POLYH          4
396 #define OB_BOUND_POLYT          5
397 #define OB_BOUND_DYN_MESH   6
398
399
400 /* **************** BASE ********************* */
401
402 /* also needed for base!!!!! or rather, thy interfere....*/
403 /* base->flag and ob->flag */
404 #define BA_WAS_SEL                      2
405 #define BA_HAS_RECALC_OB        4
406 #define BA_HAS_RECALC_DATA      8
407
408         // XXX DEPRECEATED SETTING...
409 #define BA_DO_IPO                       32
410
411 #define BA_FROMSET                      128
412
413 #define BA_TRANSFORM_CHILD      256 /* child of a transformed object */
414
415 /* an initial attempt as making selection more specific! */
416 #define BA_DESELECT     0
417 #define BA_SELECT               1
418
419
420 #define OB_FROMDUPLI            512
421 #define OB_DONE                         1024
422 #define OB_RADIO                        2048
423 #define OB_FROMGROUP            4096
424
425 /* ob->recalc (flag bits!) */
426 #define OB_RECALC_OB            1
427 #define OB_RECALC_DATA          2
428                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
429 #define OB_RECALC_TIME          4
430 #define OB_RECALC                       7
431
432
433 /* ob->gameflag */
434 #define OB_DYNAMIC              1
435 #define OB_CHILD                2
436 #define OB_ACTOR                4
437 #define OB_INERTIA_LOCK_X       8
438 #define OB_INERTIA_LOCK_Y       16
439 #define OB_INERTIA_LOCK_Z       32
440 #define OB_DO_FH                        64
441 #define OB_ROT_FH                       128
442 #define OB_ANISOTROPIC_FRICTION 256
443 #define OB_GHOST                        512
444 #define OB_RIGID_BODY           1024
445 #define OB_BOUNDS               2048
446
447 #define OB_COLLISION_RESPONSE   4096
448 #define OB_SECTOR               8192
449 #define OB_PROP                 16384
450 #define OB_MAINACTOR    32768
451
452 #define OB_COLLISION    65536
453 #define OB_SOFT_BODY    0x20000
454 #define OB_OCCLUDER             0x40000
455 #define OB_SENSOR               0x80000
456
457 /* ob->gameflag2 */
458 #define OB_NEVER_DO_ACTIVITY_CULLING    1
459 #define OB_LOCK_RIGID_BODY_X_AXIS       4
460 #define OB_LOCK_RIGID_BODY_Y_AXIS       8
461 #define OB_LOCK_RIGID_BODY_Z_AXIS       16
462 #define OB_LOCK_RIGID_BODY_X_ROT_AXIS   32
463 #define OB_LOCK_RIGID_BODY_Y_ROT_AXIS   64
464 #define OB_LOCK_RIGID_BODY_Z_ROT_AXIS   128
465
466 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
467
468 /* ob->body_type */
469 #define OB_BODY_TYPE_NO_COLLISION       0
470 #define OB_BODY_TYPE_STATIC                     1
471 #define OB_BODY_TYPE_DYNAMIC            2
472 #define OB_BODY_TYPE_RIGID                      3
473 #define OB_BODY_TYPE_SOFT                       4
474 #define OB_BODY_TYPE_OCCLUDER           5
475 #define OB_BODY_TYPE_SENSOR                     6
476
477 /* ob->scavisflag */
478 #define OB_VIS_SENS             1
479 #define OB_VIS_CONT             2
480 #define OB_VIS_ACT              4
481
482 /* ob->scaflag */
483 #define OB_SHOWSENS             64
484 #define OB_SHOWACT              128
485 #define OB_ADDSENS              256
486 #define OB_ADDCONT              512
487 #define OB_ADDACT               1024
488 #define OB_SHOWCONT             2048
489 #define OB_SETSTBIT             4096
490 #define OB_INITSTBIT    8192
491 #define OB_DEBUGSTATE   16384
492
493 /* ob->restrictflag */
494 #define OB_RESTRICT_VIEW        1
495 #define OB_RESTRICT_SELECT      2
496 #define OB_RESTRICT_RENDER      4
497
498 /* ob->shapeflag */
499 #define OB_SHAPE_LOCK           1
500 #define OB_SHAPE_TEMPLOCK       2
501
502 /* ob->nlaflag */
503         // XXX depreceated - old animation system
504 #define OB_NLA_OVERRIDE         (1<<0)
505 #define OB_NLA_COLLAPSED        (1<<1)
506
507         /* object-channel expanded status */
508 #define OB_ADS_COLLAPSED        (1<<10)
509         /* object's ipo-block */
510 #define OB_ADS_SHOWIPO          (1<<11)
511         /* object's constraint channels */
512 #define OB_ADS_SHOWCONS         (1<<12)
513         /* object's material channels */
514 #define OB_ADS_SHOWMATS         (1<<13)
515         /* object's marticle channels */
516 #define OB_ADS_SHOWPARTS        (1<<14)
517
518 /* ob->protectflag */
519 #define OB_LOCK_LOCX    1
520 #define OB_LOCK_LOCY    2
521 #define OB_LOCK_LOCZ    4
522 #define OB_LOCK_LOC             7
523 #define OB_LOCK_ROTX    8
524 #define OB_LOCK_ROTY    16
525 #define OB_LOCK_ROTZ    32
526 #define OB_LOCK_ROT             56
527 #define OB_LOCK_SCALEX  64
528 #define OB_LOCK_SCALEY  128
529 #define OB_LOCK_SCALEZ  256
530 #define OB_LOCK_SCALE   448
531 #define OB_LOCK_ROTW    512
532 #define OB_LOCK_ROT4D   1024
533
534 /* ob->mode */
535 typedef enum ObjectMode {
536         OB_MODE_OBJECT = 0,
537         OB_MODE_EDIT = 1,
538         OB_MODE_SCULPT = 2,
539         OB_MODE_VERTEX_PAINT = 4,
540         OB_MODE_WEIGHT_PAINT = 8,
541         OB_MODE_TEXTURE_PAINT = 16,
542         OB_MODE_PARTICLE_EDIT = 32,
543         OB_MODE_POSE = 64
544 } ObjectMode;
545
546 #ifdef __cplusplus
547 }
548 #endif
549
550 #endif
551
552