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