- Made SoftBody work with Particle Force Fields.
[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 BodyPoint;
55 struct BodySpring;
56
57 typedef struct bDeformGroup {
58         struct bDeformGroup *next, *prev;
59         char name[32];
60         void *data;     /* Temporary data, most likely a pointer to the bone - no need to delete */
61 } bDeformGroup;
62
63 #
64 #
65 typedef struct BoundBox {
66         float vec[8][3];
67 } BoundBox;
68
69 /* OcInfo and LBuf structs are for the Enji gameengine */
70
71 typedef struct OcInfo {
72         float dvec[3];
73         float size[3];
74 } OcInfo;
75
76 typedef struct LBuf {
77         short tot, max;
78         int pad;
79         struct Object **ob;
80 } LBuf;
81
82 typedef struct PartDeflect {
83         short deflect;          /* Deflection flag - does mesh deflect particles*/
84         short forcefield;       /* Force field type, do the vertices attract / repel particles ? */
85         short flag;                     /* general settings flag */
86         short pad;
87         
88         float pdef_damp;        /* Damping factor for particle deflection       */
89         float pdef_rdamp;       /* Random element of damping for deflection     */
90         float pdef_perm;        /* Chance of particle passing through mesh      */
91
92         float f_strength;       /* The strength of the force (+ or - )       */
93         float f_power;          /* The power law - real gravitation is 2 (square)  */
94         float maxdist;          /* if indicated, use this maximum */
95 } PartDeflect;
96
97 /* pd->forcefield:  Effector Fields types */
98 #define PFIELD_FORCE    1
99 #define PFIELD_VORTEX   2
100 #define PFIELD_MAGNET   3
101 #define PFIELD_WIND             4
102
103 /* pd->flag: various settings */
104 #define PFIELD_USEMAX   1
105
106
107 typedef struct SoftBody {
108         /* dynamic data */
109         int totpoint, totspring;
110         struct BodyPoint *bpoint;               /* not saved in file */
111         struct BodySpring *bspring;             /* not saved in file */
112         float ctime;                                    /* last time calculated */
113         
114         /* part of UI: */
115         float nodemass;         /* softbody mass of *vertex* */
116         float grav;                     /* softbody amount of gravitaion to apply */
117         float mediafrict;       /* friction to env */
118         float rklimit;          /* error limit for ODE solver */
119         
120         float goalspring;       /* softbody goal springs */
121         float goalfrict;        /* softbody goal springs friction */
122         float mingoal;          /* quick limits for goal */
123         float maxgoal;
124         
125         float inspring;         /* softbody inner springs */
126         float infrict;          /* softbody inner springs friction */
127         
128         float defgoal;          /* default goal for vertices without vgroup */
129         
130 } SoftBody;
131
132 typedef struct Object {
133         ID id;
134
135         short type, partype;
136         int par1, par2, par3;   /* can be vertexnrs */
137         char parsubstr[32];     /* String describing subobject info */
138         void *pardata;
139         struct Object *parent, *track;
140         struct Ipo *ipo;
141         struct Path *path;
142         struct BoundBox *bb;
143         struct bAction *action; 
144         struct bPose *pose;     
145         void *data;
146         
147         struct bConstraintChannel *activecon;           
148         ListBase constraintChannels;
149
150         ListBase effect;
151         ListBase network;
152         ListBase disp;
153         ListBase defbase;
154         struct Material **mat;
155         
156         /* rot en drot have to be together! (transform('r' en 's')) */
157         float loc[3], dloc[3], orig[3];
158         float size[3], dsize[3];
159         float rot[3], drot[3];
160         float quat[4], dquat[4];
161         float obmat[4][4];
162         float parentinv[4][4];
163         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
164         
165         unsigned int lay;                               /* copy of Base */
166         short flag;                     /* copy of Base */
167         short colbits;          /* when zero, from obdata */
168         char transflag, ipoflag;
169         char trackflag, upflag;
170         short ipowin, scaflag;  /* ipowin: blocktype last ipowindow */
171         short scavisflag, boundtype;
172         
173         short dupon, dupoff, dupsta, dupend;
174
175         float sf, ctime;
176         
177         /* during realtime */
178
179         /* note that inertia is only called inertia for historical reasons
180          * and is not changed to avoid DNA surgery. It actually reflects the 
181          * Size value in the GameButtons (= radius) */
182
183         float mass, damping, inertia;
184         /* The form factor k is introduced to give the user more control
185          * and to fix incompatibility problems.
186      * For rotational symmetric objects, the inertia value can be
187          * expressed as: Theta = k * m * r^2
188          * where m = Mass, r = Radius
189          * For a Sphere, the form factor is by default = 0.4
190          */
191
192         float formfactor, softtime;             /* softtime temp for softbody, remove it before release! */
193         float rdamping, sizefac;
194         
195         char dt, dtx;
196         char totcol;    /* copy of mesh or curve or meta */
197         char actcol;
198         
199         ScriptLink scriptlink;
200         ListBase prop;
201         ListBase sensors;
202         ListBase controllers;
203         ListBase actuators;
204
205     void *sumohandle;
206     
207         float bbsize[3];
208         short dfras;
209         unsigned short actdef;  /* current deformation group */
210         float col[4];
211         /**
212          * Settings for game objects
213          * bit 0: Object has dynamic behaviour
214          * bit 2: Object is evaluated by the gameengine
215          * bit 6: Use Fh settings in Materials
216          * bit 7: Use face normal to rotate Object
217          * bit 8: Friction is anisotropic
218          * bit 9: Object is a ghost
219          * bit 10: Do rigid body dynamics.
220          * bit 11: Use bounding object for physics
221          */
222         int gameflag;
223         /**
224          * More settings
225          * bit 15: Always ignore activity culling 
226          */
227         int gameflag2;
228         short softflag, dummy;                  /* temporal stuff softbody experiment */
229         float anisotropicFriction[3];
230
231         ListBase constraints;
232         ListBase nlastrips;
233         ListBase hooks;
234         
235         PartDeflect *pd;                /* particle deflector/attractor/collision data */
236         struct SoftBody *soft;  /* if exists, saved in file */
237         struct Life *life;
238
239         LBuf lbuf;
240         LBuf port;
241
242         float toonedge, smoothresh;     /* smoothresh is phong interpolation ray_shadow correction in render */
243 /* this stuff MUST NOT be here
244    is here for softbody devel purpose 
245 */
246         float sb_goalspring; /* softbody goal springs */
247         float sb_goalfrict;   /* softbody goal springs friction */
248         float sb_inspring;       /* softbody inner springs */
249         float sb_infrict;   /* softbody inner springs friction */
250         float sb_nodemass;       /* softbody mass of *vertex* */
251         float sb_grav;      /* softbody amount of gravitaion to apply */
252         float sb_mingoal;   /* quick limits for goal */
253         float sb_maxgoal;
254         float sb_mediafrict;   /* friction to env */
255         float sb_pad1;        /* free */
256     
257 } Object;
258
259 typedef struct ObHook {
260         struct ObHook *next, *prev;
261         
262         struct Object *parent;
263         float parentinv[4][4];  /* matrix making current transform unmodified */
264         float mat[4][4];                /* temp matrix while hooking */
265         float cent[3];                  /* visualization of hook */
266         float falloff;                  /* if not zero, falloff is distance where influence zero */
267         
268         char name[32];
269
270         int *indexar;
271         int totindex, curindex; /* curindex is cache for fast lookup */
272         short type, active;             /* active is only first hook, for button menu */
273         float force;
274 } ObHook;
275
276
277 /* this work object is defined in object.c */
278 extern Object workob;
279
280
281 /* **************** OBJECT ********************* */
282
283 /* used many places... should be specialized  */
284 #define SELECT                  1
285
286 /* type */
287 #define OB_EMPTY                0
288 #define OB_MESH                 1
289 #define OB_CURVE                2
290 #define OB_SURF                 3
291 #define OB_FONT                 4
292 #define OB_MBALL                5
293
294 #define OB_LAMP                 10
295 #define OB_CAMERA               11
296
297 #define OB_IKA                  20
298 #define OB_WAVE                 21
299 #define OB_LATTICE              22
300
301 /* 23 and 24 are for life and sector (old file compat.) */
302 #define OB_ARMATURE             25
303
304 /* partype: eerste 5 bits: type */
305 #define PARTYPE                 15
306 #define PAROBJECT               0
307 #define PARCURVE                1
308 #define PARKEY                  2
309 #define PARLIMB                 3
310 #define PARSKEL                 4
311 #define PARVERT1                5
312 #define PARVERT3                6
313 #define PARBONE                 7
314 #define PARSLOW                 16
315
316 /* char! transflag */
317 #define OB_OFFS_LOCAL   1
318 #define OB_QUAT                 2
319 #define OB_NEG_SCALE    4
320 #define OB_DUPLI                (8+16)
321 #define OB_DUPLIFRAMES  8
322 #define OB_DUPLIVERTS   16
323 #define OB_DUPLIROT             32
324 #define OB_DUPLINOSPEED 64
325
326 #define OB_POWERTRACK   128
327
328 /* char! ipoflag */
329 #define OB_DRAWKEY                      1
330 #define OB_DRAWKEYSEL           2
331 #define OB_OFFS_OB                      4
332 #define OB_OFFS_MAT                     8
333 #define OB_OFFS_VKEY            16
334 #define OB_OFFS_PATH            32
335 #define OB_OFFS_PARENT          64
336 #define OB_OFFS_PARTICLE        128
337
338
339 /* trackflag / upflag */
340 #define OB_POSX                 0
341 #define OB_POSY                 1
342 #define OB_POSZ                 2
343 #define OB_NEGX                 3
344 #define OB_NEGY                 4
345 #define OB_NEGZ                 5
346
347 /* gameflag in game.h */
348
349 /* dt: nummers */
350 #define OB_BOUNDBOX             1
351 #define OB_WIRE                 2
352 #define OB_SOLID                3
353 #define OB_SHADED               4
354 #define OB_TEXTURE              5
355 #define OB_TOON_MONO    6
356 #define OB_TOON_COLOR   7
357 #define OB_TOON_TRANSP  8
358 #define OB_TOON_FLAT    9
359 #define OB_TOON_SMOOTH  10
360
361 /* dtx: flags */
362 #define OB_AXIS                 2
363 #define OB_TEXSPACE             4
364 #define OB_DRAWNAME             8
365 #define OB_DRAWIMAGE    16
366 #define OB_DRAWWIRE             32 /* for solid+wire display */
367
368 /* boundtype */
369 #define OB_BOUND_BOX            0
370 #define OB_BOUND_SPHERE         1
371 #define OB_BOUND_CYLINDER       2
372 #define OB_BOUND_CONE           3
373 #define OB_BOUND_POLYH          4
374 #define OB_BOUND_POLYT          5
375
376 /* also needed for base!!!!! or rather, thy interfere....*/
377 /* base->flag and ob->flag */
378 #define BA_WASSEL                       2
379 #define BA_PARSEL                       4
380 #define BA_WHERE_UPDATE         8
381 #define BA_DISP_UPDATE          16
382 #define BA_DO_IPO                       32
383 #define OB_GONNA_MOVE           32
384 #define BA_FROMSET                      128
385 #define OB_DO_IMAT                      256
386 #define OB_FROMDUPLI            512
387 #define OB_DONE                         1024
388 #define OB_RADIO                        2048
389 #define OB_FROMGROUP            4096
390 #define OB_POSEMODE                     8192
391
392 /* ob->gameflag */
393 #define OB_DYNAMIC              1
394 #define OB_CHILD                2
395 #define OB_ACTOR                4
396 #define OB_INERTIA_LOCK_X       8
397 #define OB_INERTIA_LOCK_Y       16
398 #define OB_INERTIA_LOCK_Z       32
399 #define OB_DO_FH                        64
400 #define OB_ROT_FH                       128
401 #define OB_ANISOTROPIC_FRICTION 256
402 #define OB_GHOST                        512
403 #define OB_RIGID_BODY           1024
404 #define OB_BOUNDS               2048
405
406 #define OB_COLLISION_RESPONSE   4096
407 #define OB_SECTOR               8192
408 #define OB_PROP                 16384
409 #define OB_MAINACTOR    32768
410
411 /* ob->gameflag2 */
412 #define OB_NEVER_DO_ACTIVITY_CULLING    1
413
414 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
415
416 /* ob->scavisflag */
417 #define OB_VIS_SENS             1
418 #define OB_VIS_CONT             2
419 #define OB_VIS_ACT              4
420
421 /* ob->scaflag */
422 #define OB_SHOWSENS             64
423 #define OB_SHOWACT              128
424 #define OB_ADDSENS              256
425 #define OB_ADDCONT              512
426 #define OB_ADDACT               1024
427 #define OB_SHOWCONT             2048
428
429 /* ob->softflag */
430 #define OB_SB_ENABLE    1
431 #define OB_SB_GOAL              2
432 #define OB_SB_EDGES             4
433 #define OB_SB_QUADS             8
434 #define OB_SB_POSTDEF   16
435 #define OB_SB_REDO              32
436
437 #ifdef __cplusplus
438 }
439 #endif
440
441 #endif
442