Merge of first part of changes from the apricot branch, especially
[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 #include "DNA_scriptlink_types.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 struct bPose;   
45 struct Object;
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
57 typedef struct bDeformGroup {
58         struct bDeformGroup *next, *prev;
59         char name[32];
60 } bDeformGroup;
61
62 /**
63  * The following illustrates the orientation of the 
64  * bounding box in local space
65  * 
66  *  
67  * Z  Y
68  * | /
69  * |/
70  * .-----X
71  * 
72  * 
73  *     2----------6
74  *    /|         /|
75  *   / |        / |
76  *  1----------5  |
77  *  |  |       |  |
78  *  |  3-------|--7
79  *  | /        | /
80  *  |/         |/
81  *  0----------4
82  */
83 typedef struct BoundBox {
84         float vec[8][3];
85         int flag, pad;
86 } BoundBox;
87
88 /* boundbox flag */
89 #define OB_BB_DISABLED  1
90
91 typedef struct Object {
92         ID id;
93
94         short type, partype;
95         int par1, par2, par3;   /* can be vertexnrs */
96         char parsubstr[32];     /* String describing subobject info */
97         struct Object *parent, *track;
98         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
99         /* proxy_from is set in target back to the proxy. */
100         struct Object *proxy, *proxy_group, *proxy_from;
101         struct Ipo *ipo;
102         struct Path *path;
103         struct BoundBox *bb;
104         struct bAction *action; 
105         struct bAction *poselib;
106         struct bPose *pose;     
107         void *data;
108         
109         ListBase constraintChannels;
110         ListBase effect;
111         ListBase disp;
112         ListBase defbase;
113         ListBase modifiers; /* list of ModifierData structures */
114         
115         struct Material **mat;
116         
117         /* rot en drot have to be together! (transform('r' en 's')) */
118         float loc[3], dloc[3], orig[3];
119         float size[3], dsize[3];
120         float rot[3], drot[3];
121         /* float quat[4], dquat[4]; (not used yet) */
122         float obmat[4][4];
123         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
124         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
125         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
126         
127         unsigned int lay;                               /* copy of Base */
128         
129         short flag;                     /* copy of Base */
130         short colbits;          /* when zero, from obdata */
131         
132         short transflag, ipoflag;       /* transformation and ipo settings */
133         short trackflag, upflag;
134         short nlaflag, protectflag;     /* nlaflag defines NLA override, protectflag is bits to lock transform */
135         short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
136         short scavisflag, boundtype;
137         
138         int dupon, dupoff, dupsta, dupend;
139
140         float sf, ctime; /* sf is time-offset, ctime is the objects current time */
141         
142         /* during realtime */
143
144         /* note that inertia is only called inertia for historical reasons
145          * and is not changed to avoid DNA surgery. It actually reflects the 
146          * Size value in the GameButtons (= radius) */
147
148         float mass, damping, inertia;
149         /* The form factor k is introduced to give the user more control
150          * and to fix incompatibility problems.
151      * For rotational symmetric objects, the inertia value can be
152          * expressed as: Theta = k * m * r^2
153          * where m = Mass, r = Radius
154          * For a Sphere, the form factor is by default = 0.4
155          */
156
157         float formfactor;
158         float rdamping, sizefac;
159         
160         char dt, dtx;
161         char totcol;    /* copy of mesh or curve or meta */
162         char actcol;    /* currently selected material in the user interface */
163         char empty_drawtype, pad1[3];
164         float empty_drawsize;
165         float dupfacesca;       /* dupliface scale */
166         
167         ScriptLink scriptlink;
168         ListBase prop;
169         ListBase sensors;
170         ListBase controllers;
171         ListBase actuators;
172     
173         float bbsize[3];
174         short index;                    /* custom index, for renderpasses */
175         unsigned short actdef;  /* current deformation group */
176         float col[4];                   /* object color, adjusted via IPO's only */
177         /**
178          * Settings for game objects
179          * bit 0: Object has dynamic behaviour
180          * bit 2: Object is evaluated by the gameengine
181          * bit 6: Use Fh settings in Materials
182          * bit 7: Use face normal to rotate Object
183          * bit 8: Friction is anisotropic
184          * bit 9: Object is a ghost
185          * bit 10: Do rigid body dynamics.
186          * bit 11: Use bounding object for physics
187          */
188         int gameflag;
189         /**
190          * More settings
191          * bit 15: Always ignore activity culling 
192          */
193         int gameflag2;
194         short softflag;                 /* softboday settings */
195         short recalc;                   /* dependency flag */
196         float anisotropicFriction[3];
197
198         ListBase constraints;
199         ListBase nlastrips;
200         ListBase hooks;
201         ListBase particlesystem;        /* particle systems */
202         
203         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
204         struct SoftBody *soft;          /* if exists, saved in file */
205         struct Group *dup_group;        /* object duplicator for group */
206         
207         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
208         
209         short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
210
211         short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
212         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
213         short recalco, pad4;            /* recalco for temp storage of ob->recalc, bad design warning */
214         
215         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
216
217         struct DerivedMesh *derivedDeform, *derivedFinal;
218         int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
219         unsigned int state;                     /* bit masks of game controllers that are active */
220         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
221         int pad2;
222
223 /*#ifdef WITH_VERSE*/
224         void *vnode;                    /* pointer at object VerseNode */
225 /*#endif*/
226
227         ListBase gpulamp;               /* runtime, for lamps only */
228 } Object;
229
230 /* Warning, this is not used anymore because hooks are now modifiers */
231 typedef struct ObHook {
232         struct ObHook *next, *prev;
233         
234         struct Object *parent;
235         float parentinv[4][4];  /* matrix making current transform unmodified */
236         float mat[4][4];                /* temp matrix while hooking */
237         float cent[3];                  /* visualization of hook */
238         float falloff;                  /* if not zero, falloff is distance where influence zero */
239         
240         char name[32];
241
242         int *indexar;
243         int totindex, curindex; /* curindex is cache for fast lookup */
244         short type, active;             /* active is only first hook, for button menu */
245         float force;
246 } ObHook;
247
248
249 /* this work object is defined in object.c */
250 extern Object workob;
251
252
253 /* **************** OBJECT ********************* */
254
255 /* used many places... should be specialized  */
256 #define SELECT                  1
257
258 /* type */
259 #define OB_EMPTY                0
260 #define OB_MESH                 1
261 #define OB_CURVE                2
262 #define OB_SURF                 3
263 #define OB_FONT                 4
264 #define OB_MBALL                5
265
266 #define OB_LAMP                 10
267 #define OB_CAMERA               11
268
269 #define OB_WAVE                 21
270 #define OB_LATTICE              22
271
272 /* 23 and 24 are for life and sector (old file compat.) */
273 #define OB_ARMATURE             25
274
275 /* partype: first 4 bits: type */
276 #define PARTYPE                 15
277 #define PAROBJECT               0
278 #define PARCURVE                1
279 #define PARKEY                  2
280
281 #define PARSKEL                 4
282 #define PARVERT1                5
283 #define PARVERT3                6
284 #define PARBONE                 7
285 #define PARSLOW                 16
286
287 /* (short) transflag */
288 #define OB_OFFS_LOCAL           1
289 #define OB_QUAT                         2
290 #define OB_NEG_SCALE            4
291 #define OB_DUPLI                        (8+16+256+512+2048)
292 #define OB_DUPLIFRAMES          8
293 #define OB_DUPLIVERTS           16
294 #define OB_DUPLIROT                     32
295 #define OB_DUPLINOSPEED         64
296 #define OB_POWERTRACK           128
297 #define OB_DUPLIGROUP           256
298 #define OB_DUPLIFACES           512
299 #define OB_DUPLIFACES_SCALE     1024
300 #define OB_DUPLIPARTS           2048
301 #define OB_RENDER_DUPLI         4096
302
303 /* (short) ipoflag */
304 #define OB_DRAWKEY                      1
305 #define OB_DRAWKEYSEL           2
306 #define OB_OFFS_OB                      4
307 #define OB_OFFS_MAT                     8
308 #define OB_OFFS_VKEY            16
309 #define OB_OFFS_PATH            32
310 #define OB_OFFS_PARENT          64
311 #define OB_OFFS_PARTICLE        128
312         /* get ipo from from action or not? */
313 #define OB_ACTION_OB            256
314 #define OB_ACTION_KEY           512
315         /* for stride edit */
316 #define OB_DISABLE_PATH         1024
317
318 #define OB_OFFS_PARENTADD       2048
319
320
321 /* (short) trackflag / upflag */
322 #define OB_POSX                 0
323 #define OB_POSY                 1
324 #define OB_POSZ                 2
325 #define OB_NEGX                 3
326 #define OB_NEGY                 4
327 #define OB_NEGZ                 5
328
329 /* gameflag in game.h */
330
331 /* dt: no flags */
332 #define OB_BOUNDBOX             1
333 #define OB_WIRE                 2
334 #define OB_SOLID                3
335 #define OB_SHADED               4
336 #define OB_TEXTURE              5
337
338 /* this condition has been made more complex since editmode can draw textures */
339 #define CHECK_OB_DRAWTEXTURE(vd, dt) \
340         ((vd->drawtype==OB_TEXTURE && dt>OB_SOLID) || \
341         (vd->drawtype==OB_SOLID && vd->flag2 & V3D_SOLID_TEX))
342
343 #define CHECK_OB_DRAWFACEDOT(sce, vd, dt) \
344         (       (sce->selectmode & SCE_SELECT_FACE) && \
345                 (vd->drawtype<=OB_SOLID) && \
346                 (((vd->drawtype==OB_SOLID) && (dt>=OB_SOLID) && (vd->flag2 & V3D_SOLID_TEX) && (vd->flag & V3D_ZBUF_SELECT)) == 0) \
347         )
348
349
350 /* dtx: flags, char! */
351 #define OB_AXIS                 2
352 #define OB_TEXSPACE             4
353 #define OB_DRAWNAME             8
354 #define OB_DRAWIMAGE    16
355         /* for solid+wire display */
356 #define OB_DRAWWIRE             32
357         /* for overdraw */
358 #define OB_DRAWXRAY             64
359         /* enable transparent draw */
360 #define OB_DRAWTRANSP   128
361
362 /* empty_drawtype: no flags */
363 #define OB_ARROWS               1
364 #define OB_PLAINAXES    2
365 #define OB_CIRCLE               3
366 #define OB_SINGLE_ARROW 4
367 #define OB_CUBE                 5
368 #define OB_EMPTY_SPHERE 6
369 #define OB_EMPTY_CONE   7
370
371 /* boundtype */
372 #define OB_BOUND_BOX            0
373 #define OB_BOUND_SPHERE         1
374 #define OB_BOUND_CYLINDER       2
375 #define OB_BOUND_CONE           3
376 #define OB_BOUND_POLYH          4
377 #define OB_BOUND_POLYT          5
378 #define OB_BOUND_DYN_MESH   6
379
380
381 /* **************** BASE ********************* */
382
383 /* also needed for base!!!!! or rather, thy interfere....*/
384 /* base->flag and ob->flag */
385 #define BA_WAS_SEL                      2
386 #define BA_HAS_RECALC_OB        4
387 #define BA_HAS_RECALC_DATA      8
388
389 #define BA_DO_IPO                       32
390
391 #define BA_FROMSET                      128
392
393 /* an initial attempt as making selection more specific! */
394 #define BA_DESELECT     0
395 #define BA_SELECT               1
396
397
398 #define OB_FROMDUPLI            512
399 #define OB_DONE                         1024
400 #define OB_RADIO                        2048
401 #define OB_FROMGROUP            4096
402 #define OB_POSEMODE                     8192
403
404 /* ob->recalc (flag bits!) */
405 #define OB_RECALC_OB            1
406 #define OB_RECALC_DATA          2
407                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
408 #define OB_RECALC_TIME          4
409 #define OB_RECALC                       7
410
411 /* ob->gameflag */
412 #define OB_DYNAMIC              1
413 #define OB_CHILD                2
414 #define OB_ACTOR                4
415 #define OB_INERTIA_LOCK_X       8
416 #define OB_INERTIA_LOCK_Y       16
417 #define OB_INERTIA_LOCK_Z       32
418 #define OB_DO_FH                        64
419 #define OB_ROT_FH                       128
420 #define OB_ANISOTROPIC_FRICTION 256
421 #define OB_GHOST                        512
422 #define OB_RIGID_BODY           1024
423 #define OB_BOUNDS               2048
424
425 #define OB_COLLISION_RESPONSE   4096
426 #define OB_SECTOR               8192
427 #define OB_PROP                 16384
428 #define OB_MAINACTOR    32768
429
430 /* ob->gameflag2 */
431 #define OB_NEVER_DO_ACTIVITY_CULLING    1
432
433 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
434
435 /* ob->scavisflag */
436 #define OB_VIS_SENS             1
437 #define OB_VIS_CONT             2
438 #define OB_VIS_ACT              4
439
440 /* ob->scaflag */
441 #define OB_SHOWSENS             64
442 #define OB_SHOWACT              128
443 #define OB_ADDSENS              256
444 #define OB_ADDCONT              512
445 #define OB_ADDACT               1024
446 #define OB_SHOWCONT             2048
447 #define OB_SETSTBIT             4096
448 #define OB_INITSTBIT    8192
449
450 /* ob->restrictflag */
451 #define OB_RESTRICT_VIEW        1
452 #define OB_RESTRICT_SELECT      2
453 #define OB_RESTRICT_RENDER      4
454
455 /* ob->shapeflag */
456 #define OB_SHAPE_LOCK           1
457 #define OB_SHAPE_TEMPLOCK       2
458
459 /* ob->nlaflag */
460 #define OB_NLA_OVERRIDE         1
461 #define OB_NLA_COLLAPSED        2
462
463 /* ob->protectflag */
464 #define OB_LOCK_LOCX    1
465 #define OB_LOCK_LOCY    2
466 #define OB_LOCK_LOCZ    4
467 #define OB_LOCK_LOC             7
468 #define OB_LOCK_ROTX    8
469 #define OB_LOCK_ROTY    16
470 #define OB_LOCK_ROTZ    32
471 #define OB_LOCK_ROT             56
472 #define OB_LOCK_SCALEX  64
473 #define OB_LOCK_SCALEY  128
474 #define OB_LOCK_SCALEZ  256
475 #define OB_LOCK_SCALE   448
476
477 /* ob->softflag in DNA_object_force.h */
478
479 #ifdef __cplusplus
480 }
481 #endif
482
483 #endif
484
485