Merged 15170:15635 from trunk (no conflicts or even merges)
[blender.git] / source / blender / makesdna / DNA_modifier_types.h
1 /**
2  * $Id$ 
3  */
4
5 #ifndef DNA_MODIFIER_TYPES_H
6 #define DNA_MODIFIER_TYPES_H
7
8 #define MODSTACK_DEBUG 1
9
10 /* WARNING ALERT! TYPEDEF VALUES ARE WRITTEN IN FILES! SO DO NOT CHANGE! */
11
12 typedef enum ModifierType {
13         eModifierType_None = 0,
14         eModifierType_Subsurf,
15         eModifierType_Lattice,
16         eModifierType_Curve,
17         eModifierType_Build,
18         eModifierType_Mirror,
19         eModifierType_Decimate,
20         eModifierType_Wave,
21         eModifierType_Armature,
22         eModifierType_Hook,
23         eModifierType_Softbody,
24         eModifierType_Boolean,
25         eModifierType_Array,
26         eModifierType_EdgeSplit,
27         eModifierType_Displace,
28         eModifierType_UVProject,
29         eModifierType_Smooth,
30         eModifierType_Cast,
31         eModifierType_MeshDeform,
32         eModifierType_ParticleSystem,
33         eModifierType_ParticleInstance,
34         eModifierType_Explode,
35         eModifierType_Cloth,
36         eModifierType_Collision,
37         eModifierType_Bevel,
38         NUM_MODIFIER_TYPES
39 } ModifierType;
40
41 typedef enum ModifierMode {
42         eModifierMode_Realtime = (1<<0),
43         eModifierMode_Render = (1<<1),
44         eModifierMode_Editmode = (1<<2),
45         eModifierMode_OnCage = (1<<3),
46         eModifierMode_Expanded = (1<<4),
47         eModifierMode_Virtual = (1<<5),
48         eModifierMode_DisableTemporary = (1 << 31)
49 } ModifierMode;
50
51 typedef struct ModifierData {
52         struct ModifierData *next, *prev;
53
54         int type, mode;
55         char name[32];
56
57         char *error;
58 } ModifierData;
59
60 typedef enum {
61         eSubsurfModifierFlag_Incremental = (1<<0),
62         eSubsurfModifierFlag_DebugIncr = (1<<1),
63         eSubsurfModifierFlag_ControlEdges = (1<<2),
64         eSubsurfModifierFlag_SubsurfUv = (1<<3)
65 } SubsurfModifierFlag;
66
67 typedef struct SubsurfModifierData {
68         ModifierData modifier;
69
70         short subdivType, levels, renderLevels, flags;
71
72         void *emCache, *mCache;
73 } SubsurfModifierData;
74
75 typedef struct LatticeModifierData {
76         ModifierData modifier;
77
78         struct Object *object;
79         char name[32];                  /* optional vertexgroup name */
80 } LatticeModifierData;
81
82 typedef struct CurveModifierData {
83         ModifierData modifier;
84
85         struct Object *object;
86         char name[32];                  /* optional vertexgroup name */
87         short defaxis;                  /* axis along which curve deforms */
88         char pad[6];
89 } CurveModifierData;
90
91 /* CurveModifierData->defaxis */
92 #define MOD_CURVE_POSX  1
93 #define MOD_CURVE_POSY  2
94 #define MOD_CURVE_POSZ  3
95 #define MOD_CURVE_NEGX  4
96 #define MOD_CURVE_NEGY  5
97 #define MOD_CURVE_NEGZ  6
98
99 typedef struct BuildModifierData {
100         ModifierData modifier;
101
102         float start, length;
103         int randomize, seed;
104 } BuildModifierData;
105
106 typedef struct ArrayModifierData {
107         ModifierData modifier;
108
109         /* the object with which to cap the start of the array  */
110         struct Object *start_cap;
111         /* the object with which to cap the end of the array  */
112         struct Object *end_cap;
113         /* the curve object to use for MOD_ARR_FITCURVE */
114         struct Object *curve_ob;
115         /* the object to use for object offset */
116         struct Object *offset_ob;
117         /* a constant duplicate offset;
118            1 means the duplicates are 1 unit apart
119     */
120         float offset[3];
121         /* a scaled factor for duplicate offsets;
122            1 means the duplicates are 1 object-width apart
123     */
124         float scale[3];
125         /* the length over which to distribute the duplicates */
126         float length;
127         /* the limit below which to merge vertices in adjacent duplicates */
128         float merge_dist;
129         /* determines how duplicate count is calculated; one of:
130               MOD_ARR_FIXEDCOUNT -> fixed
131               MOD_ARR_FITLENGTH  -> calculated to fit a set length
132               MOD_ARR_FITCURVE   -> calculated to fit the length of a Curve object
133     */
134         int fit_type;
135         /* flags specifying how total offset is calculated; binary OR of:
136              MOD_ARR_OFF_CONST    -> total offset += offset
137              MOD_ARR_OFF_RELATIVE -> total offset += relative * object width
138              MOD_ARR_OFF_OBJ      -> total offset += offset_ob's matrix
139            total offset is the sum of the individual enabled offsets
140         */
141         int offset_type;
142         /* general flags:
143               MOD_ARR_MERGE -> merge vertices in adjacent duplicates
144         */
145         int flags;
146         /* the number of duplicates to generate for MOD_ARR_FIXEDCOUNT */
147         int count;
148 } ArrayModifierData;
149
150 /* ArrayModifierData->fit_type */
151 #define MOD_ARR_FIXEDCOUNT 0
152 #define MOD_ARR_FITLENGTH  1
153 #define MOD_ARR_FITCURVE   2
154
155 /* ArrayModifierData->offset_type */
156 #define MOD_ARR_OFF_CONST    1<<0
157 #define MOD_ARR_OFF_RELATIVE 1<<1
158 #define MOD_ARR_OFF_OBJ      1<<2
159
160 /* ArrayModifierData->flags */
161 #define MOD_ARR_MERGE      1<<0
162 #define MOD_ARR_MERGEFINAL 1<<1
163
164 typedef struct MirrorModifierData {
165         ModifierData modifier;
166
167         short axis, flag;
168         float tolerance;
169         struct Object *mirror_ob;
170 } MirrorModifierData;
171
172 /* MirrorModifierData->flag */
173 #define MOD_MIR_CLIPPING        1<<0
174 #define MOD_MIR_MIRROR_U        1<<1
175 #define MOD_MIR_MIRROR_V        1<<2
176 #define MOD_MIR_AXIS_X          1<<3
177 #define MOD_MIR_AXIS_Y          1<<4
178 #define MOD_MIR_AXIS_Z          1<<5
179 #define MOD_MIR_VGROUP          1<<6
180
181 typedef struct EdgeSplitModifierData {
182         ModifierData modifier;
183
184         float split_angle;    /* angle above which edges should be split */
185         int flags;
186 } EdgeSplitModifierData;
187
188 /* EdgeSplitModifierData->flags */
189 #define MOD_EDGESPLIT_FROMANGLE   1<<1
190 #define MOD_EDGESPLIT_FROMFLAG    1<<2
191
192 typedef struct BevelModifierData {
193         ModifierData modifier;
194
195         float value;          /* the "raw" bevel value (distance/amount to bevel) */
196         int res;              /* the resolution (as originally coded, it is the number of recursive bevels) */
197         int pad;
198         short flags;          /* general option flags */
199         short val_flags;      /* flags used to interpret the bevel value */
200         short lim_flags;      /* flags to tell the tool how to limit the bevel */
201         short e_flags;        /* flags to direct how edge weights are applied to verts */
202         float bevel_angle;    /* if the BME_BEVEL_ANGLE is set, this will be how "sharp" an edge must be before it gets beveled */
203         char defgrp_name[32]; /* if the BME_BEVEL_VWEIGHT option is set, this will be the name of the vert group */
204 } BevelModifierData;
205
206 typedef struct BMeshModifierData {
207         ModifierData modifier;
208
209         float pad;
210         int type;
211 } BMeshModifierData;
212
213 typedef struct DisplaceModifierData {
214         ModifierData modifier;
215
216         struct Tex *texture;
217         float strength;
218         int direction;
219         char defgrp_name[32];
220         float midlevel;
221         int texmapping;
222         struct Object *map_object;
223         char uvlayer_name[32];
224         int uvlayer_tmp, pad;
225 } DisplaceModifierData;
226
227 /* DisplaceModifierData->direction */
228 enum {
229         MOD_DISP_DIR_X,
230         MOD_DISP_DIR_Y,
231         MOD_DISP_DIR_Z,
232         MOD_DISP_DIR_NOR,
233         MOD_DISP_DIR_RGB_XYZ,
234 };
235
236 /* DisplaceModifierData->texmapping */
237 enum {
238         MOD_DISP_MAP_LOCAL,
239         MOD_DISP_MAP_GLOBAL,
240         MOD_DISP_MAP_OBJECT,
241         MOD_DISP_MAP_UV,
242 };
243
244 typedef struct UVProjectModifierData {
245         ModifierData modifier;
246
247         /* the objects which do the projecting */
248         struct Object *projectors[10];
249         struct Image *image;      /* the image to project */
250         int flags;
251         int num_projectors;
252         float aspectx, aspecty;
253         char uvlayer_name[32];
254         int uvlayer_tmp, pad;
255 } UVProjectModifierData;
256
257 #define MOD_UVPROJECT_MAXPROJECTORS 10
258
259 /* UVProjectModifierData->flags */
260 #define MOD_UVPROJECT_OVERRIDEIMAGE 1<<0
261
262 typedef struct DecimateModifierData {
263         ModifierData modifier;
264
265         float percent;
266         int faceCount;
267 } DecimateModifierData;
268
269 /* Smooth modifier flags */
270 #define MOD_SMOOTH_X (1<<1)
271 #define MOD_SMOOTH_Y (1<<2)
272 #define MOD_SMOOTH_Z (1<<3)
273
274 typedef struct SmoothModifierData {
275         ModifierData modifier;
276         float fac;
277         char defgrp_name[32];
278         short flag, repeat;
279
280 } SmoothModifierData;
281
282 /* Cast modifier flags */
283 #define MOD_CAST_X (1<<1)
284 #define MOD_CAST_Y (1<<2)
285 #define MOD_CAST_Z (1<<3)
286 #define MOD_CAST_USE_OB_TRANSFORM (1<<4)
287 #define MOD_CAST_SIZE_FROM_RADIUS (1<<5)
288
289 /* Cast modifier projection types */
290 #define MOD_CAST_TYPE_SPHERE 0
291 #define MOD_CAST_TYPE_CYLINDER 1
292 #define MOD_CAST_TYPE_CUBOID 2
293
294 typedef struct CastModifierData {
295         ModifierData modifier;
296
297         struct Object *object;
298         float fac;
299         float radius;
300         float size;
301         char defgrp_name[32];
302         short flag, type;
303 } CastModifierData;
304
305 enum {
306         MOD_WAV_MAP_LOCAL,
307         MOD_WAV_MAP_GLOBAL,
308         MOD_WAV_MAP_OBJECT,
309         MOD_WAV_MAP_UV,
310 };
311
312 /* WaveModifierData.flag */
313 #define MOD_WAVE_X      1<<1
314 #define MOD_WAVE_Y      1<<2
315 #define MOD_WAVE_CYCL   1<<3
316 #define MOD_WAVE_NORM   1<<4
317 #define MOD_WAVE_NORM_X 1<<5
318 #define MOD_WAVE_NORM_Y 1<<6
319 #define MOD_WAVE_NORM_Z 1<<7
320
321 typedef struct WaveModifierData {
322         ModifierData modifier;
323
324         struct Object *objectcenter;
325         char defgrp_name[32];
326         struct Tex *texture;
327         struct Object *map_object;
328
329         short flag, pad;
330
331         float startx, starty, height, width;
332         float narrow, speed, damp, falloff;
333
334         int texmapping, uvlayer_tmp;
335
336         char uvlayer_name[32];
337
338         float timeoffs, lifetime;
339         float pad1;
340 } WaveModifierData;
341
342 typedef struct ArmatureModifierData {
343         ModifierData modifier;
344
345         short deformflag, multi;                /* deformflag replaces armature->deformflag */
346         int pad2;
347         struct Object *object;
348         float *prevCos;         /* stored input of previous modifier, for vertexgroup blending */
349         char defgrp_name[32];
350 } ArmatureModifierData;
351
352 typedef struct HookModifierData {
353         ModifierData modifier;
354
355         struct Object *object;
356         float parentinv[4][4];  /* matrix making current transform unmodified */
357         float cent[3];                  /* visualization of hook */
358         float falloff;                  /* if not zero, falloff is distance where influence zero */
359         
360         int *indexar;                   /* if NULL, it's using vertexgroup */
361         int totindex;
362         float force;
363         char name[32];                  /* optional vertexgroup name */
364 } HookModifierData;
365
366 typedef struct SoftbodyModifierData {
367         ModifierData modifier;
368 } SoftbodyModifierData;
369
370 typedef struct ClothModifierData {
371    ModifierData         modifier;
372
373    struct Cloth *clothObject; /* The internal data structure for cloth. */
374    struct ClothSimSettings *sim_parms; /* definition is in DNA_cloth_types.h */
375    struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
376    struct PointCache *point_cache;      /* definition is in DNA_object_force.h */
377 } ClothModifierData;
378
379 typedef struct CollisionModifierData {
380         ModifierData    modifier;
381         
382         struct MVert *x; /* position at the beginning of the frame */
383         struct MVert *xnew; /* position at the end of the frame */
384         struct MVert *xold; /* unsued atm, but was discussed during sprint */
385         struct MVert *current_xnew; /* new position at the actual inter-frame step */
386         struct MVert *current_x; /* position at the actual inter-frame step */
387         struct MVert *current_v; /* (xnew - x) at the actual inter-frame step */
388         
389         struct MFace *mfaces; /* object face data */
390         
391         unsigned int numverts;
392         unsigned int numfaces;
393         int pad;
394         float time;             /* cfra time of modifier */
395         struct BVHTree *bvhtree; /* bounding volume hierarchy for this cloth object */
396 } CollisionModifierData;
397
398 typedef enum {
399         eBooleanModifierOp_Intersect,
400         eBooleanModifierOp_Union,
401         eBooleanModifierOp_Difference,
402 } BooleanModifierOp;
403 typedef struct BooleanModifierData {
404         ModifierData modifier;
405
406         struct Object *object;
407         int operation, pad;
408 } BooleanModifierData;
409
410 #define MOD_MDEF_INVERT_VGROUP (1<<0)
411 #define MOD_MDEF_DYNAMIC_BIND  (1<<1)
412
413 typedef struct MDefInfluence {
414         int vertex;
415         float weight;
416 } MDefInfluence;
417
418 typedef struct MDefCell {
419         int offset;
420         int totinfluence;
421 } MDefCell;
422
423 typedef struct MeshDeformModifierData {
424         ModifierData modifier;
425
426         struct Object *object;                  /* mesh object */
427         char defgrp_name[32];                   /* optional vertexgroup name */
428
429         short gridsize, needbind;
430         short flag, pad;
431
432         /* variables filled in when bound */
433         float *bindweights, *bindcos;   /* computed binding weights */
434         int totvert, totcagevert;               /* total vertices in mesh and cage */
435         MDefCell *dyngrid;                              /* grid with dynamic binding cell points */
436         MDefInfluence *dyninfluences;   /* dynamic binding vertex influences */
437         int *dynverts, *pad2;                   /* is this vertex bound or not? */
438         int dyngridsize;                                /* size of the dynamic bind grid */
439         int totinfluence;                               /* total number of vertex influences */
440         float dyncellmin[3];                    /* offset of the dynamic bind grid */
441         float dyncellwidth;                             /* width of dynamic bind cell */
442         float bindmat[4][4];                    /* matrix of cage at binding time */
443 } MeshDeformModifierData;
444
445 typedef enum {
446         eParticleSystemFlag_Loaded =            (1<<0),
447         eParticleSystemFlag_Pars =                      (1<<1),
448         eParticleSystemFlag_FromCurve =         (1<<2),
449         eParticleSystemFlag_DM_changed =        (1<<3),
450         eParticleSystemFlag_Disabled =          (1<<4),
451         eParticleSystemFlag_psys_updated =      (1<<5),
452 } ParticleSystemModifierFlag;
453
454 typedef struct ParticleSystemModifierData {
455         ModifierData modifier;
456         struct ParticleSystem *psys;
457         struct DerivedMesh *dm;
458         int totdmvert, totdmedge, totdmface;
459         short flag, rt;
460 } ParticleSystemModifierData;
461
462 typedef enum {
463         eParticleInstanceFlag_Parents =         (1<<0),
464         eParticleInstanceFlag_Children =        (1<<1),
465         eParticleInstanceFlag_Path =            (1<<2),
466         eParticleInstanceFlag_Unborn =          (1<<3),
467         eParticleInstanceFlag_Alive =           (1<<4),
468         eParticleInstanceFlag_Dead =            (1<<5),
469 } ParticleInstanceModifierFlag;
470
471 typedef struct ParticleInstanceModifierData {
472         ModifierData modifier;
473         struct Object *ob;
474         short psys, flag, rt[2];
475 } ParticleInstanceModifierData;
476
477 typedef enum {
478         eExplodeFlag_CalcFaces =        (1<<0),
479         //eExplodeFlag_PaSize =         (1<<1),
480         eExplodeFlag_EdgeSplit =        (1<<2),
481         eExplodeFlag_Unborn =           (1<<3),
482         eExplodeFlag_Alive =            (1<<4),
483         eExplodeFlag_Dead =                     (1<<5),
484 } ExplodeModifierFlag;
485
486 typedef struct ExplodeModifierData {
487         ModifierData modifier;
488         int *facepa;
489         short flag, vgroup;
490         float protect;
491 } ExplodeModifierData;
492
493 #endif