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