Workbench: Option to use Object color
[blender.git] / source / blender / makesdna / DNA_object_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_object_types.h
29  *  \ingroup DNA
30  *  \brief Object is a sort of wrapper for general info.
31  */
32
33 #ifndef __DNA_OBJECT_TYPES_H__
34 #define __DNA_OBJECT_TYPES_H__
35
36 #include "DNA_object_enums.h"
37
38 #include "DNA_defs.h"
39 #include "DNA_listBase.h"
40 #include "DNA_ID.h"
41 #include "DNA_action_types.h" /* bAnimVizSettings */
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 struct Object;
48 struct AnimData;
49 struct Ipo;
50 struct BoundBox;
51 struct Path;
52 struct Material;
53 struct PartDeflect;
54 struct SoftBody;
55 struct FluidsimSettings;
56 struct ParticleSystem;
57 struct DerivedMesh;
58 struct SculptSession;
59 struct bGPdata;
60 struct RigidBodyOb;
61
62
63 /* Vertex Groups - Name Info */
64 typedef struct bDeformGroup {
65         struct bDeformGroup *next, *prev;
66         char name[64];  /* MAX_VGROUP_NAME */
67         /* need this flag for locking weights */
68         char flag, pad[7];
69 } bDeformGroup;
70
71 /* Face Maps*/
72 typedef struct bFaceMap {
73         struct bFaceMap *next, *prev;
74         char name[64];  /* MAX_VGROUP_NAME */
75         char flag;
76         char pad[7];
77 } bFaceMap;
78
79 /* Object Runtime display data */
80 struct ObjectEngineData;
81 typedef void (*ObjectEngineDataInitCb)(struct ObjectEngineData *engine_data);
82 typedef void (*ObjectEngineDataFreeCb)(struct ObjectEngineData *engine_data);
83
84 #
85 #
86 typedef struct ObjectEngineData {
87         struct ObjectEngineData *next, *prev;
88         struct DrawEngineType *engine_type;
89         /* Only nested data, NOT the engine data itself. */
90         ObjectEngineDataFreeCb free;
91         /* Accumulated recalc flags, which corresponds to ID->recalc flags. */
92         int recalc;
93 } ObjectEngineData;
94
95 #define MAX_VGROUP_NAME 64
96
97 /* bDeformGroup->flag */
98 #define DG_LOCK_WEIGHT 1
99
100 /**
101  * The following illustrates the orientation of the
102  * bounding box in local space
103  *
104  * <pre>
105  *
106  * Z  Y
107  * | /
108  * |/
109  * .-----X
110  *
111  *
112  *     2----------6
113  *    /|         /|
114  *   / |        / |
115  *  1----------5  |
116  *  |  |       |  |
117  *  |  3-------|--7
118  *  | /        | /
119  *  |/         |/
120  *  0----------4
121  * </pre>
122  */
123 typedef struct BoundBox {
124         float vec[8][3];
125         int flag, pad;
126 } BoundBox;
127
128 /* boundbox flag */
129 enum {
130         BOUNDBOX_DISABLED = (1 << 0),
131         BOUNDBOX_DIRTY  = (1 << 1),
132 };
133
134 typedef struct LodLevel {
135         struct LodLevel *next, *prev;
136         struct Object *source;
137         int flags;
138         float distance, pad;
139         int obhysteresis;
140 } LodLevel;
141
142 typedef struct Object {
143         ID id;
144         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */ 
145
146         struct SculptSession *sculpt;
147         
148         short type, partype;
149         int par1, par2, par3;   /* can be vertexnrs */
150         char parsubstr[64];     /* String describing subobject info, MAX_ID_NAME-2 */
151         struct Object *parent, *track;
152         /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
153         /* proxy_from is set in target back to the proxy. */
154         struct Object *proxy, *proxy_group, *proxy_from;
155         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
156         /* struct Path *path; */
157         struct BoundBox *bb;  /* axis aligned boundbox (in localspace) */
158         struct bAction *action  DNA_DEPRECATED;  // XXX deprecated... old animation system
159         struct bAction *poselib;
160         struct bPose *pose;  /* pose data, armature objects only */
161         void *data;  /* pointer to objects data - an 'ID' or NULL */
162         
163         struct bGPdata *gpd;    /* Grease Pencil data */
164         
165         bAnimVizSettings avs;   /* settings for visualization of object-transform animation */
166         bMotionPath *mpath;             /* motion path cache for this object */
167         void *pad1;
168         
169         ListBase constraintChannels  DNA_DEPRECATED; // XXX deprecated... old animation system
170         ListBase effect  DNA_DEPRECATED;             // XXX deprecated... keep for readfile
171         ListBase defbase;   /* list of bDeformGroup (vertex groups) names and flag only */
172         ListBase modifiers; /* list of ModifierData structures */
173         ListBase fmaps;     /* list of facemaps */
174
175         int mode;           /* Local object mode */
176         int restore_mode;
177
178         /* materials */
179         struct Material **mat;  /* material slots */
180         char *matbits;                  /* a boolean field, with each byte 1 if corresponding material is linked to object */
181         int totcol;                             /* copy of mesh, curve & meta struct member of same name (keep in sync) */
182         int actcol;                             /* currently selected material in the UI */
183         
184         /* rot en drot have to be together! (transform('r' en 's')) */
185         float loc[3], dloc[3], orig[3];
186         float size[3];              /* scale in fact */
187         float dsize[3] DNA_DEPRECATED ; /* DEPRECATED, 2.60 and older only */
188         float dscale[3];            /* ack!, changing */
189         float rot[3], drot[3];          /* euler rotation */
190         float quat[4], dquat[4];        /* quaternion rotation */
191         float rotAxis[3], drotAxis[3];  /* axis angle rotation - axis part */
192         float rotAngle, drotAngle;      /* axis angle rotation - angle part */
193         float obmat[4][4];              /* final worldspace matrix with constraints & animsys applied */
194         float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
195         float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
196         float imat[4][4];       /* inverse matrix of 'obmat' for any other use than rendering! */
197                             /* note: this isn't assured to be valid as with 'obmat',
198                              *       before using this value you should do...
199                              *       invert_m4_m4(ob->imat, ob->obmat); */
200         
201         /* Previously 'imat' was used at render time, but as other places use it too
202          * the interactive ui of 2.5 creates problems. So now only 'imat_ren' should
203          * be used when ever the inverse of ob->obmat * re->viewmat is needed! - jahka
204          */
205         float imat_ren[4][4];
206         
207         unsigned int lay;       /* copy of Base's layer in the scene */
208
209         short flag;                     /* copy of Base */
210         short colbits DNA_DEPRECATED;           /* deprecated, use 'matbits' */
211         
212         short transflag, protectflag;   /* transformation settings and transform locks  */
213         short trackflag, upflag;
214         short nlaflag;                          /* used for DopeSheet filtering settings (expanded/collapsed) */
215         short pad[2];
216
217         /* did last modifier stack generation need mapping support? */
218         char lastNeedMapping;  /* bool */
219         char duplicator_visibility_flag;
220
221         /* dupli-frame settings */
222         int dupon, dupoff, dupsta, dupend;
223
224         /* Depsgraph */
225         short base_flag; /* used by depsgraph, flushed from base */
226         short pad8;
227
228         /** Collision mask settings */
229         unsigned short col_group, col_mask;
230
231         short rotmode;          /* rotation mode - uses defines set out in DNA_action_types.h for PoseChannel rotations... */
232
233         char boundtype;            /* bounding box use for drawing */
234         char collision_boundtype;  /* bounding box type used for collision */
235
236         short dtx;                      /* viewport draw extra settings */
237         char dt;                        /* viewport draw type */
238         char empty_drawtype;
239         float empty_drawsize;
240         float dupfacesca;       /* dupliface scale */
241
242         float sf; /* sf is time-offset */
243
244         short index;                    /* custom index, for renderpasses */
245         unsigned short actdef;  /* current deformation group, note: index starts at 1 */
246         unsigned short actfmap; /* current face map, note: index starts at 1 */
247         unsigned char pad5[6];
248         float col[4];                   /* object color */
249
250         char restrictflag;              /* for restricting view, select, render etc. accessible in outliner */
251         char pad3;
252         short softflag;                 /* softbody settings */
253         float pad9[3];
254
255         ListBase constraints;           /* object constraints */
256         ListBase nlastrips  DNA_DEPRECATED;                     // XXX deprecated... old animation system
257         ListBase hooks  DNA_DEPRECATED;                         // XXX deprecated... old animation system
258         ListBase particlesystem;        /* particle systems */
259         
260         struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
261         struct SoftBody *soft;          /* if exists, saved in file */
262         struct Group *dup_group;        /* object duplicator for group */
263         void *pad10;
264
265         char  pad4;
266         char  shapeflag;                        /* flag for pinning */
267         short shapenr;                          /* current shape key for menu or pinned */
268         float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
269
270         struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
271
272         struct DerivedMesh *derivedDeform, *derivedFinal;
273         void *pad7;
274         uint64_t lastDataMask;   /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
275         uint64_t customdata_mask; /* (extra) custom data layer mask to use for creating derivedmesh, set by depsgraph */
276
277         /* Runtime valuated curve-specific data, not stored in the file */
278         struct CurveCache *curve_cache;
279
280         ListBase gpulamp;               /* runtime, for glsl lamp display only */
281         ListBase pc_ids;
282         
283         struct RigidBodyOb *rigidbody_object;           /* settings for Bullet rigid body */
284         struct RigidBodyCon *rigidbody_constraint;      /* settings for Bullet constraint */
285
286         float ima_ofs[2];               /* offset for image empties */
287         ImageUser *iuser;               /* must be non-null when oject is an empty image */
288
289         ListBase lodlevels;             /* contains data for levels of detail */
290         LodLevel *currentlod;
291
292         struct PreviewImage *preview;
293
294         struct IDProperty *base_collection_properties; /* used by depsgraph, flushed from base */
295
296         ListBase drawdata;              /* runtime, ObjectEngineData */
297         int pad6;
298         int select_color;
299
300         /* Mesh structure createrd during object evaluaiton.
301          * It has all modifiers applied.
302          */
303         struct Mesh *mesh_evaluated;
304 } Object;
305
306 /* Warning, this is not used anymore because hooks are now modifiers */
307 typedef struct ObHook {
308         struct ObHook *next, *prev;
309         
310         struct Object *parent;
311         float parentinv[4][4];  /* matrix making current transform unmodified */
312         float mat[4][4];                /* temp matrix while hooking */
313         float cent[3];                  /* visualization of hook */
314         float falloff;                  /* if not zero, falloff is distance where influence zero */
315         
316         char name[64];  /* MAX_NAME */
317
318         int *indexar;
319         int totindex, curindex; /* curindex is cache for fast lookup */
320         short type, active;             /* active is only first hook, for button menu */
321         float force;
322 } ObHook;
323
324 /* runtime only, but include here for rna access */
325 typedef struct DupliObject {
326         struct DupliObject *next, *prev;
327         struct Object *ob;
328         float mat[4][4];
329         float orco[3], uv[2];
330
331         short type; /* from Object.transflag */
332         char no_draw, animated;
333
334         /* persistent identifier for a dupli object, for inter-frame matching of
335          * objects with motion blur, or inter-update matching for syncing */
336         int persistent_id[16]; /* 2*MAX_DUPLI_RECUR */
337
338         /* particle this dupli was generated from */
339         struct ParticleSystem *particle_system;
340         unsigned int random_id;
341         unsigned int pad;
342         struct IDProperty *collection_properties;
343 } DupliObject;
344
345 /* **************** OBJECT ********************* */
346
347 /* used many places... should be specialized  */
348 #define SELECT          1
349
350 /* type */
351 enum {
352         OB_EMPTY      = 0,
353         OB_MESH       = 1,
354         OB_CURVE      = 2,
355         OB_SURF       = 3,
356         OB_FONT       = 4,
357         OB_MBALL      = 5,
358
359         OB_LAMP       = 10,
360         OB_CAMERA     = 11,
361
362         OB_SPEAKER    = 12,
363         OB_LIGHTPROBE = 13,
364
365 /*      OB_WAVE       = 21, */
366         OB_LATTICE    = 22,
367
368 /* 23 and 24 are for life and sector (old file compat.) */
369         OB_ARMATURE   = 25,
370 };
371
372 /* check if the object type supports materials */
373 #define OB_TYPE_SUPPORT_MATERIAL(_type) \
374         ((_type) >= OB_MESH && (_type) <= OB_MBALL)
375 #define OB_TYPE_SUPPORT_VGROUP(_type) \
376         (ELEM(_type, OB_MESH, OB_LATTICE))
377 #define OB_TYPE_SUPPORT_EDITMODE(_type) \
378         (ELEM(_type, OB_MESH, OB_FONT, OB_CURVE, OB_SURF, OB_MBALL, OB_LATTICE, OB_ARMATURE))
379 #define OB_TYPE_SUPPORT_PARVERT(_type) \
380         (ELEM(_type, OB_MESH, OB_SURF, OB_CURVE, OB_LATTICE))
381
382 /* is this ID type used as object data */
383 #define OB_DATA_SUPPORT_ID(_id_type) \
384         (ELEM(_id_type, ID_ME, ID_CU, ID_MB, ID_LA, ID_SPK, ID_LP, ID_CA, ID_LT, ID_AR))
385
386 #define OB_DATA_SUPPORT_ID_CASE \
387         ID_ME: case ID_CU: case ID_MB: case ID_LA: case ID_SPK: case ID_LP: case ID_CA: case ID_LT: case ID_AR
388
389 /* partype: first 4 bits: type */
390 enum {
391         PARTYPE       = (1 << 4) - 1,
392         PAROBJECT     = 0,
393 #ifdef DNA_DEPRECATED
394         PARCURVE      = 1,  /* Deprecated. */
395 #endif
396         PARKEY        = 2,  /* XXX Unused, deprecated? */
397
398         PARSKEL       = 4,
399         PARVERT1      = 5,
400         PARVERT3      = 6,
401         PARBONE       = 7,
402
403         /* slow parenting - is not threadsafe and/or may give errors after jumping  */
404         PARSLOW       = 16,
405 };
406
407 /* (short) transflag */
408 /* flags 1 and 2 were unused or relics from past features */
409 enum {
410         OB_NEG_SCALE        = 1 << 2,
411         OB_DUPLIFRAMES      = 1 << 3,
412         OB_DUPLIVERTS       = 1 << 4,
413         OB_DUPLIROT         = 1 << 5,
414         OB_DUPLINOSPEED     = 1 << 6,
415         OB_DUPLICALCDERIVED = 1 << 7, /* runtime, calculate derivedmesh for dupli before it's used */
416         OB_DUPLIGROUP       = 1 << 8,
417         OB_DUPLIFACES       = 1 << 9,
418         OB_DUPLIFACES_SCALE = 1 << 10,
419         OB_DUPLIPARTS       = 1 << 11,
420         OB_RENDER_DUPLI     = 1 << 12,
421         OB_NO_CONSTRAINTS   = 1 << 13,  /* runtime constraints disable */
422         OB_NO_PSYS_UPDATE   = 1 << 14,  /* hack to work around particle issue */
423
424         OB_DUPLI            = OB_DUPLIFRAMES | OB_DUPLIVERTS | OB_DUPLIGROUP | OB_DUPLIFACES | OB_DUPLIPARTS,
425 };
426
427 /* (short) trackflag / upflag */
428 enum {
429         OB_POSX = 0,
430         OB_POSY = 1,
431         OB_POSZ = 2,
432         OB_NEGX = 3,
433         OB_NEGY = 4,
434         OB_NEGZ = 5,
435 };
436
437 /* dt: no flags */
438 enum {
439         OB_BOUNDBOX  = 1,
440         OB_WIRE      = 2,
441         OB_SOLID     = 3,
442         OB_MATERIAL  = 4,
443         OB_TEXTURE   = 5,
444         OB_RENDER    = 6,
445
446         OB_PAINT     = 100,  /* temporary used in draw code */
447 };
448
449 /* dtx: flags (short) */
450 enum {
451         OB_DRAWBOUNDOX    = 1 << 0,
452         OB_AXIS           = 1 << 1,
453         OB_TEXSPACE       = 1 << 2,
454         OB_DRAWNAME       = 1 << 3,
455         OB_DRAWIMAGE      = 1 << 4,
456         /* for solid+wire display */
457         OB_DRAWWIRE       = 1 << 5,
458         /* for overdraw s*/
459         OB_DRAWXRAY       = 1 << 6,
460         /* enable transparent draw */
461         OB_DRAWTRANSP     = 1 << 7,
462         OB_DRAW_ALL_EDGES = 1 << 8,  /* only for meshes currently */
463 };
464
465 /* empty_drawtype: no flags */
466 enum {
467         OB_ARROWS        = 1,
468         OB_PLAINAXES     = 2,
469         OB_CIRCLE        = 3,
470         OB_SINGLE_ARROW  = 4,
471         OB_CUBE          = 5,
472         OB_EMPTY_SPHERE  = 6,
473         OB_EMPTY_CONE    = 7,
474         OB_EMPTY_IMAGE   = 8,
475 };
476
477 /* boundtype */
478 enum {
479         OB_BOUND_BOX           = 0,
480         OB_BOUND_SPHERE        = 1,
481         OB_BOUND_CYLINDER      = 2,
482         OB_BOUND_CONE          = 3,
483         OB_BOUND_TRIANGLE_MESH = 4,
484         OB_BOUND_CONVEX_HULL   = 5,
485 /*      OB_BOUND_DYN_MESH      = 6, */ /*UNUSED*/
486         OB_BOUND_CAPSULE       = 7,
487 };
488
489 /* lod flags */
490 enum {
491         OB_LOD_USE_MESH         = 1 << 0,
492         OB_LOD_USE_MAT          = 1 << 1,
493         OB_LOD_USE_HYST         = 1 << 2,
494 };
495
496
497 /* **************** BASE ********************* */
498
499 /* also needed for base!!!!! or rather, they interfere....*/
500 /* base->flag and ob->flag */
501 enum {
502         BA_WAS_SEL = (1 << 1),
503         /* NOTE: BA_HAS_RECALC_DATA can be re-used later if freed in readfile.c. */
504         // BA_HAS_RECALC_OB = (1 << 2),  /* DEPRECATED */
505         // BA_HAS_RECALC_DATA =  (1 << 3),  /* DEPRECATED */
506         BA_SNAP_FIX_DEPS_FIASCO = (1 << 2),  /* Yes, re-use deprecated bit, all fine since it's runtime only. */
507 };
508
509         /* NOTE: this was used as a proper setting in past, so nullify before using */
510 #define BA_TEMP_TAG         (1 << 5)
511
512 /* #define BA_FROMSET          (1 << 7) */ /*UNUSED*/
513
514 #define BA_TRANSFORM_CHILD  (1 << 8)  /* child of a transformed object */
515 #define BA_TRANSFORM_PARENT (1 << 13)  /* parent of a transformed object */
516
517 #define OB_FROMDUPLI        (1 << 9)
518 #define OB_DONE             (1 << 10)  /* unknown state, clear before use */
519 /* #define OB_RADIO            (1 << 11) */  /* deprecated */
520 #define OB_FROMGROUP        (1 << 12)
521
522 /* WARNING - when adding flags check on PSYS_RECALC */
523 /* ob->recalc (flag bits!) */
524 enum {
525         OB_RECALC_OB        = 1 << 0,
526         OB_RECALC_DATA      = 1 << 1,
527 /* time flag is set when time changes need recalc, so baked systems can ignore it */
528         OB_RECALC_TIME      = 1 << 2,
529 /* only use for matching any flag, NOT as an argument since more flags may be added. */
530         OB_RECALC_ALL       = OB_RECALC_OB | OB_RECALC_DATA | OB_RECALC_TIME,
531 };
532
533 /* controller state */
534 #define OB_MAX_STATES       30
535
536 /* collision masks */
537 #define OB_MAX_COL_MASKS    16
538
539 /* ob->restrictflag */
540 enum {
541         OB_RESTRICT_VIEW    = 1 << 0,
542         OB_RESTRICT_SELECT  = 1 << 1,
543         OB_RESTRICT_RENDER  = 1 << 2,
544 };
545
546 /* ob->shapeflag */
547 enum {
548         OB_SHAPE_LOCK       = 1 << 0,
549         // OB_SHAPE_TEMPLOCK   = 1 << 1,  /* deprecated */
550         OB_SHAPE_EDIT_MODE  = 1 << 2,
551 };
552
553 /* ob->nlaflag */
554 enum {
555         /* WARNING: flags (1 << 0) and (1 << 1) were from old animsys */
556         /* object-channel expanded status */
557         OB_ADS_COLLAPSED    = 1 << 10,
558         /* object's ipo-block */
559         OB_ADS_SHOWIPO      = 1 << 11,
560         /* object's constraint channels */
561         OB_ADS_SHOWCONS     = 1 << 12,
562         /* object's material channels */
563         OB_ADS_SHOWMATS     = 1 << 13,
564         /* object's marticle channels */
565         OB_ADS_SHOWPARTS    = 1 << 14,
566 };
567
568 /* ob->protectflag */
569 enum {
570         OB_LOCK_LOCX    = 1 << 0,
571         OB_LOCK_LOCY    = 1 << 1,
572         OB_LOCK_LOCZ    = 1 << 2,
573         OB_LOCK_LOC     = OB_LOCK_LOCX | OB_LOCK_LOCY | OB_LOCK_LOCZ,
574         OB_LOCK_ROTX    = 1 << 3,
575         OB_LOCK_ROTY    = 1 << 4,
576         OB_LOCK_ROTZ    = 1 << 5,
577         OB_LOCK_ROT     = OB_LOCK_ROTX | OB_LOCK_ROTY | OB_LOCK_ROTZ,
578         OB_LOCK_SCALEX  = 1 << 6,
579         OB_LOCK_SCALEY  = 1 << 7,
580         OB_LOCK_SCALEZ  = 1 << 8,
581         OB_LOCK_SCALE   = OB_LOCK_SCALEX | OB_LOCK_SCALEY | OB_LOCK_SCALEZ,
582         OB_LOCK_ROTW    = 1 << 9,
583         OB_LOCK_ROT4D   = 1 << 10,
584 };
585
586 /* ob->duplicator_visibility_flag */
587 enum {
588         OB_DUPLI_FLAG_VIEWPORT = 1 << 0,
589         OB_DUPLI_FLAG_RENDER   = 1 << 1,
590 };
591
592 #define MAX_DUPLI_RECUR 8
593
594 #ifdef __cplusplus
595 }
596 #endif
597
598 #endif
599