code cleanup: remove USE_BMESH_FORWARD_COMPAT - this was added to load bmesh in pre...
[blender.git] / source / blender / makesdna / DNA_modifier_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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file DNA_modifier_types.h
22  *  \ingroup DNA
23  */
24
25 #ifndef __DNA_MODIFIER_TYPES_H__
26 #define __DNA_MODIFIER_TYPES_H__
27
28 #include "DNA_defs.h"
29 #include "DNA_listBase.h"
30
31 /* WARNING ALERT! TYPEDEF VALUES ARE WRITTEN IN FILES! SO DO NOT CHANGE!
32  * (ONLY ADD NEW ITEMS AT THE END) */
33
34 typedef enum ModifierType {
35         eModifierType_None              = 0,
36         eModifierType_Subsurf           = 1,
37         eModifierType_Lattice           = 2,
38         eModifierType_Curve             = 3,
39         eModifierType_Build             = 4,
40         eModifierType_Mirror            = 5,
41         eModifierType_Decimate          = 6,
42         eModifierType_Wave              = 7,
43         eModifierType_Armature          = 8,
44         eModifierType_Hook              = 9,
45         eModifierType_Softbody          = 10,
46         eModifierType_Boolean           = 11,
47         eModifierType_Array             = 12,
48         eModifierType_EdgeSplit         = 13,
49         eModifierType_Displace          = 14,
50         eModifierType_UVProject         = 15,
51         eModifierType_Smooth            = 16,
52         eModifierType_Cast              = 17,
53         eModifierType_MeshDeform        = 18,
54         eModifierType_ParticleSystem    = 19,
55         eModifierType_ParticleInstance  = 20,
56         eModifierType_Explode           = 21,
57         eModifierType_Cloth             = 22,
58         eModifierType_Collision         = 23,
59         eModifierType_Bevel             = 24,
60         eModifierType_Shrinkwrap        = 25,
61         eModifierType_Fluidsim          = 26,
62         eModifierType_Mask              = 27,
63         eModifierType_SimpleDeform      = 28,
64         eModifierType_Multires          = 29,
65         eModifierType_Surface           = 30,
66         eModifierType_Smoke             = 31,
67         eModifierType_ShapeKey          = 32,
68         eModifierType_Solidify          = 33,
69         eModifierType_Screw             = 34,
70         eModifierType_Warp              = 35,
71         eModifierType_WeightVGEdit      = 36,
72         eModifierType_WeightVGMix       = 37,
73         eModifierType_WeightVGProximity = 38,
74         eModifierType_Ocean             = 39,
75         eModifierType_DynamicPaint      = 40,
76         eModifierType_Remesh            = 41,
77         eModifierType_Skin              = 42,
78         NUM_MODIFIER_TYPES
79 } ModifierType;
80
81 typedef enum ModifierMode {
82         eModifierMode_Realtime = (1<<0),
83         eModifierMode_Render = (1<<1),
84         eModifierMode_Editmode = (1<<2),
85         eModifierMode_OnCage = (1<<3),
86         eModifierMode_Expanded = (1<<4),
87         eModifierMode_Virtual = (1<<5),
88         eModifierMode_ApplyOnSpline = (1<<6),
89         eModifierMode_DisableTemporary = (1 << 31)
90 } ModifierMode;
91
92 typedef struct ModifierData {
93         struct ModifierData *next, *prev;
94
95         int type, mode;
96         int stackindex, pad;
97         char name[64];  /* MAX_NAME */
98         
99         /* XXX for timing info set by caller... solve later? (ton) */
100         struct Scene *scene;
101         
102         char *error;
103 } ModifierData;
104
105 typedef enum {
106         eSubsurfModifierFlag_Incremental = (1<<0),
107         eSubsurfModifierFlag_DebugIncr = (1<<1),
108         eSubsurfModifierFlag_ControlEdges = (1<<2),
109         eSubsurfModifierFlag_SubsurfUv = (1<<3)
110 } SubsurfModifierFlag;
111
112 /* not a real modifier */
113 typedef struct MappingInfoModifierData {
114         ModifierData modifier;
115
116         struct Tex *texture;
117         struct Object *map_object;
118         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
119         int uvlayer_tmp;
120         int texmapping;
121 } MappingInfoModifierData;
122
123 typedef struct SubsurfModifierData {
124         ModifierData modifier;
125
126         short subdivType, levels, renderLevels, flags;
127
128         void *emCache, *mCache;
129 } SubsurfModifierData;
130
131 typedef struct LatticeModifierData {
132         ModifierData modifier;
133
134         struct Object *object;
135         char name[64];                  /* optional vertexgroup name, MAX_VGROUP_NAME */
136         float strength;
137         char pad[4];
138 } LatticeModifierData;
139
140 typedef struct CurveModifierData {
141         ModifierData modifier;
142
143         struct Object *object;
144         char name[64];                  /* optional vertexgroup name, MAX_VGROUP_NAME */
145         short defaxis;                  /* axis along which curve deforms */
146         char pad[6];
147 } CurveModifierData;
148
149 /* CurveModifierData->defaxis */
150 #define MOD_CURVE_POSX  1
151 #define MOD_CURVE_POSY  2
152 #define MOD_CURVE_POSZ  3
153 #define MOD_CURVE_NEGX  4
154 #define MOD_CURVE_NEGY  5
155 #define MOD_CURVE_NEGZ  6
156
157 typedef struct BuildModifierData {
158         ModifierData modifier;
159
160         float start, length;
161         int randomize, seed;
162 } BuildModifierData;
163
164 /* Mask Modifier */
165 typedef struct MaskModifierData {
166         ModifierData modifier;
167         
168         struct Object *ob_arm;  /* armature to use to in place of hardcoded vgroup */
169         char vgroup[64];                /* name of vertex group to use to mask, MAX_VGROUP_NAME */
170         
171         int mode;                               /* using armature or hardcoded vgroup */
172         int flag;                               /* flags for various things */
173 } MaskModifierData;
174
175 /* Mask Modifier -> mode */
176 #define MOD_MASK_MODE_VGROUP            0
177 #define MOD_MASK_MODE_ARM                       1
178
179 /* Mask Modifier -> flag */
180 #define MOD_MASK_INV                    (1<<0)
181
182 typedef struct ArrayModifierData {
183         ModifierData modifier;
184
185         /* the object with which to cap the start of the array  */
186         struct Object *start_cap;
187         /* the object with which to cap the end of the array  */
188         struct Object *end_cap;
189         /* the curve object to use for MOD_ARR_FITCURVE */
190         struct Object *curve_ob;
191         /* the object to use for object offset */
192         struct Object *offset_ob;
193         /* a constant duplicate offset;
194          * 1 means the duplicates are 1 unit apart
195          */
196         float offset[3];
197         /* a scaled factor for duplicate offsets;
198          * 1 means the duplicates are 1 object-width apart
199          */
200         float scale[3];
201         /* the length over which to distribute the duplicates */
202         float length;
203         /* the limit below which to merge vertices in adjacent duplicates */
204         float merge_dist;
205         /* determines how duplicate count is calculated; one of:
206          * - MOD_ARR_FIXEDCOUNT -> fixed
207          * - MOD_ARR_FITLENGTH  -> calculated to fit a set length
208          * - MOD_ARR_FITCURVE   -> calculated to fit the length of a Curve object
209          */
210         int fit_type;
211         /* flags specifying how total offset is calculated; binary OR of:
212          * - MOD_ARR_OFF_CONST    -> total offset += offset
213          * - MOD_ARR_OFF_RELATIVE -> total offset += relative * object width
214          * - MOD_ARR_OFF_OBJ      -> total offset += offset_ob's matrix
215          * total offset is the sum of the individual enabled offsets
216          */
217         int offset_type;
218         /* general flags:
219          * MOD_ARR_MERGE -> merge vertices in adjacent duplicates
220          */
221         int flags;
222         /* the number of duplicates to generate for MOD_ARR_FIXEDCOUNT */
223         int count;
224 } ArrayModifierData;
225
226 /* ArrayModifierData->fit_type */
227 #define MOD_ARR_FIXEDCOUNT 0
228 #define MOD_ARR_FITLENGTH  1
229 #define MOD_ARR_FITCURVE   2
230
231 /* ArrayModifierData->offset_type */
232 #define MOD_ARR_OFF_CONST    (1<<0)
233 #define MOD_ARR_OFF_RELATIVE (1<<1)
234 #define MOD_ARR_OFF_OBJ      (1<<2)
235
236 /* ArrayModifierData->flags */
237 #define MOD_ARR_MERGE      (1<<0)
238 #define MOD_ARR_MERGEFINAL (1<<1)
239
240 typedef struct MirrorModifierData {
241         ModifierData modifier;
242
243         short axis  DNA_DEPRECATED; /* deprecated, use flag instead */
244         short flag;
245         float tolerance;
246         struct Object *mirror_ob;
247 } MirrorModifierData;
248
249 /* MirrorModifierData->flag */
250 #define MOD_MIR_CLIPPING        (1<<0)
251 #define MOD_MIR_MIRROR_U        (1<<1)
252 #define MOD_MIR_MIRROR_V        (1<<2)
253 #define MOD_MIR_AXIS_X          (1<<3)
254 #define MOD_MIR_AXIS_Y          (1<<4)
255 #define MOD_MIR_AXIS_Z          (1<<5)
256 #define MOD_MIR_VGROUP          (1<<6)
257 #define MOD_MIR_NO_MERGE        (1<<7)
258
259 typedef struct EdgeSplitModifierData {
260         ModifierData modifier;
261
262         float split_angle;    /* angle above which edges should be split */
263         int flags;
264 } EdgeSplitModifierData;
265
266 /* EdgeSplitModifierData->flags */
267 #define MOD_EDGESPLIT_FROMANGLE   (1<<1)
268 #define MOD_EDGESPLIT_FROMFLAG    (1<<2)
269
270 typedef struct BevelModifierData {
271         ModifierData modifier;
272
273         float value;          /* the "raw" bevel value (distance/amount to bevel) */
274         int res;              /* the resolution (as originally coded, it is the number of recursive bevels) */
275         int pad;
276         short flags;          /* general option flags */
277         short val_flags;      /* flags used to interpret the bevel value */
278         short lim_flags;      /* flags to tell the tool how to limit the bevel */
279         short e_flags;        /* flags to direct how edge weights are applied to verts */
280         float bevel_angle;    /* if the BME_BEVEL_ANGLE is set, this will be how "sharp" an edge must be before it gets beveled */
281         char defgrp_name[64]; /* if the BME_BEVEL_VWEIGHT option is set, this will be the name of the vert group, MAX_VGROUP_NAME */
282 } BevelModifierData;
283
284 typedef struct BMeshModifierData {
285         ModifierData modifier;
286
287         float pad;
288         int type;
289 } BMeshModifierData;
290
291
292 /* Smoke modifier flags */
293 #define MOD_SMOKE_TYPE_DOMAIN (1 << 0)
294 #define MOD_SMOKE_TYPE_FLOW (1 << 1)
295 #define MOD_SMOKE_TYPE_COLL (1 << 2)
296
297 typedef struct SmokeModifierData {
298         ModifierData modifier;
299
300         struct SmokeDomainSettings *domain;
301         struct SmokeFlowSettings *flow; /* inflow, outflow, smoke objects */
302         struct SmokeCollSettings *coll; /* collision objects */
303         float time;
304         int type;  /* domain, inflow, outflow, ... */
305 } SmokeModifierData;
306
307 typedef struct DisplaceModifierData {
308         ModifierData modifier;
309
310         /* keep in sync with MappingInfoModifierData */
311         struct Tex *texture;
312         struct Object *map_object;
313         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
314         int uvlayer_tmp;
315         int texmapping;
316         /* end MappingInfoModifierData */
317
318         float strength;
319         int direction;
320         char defgrp_name[64];   /* MAX_VGROUP_NAME */
321         float midlevel;
322         int pad;
323 } DisplaceModifierData;
324
325 /* DisplaceModifierData->direction */
326 enum {
327         MOD_DISP_DIR_X = 0,
328         MOD_DISP_DIR_Y = 1,
329         MOD_DISP_DIR_Z = 2,
330         MOD_DISP_DIR_NOR = 3,
331         MOD_DISP_DIR_RGB_XYZ = 4,
332 };
333
334 /* DisplaceModifierData->texmapping */
335 enum {
336         MOD_DISP_MAP_LOCAL = 0,
337         MOD_DISP_MAP_GLOBAL = 1,
338         MOD_DISP_MAP_OBJECT = 2,
339         MOD_DISP_MAP_UV = 3
340 };
341
342 typedef struct UVProjectModifierData {
343         ModifierData modifier;
344
345         /* the objects which do the projecting */
346         struct Object *projectors[10]; /* MOD_UVPROJECT_MAX */
347         struct Image *image;      /* the image to project */
348         int flags;
349         int num_projectors;
350         float aspectx, aspecty;
351         float scalex, scaley;                                                                                           
352         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
353         int uvlayer_tmp, pad;
354 } UVProjectModifierData;
355
356 #define MOD_UVPROJECT_MAXPROJECTORS 10
357
358 /* UVProjectModifierData->flags */
359 #define MOD_UVPROJECT_OVERRIDEIMAGE (1<<0)
360
361 typedef struct DecimateModifierData {
362         ModifierData modifier;
363
364         float percent;
365         int faceCount;
366 } DecimateModifierData;
367
368 /* Smooth modifier flags */
369 #define MOD_SMOOTH_X (1<<1)
370 #define MOD_SMOOTH_Y (1<<2)
371 #define MOD_SMOOTH_Z (1<<3)
372
373 typedef struct SmoothModifierData {
374         ModifierData modifier;
375         float fac;
376         char defgrp_name[64];   /* MAX_VGROUP_NAME */
377         short flag, repeat;
378
379 } SmoothModifierData;
380
381 /* Cast modifier flags */
382 #define MOD_CAST_X (1<<1)
383 #define MOD_CAST_Y (1<<2)
384 #define MOD_CAST_Z (1<<3)
385 #define MOD_CAST_USE_OB_TRANSFORM (1<<4)
386 #define MOD_CAST_SIZE_FROM_RADIUS (1<<5)
387
388 /* Cast modifier projection types */
389 #define MOD_CAST_TYPE_SPHERE 0
390 #define MOD_CAST_TYPE_CYLINDER 1
391 #define MOD_CAST_TYPE_CUBOID 2
392
393 typedef struct CastModifierData {
394         ModifierData modifier;
395
396         struct Object *object;
397         float fac;
398         float radius;
399         float size;
400         char defgrp_name[64];   /* MAX_VGROUP_NAME */
401         short flag, type;
402 } CastModifierData;
403
404 /* WaveModifierData.flag */
405 #define MOD_WAVE_X      (1<<1)
406 #define MOD_WAVE_Y      (1<<2)
407 #define MOD_WAVE_CYCL   (1<<3)
408 #define MOD_WAVE_NORM   (1<<4)
409 #define MOD_WAVE_NORM_X (1<<5)
410 #define MOD_WAVE_NORM_Y (1<<6)
411 #define MOD_WAVE_NORM_Z (1<<7)
412
413 typedef struct WaveModifierData {
414         ModifierData modifier;
415
416         /* keep in sync with MappingInfoModifierData */
417         struct Tex *texture;
418         struct Object *map_object;
419         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
420         int uvlayer_tmp;
421         int texmapping;
422         /* end MappingInfoModifierData */
423
424         struct Object *objectcenter;
425         char defgrp_name[64];   /* MAX_VGROUP_NAME */
426
427         short flag, pad;
428
429         float startx, starty, height, width;
430         float narrow, speed, damp, falloff;
431
432         float timeoffs, lifetime;
433         float pad1;
434 } WaveModifierData;
435
436 typedef struct ArmatureModifierData {
437         ModifierData modifier;
438
439         short deformflag, multi;                /* deformflag replaces armature->deformflag */
440         int pad2;
441         struct Object *object;
442         float *prevCos;         /* stored input of previous modifier, for vertexgroup blending */
443         char defgrp_name[64];   /* MAX_VGROUP_NAME */
444 } ArmatureModifierData;
445
446 typedef struct HookModifierData {
447         ModifierData modifier;
448
449         struct Object *object;
450         char subtarget[64];             /* optional name of bone target, MAX_ID_NAME-2 */
451         
452         float parentinv[4][4];  /* matrix making current transform unmodified */
453         float cent[3];                  /* visualization of hook */
454         float falloff;                  /* if not zero, falloff is distance where influence zero */
455         
456         int *indexar;                   /* if NULL, it's using vertexgroup */
457         int totindex;
458         float force;
459         char name[64];                  /* optional vertexgroup name, MAX_VGROUP_NAME */
460 } HookModifierData;
461
462 typedef struct SoftbodyModifierData {
463         ModifierData modifier;
464 } SoftbodyModifierData;
465
466 typedef struct ClothModifierData {
467         ModifierData            modifier;
468
469         struct Scene *scene;                    /* the context, time etc is here */
470         struct Cloth *clothObject;              /* The internal data structure for cloth. */
471         struct ClothSimSettings *sim_parms; /* definition is in DNA_cloth_types.h */
472         struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
473         struct PointCache *point_cache; /* definition is in DNA_object_force.h */
474         struct ListBase ptcaches;
475 } ClothModifierData;
476
477 typedef struct CollisionModifierData {
478         ModifierData    modifier;
479         
480         struct MVert *x; /* position at the beginning of the frame */
481         struct MVert *xnew; /* position at the end of the frame */
482         struct MVert *xold; /* unsued atm, but was discussed during sprint */
483         struct MVert *current_xnew; /* new position at the actual inter-frame step */
484         struct MVert *current_x; /* position at the actual inter-frame step */
485         struct MVert *current_v; /* (xnew - x) at the actual inter-frame step */
486         
487         struct MFace *mfaces; /* object face data */
488         
489         unsigned int numverts;
490         unsigned int numfaces;
491         float time_x, time_xnew;                /* cfra time of modifier */
492         struct BVHTree *bvhtree; /* bounding volume hierarchy for this cloth object */
493 } CollisionModifierData;
494
495 typedef struct SurfaceModifierData {
496         ModifierData    modifier;
497
498         struct MVert *x; /* old position */
499         struct MVert *v; /* velocity */
500
501         struct DerivedMesh *dm;
502
503         struct BVHTreeFromMesh *bvhtree; /* bounding volume hierarchy of the mesh faces */
504
505         int cfra, numverts;
506 } SurfaceModifierData;
507
508 typedef enum {
509         eBooleanModifierOp_Intersect = 0,
510         eBooleanModifierOp_Union = 1,
511         eBooleanModifierOp_Difference = 2,
512 } BooleanModifierOp;
513 typedef struct BooleanModifierData {
514         ModifierData modifier;
515
516         struct Object *object;
517         int operation, pad;
518 } BooleanModifierData;
519
520 #define MOD_MDEF_INVERT_VGROUP  (1<<0)
521 #define MOD_MDEF_DYNAMIC_BIND   (1<<1)
522
523 #define MOD_MDEF_VOLUME                 0
524 #define MOD_MDEF_SURFACE                1
525
526 typedef struct MDefInfluence {
527         int vertex;
528         float weight;
529 } MDefInfluence;
530
531 typedef struct MDefCell {
532         int offset;
533         int totinfluence;
534 } MDefCell;
535
536 typedef struct MeshDeformModifierData {
537         ModifierData modifier;
538
539         struct Object *object;                  /* mesh object */
540         char defgrp_name[64];                   /* optional vertexgroup name, MAX_VGROUP_NAME */
541
542         short gridsize, flag, mode, pad;
543
544         /* result of static binding */
545         MDefInfluence *bindinfluences;  /* influences */
546         int *bindoffsets;                               /* offsets into influences array */
547         float *bindcagecos;                             /* coordinates that cage was bound with */
548         int totvert, totcagevert;               /* total vertices in mesh and cage */
549
550         /* result of dynamic binding */
551         MDefCell *dyngrid;                              /* grid with dynamic binding cell points */
552         MDefInfluence *dyninfluences;   /* dynamic binding vertex influences */
553         int *dynverts, *pad2;                   /* is this vertex bound or not? */
554         int dyngridsize;                                /* size of the dynamic bind grid */
555         int totinfluence;                               /* total number of vertex influences */
556         float dyncellmin[3];                    /* offset of the dynamic bind grid */
557         float dyncellwidth;                             /* width of dynamic bind cell */
558         float bindmat[4][4];                    /* matrix of cage at binding time */
559
560         /* deprecated storage */
561         float *bindweights;                             /* deprecated inefficient storage */
562         float *bindcos;                                 /* deprecated storage of cage coords */
563
564         /* runtime */
565         void (*bindfunc)(struct Scene *scene,
566                 struct MeshDeformModifierData *mmd,
567                 float *vertexcos, int totvert, float cagemat[][4]);
568 } MeshDeformModifierData;
569
570 typedef enum {
571         eParticleSystemFlag_Pars =                      (1<<0),
572         eParticleSystemFlag_psys_updated =      (1<<1),
573         eParticleSystemFlag_file_loaded =       (1<<2),
574 } ParticleSystemModifierFlag;
575
576 typedef struct ParticleSystemModifierData {
577         ModifierData modifier;
578         struct ParticleSystem *psys;
579         struct DerivedMesh *dm;
580         int totdmvert, totdmedge, totdmface;
581         short flag, rt;
582 } ParticleSystemModifierData;
583
584 typedef enum {
585         eParticleInstanceFlag_Parents =         (1<<0),
586         eParticleInstanceFlag_Children =        (1<<1),
587         eParticleInstanceFlag_Path =            (1<<2),
588         eParticleInstanceFlag_Unborn =          (1<<3),
589         eParticleInstanceFlag_Alive =           (1<<4),
590         eParticleInstanceFlag_Dead =            (1<<5),
591         eParticleInstanceFlag_KeepShape =       (1<<6),
592         eParticleInstanceFlag_UseSize =         (1<<7),
593 } ParticleInstanceModifierFlag;
594
595 typedef struct ParticleInstanceModifierData {
596         ModifierData modifier;
597         struct Object *ob;
598         short psys, flag, axis, rt;
599         float position, random_position;
600 } ParticleInstanceModifierData;
601
602 typedef enum {
603         eExplodeFlag_CalcFaces =        (1<<0),
604         eExplodeFlag_PaSize =           (1<<1),
605         eExplodeFlag_EdgeCut =          (1<<2),
606         eExplodeFlag_Unborn =           (1<<3),
607         eExplodeFlag_Alive =            (1<<4),
608         eExplodeFlag_Dead =                     (1<<5),
609 } ExplodeModifierFlag;
610
611 typedef struct ExplodeModifierData {
612         ModifierData modifier;
613         int *facepa;
614         short flag, vgroup;
615         float protect;
616         char uvname[64];        /* MAX_CUSTOMDATA_LAYER_NAME */
617 } ExplodeModifierData;
618
619 typedef struct MultiresModifierData {
620         ModifierData modifier;
621
622         char lvl, sculptlvl, renderlvl, totlvl;
623         char simple, flags, pad[2];
624 } MultiresModifierData;
625
626 typedef enum {
627         eMultiresModifierFlag_ControlEdges = (1<<0),
628         eMultiresModifierFlag_PlainUv = (1<<1),
629 } MultiresModifierFlag;
630
631 typedef struct FluidsimModifierData {
632         ModifierData modifier;
633         
634         struct FluidsimSettings *fss; /* definition is in DNA_object_fluidsim.h */
635         struct PointCache *point_cache; /* definition is in DNA_object_force.h */
636 } FluidsimModifierData;
637
638 typedef struct ShrinkwrapModifierData {
639         ModifierData modifier;
640
641         struct Object *target;  /* shrink target */
642         struct Object *auxTarget; /* additional shrink target */
643         char vgroup_name[64];   /* optional vertexgroup name, MAX_VGROUP_NAME */
644         float keepDist;                 /* distance offset to keep from mesh/projection point */
645         short shrinkType;               /* shrink type projection */
646         short shrinkOpts;               /* shrink options */
647         char projAxis;                  /* axis to project over */
648
649         /*
650          * if using projection over vertex normal this controls the
651          * the level of subsurface that must be done before getting the
652          * vertex coordinates and normal
653          */
654         char subsurfLevels;
655
656         char pad[6];
657
658 } ShrinkwrapModifierData;
659
660 /* Shrinkwrap->shrinkType */
661 #define MOD_SHRINKWRAP_NEAREST_SURFACE  0
662 #define MOD_SHRINKWRAP_PROJECT                  1
663 #define MOD_SHRINKWRAP_NEAREST_VERTEX   2
664
665 /* Shrinkwrap->shrinkOpts */
666 #define MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR    (1<<0)  /* allow shrinkwrap to move the vertex in the positive direction of axis */
667 #define MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR    (1<<1)  /* allow shrinkwrap to move the vertex in the negative direction of axis */
668
669 #define MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE    (1<<3)  /* ignore vertex moves if a vertex ends projected on a front face of the target */
670 #define MOD_SHRINKWRAP_CULL_TARGET_BACKFACE             (1<<4)  /* ignore vertex moves if a vertex ends projected on a back face of the target */
671
672 #define MOD_SHRINKWRAP_KEEP_ABOVE_SURFACE               (1<<5)  /* distance is measure to the front face of the target */
673
674 #define MOD_SHRINKWRAP_PROJECT_OVER_X_AXIS              (1<<0)
675 #define MOD_SHRINKWRAP_PROJECT_OVER_Y_AXIS              (1<<1)
676 #define MOD_SHRINKWRAP_PROJECT_OVER_Z_AXIS              (1<<2)
677 #define MOD_SHRINKWRAP_PROJECT_OVER_NORMAL                      0       /* projection over normal is used if no axis is selected */
678
679
680 typedef struct SimpleDeformModifierData {
681         ModifierData modifier;
682
683         struct Object *origin;  /* object to control the origin of modifier space coordinates */
684         char vgroup_name[64];   /* optional vertexgroup name, MAX_VGROUP_NAME */
685         float factor;                   /* factors to control simple deforms */
686         float limit[2];                 /* lower and upper limit */             
687
688         char mode;                              /* deform function */
689         char axis;                              /* lock axis (for taper and strech) */
690         char originOpts;                /* originOptions */
691         char pad;
692
693 } SimpleDeformModifierData;
694
695 #define MOD_SIMPLEDEFORM_MODE_TWIST             1
696 #define MOD_SIMPLEDEFORM_MODE_BEND              2
697 #define MOD_SIMPLEDEFORM_MODE_TAPER             3
698 #define MOD_SIMPLEDEFORM_MODE_STRETCH   4
699
700 #define MOD_SIMPLEDEFORM_LOCK_AXIS_X                    (1<<0)
701 #define MOD_SIMPLEDEFORM_LOCK_AXIS_Y                    (1<<1)
702
703 /* indicates whether simple deform should use the local
704  * coordinates or global coordinates of origin */
705 /* XXX, this should have never been an option, all other modifiers work relatively
706  * (so moving both objects makes no change!) - Campbell */
707 #define MOD_SIMPLEDEFORM_ORIGIN_LOCAL                   (1<<0)
708
709 #define MOD_UVPROJECT_MAX                               10
710
711 typedef struct ShapeKeyModifierData {
712         ModifierData modifier;
713 } ShapeKeyModifierData;
714
715 typedef struct SolidifyModifierData {
716         ModifierData modifier;
717
718         char defgrp_name[64];   /* name of vertex group to use, MAX_VGROUP_NAME */
719         float offset;                   /* new surface offset level*/
720         float offset_fac;               /* midpoint of the offset  */
721         float offset_fac_vg;    /* factor for the minimum weight to use when vgroups are used, avoids 0.0 weights giving duplicate geometry */
722         float crease_inner;
723         float crease_outer;
724         float crease_rim;
725         int flag;
726         short mat_ofs;
727         short mat_ofs_rim;
728 } SolidifyModifierData;
729
730 #define MOD_SOLIDIFY_RIM            (1 << 0)
731 #define MOD_SOLIDIFY_EVEN           (1 << 1)
732 #define MOD_SOLIDIFY_NORMAL_CALC    (1 << 2)
733 #define MOD_SOLIDIFY_VGROUP_INV     (1 << 3)
734 #define MOD_SOLIDIFY_RIM_MATERIAL   (1 << 4) /* deprecated, used in do_versions */
735 #define MOD_SOLIDIFY_FLIP           (1 << 5)
736
737 typedef struct ScrewModifierData {
738         ModifierData modifier;
739         struct Object *ob_axis;
740         int             steps;
741         int             render_steps;
742         int             iter;
743         float   screw_ofs;
744         float   angle;
745         short   axis;
746         short   flag;
747 } ScrewModifierData;
748
749 #define MOD_SCREW_NORMAL_FLIP    (1 << 0)
750 #define MOD_SCREW_NORMAL_CALC    (1 << 1)
751 #define MOD_SCREW_OBJECT_OFFSET  (1 << 2)
752 // #define MOD_SCREW_OBJECT_ANGLE       (1 << 4)
753 #define MOD_SCREW_SMOOTH_SHADING (1 << 5)
754
755 typedef struct OceanModifierData {
756         ModifierData modifier;
757         
758         struct Ocean *ocean;
759         struct OceanCache *oceancache;
760         
761         int             resolution;
762         int             spatial_size;
763         
764         float   wind_velocity;
765         
766         float   damp;
767         float   smallest_wave;
768         float   depth;
769         
770         float   wave_alignment;
771         float   wave_direction;
772         float   wave_scale;
773         
774         float   chop_amount;
775         float   foam_coverage;
776         float   time;
777         
778         int             bakestart;
779         int             bakeend;
780         
781         char    cachepath[1024];        // FILE_MAX
782         char    foamlayername[64];      /* MAX_CUSTOMDATA_LAYER_NAME */
783         char    cached;
784         char    geometry_mode;
785
786         char    flag;
787         char    refresh;
788
789         short   repeat_x;
790         short   repeat_y;
791
792         int             seed;
793
794         float   size;
795         
796         float   foam_fade;
797
798         int pad;
799
800 } OceanModifierData;
801
802 #define MOD_OCEAN_GEOM_GENERATE 0
803 #define MOD_OCEAN_GEOM_DISPLACE 1
804 #define MOD_OCEAN_GEOM_SIM_ONLY 2
805
806 #define MOD_OCEAN_REFRESH_RESET                 1
807 #define MOD_OCEAN_REFRESH_SIM                   2
808 #define MOD_OCEAN_REFRESH_ADD                   4
809 #define MOD_OCEAN_REFRESH_CLEAR_CACHE   8
810 #define MOD_OCEAN_REFRESH_TOPOLOGY              16
811
812 #define MOD_OCEAN_GENERATE_FOAM 1
813 #define MOD_OCEAN_GENERATE_NORMALS      2
814
815
816 typedef struct WarpModifierData {
817         ModifierData modifier;
818         /* keep in sync with MappingInfoModifierData */
819         struct Tex *texture;
820         struct Object *map_object;
821         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
822         int uvlayer_tmp;
823         int texmapping;
824         /* end MappingInfoModifierData */
825
826         struct Object *object_from;
827         struct Object *object_to;
828         struct CurveMapping *curfalloff;
829         char defgrp_name[64];                   /* optional vertexgroup name, MAX_VGROUP_NAME */
830         float strength;
831         float falloff_radius;
832         char flag; /* not used yet */
833         char falloff_type;
834         char pad[6];
835 } WarpModifierData;
836
837 #define MOD_WARP_VOLUME_PRESERVE 1
838
839 typedef enum {
840         eWarp_Falloff_None =            0,
841         eWarp_Falloff_Curve =           1,
842         eWarp_Falloff_Sharp =           2, /* PROP_SHARP */
843         eWarp_Falloff_Smooth =          3, /* PROP_SMOOTH */
844         eWarp_Falloff_Root =            4, /* PROP_ROOT */
845         eWarp_Falloff_Linear =          5, /* PROP_LIN */
846         eWarp_Falloff_Const =           6, /* PROP_CONST */
847         eWarp_Falloff_Sphere =          7, /* PROP_SPHERE */
848         /* PROP_RANDOM not used */
849 } WarpModifierFalloff;
850
851 typedef struct WeightVGEditModifierData {
852         ModifierData modifier;
853
854         /* Note: I tried to keep everything logically ordered - provided the
855          * alignment constraints... */
856
857         char    defgrp_name[64];      /* Name of vertex group to edit. MAX_VGROUP_NAME. */
858
859         short   edit_flags;     /* Using MOD_WVG_EDIT_* flags. */
860         short   falloff_type;   /* Using MOD_WVG_MAPPING_* defines. */
861         float   default_weight; /* Weight for vertices not in vgroup. */
862
863         /* Mapping stuff. */
864         struct CurveMapping *cmap_curve;  /* The custom mapping curve! */
865
866         /* The add/remove vertices weight thresholds. */
867         float   add_threshold, rem_threshold;
868
869         /* Masking options. */
870         float   mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
871         /* Name of mask vertex group from which to get weight factors. */
872         char    mask_defgrp_name[64];   /* MAX_VGROUP_NAME */
873
874         /* Texture masking. */
875         int             mask_tex_use_channel;      /* Which channel to use as weightf. */
876         struct Tex *mask_texture;          /* The texture. */
877         struct Object *mask_tex_map_obj;   /* Name of the map object. */
878         /* How to map the texture (using MOD_DISP_MAP_* constants). */
879         int             mask_tex_mapping;
880         char    mask_tex_uvlayer_name[64]; /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME */
881
882         /* Padding... */
883         int pad_i1;
884 } WeightVGEditModifierData;
885
886 /* WeightVGEdit flags. */
887 /* Use parametric mapping. */
888 //#define MOD_WVG_EDIT_MAP                                      (1 << 0)
889 /* Use curve mapping. */
890 //#define MOD_WVG_EDIT_CMAP                                     (1 << 1)
891 /* Reverse weights (in the [0.0, 1.0] standard range). */
892 //#define MOD_WVG_EDIT_REVERSE_WEIGHTS          (1 << 2)
893 /* Add vertices with higher weight than threshold to vgroup. */
894 #define MOD_WVG_EDIT_ADD2VG                                     (1 << 3)
895 /* Remove vertices with lower weight than threshold from vgroup. */
896 #define MOD_WVG_EDIT_REMFVG                                     (1 << 4)
897 /* Clamp weights. */
898 //#define MOD_WVG_EDIT_CLAMP                                    (1 << 5)
899
900 typedef struct WeightVGMixModifierData {
901         ModifierData modifier;
902
903         /* XXX Note: I tried to keep everything logically ordered - provided the
904          *           alignment constraints... */
905
906         char    defgrp_name_a[64];      /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
907         char    defgrp_name_b[64];     /* Name of other vertex group to mix in. MAX_VGROUP_NAME. */
908         float   default_weight_a;       /* Default weight value for first vgroup. */
909         float   default_weight_b;      /* Default weight value to mix in. */
910         char    mix_mode;             /* How second vgroups weights affect first ones */
911         char    mix_set;              /* What vertices to affect. */
912
913         char    pad_c1[6];
914
915         /* Masking options. */
916         float   mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
917         /* Name of mask vertex group from which to get weight factors. */
918         char    mask_defgrp_name[64];   /* MAX_VGROUP_NAME */
919
920         /* Texture masking. */
921         int             mask_tex_use_channel;      /* Which channel to use as weightf. */
922         struct Tex *mask_texture;          /* The texture. */
923         struct Object *mask_tex_map_obj;   /* Name of the map object. */
924         int             mask_tex_mapping;          /* How to map the texture! */
925         char    mask_tex_uvlayer_name[64]; /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
926
927         /* Padding... */
928         int pad_i1;
929 } WeightVGMixModifierData;
930
931 /* How second vgroup's weights affect first ones. */
932 #define MOD_WVG_MIX_SET                 1 /* Second weights replace weights. */
933 #define MOD_WVG_MIX_ADD                 2 /* Second weights are added to weights. */
934 #define MOD_WVG_MIX_SUB                 3 /* Second weights are subtracted from weights. */
935 #define MOD_WVG_MIX_MUL                 4 /* Second weights are multiplied with weights. */
936 #define MOD_WVG_MIX_DIV                 5 /* Second weights divide weights. */
937 #define MOD_WVG_MIX_DIF                 6 /* Difference between second weights and weights. */
938 #define MOD_WVG_MIX_AVG                 7 /* Average of both weights. */
939
940 /* What vertices to affect. */
941 #define MOD_WVG_SET_ALL                 1 /* Affect all vertices. */
942 #define MOD_WVG_SET_A                   2 /* Affect only vertices in first vgroup. */
943 #define MOD_WVG_SET_B                   3 /* Affect only vertices in second vgroup. */
944 #define MOD_WVG_SET_OR                  4 /* Affect only vertices in one vgroup or the other. */
945 #define MOD_WVG_SET_AND                 5 /* Affect only vertices in both vgroups. */
946
947 typedef struct WeightVGProximityModifierData {
948         ModifierData modifier;
949
950         /* Note: I tried to keep everything logically ordered - provided the
951          * alignment constraints... */
952
953         char    defgrp_name[64];      /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
954
955         /* Proximity modes. */
956         int             proximity_mode;
957         int             proximity_flags;
958
959         /* Target object from which to calculate vertices distances. */
960         struct Object *proximity_ob_target;
961
962         /* Masking options. */
963         float   mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
964         /* Name of mask vertex group from which to get weight factors. */
965         char    mask_defgrp_name[64];   /* MAX_VGROUP_NAME */
966
967         /* Texture masking. */
968         int             mask_tex_use_channel;      /* Which channel to use as weightf. */
969         struct Tex *mask_texture;          /* The texture. */
970         struct Object *mask_tex_map_obj;   /* Name of the map object. */
971         int             mask_tex_mapping;          /* How to map the texture! */
972         char    mask_tex_uvlayer_name[64]; /* Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
973
974         float   min_dist, max_dist;        /* Distances mapping to 0.0/1.0 weights. */
975
976         /* Put here to avoid breaking existing struct... */
977         short   falloff_type;              /* Using MOD_WVG_MAPPING_* defines. */
978
979         /* Padding... */
980         short pad_s1;
981 } WeightVGProximityModifierData;
982
983 /* Modes of proximity weighting. */
984 /* Dist from target object to affected object. */
985 #define MOD_WVG_PROXIMITY_OBJECT                        1 /* source vertex to other location */
986 /* Dist from target object to vertex. */
987 #define MOD_WVG_PROXIMITY_GEOMETRY                      2 /* source vertex to other geometry */
988
989 /* Flags options for proximity weighting. */
990 /* Use nearest vertices of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
991 #define MOD_WVG_PROXIMITY_GEOM_VERTS            (1 << 0)
992 /* Use nearest edges of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
993 #define MOD_WVG_PROXIMITY_GEOM_EDGES            (1 << 1)
994 /* Use nearest faces of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
995 #define MOD_WVG_PROXIMITY_GEOM_FACES            (1 << 2)
996
997 /* Defines common to all WeightVG modifiers. */
998 /* Mapping modes. */
999 #define MOD_WVG_MAPPING_NONE                            0
1000 #define MOD_WVG_MAPPING_CURVE                           1
1001 #define MOD_WVG_MAPPING_SHARP                           2 /* PROP_SHARP */
1002 #define MOD_WVG_MAPPING_SMOOTH                          3 /* PROP_SMOOTH */
1003 #define MOD_WVG_MAPPING_ROOT                            4 /* PROP_ROOT */
1004 /* PROP_LIN not used (same as NONE, here...). */
1005 /* PROP_CONST not used. */
1006 #define MOD_WVG_MAPPING_SPHERE                          7 /* PROP_SPHERE */
1007 #define MOD_WVG_MAPPING_RANDOM                          8 /* PROP_RANDOM */
1008 #define MOD_WVG_MAPPING_STEP                            9 /* Median Step. */
1009
1010 /* Tex channel to be used as mask. */
1011 #define MOD_WVG_MASK_TEX_USE_INT                        1
1012 #define MOD_WVG_MASK_TEX_USE_RED                        2
1013 #define MOD_WVG_MASK_TEX_USE_GREEN                      3
1014 #define MOD_WVG_MASK_TEX_USE_BLUE                       4
1015 #define MOD_WVG_MASK_TEX_USE_HUE                        5
1016 #define MOD_WVG_MASK_TEX_USE_SAT                        6
1017 #define MOD_WVG_MASK_TEX_USE_VAL                        7
1018 #define MOD_WVG_MASK_TEX_USE_ALPHA                      8
1019
1020 /* Dynamic paint modifier flags */
1021 #define MOD_DYNAMICPAINT_TYPE_CANVAS (1 << 0)
1022 #define MOD_DYNAMICPAINT_TYPE_BRUSH (1 << 1)
1023
1024 typedef struct DynamicPaintModifierData {
1025         ModifierData modifier;
1026
1027         struct DynamicPaintCanvasSettings *canvas;
1028         struct DynamicPaintBrushSettings *brush;
1029         int type;  /* ui display: canvas / brush */
1030         int pad;
1031 } DynamicPaintModifierData;
1032
1033 /* Remesh modifier */
1034
1035 typedef enum RemeshModifierFlags {
1036         MOD_REMESH_FLOOD_FILL = 1,
1037         MOD_REMESH_SMOOTH_SHADING = 2,
1038 } RemeshModifierFlags;
1039
1040 typedef enum RemeshModifierMode {
1041         /* blocky */
1042         MOD_REMESH_CENTROID = 0,
1043         /* smooth */
1044         MOD_REMESH_MASS_POINT = 1,
1045         /* keeps sharp edges */
1046         MOD_REMESH_SHARP_FEATURES = 2,
1047 } RemeshModifierMode;
1048
1049 typedef struct RemeshModifierData {
1050         ModifierData modifier;
1051
1052         /* floodfill option, controls how small components can be
1053          * before they are removed */
1054         float threshold;
1055
1056         /* ratio between size of model and grid */
1057         float scale;
1058
1059         float hermite_num;
1060
1061         /* octree depth */
1062         char depth;
1063
1064         char flag;
1065         char mode;
1066         char pad;
1067 } RemeshModifierData;
1068
1069 /* Skin modifier */
1070
1071 typedef struct SkinModifierData {
1072         ModifierData modifier;
1073
1074         float branch_smoothing;
1075
1076         char flag;
1077         
1078         char symmetry_axes;
1079
1080         char pad[2];
1081 } SkinModifierData;
1082
1083 /* SkinModifierData.symmetry_axes */
1084 enum {
1085         MOD_SKIN_SYMM_X = 1,
1086         MOD_SKIN_SYMM_Y = 2,
1087         MOD_SKIN_SYMM_Z = 4,
1088 };
1089
1090 /* SkinModifierData.flag */
1091 enum {
1092         MOD_SKIN_SMOOTH_SHADING = 1
1093 };
1094
1095 #endif