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