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