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