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