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