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