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