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