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