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