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