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