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