2.5 - AnimData fixes
[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 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.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33 #ifndef DNA_OBJECT_TYPES_H
34 #define DNA_OBJECT_TYPES_H
35
36 #include "DNA_listBase.h"
37 #include "DNA_ID.h"
38 #include "DNA_scriptlink_types.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 struct bPose;   
45 struct Object;
46 struct AnimData;
47 struct Ipo;
48 struct BoundBox;
49 struct Path;
50 struct Material;
51 struct bConstraintChannel;
52 struct PartDeflect;
53 struct SoftBody;
54 struct FluidsimSettings;
55 struct ParticleSystem;
56 struct DerivedMesh;
57
58 typedef struct bDeformGroup {
59         struct bDeformGroup *next, *prev;
60         char name[32];
61 } bDeformGroup;
62
63 /**
64  * The following illustrates the orientation of the 
65  * bounding box in local space
66  * 
67  *  
68  * Z  Y
69  * | /
70  * |/
71  * .-----X
72  * 
73  * 
74  *     2----------6
75  *    /|         /|
76  *   / |        / |
77  *  1----------5  |
78  *  |  |       |  |
79  *  |  3-------|--7
80  *  | /        | /
81  *  |/         |/
82  *  0----------4
83  */
84 typedef struct BoundBox {
85         float vec[8][3];
86         int flag, pad;
87 } BoundBox;
88
89 /* boundbox flag */
90 #define OB_BB_DISABLED  1
91
92 typedef struct Object {
93         ID id;
94         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
95         
96         short type, partype;
97         int par1, par2, par3;   /* can be vertexnrs */
98         char parsubstr[32];     /* String describing subobject info */
99         struct Object *parent, *track;
100         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
101         /* proxy_from is set in target back to the proxy. */
102         struct Object *proxy, *proxy_group, *proxy_from;
103         struct Ipo *ipo;                // XXX depreceated... old animation system
104         struct Path *path;
105         struct BoundBox *bb;
106         struct bAction *action;  // XXX depreceated... old animation system
107         struct bAction *poselib;
108         struct bPose *pose;     
109         void *data;
110         
111         ListBase constraintChannels; // XXX depreceated... old animation system
112         ListBase effect;
113         ListBase disp;
114         ListBase defbase;
115         ListBase modifiers; /* list of ModifierData structures */
116         
117         struct Material **mat;
118         
119         /* rot en drot have to be together! (transform('r' en 's')) */
120         float loc[3], dloc[3], orig[3];
121         float size[3], dsize[3];
122         float rot[3], drot[3];
123         /* float quat[4], dquat[4]; (not used yet) */
124         float obmat[4][4];
125         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
126         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
127         float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
128         
129         unsigned int lay;                               /* copy of Base */
130         
131         short flag;                     /* copy of Base */
132         short colbits;          /* when zero, from obdata */
133         
134         short transflag, protectflag;   /* transformation settings and transform locks  */
135         short trackflag, upflag;
136         short nlaflag, ipoflag;         // xxx depreceated... old animation system
137         short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
138         short scavisflag, boundtype;
139         
140         int dupon, dupoff, dupsta, dupend;
141
142         float sf, ctime; /* sf is time-offset, ctime is the objects current time (XXX timing needs to be revised) */
143         
144         /* during realtime */
145
146         /* note that inertia is only called inertia for historical reasons
147          * and is not changed to avoid DNA surgery. It actually reflects the 
148          * Size value in the GameButtons (= radius) */
149
150         float mass, damping, inertia;
151         /* The form factor k is introduced to give the user more control
152          * and to fix incompatibility problems.
153      * For rotational symmetric objects, the inertia value can be
154          * expressed as: Theta = k * m * r^2
155          * where m = Mass, r = Radius
156          * For a Sphere, the form factor is by default = 0.4
157          */
158
159         float formfactor;
160         float rdamping, sizefac;
161         float margin;
162         int   pad3;
163
164         char dt, dtx;
165         char totcol;    /* copy of mesh or curve or meta */
166         char actcol;    /* currently selected material in the user interface */
167         char empty_drawtype, pad1[3];
168         float empty_drawsize;
169         float dupfacesca;       /* dupliface scale */
170         
171         ScriptLink scriptlink;
172         ListBase prop;
173         ListBase sensors;
174         ListBase controllers;
175         ListBase actuators;
176     
177         float bbsize[3];
178         short index;                    /* custom index, for renderpasses */
179         unsigned short actdef;  /* current deformation group */
180         float col[4];                   /* object color, adjusted via IPO's only */
181         /**
182          * Settings for game objects
183          * bit 0: Object has dynamic behaviour
184          * bit 2: Object is evaluated by the gameengine
185          * bit 6: Use Fh settings in Materials
186          * bit 7: Use face normal to rotate Object
187          * bit 8: Friction is anisotropic
188          * bit 9: Object is a ghost
189          * bit 10: Do rigid body dynamics.
190          * bit 11: Use bounding object for physics
191          */
192         int gameflag;
193         /**
194          * More settings
195          * bit 15: Always ignore activity culling 
196          */
197         int gameflag2;
198         struct BulletSoftBody *bsoft;   /* settings for game engine bullet soft body */
199
200         short softflag;                 /* softbody settings */
201         short recalc;                   /* dependency flag */
202         float anisotropicFriction[3];
203
204         ListBase constraints;
205         ListBase nlastrips;                     // XXX depreceated... old animation system
206         ListBase hooks;
207         ListBase particlesystem;        /* particle systems */
208         
209         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
210         struct SoftBody *soft;          /* if exists, saved in file */
211         struct Group *dup_group;        /* object duplicator for group */
212         
213         short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
214         
215         short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
216
217         short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
218         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
219         short recalco;                          /* recalco for temp storage of ob->recalc, bad design warning */
220         short body_type;                        /* for now used to temporarily holds the type of collision object */
221         
222         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
223
224         struct DerivedMesh *derivedDeform, *derivedFinal;
225         int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
226         unsigned int state;                     /* bit masks of game controllers that are active */
227         unsigned int init_state;        /* bit masks of initial state as recorded by the users */
228         int pad2;
229
230         ListBase gpulamp;               /* runtime, for lamps only */
231 } Object;
232
233 /* Warning, this is not used anymore because hooks are now modifiers */
234 typedef struct ObHook {
235         struct ObHook *next, *prev;
236         
237         struct Object *parent;
238         float parentinv[4][4];  /* matrix making current transform unmodified */
239         float mat[4][4];                /* temp matrix while hooking */
240         float cent[3];                  /* visualization of hook */
241         float falloff;                  /* if not zero, falloff is distance where influence zero */
242         
243         char name[32];
244
245         int *indexar;
246         int totindex, curindex; /* curindex is cache for fast lookup */
247         short type, active;             /* active is only first hook, for button menu */
248         float force;
249 } ObHook;
250
251
252 /* this work object is defined in object.c */
253 extern Object workob;
254
255
256 /* **************** OBJECT ********************* */
257
258 /* used many places... should be specialized  */
259 #define SELECT                  1
260
261 /* type */
262 #define OB_EMPTY                0
263 #define OB_MESH                 1
264 #define OB_CURVE                2
265 #define OB_SURF                 3
266 #define OB_FONT                 4
267 #define OB_MBALL                5
268
269 #define OB_LAMP                 10
270 #define OB_CAMERA               11
271
272 #define OB_WAVE                 21
273 #define OB_LATTICE              22
274
275 /* 23 and 24 are for life and sector (old file compat.) */
276 #define OB_ARMATURE             25
277
278 /* partype: first 4 bits: type */
279 #define PARTYPE                 15
280 #define PAROBJECT               0
281 #define PARCURVE                1
282 #define PARKEY                  2
283
284 #define PARSKEL                 4
285 #define PARVERT1                5
286 #define PARVERT3                6
287 #define PARBONE                 7
288 #define PARSLOW                 16
289
290 /* (short) transflag */
291 #define OB_OFFS_LOCAL           1
292 #define OB_QUAT                         2
293 #define OB_NEG_SCALE            4
294 #define OB_DUPLI                        (8+16+256+512+2048)
295 #define OB_DUPLIFRAMES          8
296 #define OB_DUPLIVERTS           16
297 #define OB_DUPLIROT                     32
298 #define OB_DUPLINOSPEED         64
299 #define OB_POWERTRACK           128
300 #define OB_DUPLIGROUP           256
301 #define OB_DUPLIFACES           512
302 #define OB_DUPLIFACES_SCALE     1024
303 #define OB_DUPLIPARTS           2048
304 #define OB_RENDER_DUPLI         4096
305
306 /* (short) ipoflag */
307         // XXX depreceated - old animation system crap
308 #define OB_DRAWKEY                      1
309 #define OB_DRAWKEYSEL           2
310 #define OB_OFFS_OB                      4
311 #define OB_OFFS_MAT                     8
312 #define OB_OFFS_VKEY            16
313 #define OB_OFFS_PATH            32
314 #define OB_OFFS_PARENT          64
315 #define OB_OFFS_PARTICLE        128
316         /* get ipo from from action or not? */
317 #define OB_ACTION_OB            256
318 #define OB_ACTION_KEY           512
319         /* for stride edit */
320 #define OB_DISABLE_PATH         1024
321
322 #define OB_OFFS_PARENTADD       2048
323
324
325 /* (short) trackflag / upflag */
326 #define OB_POSX                 0
327 #define OB_POSY                 1
328 #define OB_POSZ                 2
329 #define OB_NEGX                 3
330 #define OB_NEGY                 4
331 #define OB_NEGZ                 5
332
333 /* gameflag in game.h */
334
335 /* dt: no flags */
336 #define OB_BOUNDBOX             1
337 #define OB_WIRE                 2
338 #define OB_SOLID                3
339 #define OB_SHADED               4
340 #define OB_TEXTURE              5
341
342 /* this condition has been made more complex since editmode can draw textures */
343 #define CHECK_OB_DRAWTEXTURE(vd, dt) \
344         ((vd->drawtype==OB_TEXTURE && dt>OB_SOLID) || \
345         (vd->drawtype==OB_SOLID && vd->flag2 & V3D_SOLID_TEX))
346
347 #define CHECK_OB_DRAWFACEDOT(sce, vd, dt) \
348         (       (sce->selectmode & SCE_SELECT_FACE) && \
349                 (vd->drawtype<=OB_SOLID) && \
350                 (((vd->drawtype==OB_SOLID) && (dt>=OB_SOLID) && (vd->flag2 & V3D_SOLID_TEX) && (vd->flag & V3D_ZBUF_SELECT)) == 0) \
351         )
352
353
354 /* dtx: flags, char! */
355 #define OB_AXIS                 2
356 #define OB_TEXSPACE             4
357 #define OB_DRAWNAME             8
358 #define OB_DRAWIMAGE    16
359         /* for solid+wire display */
360 #define OB_DRAWWIRE             32
361         /* for overdraw */
362 #define OB_DRAWXRAY             64
363         /* enable transparent draw */
364 #define OB_DRAWTRANSP   128
365
366 /* empty_drawtype: no flags */
367 #define OB_ARROWS               1
368 #define OB_PLAINAXES    2
369 #define OB_CIRCLE               3
370 #define OB_SINGLE_ARROW 4
371 #define OB_CUBE                 5
372 #define OB_EMPTY_SPHERE 6
373 #define OB_EMPTY_CONE   7
374
375 /* boundtype */
376 #define OB_BOUND_BOX            0
377 #define OB_BOUND_SPHERE         1
378 #define OB_BOUND_CYLINDER       2
379 #define OB_BOUND_CONE           3
380 #define OB_BOUND_POLYH          4
381 #define OB_BOUND_POLYT          5
382 #define OB_BOUND_DYN_MESH   6
383
384
385 /* **************** BASE ********************* */
386
387 /* also needed for base!!!!! or rather, thy interfere....*/
388 /* base->flag and ob->flag */
389 #define BA_WAS_SEL                      2
390 #define BA_HAS_RECALC_OB        4
391 #define BA_HAS_RECALC_DATA      8
392
393 #define BA_DO_IPO                       32
394
395 #define BA_FROMSET                      128
396
397 #define BA_TRANSFORM_CHILD      256 /* child of a transformed object */
398
399 /* an initial attempt as making selection more specific! */
400 #define BA_DESELECT     0
401 #define BA_SELECT               1
402
403
404 #define OB_FROMDUPLI            512
405 #define OB_DONE                         1024
406 #define OB_RADIO                        2048
407 #define OB_FROMGROUP            4096
408 #define OB_POSEMODE                     8192
409
410 /* ob->recalc (flag bits!) */
411 #define OB_RECALC_OB            1
412 #define OB_RECALC_DATA          2
413                 /* time flag is set when time changes need recalc, so baked systems can ignore it */
414 #define OB_RECALC_TIME          4
415 #define OB_RECALC                       7
416
417
418 /* ob->gameflag */
419 #define OB_DYNAMIC              1
420 #define OB_CHILD                2
421 #define OB_ACTOR                4
422 #define OB_INERTIA_LOCK_X       8
423 #define OB_INERTIA_LOCK_Y       16
424 #define OB_INERTIA_LOCK_Z       32
425 #define OB_DO_FH                        64
426 #define OB_ROT_FH                       128
427 #define OB_ANISOTROPIC_FRICTION 256
428 #define OB_GHOST                        512
429 #define OB_RIGID_BODY           1024
430 #define OB_BOUNDS               2048
431
432 #define OB_COLLISION_RESPONSE   4096
433 #define OB_SECTOR               8192
434 #define OB_PROP                 16384
435 #define OB_MAINACTOR    32768
436
437 #define OB_COLLISION    65536
438 #define OB_SOFT_BODY    0x20000
439
440 /* ob->gameflag2 */
441 #define OB_NEVER_DO_ACTIVITY_CULLING    1
442
443 #define OB_LIFE                 (OB_PROP|OB_DYNAMIC|OB_ACTOR|OB_MAINACTOR|OB_CHILD)
444
445 /* ob->body_type */
446 #define OB_BODY_TYPE_NO_COLLISION       0
447 #define OB_BODY_TYPE_STATIC                     1
448 #define OB_BODY_TYPE_DYNAMIC            2
449 #define OB_BODY_TYPE_RIGID                      3
450 #define OB_BODY_TYPE_SOFT                       4
451
452 /* ob->scavisflag */
453 #define OB_VIS_SENS             1
454 #define OB_VIS_CONT             2
455 #define OB_VIS_ACT              4
456
457 /* ob->scaflag */
458 #define OB_SHOWSENS             64
459 #define OB_SHOWACT              128
460 #define OB_ADDSENS              256
461 #define OB_ADDCONT              512
462 #define OB_ADDACT               1024
463 #define OB_SHOWCONT             2048
464 #define OB_SETSTBIT             4096
465 #define OB_INITSTBIT    8192
466 #define OB_DEBUGSTATE   16384
467
468 /* ob->restrictflag */
469 #define OB_RESTRICT_VIEW        1
470 #define OB_RESTRICT_SELECT      2
471 #define OB_RESTRICT_RENDER      4
472
473 /* ob->shapeflag */
474 #define OB_SHAPE_LOCK           1
475 #define OB_SHAPE_TEMPLOCK       2
476
477 /* ob->nlaflag */
478         // XXX depreceated - old animation system
479 #define OB_NLA_OVERRIDE         (1<<0)
480 #define OB_NLA_COLLAPSED        (1<<1)
481
482         /* object-channel expanded status */
483 #define OB_ADS_COLLAPSED        (1<<10)
484         /* object's ipo-block */
485 #define OB_ADS_SHOWIPO          (1<<11)
486         /* object's constraint channels */
487 #define OB_ADS_SHOWCONS         (1<<12)
488         /* object's material channels */
489 #define OB_ADS_SHOWMATS         (1<<13)
490
491 /* ob->protectflag */
492 #define OB_LOCK_LOCX    1
493 #define OB_LOCK_LOCY    2
494 #define OB_LOCK_LOCZ    4
495 #define OB_LOCK_LOC             7
496 #define OB_LOCK_ROTX    8
497 #define OB_LOCK_ROTY    16
498 #define OB_LOCK_ROTZ    32
499 #define OB_LOCK_ROT             56
500 #define OB_LOCK_SCALEX  64
501 #define OB_LOCK_SCALEY  128
502 #define OB_LOCK_SCALEZ  256
503 #define OB_LOCK_SCALE   448
504
505 /* ob->softflag in DNA_object_force.h */
506
507 #ifdef __cplusplus
508 }
509 #endif
510
511 #endif
512
513