Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_modifier_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file DNA_modifier_types.h
22  *  \ingroup DNA
23  */
24
25 #ifndef __DNA_MODIFIER_TYPES_H__
26 #define __DNA_MODIFIER_TYPES_H__
27
28 #include "DNA_defs.h"
29 #include "DNA_listBase.h"
30
31 /* WARNING ALERT! TYPEDEF VALUES ARE WRITTEN IN FILES! SO DO NOT CHANGE!
32  * (ONLY ADD NEW ITEMS AT THE END)
33  */
34
35 typedef enum ModifierType {
36         eModifierType_None              = 0,
37         eModifierType_Subsurf           = 1,
38         eModifierType_Lattice           = 2,
39         eModifierType_Curve             = 3,
40         eModifierType_Build             = 4,
41         eModifierType_Mirror            = 5,
42         eModifierType_Decimate          = 6,
43         eModifierType_Wave              = 7,
44         eModifierType_Armature          = 8,
45         eModifierType_Hook              = 9,
46         eModifierType_Softbody          = 10,
47         eModifierType_Boolean           = 11,
48         eModifierType_Array             = 12,
49         eModifierType_EdgeSplit         = 13,
50         eModifierType_Displace          = 14,
51         eModifierType_UVProject         = 15,
52         eModifierType_Smooth            = 16,
53         eModifierType_Cast              = 17,
54         eModifierType_MeshDeform        = 18,
55         eModifierType_ParticleSystem    = 19,
56         eModifierType_ParticleInstance  = 20,
57         eModifierType_Explode           = 21,
58         eModifierType_Cloth             = 22,
59         eModifierType_Collision         = 23,
60         eModifierType_Bevel             = 24,
61         eModifierType_Shrinkwrap        = 25,
62         eModifierType_Fluidsim          = 26,
63         eModifierType_Mask              = 27,
64         eModifierType_SimpleDeform      = 28,
65         eModifierType_Multires          = 29,
66         eModifierType_Surface           = 30,
67         eModifierType_Smoke             = 31,
68         eModifierType_ShapeKey          = 32,
69         eModifierType_Solidify          = 33,
70         eModifierType_Screw             = 34,
71         eModifierType_Warp              = 35,
72         eModifierType_WeightVGEdit      = 36,
73         eModifierType_WeightVGMix       = 37,
74         eModifierType_WeightVGProximity = 38,
75         eModifierType_Ocean             = 39,
76         eModifierType_DynamicPaint      = 40,
77         eModifierType_Remesh            = 41,
78         eModifierType_Skin              = 42,
79         eModifierType_LaplacianSmooth   = 43,
80         eModifierType_Triangulate       = 44,
81         eModifierType_UVWarp            = 45,
82         eModifierType_MeshCache         = 46,
83         eModifierType_LaplacianDeform   = 47,
84         eModifierType_Wireframe         = 48,
85         eModifierType_DataTransfer      = 49,
86         eModifierType_NormalEdit        = 50,
87         eModifierType_CorrectiveSmooth  = 51,
88         eModifierType_MeshSequenceCache = 52,
89         eModifierType_SurfaceDeform     = 53,
90         NUM_MODIFIER_TYPES
91 } ModifierType;
92
93 typedef enum ModifierMode {
94         eModifierMode_Realtime          = (1 << 0),
95         eModifierMode_Render            = (1 << 1),
96         eModifierMode_Editmode          = (1 << 2),
97         eModifierMode_OnCage            = (1 << 3),
98         eModifierMode_Expanded          = (1 << 4),
99         eModifierMode_Virtual           = (1 << 5),
100         eModifierMode_ApplyOnSpline     = (1 << 6),
101         eModifierMode_DisableTemporary  = (1u << 31)
102 } ModifierMode;
103
104 typedef struct ModifierData {
105         struct ModifierData *next, *prev;
106
107         int type, mode;
108         int stackindex, pad;
109         char name[64];  /* MAX_NAME */
110
111         /* XXX for timing info set by caller... solve later? (ton) */
112         struct Scene *scene;
113
114         char *error;
115 } ModifierData;
116
117 typedef enum {
118         eSubsurfModifierFlag_Incremental  = (1 << 0),
119         eSubsurfModifierFlag_DebugIncr    = (1 << 1),
120         eSubsurfModifierFlag_ControlEdges = (1 << 2),
121         eSubsurfModifierFlag_SubsurfUv    = (1 << 3),
122 } SubsurfModifierFlag;
123
124 /* not a real modifier */
125 typedef struct MappingInfoModifierData {
126         ModifierData modifier;
127
128         struct Tex *texture;
129         struct Object *map_object;
130         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
131         int uvlayer_tmp;
132         int texmapping;
133 } MappingInfoModifierData;
134
135 typedef struct SubsurfModifierData {
136         ModifierData modifier;
137
138         short subdivType, levels, renderLevels, flags;
139         short use_opensubdiv, pad[3];
140
141         void *emCache, *mCache;
142 } SubsurfModifierData;
143
144 typedef struct LatticeModifierData {
145         ModifierData modifier;
146
147         struct Object *object;
148         char name[64];          /* optional vertexgroup name, MAX_VGROUP_NAME */
149         float strength;
150         char pad[4];
151 } LatticeModifierData;
152
153 typedef struct CurveModifierData {
154         ModifierData modifier;
155
156         struct Object *object;
157         char name[64];          /* optional vertexgroup name, MAX_VGROUP_NAME */
158         short defaxis;          /* axis along which curve deforms */
159         char pad[6];
160 } CurveModifierData;
161
162 /* CurveModifierData->defaxis */
163 enum {
164         MOD_CURVE_POSX = 1,
165         MOD_CURVE_POSY = 2,
166         MOD_CURVE_POSZ = 3,
167         MOD_CURVE_NEGX = 4,
168         MOD_CURVE_NEGY = 5,
169         MOD_CURVE_NEGZ = 6,
170 };
171
172 typedef struct BuildModifierData {
173         ModifierData modifier;
174
175         float start, length;
176         short flag;
177         
178         short randomize;      /* (bool) whether order of vertices is randomized - legacy files (for readfile conversion) */
179         int seed;             /* (int) random seed */
180 } BuildModifierData;
181
182 /* Build Modifier -> flag */
183 enum {
184         MOD_BUILD_FLAG_RANDOMIZE = (1 << 0),  /* order of vertices is randomized */
185         MOD_BUILD_FLAG_REVERSE   = (1 << 1),  /* frame range is reversed, resulting in a deconstruction effect */
186 };
187
188 /* Mask Modifier */
189 typedef struct MaskModifierData {
190         ModifierData modifier;
191
192         struct Object *ob_arm;  /* armature to use to in place of hardcoded vgroup */
193         char vgroup[64];        /* name of vertex group to use to mask, MAX_VGROUP_NAME */
194
195         int mode;               /* using armature or hardcoded vgroup */
196         int flag;               /* flags for various things */
197 } MaskModifierData;
198
199 /* Mask Modifier -> mode */
200 enum {
201         MOD_MASK_MODE_VGROUP = 0,
202         MOD_MASK_MODE_ARM    = 1,
203 };
204
205 /* Mask Modifier -> flag */
206 enum {
207         MOD_MASK_INV         = (1 << 0),
208 };
209
210 typedef struct ArrayModifierData {
211         ModifierData modifier;
212
213         /* the object with which to cap the start of the array  */
214         struct Object *start_cap;
215         /* the object with which to cap the end of the array  */
216         struct Object *end_cap;
217         /* the curve object to use for MOD_ARR_FITCURVE */
218         struct Object *curve_ob;
219         /* the object to use for object offset */
220         struct Object *offset_ob;
221         /* a constant duplicate offset;
222          * 1 means the duplicates are 1 unit apart
223          */
224         float offset[3];
225         /* a scaled factor for duplicate offsets;
226          * 1 means the duplicates are 1 object-width apart
227          */
228         float scale[3];
229         /* the length over which to distribute the duplicates */
230         float length;
231         /* the limit below which to merge vertices in adjacent duplicates */
232         float merge_dist;
233         /* determines how duplicate count is calculated; one of:
234          * - MOD_ARR_FIXEDCOUNT -> fixed
235          * - MOD_ARR_FITLENGTH  -> calculated to fit a set length
236          * - MOD_ARR_FITCURVE   -> calculated to fit the length of a Curve object
237          */
238         int fit_type;
239         /* flags specifying how total offset is calculated; binary OR of:
240          * - MOD_ARR_OFF_CONST    -> total offset += offset
241          * - MOD_ARR_OFF_RELATIVE -> total offset += relative * object width
242          * - MOD_ARR_OFF_OBJ      -> total offset += offset_ob's matrix
243          * total offset is the sum of the individual enabled offsets
244          */
245         int offset_type;
246         /* general flags:
247          * MOD_ARR_MERGE -> merge vertices in adjacent duplicates
248          */
249         int flags;
250         /* the number of duplicates to generate for MOD_ARR_FIXEDCOUNT */
251         int count;
252         float uv_offset[2];
253 } ArrayModifierData;
254
255 /* ArrayModifierData->fit_type */
256 enum {
257         MOD_ARR_FIXEDCOUNT = 0,
258         MOD_ARR_FITLENGTH  = 1,
259         MOD_ARR_FITCURVE   = 2,
260 };
261
262 /* ArrayModifierData->offset_type */
263 enum {
264         MOD_ARR_OFF_CONST    = (1 << 0),
265         MOD_ARR_OFF_RELATIVE = (1 << 1),
266         MOD_ARR_OFF_OBJ      = (1 << 2),
267 };
268
269 /* ArrayModifierData->flags */
270 enum {
271         MOD_ARR_MERGE      = (1 << 0),
272         MOD_ARR_MERGEFINAL = (1 << 1),
273 };
274
275 typedef struct MirrorModifierData {
276         ModifierData modifier;
277
278         short axis  DNA_DEPRECATED; /* deprecated, use flag instead */
279         short flag;
280         float tolerance;
281         float uv_offset[2];
282         float uv_offset_copy[2];
283         struct Object *mirror_ob;
284 } MirrorModifierData;
285
286 /* MirrorModifierData->flag */
287 enum {
288         MOD_MIR_CLIPPING  = (1 << 0),
289         MOD_MIR_MIRROR_U  = (1 << 1),
290         MOD_MIR_MIRROR_V  = (1 << 2),
291         MOD_MIR_AXIS_X    = (1 << 3),
292         MOD_MIR_AXIS_Y    = (1 << 4),
293         MOD_MIR_AXIS_Z    = (1 << 5),
294         MOD_MIR_VGROUP    = (1 << 6),
295         MOD_MIR_NO_MERGE  = (1 << 7),
296 };
297
298 typedef struct EdgeSplitModifierData {
299         ModifierData modifier;
300
301         float split_angle;    /* angle above which edges should be split */
302         int flags;
303 } EdgeSplitModifierData;
304
305 /* EdgeSplitModifierData->flags */
306 enum {
307         MOD_EDGESPLIT_FROMANGLE  = (1 << 1),
308         MOD_EDGESPLIT_FROMFLAG   = (1 << 2),
309 };
310
311 typedef struct BevelModifierData {
312         ModifierData modifier;
313
314         float value;          /* the "raw" bevel value (distance/amount to bevel) */
315         int res;              /* the resolution (as originally coded, it is the number of recursive bevels) */
316         short flags;          /* general option flags */
317         short val_flags;      /* used to interpret the bevel value */
318         short lim_flags;      /* flags to tell the tool how to limit the bevel */
319         short e_flags;        /* flags to direct how edge weights are applied to verts */
320         short mat;            /* material index if >= 0, else material inherited from surrounding faces */
321         short pad;
322         int pad2;
323         float profile;        /* controls profile shape (0->1, .5 is round) */
324         /* if the MOD_BEVEL_ANGLE is set, this will be how "sharp" an edge must be before it gets beveled */
325         float bevel_angle;
326         /* if the MOD_BEVEL_VWEIGHT option is set, this will be the name of the vert group, MAX_VGROUP_NAME */
327         char defgrp_name[64];
328 } BevelModifierData;
329
330 /* BevelModifierData->flags and BevelModifierData->lim_flags */
331 enum {
332         MOD_BEVEL_VERT          = (1 << 1),
333 /*      MOD_BEVEL_RADIUS        = (1 << 2), */
334         MOD_BEVEL_ANGLE         = (1 << 3),
335         MOD_BEVEL_WEIGHT        = (1 << 4),
336         MOD_BEVEL_VGROUP        = (1 << 5),
337         MOD_BEVEL_EMIN          = (1 << 7),
338         MOD_BEVEL_EMAX          = (1 << 8),
339 /*      MOD_BEVEL_RUNNING       = (1 << 9), */
340 /*      MOD_BEVEL_RES           = (1 << 10), */
341         /* This is a new setting not related to old (trunk bmesh bevel code)
342          * but adding here because they are mixed - campbell
343          */
344 /*      MOD_BEVEL_EVEN          = (1 << 11), */
345 /*      MOD_BEVEL_DIST          = (1 << 12), */  /* same as above */
346         MOD_BEVEL_OVERLAP_OK    = (1 << 13),
347         MOD_BEVEL_EVEN_WIDTHS   = (1 << 14),
348 };
349
350 /* BevelModifierData->val_flags (not used as flags any more) */
351 enum {
352         MOD_BEVEL_AMT_OFFSET = 0,
353         MOD_BEVEL_AMT_WIDTH = 1,
354         MOD_BEVEL_AMT_DEPTH = 2,
355         MOD_BEVEL_AMT_PERCENT = 3,
356 };
357
358 typedef struct SmokeModifierData {
359         ModifierData modifier;
360
361         struct SmokeDomainSettings *domain;
362         struct SmokeFlowSettings *flow; /* inflow, outflow, smoke objects */
363         struct SmokeCollSettings *coll; /* collision objects */
364         float time;
365         int type;  /* domain, inflow, outflow, ... */
366 } SmokeModifierData;
367
368 /* Smoke modifier flags */
369 enum {
370         MOD_SMOKE_TYPE_DOMAIN = (1 << 0),
371         MOD_SMOKE_TYPE_FLOW   = (1 << 1),
372         MOD_SMOKE_TYPE_COLL   = (1 << 2),
373 };
374
375 typedef struct DisplaceModifierData {
376         ModifierData modifier;
377
378         /* keep in sync with MappingInfoModifierData */
379         struct Tex *texture;
380         struct Object *map_object;
381         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
382         int uvlayer_tmp;
383         int texmapping;
384         /* end MappingInfoModifierData */
385
386         float strength;
387         int direction;
388         char defgrp_name[64];   /* MAX_VGROUP_NAME */
389         float midlevel;
390         int space;
391 } DisplaceModifierData;
392
393 /* DisplaceModifierData->direction */
394 enum {
395         MOD_DISP_DIR_X       = 0,
396         MOD_DISP_DIR_Y       = 1,
397         MOD_DISP_DIR_Z       = 2,
398         MOD_DISP_DIR_NOR     = 3,
399         MOD_DISP_DIR_RGB_XYZ = 4,
400         MOD_DISP_DIR_CLNOR   = 5,
401 };
402
403 /* DisplaceModifierData->texmapping */
404 enum {
405         MOD_DISP_MAP_LOCAL  = 0,
406         MOD_DISP_MAP_GLOBAL = 1,
407         MOD_DISP_MAP_OBJECT = 2,
408         MOD_DISP_MAP_UV     = 3,
409 };
410
411 /* DisplaceModifierData->space */
412 enum {
413         MOD_DISP_SPACE_LOCAL  = 0,
414         MOD_DISP_SPACE_GLOBAL = 1,
415 };
416
417 typedef struct UVProjectModifierData {
418         ModifierData modifier;
419
420         /* the objects which do the projecting */
421         struct Object *projectors[10]; /* MOD_UVPROJECT_MAXPROJECTORS */
422         struct Image *image;           /* the image to project */
423         int pad2;
424         int num_projectors;
425         float aspectx, aspecty;
426         float scalex, scaley;
427         char uvlayer_name[64];         /* MAX_CUSTOMDATA_LAYER_NAME */
428         int uvlayer_tmp, pad;
429 } UVProjectModifierData;
430
431 #define MOD_UVPROJECT_MAXPROJECTORS 10
432
433 /* UVProjectModifierData->flags */
434 enum {
435         MOD_UVPROJECT_OVERRIDEIMAGE = (1 << 0),
436 };
437
438 typedef struct DecimateModifierData {
439         ModifierData modifier;
440
441         float percent;  /* (mode == MOD_DECIM_MODE_COLLAPSE) */
442         short iter;     /* (mode == MOD_DECIM_MODE_UNSUBDIV) */
443         char delimit;   /* (mode == MOD_DECIM_MODE_DISSOLVE) */
444         char symmetry_axis; /* (mode == MOD_DECIM_MODE_COLLAPSE) */
445         float angle;    /* (mode == MOD_DECIM_MODE_DISSOLVE) */
446
447         char defgrp_name[64];  /* MAX_VGROUP_NAME */
448         float defgrp_factor;
449         short flag, mode;
450
451         /* runtime only */
452         int face_count;
453 } DecimateModifierData;
454
455 enum {
456         MOD_DECIM_FLAG_INVERT_VGROUP       = (1 << 0),
457         MOD_DECIM_FLAG_TRIANGULATE         = (1 << 1),  /* for collapse only. dont convert tri pairs back to quads */
458         MOD_DECIM_FLAG_ALL_BOUNDARY_VERTS  = (1 << 2),  /* for dissolve only. collapse all verts between 2 faces */
459         MOD_DECIM_FLAG_SYMMETRY            = (1 << 3),
460 };
461
462 enum {
463         MOD_DECIM_MODE_COLLAPSE,
464         MOD_DECIM_MODE_UNSUBDIV,
465         MOD_DECIM_MODE_DISSOLVE,  /* called planar in the UI */
466 };
467
468 typedef struct SmoothModifierData {
469         ModifierData modifier;
470         float fac;
471         char defgrp_name[64];   /* MAX_VGROUP_NAME */
472         short flag, repeat;
473
474 } SmoothModifierData;
475
476 /* Smooth modifier flags */
477 enum {
478         MOD_SMOOTH_X = (1 << 1),
479         MOD_SMOOTH_Y = (1 << 2),
480         MOD_SMOOTH_Z = (1 << 3),
481 };
482
483 typedef struct CastModifierData {
484         ModifierData modifier;
485
486         struct Object *object;
487         float fac;
488         float radius;
489         float size;
490         char defgrp_name[64];  /* MAX_VGROUP_NAME */
491         short flag, type;
492 } CastModifierData;
493
494 /* Cast modifier flags */
495 enum {
496         /* And what bout (1 << 0) flag? ;) */
497         MOD_CAST_X                = (1 << 1),
498         MOD_CAST_Y                = (1 << 2),
499         MOD_CAST_Z                = (1 << 3),
500         MOD_CAST_USE_OB_TRANSFORM = (1 << 4),
501         MOD_CAST_SIZE_FROM_RADIUS = (1 << 5),
502 };
503
504 /* Cast modifier projection types */
505 enum {
506         MOD_CAST_TYPE_SPHERE   = 0,
507         MOD_CAST_TYPE_CYLINDER = 1,
508         MOD_CAST_TYPE_CUBOID   = 2,
509 };
510
511 typedef struct WaveModifierData {
512         ModifierData modifier;
513
514         /* keep in sync with MappingInfoModifierData */
515         struct Tex *texture;
516         struct Object *map_object;
517         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
518         int uvlayer_tmp;
519         int texmapping;
520         /* end MappingInfoModifierData */
521
522         struct Object *objectcenter;
523         char defgrp_name[64];   /* MAX_VGROUP_NAME */
524
525         short flag, pad;
526
527         float startx, starty, height, width;
528         float narrow, speed, damp, falloff;
529
530         float timeoffs, lifetime;
531         float pad1;
532 } WaveModifierData;
533
534 /* WaveModifierData.flag */
535 enum {
536         /* And what bout (1 << 0) flag? ;) */
537         MOD_WAVE_X      = (1 << 1),
538         MOD_WAVE_Y      = (1 << 2),
539         MOD_WAVE_CYCL   = (1 << 3),
540         MOD_WAVE_NORM   = (1 << 4),
541         MOD_WAVE_NORM_X = (1 << 5),
542         MOD_WAVE_NORM_Y = (1 << 6),
543         MOD_WAVE_NORM_Z = (1 << 7),
544 };
545
546 typedef struct ArmatureModifierData {
547         ModifierData modifier;
548
549         short deformflag, multi;  /* deformflag replaces armature->deformflag */
550         int pad2;
551         struct Object *object;
552         float *prevCos;           /* stored input of previous modifier, for vertexgroup blending */
553         char defgrp_name[64];     /* MAX_VGROUP_NAME */
554 } ArmatureModifierData;
555
556 enum {
557         MOD_HOOK_UNIFORM_SPACE = (1 << 0),
558 };
559
560 /* same as WarpModifierFalloff */
561 typedef enum {
562         eHook_Falloff_None   = 0,
563         eHook_Falloff_Curve  = 1,
564         eHook_Falloff_Sharp  = 2, /* PROP_SHARP */
565         eHook_Falloff_Smooth = 3, /* PROP_SMOOTH */
566         eHook_Falloff_Root   = 4, /* PROP_ROOT */
567         eHook_Falloff_Linear = 5, /* PROP_LIN */
568         eHook_Falloff_Const  = 6, /* PROP_CONST */
569         eHook_Falloff_Sphere = 7, /* PROP_SPHERE */
570         eHook_Falloff_InvSquare = 8, /* PROP_INVSQUARE */
571         /* PROP_RANDOM not used */
572 } HookModifierFalloff;
573
574 typedef struct HookModifierData {
575         ModifierData modifier;
576
577         struct Object *object;
578         char subtarget[64];     /* optional name of bone target, MAX_ID_NAME-2 */
579
580         char flag;
581         char falloff_type;      /* use enums from WarpModifier (exact same functionality) */
582         char pad[6];
583         float parentinv[4][4];  /* matrix making current transform unmodified */
584         float cent[3];          /* visualization of hook */
585         float falloff;          /* if not zero, falloff is distance where influence zero */
586
587         struct CurveMapping *curfalloff;
588
589         int *indexar;           /* if NULL, it's using vertexgroup */
590         int totindex;
591         float force;
592         char name[64];          /* optional vertexgroup name, MAX_VGROUP_NAME */
593 } HookModifierData;
594
595 typedef struct SoftbodyModifierData {
596         ModifierData modifier;
597 } SoftbodyModifierData;
598
599 typedef struct ClothModifierData {
600         ModifierData modifier;
601
602         struct Scene *scene;                  /* the context, time etc is here */
603         struct Cloth *clothObject;            /* The internal data structure for cloth. */
604         struct ClothSimSettings *sim_parms;   /* definition is in DNA_cloth_types.h */
605         struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
606         struct PointCache *point_cache;       /* definition is in DNA_object_force_types.h */
607         struct ListBase ptcaches;
608         /* XXX nasty hack, remove once hair can be separated from cloth modifier data */
609         struct ClothHairData *hairdata;
610         /* grid geometry values of hair continuum */
611         float hair_grid_min[3];
612         float hair_grid_max[3];
613         int hair_grid_res[3];
614         float hair_grid_cellsize;
615         
616         struct ClothSolverResult *solver_result;
617 } ClothModifierData;
618
619 typedef struct CollisionModifierData {
620         ModifierData modifier;
621
622         struct MVert *x;            /* position at the beginning of the frame */
623         struct MVert *xnew;         /* position at the end of the frame */
624         struct MVert *xold;         /* unused atm, but was discussed during sprint */
625         struct MVert *current_xnew; /* new position at the actual inter-frame step */
626         struct MVert *current_x;    /* position at the actual inter-frame step */
627         struct MVert *current_v;    /* (xnew - x) at the actual inter-frame step */
628
629         struct MVertTri *tri;
630
631         unsigned int mvert_num;
632         unsigned int tri_num;
633         float time_x, time_xnew;    /* cfra time of modifier */
634         char is_static;             /* collider doesn't move this frame, i.e. x[].co==xnew[].co */
635         char pad[7];
636
637         struct BVHTree *bvhtree;    /* bounding volume hierarchy for this cloth object */
638 } CollisionModifierData;
639
640 typedef struct SurfaceModifierData {
641         ModifierData modifier;
642
643         struct MVert *x; /* old position */
644         struct MVert *v; /* velocity */
645
646         struct DerivedMesh *dm;
647
648         struct BVHTreeFromMesh *bvhtree; /* bounding volume hierarchy of the mesh faces */
649
650         int cfra, numverts;
651 } SurfaceModifierData;
652
653 typedef struct BooleanModifierData {
654         ModifierData modifier;
655
656         struct Object *object;
657         char operation;
658         char pad[2];
659         char bm_flag;
660         float double_threshold;
661 } BooleanModifierData;
662
663 typedef enum {
664         eBooleanModifierOp_Intersect  = 0,
665         eBooleanModifierOp_Union      = 1,
666         eBooleanModifierOp_Difference = 2,
667 } BooleanModifierOp;
668
669 /* bm_flag (only used when G_DEBUG) */
670 enum {
671         eBooleanModifierBMeshFlag_BMesh_Separate            = (1 << 0),
672         eBooleanModifierBMeshFlag_BMesh_NoDissolve          = (1 << 1),
673         eBooleanModifierBMeshFlag_BMesh_NoConnectRegions    = (1 << 2),
674 };
675
676 typedef struct MDefInfluence {
677         int vertex;
678         float weight;
679 } MDefInfluence;
680
681 typedef struct MDefCell {
682         int offset;
683         int totinfluence;
684 } MDefCell;
685
686 typedef struct MeshDeformModifierData {
687         ModifierData modifier;
688
689         struct Object *object;          /* mesh object */
690         char defgrp_name[64];           /* optional vertexgroup name, MAX_VGROUP_NAME */
691
692         short gridsize, flag, pad[2];
693
694         /* result of static binding */
695         MDefInfluence *bindinfluences;  /* influences */
696         int *bindoffsets;               /* offsets into influences array */
697         float *bindcagecos;             /* coordinates that cage was bound with */
698         int totvert, totcagevert;       /* total vertices in mesh and cage */
699
700         /* result of dynamic binding */
701         MDefCell *dyngrid;              /* grid with dynamic binding cell points */
702         MDefInfluence *dyninfluences;   /* dynamic binding vertex influences */
703         int *dynverts;                  /* is this vertex bound or not? */
704         int dyngridsize;                /* size of the dynamic bind grid */
705         int totinfluence;               /* total number of vertex influences */
706         float dyncellmin[3];            /* offset of the dynamic bind grid */
707         float dyncellwidth;             /* width of dynamic bind cell */
708         float bindmat[4][4];            /* matrix of cage at binding time */
709
710         /* deprecated storage */
711         float *bindweights;             /* deprecated inefficient storage */
712         float *bindcos;                 /* deprecated storage of cage coords */
713
714         /* runtime */
715         void (*bindfunc)(struct Scene *scene, struct MeshDeformModifierData *mmd, struct DerivedMesh *cagedm,
716                          float *vertexcos, int totvert, float cagemat[4][4]);
717 } MeshDeformModifierData;
718
719 enum {
720         MOD_MDEF_INVERT_VGROUP = (1 << 0),
721         MOD_MDEF_DYNAMIC_BIND  = (1 << 1),
722 };
723
724 enum {
725         MOD_MDEF_VOLUME   = 0,
726         MOD_MDEF_SURFACE  = 1,
727 };
728
729 typedef struct ParticleSystemModifierData {
730         ModifierData modifier;
731
732         struct ParticleSystem *psys;
733         struct DerivedMesh *dm_final;  /* Final DM - its topology may differ from orig mesh. */
734         struct DerivedMesh *dm_deformed;  /* Deformed-onle DM - its topology is same as orig mesh one. */
735         int totdmvert, totdmedge, totdmface;
736         short flag, pad;
737 } ParticleSystemModifierData;
738
739 typedef enum {
740         eParticleSystemFlag_Pars         = (1 << 0),
741         eParticleSystemFlag_psys_updated = (1 << 1),
742         eParticleSystemFlag_file_loaded  = (1 << 2),
743 } ParticleSystemModifierFlag;
744
745 typedef enum {
746         eParticleInstanceFlag_Parents   = (1 << 0),
747         eParticleInstanceFlag_Children  = (1 << 1),
748         eParticleInstanceFlag_Path      = (1 << 2),
749         eParticleInstanceFlag_Unborn    = (1 << 3),
750         eParticleInstanceFlag_Alive     = (1 << 4),
751         eParticleInstanceFlag_Dead      = (1 << 5),
752         eParticleInstanceFlag_KeepShape = (1 << 6),
753         eParticleInstanceFlag_UseSize   = (1 << 7),
754 } ParticleInstanceModifierFlag;
755
756 typedef struct ParticleInstanceModifierData {
757         ModifierData modifier;
758
759         struct Object *ob;
760         short psys, flag, axis, pad;
761         float position, random_position;
762 } ParticleInstanceModifierData;
763
764 typedef enum {
765         eExplodeFlag_CalcFaces = (1 << 0),
766         eExplodeFlag_PaSize    = (1 << 1),
767         eExplodeFlag_EdgeCut   = (1 << 2),
768         eExplodeFlag_Unborn    = (1 << 3),
769         eExplodeFlag_Alive     = (1 << 4),
770         eExplodeFlag_Dead      = (1 << 5),
771 } ExplodeModifierFlag;
772
773 typedef struct ExplodeModifierData {
774         ModifierData modifier;
775
776         int *facepa;
777         short flag, vgroup;
778         float protect;
779         char uvname[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
780 } ExplodeModifierData;
781
782 typedef struct MultiresModifierData {
783         ModifierData modifier;
784
785         char lvl, sculptlvl, renderlvl, totlvl;
786         char simple, flags, pad[2];
787 } MultiresModifierData;
788
789 typedef enum {
790         eMultiresModifierFlag_ControlEdges = (1 << 0),
791         eMultiresModifierFlag_PlainUv      = (1 << 1),
792 } MultiresModifierFlag;
793
794 typedef struct FluidsimModifierData {
795         ModifierData modifier;
796
797         struct FluidsimSettings *fss;   /* definition is in DNA_object_fluidsim_types.h */
798         struct PointCache *point_cache; /* definition is in DNA_object_force_types.h */
799 } FluidsimModifierData;
800
801 typedef struct ShrinkwrapModifierData {
802         ModifierData modifier;
803
804         struct Object *target;    /* shrink target */
805         struct Object *auxTarget; /* additional shrink target */
806         char vgroup_name[64];     /* optional vertexgroup name, MAX_VGROUP_NAME */
807         float keepDist;           /* distance offset to keep from mesh/projection point */
808         short shrinkType;         /* shrink type projection */
809         char  shrinkOpts;         /* shrink options */
810         char  pad1;
811         float projLimit;          /* limit the projection ray cast */
812         char  projAxis;           /* axis to project over */
813
814         /* If using projection over vertex normal this controls the level of subsurface that must be done
815          * before getting the vertex coordinates and normal
816          */
817         char subsurfLevels;
818
819         char pad[2];
820 } ShrinkwrapModifierData;
821
822 /* Shrinkwrap->shrinkType */
823 enum {
824         MOD_SHRINKWRAP_NEAREST_SURFACE = 0,
825         MOD_SHRINKWRAP_PROJECT         = 1,
826         MOD_SHRINKWRAP_NEAREST_VERTEX  = 2,
827 };
828
829 /* Shrinkwrap->shrinkOpts */
830 enum {
831         /* allow shrinkwrap to move the vertex in the positive direction of axis */
832         MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR = (1 << 0),
833         /* allow shrinkwrap to move the vertex in the negative direction of axis */
834         MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR = (1 << 1),
835
836         /* ignore vertex moves if a vertex ends projected on a front face of the target */
837         MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE = (1 << 3),
838         /* ignore vertex moves if a vertex ends projected on a back face of the target */
839         MOD_SHRINKWRAP_CULL_TARGET_BACKFACE  = (1 << 4),
840
841         MOD_SHRINKWRAP_KEEP_ABOVE_SURFACE    = (1 << 5),  /* distance is measure to the front face of the target */
842
843         MOD_SHRINKWRAP_INVERT_VGROUP         = (1 << 6),
844 };
845
846 /* Shrinkwrap->projAxis */
847 enum {
848         MOD_SHRINKWRAP_PROJECT_OVER_NORMAL   = 0,        /* projection over normal is used if no axis is selected */
849         MOD_SHRINKWRAP_PROJECT_OVER_X_AXIS   = (1 << 0),
850         MOD_SHRINKWRAP_PROJECT_OVER_Y_AXIS   = (1 << 1),
851         MOD_SHRINKWRAP_PROJECT_OVER_Z_AXIS   = (1 << 2),
852 };
853
854
855 typedef struct SimpleDeformModifierData {
856         ModifierData modifier;
857
858         struct Object *origin;  /* object to control the origin of modifier space coordinates */
859         char vgroup_name[64];   /* optional vertexgroup name, MAX_VGROUP_NAME */
860         float factor;           /* factors to control simple deforms */
861         float limit[2];         /* lower and upper limit */
862
863         char mode;              /* deform function */
864         char axis;              /* lock axis (for taper and strech) */
865         char deform_axis;       /* axis to perform the deform on (default is X, but can be overridden by origin */
866         char flag;
867
868 } SimpleDeformModifierData;
869
870 /* SimpleDeform->flag */
871 enum {
872         MOD_SIMPLEDEFORM_FLAG_INVERT_VGROUP = (1 << 0),
873 };
874
875
876 enum {
877         MOD_SIMPLEDEFORM_MODE_TWIST   = 1,
878         MOD_SIMPLEDEFORM_MODE_BEND    = 2,
879         MOD_SIMPLEDEFORM_MODE_TAPER   = 3,
880         MOD_SIMPLEDEFORM_MODE_STRETCH = 4,
881 };
882
883 enum {
884         MOD_SIMPLEDEFORM_LOCK_AXIS_X = (1 << 0),
885         MOD_SIMPLEDEFORM_LOCK_AXIS_Y = (1 << 1),
886         MOD_SIMPLEDEFORM_LOCK_AXIS_Z = (1 << 2),
887 };
888
889 typedef struct ShapeKeyModifierData {
890         ModifierData modifier;
891 } ShapeKeyModifierData;
892
893 typedef struct SolidifyModifierData {
894         ModifierData modifier;
895
896         char defgrp_name[64];   /* name of vertex group to use, MAX_VGROUP_NAME */
897         float offset;           /* new surface offset level*/
898         float offset_fac;       /* midpoint of the offset  */
899         /* factor for the minimum weight to use when vgroups are used, avoids 0.0 weights giving duplicate geometry */
900         float offset_fac_vg;
901         float offset_clamp;     /* clamp offset based on surrounding geometry */
902         float pad;
903         float crease_inner;
904         float crease_outer;
905         float crease_rim;
906         int flag;
907         short mat_ofs;
908         short mat_ofs_rim;
909 } SolidifyModifierData;
910
911 enum {
912         MOD_SOLIDIFY_RIM            = (1 << 0),
913         MOD_SOLIDIFY_EVEN           = (1 << 1),
914         MOD_SOLIDIFY_NORMAL_CALC    = (1 << 2),
915         MOD_SOLIDIFY_VGROUP_INV     = (1 << 3),
916 #ifdef DNA_DEPRECATED
917         MOD_SOLIDIFY_RIM_MATERIAL   = (1 << 4),  /* deprecated, used in do_versions */
918 #endif
919         MOD_SOLIDIFY_FLIP           = (1 << 5),
920         MOD_SOLIDIFY_NOSHELL        = (1 << 6),
921 };
922
923 typedef struct ScrewModifierData {
924         ModifierData modifier;
925
926         struct Object *ob_axis;
927         unsigned int steps;
928         unsigned int render_steps;
929         unsigned int iter;
930         float screw_ofs;
931         float angle;
932         float merge_dist;
933         short flag;
934         char axis;
935         char pad[5];
936 } ScrewModifierData;
937
938 enum {
939         MOD_SCREW_NORMAL_FLIP    = (1 << 0),
940         MOD_SCREW_NORMAL_CALC    = (1 << 1),
941         MOD_SCREW_OBJECT_OFFSET  = (1 << 2),
942 /*      MOD_SCREW_OBJECT_ANGLE   = (1 << 4), */
943         MOD_SCREW_SMOOTH_SHADING = (1 << 5),
944         MOD_SCREW_UV_STRETCH_U   = (1 << 6),
945         MOD_SCREW_UV_STRETCH_V   = (1 << 7),
946         MOD_SCREW_MERGE          = (1 << 8),
947 };
948
949 typedef struct OceanModifierData {
950         ModifierData modifier;
951
952         struct Ocean *ocean;
953         struct OceanCache *oceancache;
954         
955         int resolution;
956         int spatial_size;
957
958         float wind_velocity;
959
960         float damp;
961         float smallest_wave;
962         float depth;
963
964         float wave_alignment;
965         float wave_direction;
966         float wave_scale;
967
968         float chop_amount;
969         float foam_coverage;
970         float time;
971
972         int bakestart;
973         int bakeend;
974
975         char cachepath[1024];    /* FILE_MAX */
976         char foamlayername[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
977         char cached;
978         char geometry_mode;
979
980         char flag;
981         char refresh;
982
983         short repeat_x;
984         short repeat_y;
985
986         int seed;
987
988         float size;
989
990         float foam_fade;
991
992         int pad;
993 } OceanModifierData;
994
995 enum {
996         MOD_OCEAN_GEOM_GENERATE = 0,
997         MOD_OCEAN_GEOM_DISPLACE = 1,
998         MOD_OCEAN_GEOM_SIM_ONLY = 2,
999 };
1000
1001 enum {
1002         MOD_OCEAN_REFRESH_RESET        = (1 << 0),
1003         MOD_OCEAN_REFRESH_SIM          = (1 << 1),
1004         MOD_OCEAN_REFRESH_ADD          = (1 << 2),
1005         MOD_OCEAN_REFRESH_CLEAR_CACHE  = (1 << 3),
1006         MOD_OCEAN_REFRESH_TOPOLOGY     = (1 << 4),
1007 };
1008
1009 enum {
1010         MOD_OCEAN_GENERATE_FOAM     = (1 << 0),
1011         MOD_OCEAN_GENERATE_NORMALS  = (1 << 1),
1012 };
1013
1014 typedef struct WarpModifierData {
1015         ModifierData modifier;
1016         /* keep in sync with MappingInfoModifierData */
1017         struct Tex *texture;
1018         struct Object *map_object;
1019         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
1020         int uvlayer_tmp;
1021         int texmapping;
1022         /* end MappingInfoModifierData */
1023
1024         struct Object *object_from;
1025         struct Object *object_to;
1026         struct CurveMapping *curfalloff;
1027         char defgrp_name[64];  /* optional vertexgroup name, MAX_VGROUP_NAME */
1028         float strength;
1029         float falloff_radius;
1030         char flag; /* not used yet */
1031         char falloff_type;
1032         char pad[6];
1033 } WarpModifierData;
1034
1035 #define MOD_WARP_VOLUME_PRESERVE 1
1036
1037 typedef enum {
1038         eWarp_Falloff_None   = 0,
1039         eWarp_Falloff_Curve  = 1,
1040         eWarp_Falloff_Sharp  = 2, /* PROP_SHARP */
1041         eWarp_Falloff_Smooth = 3, /* PROP_SMOOTH */
1042         eWarp_Falloff_Root   = 4, /* PROP_ROOT */
1043         eWarp_Falloff_Linear = 5, /* PROP_LIN */
1044         eWarp_Falloff_Const  = 6, /* PROP_CONST */
1045         eWarp_Falloff_Sphere = 7, /* PROP_SPHERE */
1046         eWarp_Falloff_InvSquare = 8, /* PROP_INVSQUARE */
1047         /* PROP_RANDOM not used */
1048 } WarpModifierFalloff;
1049
1050 typedef struct WeightVGEditModifierData {
1051         ModifierData modifier;
1052
1053         char defgrp_name[64]; /* Name of vertex group to edit. MAX_VGROUP_NAME. */
1054
1055         short edit_flags;     /* Using MOD_WVG_EDIT_* flags. */
1056         short falloff_type;   /* Using MOD_WVG_MAPPING_* defines. */
1057         float default_weight; /* Weight for vertices not in vgroup. */
1058
1059         /* Mapping stuff. */
1060         struct CurveMapping *cmap_curve;  /* The custom mapping curve! */
1061
1062         /* The add/remove vertices weight thresholds. */
1063         float add_threshold, rem_threshold;
1064
1065         /* Masking options. */
1066         float mask_constant;        /* The global "influence", if no vgroup nor tex is used as mask. */
1067         char mask_defgrp_name[64];  /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
1068
1069         /* Texture masking. */
1070         int mask_tex_use_channel;          /* Which channel to use as weightf. */
1071         struct Tex *mask_texture;          /* The texture. */
1072         struct Object *mask_tex_map_obj;   /* Name of the map object. */
1073         int mask_tex_mapping;              /* How to map the texture (using MOD_DISP_MAP_* enums). */
1074         char mask_tex_uvlayer_name[64];    /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME */
1075
1076         /* Padding... */
1077         int pad_i1;
1078 } WeightVGEditModifierData;
1079
1080 /* WeightVGEdit flags. */
1081 enum {
1082         /* (1 << 0), (1 << 1) and (1 << 2) are free for future use! */
1083         MOD_WVG_EDIT_ADD2VG  = (1 << 3),  /* Add vertices with higher weight than threshold to vgroup. */
1084         MOD_WVG_EDIT_REMFVG  = (1 << 4),  /* Remove vertices with lower weight than threshold from vgroup. */
1085 };
1086
1087 typedef struct WeightVGMixModifierData {
1088         ModifierData modifier;
1089
1090         char defgrp_name_a[64];    /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
1091         char defgrp_name_b[64];    /* Name of other vertex group to mix in. MAX_VGROUP_NAME. */
1092         float default_weight_a;    /* Default weight value for first vgroup. */
1093         float default_weight_b;    /* Default weight value to mix in. */
1094         char mix_mode;             /* How second vgroups weights affect first ones */
1095         char mix_set;              /* What vertices to affect. */
1096
1097         char pad_c1[6];
1098
1099         /* Masking options. */
1100         float mask_constant;        /* The global "influence", if no vgroup nor tex is used as mask. */
1101         char mask_defgrp_name[64];  /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
1102
1103         /* Texture masking. */
1104         int mask_tex_use_channel;         /* Which channel to use as weightf. */
1105         struct Tex *mask_texture;         /* The texture. */
1106         struct Object *mask_tex_map_obj;  /* Name of the map object. */
1107         int mask_tex_mapping;             /* How to map the texture! */
1108         char mask_tex_uvlayer_name[64];   /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
1109
1110         /* Padding... */
1111         int pad_i1;
1112 } WeightVGMixModifierData;
1113
1114 /* How second vgroup's weights affect first ones. */
1115 enum {
1116         MOD_WVG_MIX_SET = 1,  /* Second weights replace weights. */
1117         MOD_WVG_MIX_ADD = 2,  /* Second weights are added to weights. */
1118         MOD_WVG_MIX_SUB = 3,  /* Second weights are subtracted from weights. */
1119         MOD_WVG_MIX_MUL = 4,  /* Second weights are multiplied with weights. */
1120         MOD_WVG_MIX_DIV = 5,  /* Second weights divide weights. */
1121         MOD_WVG_MIX_DIF = 6,  /* Difference between second weights and weights. */
1122         MOD_WVG_MIX_AVG = 7,  /* Average of both weights. */
1123 };
1124
1125 /* What vertices to affect. */
1126 enum {
1127         MOD_WVG_SET_ALL = 1,  /* Affect all vertices. */
1128         MOD_WVG_SET_A   = 2,  /* Affect only vertices in first vgroup. */
1129         MOD_WVG_SET_B   = 3,  /* Affect only vertices in second vgroup. */
1130         MOD_WVG_SET_OR  = 4,  /* Affect only vertices in one vgroup or the other. */
1131         MOD_WVG_SET_AND = 5,  /* Affect only vertices in both vgroups. */
1132 };
1133
1134 typedef struct WeightVGProximityModifierData {
1135         ModifierData modifier;
1136
1137         char defgrp_name[64];      /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
1138
1139         /* Proximity modes. */
1140         int proximity_mode;
1141         int proximity_flags;
1142
1143         /* Target object from which to calculate vertices distances. */
1144         struct Object *proximity_ob_target;
1145
1146         /* Masking options. */
1147         float mask_constant;        /* The global "influence", if no vgroup nor tex is used as mask. */
1148         char mask_defgrp_name[64];  /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
1149
1150         /* Texture masking. */
1151         int mask_tex_use_channel;        /* Which channel to use as weightf. */
1152         struct Tex *mask_texture;        /* The texture. */
1153         struct Object *mask_tex_map_obj; /* Name of the map object. */
1154         int mask_tex_mapping;            /* How to map the texture! */
1155         char mask_tex_uvlayer_name[64];  /* Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
1156
1157         float min_dist, max_dist;        /* Distances mapping to 0.0/1.0 weights. */
1158
1159         /* Put here to avoid breaking existing struct... */
1160         short falloff_type;              /* Using MOD_WVG_MAPPING_* enums. */
1161
1162         /* Padding... */
1163         short pad_s1;
1164 } WeightVGProximityModifierData;
1165
1166 /* Modes of proximity weighting. */
1167 enum {
1168         MOD_WVG_PROXIMITY_OBJECT    = 1,  /* source vertex to other location */
1169         MOD_WVG_PROXIMITY_GEOMETRY  = 2,  /* source vertex to other geometry */
1170 };
1171
1172 /* Flags options for proximity weighting. */
1173 enum {
1174         /* Use nearest vertices of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
1175         MOD_WVG_PROXIMITY_GEOM_VERTS  = (1 << 0),
1176         /* Use nearest edges of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
1177         MOD_WVG_PROXIMITY_GEOM_EDGES  = (1 << 1),
1178         /* Use nearest faces of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
1179         MOD_WVG_PROXIMITY_GEOM_FACES  = (1 << 2),
1180 };
1181
1182 /* Defines common to all WeightVG modifiers. */
1183 /* Mapping modes. */
1184 enum {
1185         MOD_WVG_MAPPING_NONE    = 0,
1186         MOD_WVG_MAPPING_CURVE   = 1,
1187         MOD_WVG_MAPPING_SHARP   = 2,  /* PROP_SHARP */
1188         MOD_WVG_MAPPING_SMOOTH  = 3,  /* PROP_SMOOTH */
1189         MOD_WVG_MAPPING_ROOT    = 4,  /* PROP_ROOT */
1190         /* PROP_LIN not used (same as NONE, here...). */
1191         /* PROP_CONST not used. */
1192         MOD_WVG_MAPPING_SPHERE  = 7,  /* PROP_SPHERE */
1193         MOD_WVG_MAPPING_RANDOM  = 8,  /* PROP_RANDOM */
1194         MOD_WVG_MAPPING_STEP    = 9,  /* Median Step. */
1195 };
1196
1197 /* Tex channel to be used as mask. */
1198 enum {
1199         MOD_WVG_MASK_TEX_USE_INT    = 1,
1200         MOD_WVG_MASK_TEX_USE_RED    = 2,
1201         MOD_WVG_MASK_TEX_USE_GREEN  = 3,
1202         MOD_WVG_MASK_TEX_USE_BLUE   = 4,
1203         MOD_WVG_MASK_TEX_USE_HUE    = 5,
1204         MOD_WVG_MASK_TEX_USE_SAT    = 6,
1205         MOD_WVG_MASK_TEX_USE_VAL    = 7,
1206         MOD_WVG_MASK_TEX_USE_ALPHA  = 8,
1207 };
1208
1209 typedef struct DynamicPaintModifierData {
1210         ModifierData modifier;
1211
1212         struct DynamicPaintCanvasSettings *canvas;
1213         struct DynamicPaintBrushSettings *brush;
1214         int type;  /* ui display: canvas / brush */
1215         int pad;
1216 } DynamicPaintModifierData;
1217
1218 /* Dynamic paint modifier flags */
1219 enum {
1220         MOD_DYNAMICPAINT_TYPE_CANVAS  = (1 << 0),
1221         MOD_DYNAMICPAINT_TYPE_BRUSH   = (1 << 1),
1222 };
1223
1224 /* Remesh modifier */
1225 typedef enum eRemeshModifierFlags {
1226         MOD_REMESH_FLOOD_FILL     = 1,
1227         MOD_REMESH_SMOOTH_SHADING = 2,
1228 } RemeshModifierFlags;
1229
1230 typedef enum eRemeshModifierMode {
1231         /* blocky */
1232         MOD_REMESH_CENTROID       = 0,
1233         /* smooth */
1234         MOD_REMESH_MASS_POINT     = 1,
1235         /* keeps sharp edges */
1236         MOD_REMESH_SHARP_FEATURES = 2,
1237 } eRemeshModifierMode;
1238
1239 typedef struct RemeshModifierData {
1240         ModifierData modifier;
1241
1242         /* floodfill option, controls how small components can be before they are removed */
1243         float threshold;
1244
1245         /* ratio between size of model and grid */
1246         float scale;
1247
1248         float hermite_num;
1249
1250         /* octree depth */
1251         char depth;
1252
1253         char flag;
1254         char mode;
1255         char pad;
1256 } RemeshModifierData;
1257
1258 /* Skin modifier */
1259 typedef struct SkinModifierData {
1260         ModifierData modifier;
1261
1262         float branch_smoothing;
1263
1264         char flag;
1265
1266         char symmetry_axes;
1267
1268         char pad[2];
1269 } SkinModifierData;
1270
1271 /* SkinModifierData.symmetry_axes */
1272 enum {
1273         MOD_SKIN_SYMM_X = (1 << 0),
1274         MOD_SKIN_SYMM_Y = (1 << 1),
1275         MOD_SKIN_SYMM_Z = (1 << 2),
1276 };
1277
1278 /* SkinModifierData.flag */
1279 enum {
1280         MOD_SKIN_SMOOTH_SHADING = 1,
1281 };
1282
1283 /* Triangulate modifier */
1284 typedef struct TriangulateModifierData {
1285         ModifierData modifier;
1286
1287         int flag;
1288         int quad_method;
1289         int ngon_method;
1290         int pad;
1291 } TriangulateModifierData;
1292
1293 #ifdef DNA_DEPRECATED
1294 enum {
1295         MOD_TRIANGULATE_BEAUTY = (1 << 0), /* deprecated */
1296 };
1297 #endif
1298
1299 /* Triangulate methods - NGons */
1300 enum {
1301         MOD_TRIANGULATE_NGON_BEAUTY = 0,
1302         MOD_TRIANGULATE_NGON_EARCLIP,
1303 };
1304
1305 /* Triangulate methods - Quads */
1306 enum {
1307         MOD_TRIANGULATE_QUAD_BEAUTY = 0,
1308         MOD_TRIANGULATE_QUAD_FIXED,
1309         MOD_TRIANGULATE_QUAD_ALTERNATE,
1310         MOD_TRIANGULATE_QUAD_SHORTEDGE
1311 };
1312
1313 typedef struct LaplacianSmoothModifierData {
1314         ModifierData modifier;
1315
1316         float lambda, lambda_border, pad1;
1317         char defgrp_name[64];  /* MAX_VGROUP_NAME */
1318         short flag, repeat;
1319 } LaplacianSmoothModifierData;
1320
1321 /* Smooth modifier flags */
1322 enum {
1323         MOD_LAPLACIANSMOOTH_X               = (1 << 1),
1324         MOD_LAPLACIANSMOOTH_Y               = (1 << 2),
1325         MOD_LAPLACIANSMOOTH_Z               = (1 << 3),
1326         MOD_LAPLACIANSMOOTH_PRESERVE_VOLUME = (1 << 4),
1327         MOD_LAPLACIANSMOOTH_NORMALIZED      = (1 << 5),
1328 };
1329
1330
1331 typedef struct CorrectiveSmoothModifierData {
1332         ModifierData modifier;
1333
1334         /* positions set during 'bind' operator
1335          * use for MOD_CORRECTIVESMOOTH_RESTSOURCE_BIND */
1336         float (*bind_coords)[3];
1337
1338         /* note: -1 is used to bind */
1339         unsigned int bind_coords_num;
1340
1341         float lambda;
1342         short repeat, flag;
1343         char smooth_type, rest_source;
1344         char pad[2];
1345
1346         char defgrp_name[64];  /* MAX_VGROUP_NAME */
1347
1348         /* runtime-only cache (delta's between),
1349          * delta's between the original positions and the smoothed positions */
1350         float (*delta_cache)[3];
1351         unsigned int delta_cache_num;
1352         char pad2[4];
1353 } CorrectiveSmoothModifierData;
1354
1355 enum {
1356         MOD_CORRECTIVESMOOTH_SMOOTH_SIMPLE         = 0,
1357         MOD_CORRECTIVESMOOTH_SMOOTH_LENGTH_WEIGHT    = 1,
1358 };
1359
1360 enum {
1361         MOD_CORRECTIVESMOOTH_RESTSOURCE_ORCO       = 0,
1362         MOD_CORRECTIVESMOOTH_RESTSOURCE_BIND       = 1,
1363 };
1364
1365 /* Corrective Smooth modifier flags */
1366 enum {
1367         MOD_CORRECTIVESMOOTH_INVERT_VGROUP         = (1 << 0),
1368         MOD_CORRECTIVESMOOTH_ONLY_SMOOTH           = (1 << 1),
1369         MOD_CORRECTIVESMOOTH_PIN_BOUNDARY          = (1 << 2),
1370 };
1371
1372 typedef struct UVWarpModifierData {
1373         ModifierData modifier;
1374
1375         char axis_u, axis_v;
1376         char pad[6];
1377         float center[2];            /* used for rotate/scale */
1378
1379         struct Object *object_src;  /* source */
1380         char bone_src[64];          /* optional name of bone target, MAX_ID_NAME-2 */
1381         struct Object *object_dst;  /* target */
1382         char bone_dst[64];          /* optional name of bone target, MAX_ID_NAME-2 */
1383
1384         char vgroup_name[64];       /* optional vertexgroup name, MAX_VGROUP_NAME */
1385         char uvlayer_name[64];      /* MAX_CUSTOMDATA_LAYER_NAME */
1386 } UVWarpModifierData;
1387
1388 /* cache modifier */
1389 typedef struct MeshCacheModifierData {
1390         ModifierData modifier;
1391
1392         char flag;
1393         char type;  /* file format */
1394         char time_mode;
1395         char play_mode;
1396
1397         /* axis conversion */
1398         char forward_axis;
1399         char up_axis;
1400         char flip_axis;
1401
1402         char interp;
1403
1404         float factor;
1405         char deform_mode;
1406         char pad[7];
1407
1408         /* play_mode == MOD_MESHCACHE_PLAY_CFEA */
1409         float frame_start;
1410         float frame_scale;
1411
1412         /* play_mode == MOD_MESHCACHE_PLAY_EVAL */
1413         /* we could use one float for all these but their purpose is very different */
1414         float eval_frame;
1415         float eval_time;
1416         float eval_factor;
1417
1418         char filepath[1024];  /* FILE_MAX */
1419 } MeshCacheModifierData;
1420
1421 enum {
1422         MOD_MESHCACHE_TYPE_MDD  = 1,
1423         MOD_MESHCACHE_TYPE_PC2  = 2,
1424 };
1425
1426 enum {
1427         MOD_MESHCACHE_DEFORM_OVERWRITE  = 0,
1428         MOD_MESHCACHE_DEFORM_INTEGRATE  = 1,
1429 };
1430
1431 enum {
1432         MOD_MESHCACHE_INTERP_NONE      = 0,
1433         MOD_MESHCACHE_INTERP_LINEAR    = 1,
1434 /*      MOD_MESHCACHE_INTERP_CARDINAL  = 2, */
1435 };
1436
1437 enum {
1438         MOD_MESHCACHE_TIME_FRAME   = 0,
1439         MOD_MESHCACHE_TIME_SECONDS = 1,
1440         MOD_MESHCACHE_TIME_FACTOR  = 2,
1441 };
1442
1443 enum {
1444         MOD_MESHCACHE_PLAY_CFEA = 0,
1445         MOD_MESHCACHE_PLAY_EVAL = 1,
1446 };
1447
1448
1449 typedef struct LaplacianDeformModifierData {
1450         ModifierData modifier;
1451         char anchor_grp_name[64];  /* MAX_VGROUP_NAME */
1452         int total_verts, repeat;
1453         float *vertexco;
1454         void *cache_system;  /* runtime only */
1455         short flag, pad[3];
1456
1457 } LaplacianDeformModifierData;
1458
1459 /* Smooth modifier flags */
1460 enum {
1461         MOD_LAPLACIANDEFORM_BIND = 1,
1462 };
1463
1464 /* many of these options match 'solidify' */
1465 typedef struct WireframeModifierData {
1466         ModifierData modifier;
1467         char defgrp_name[64];  /* MAX_VGROUP_NAME */
1468         float offset;
1469         float offset_fac;
1470         float offset_fac_vg;
1471         float crease_weight;
1472         short flag, mat_ofs;
1473         short pad[2];
1474 } WireframeModifierData;
1475
1476 enum {
1477         MOD_WIREFRAME_INVERT_VGROUP = (1 << 0),
1478         MOD_WIREFRAME_REPLACE       = (1 << 1),
1479         MOD_WIREFRAME_BOUNDARY      = (1 << 2),
1480         MOD_WIREFRAME_OFS_EVEN      = (1 << 3),
1481         MOD_WIREFRAME_OFS_RELATIVE  = (1 << 4),
1482         MOD_WIREFRAME_CREASE        = (1 << 5),
1483 };
1484
1485
1486 typedef struct DataTransferModifierData {
1487         ModifierData modifier;
1488
1489         struct Object *ob_source;
1490
1491         int data_types;  /* See DT_TYPE_ enum in ED_object.h */
1492
1493         /* See MREMAP_MODE_ enum in BKE_mesh_mapping.h */
1494         int vmap_mode;
1495         int emap_mode;
1496         int lmap_mode;
1497         int pmap_mode;
1498
1499         float map_max_distance;
1500         float map_ray_radius;
1501         float islands_precision;
1502
1503         int pad_i1;
1504
1505         int layers_select_src[4];  /* DT_MULTILAYER_INDEX_MAX; See DT_FROMLAYERS_ enum in ED_object.h */
1506         int layers_select_dst[4];  /* DT_MULTILAYER_INDEX_MAX; See DT_TOLAYERS_ enum in ED_object.h */
1507
1508         int mix_mode;  /* See CDT_MIX_ enum in BKE_customdata.h */
1509         float mix_factor;
1510         char defgrp_name[64];  /* MAX_VGROUP_NAME */
1511
1512         int flags;
1513 } DataTransferModifierData;
1514
1515 /* DataTransferModifierData.flags */
1516 enum {
1517         MOD_DATATRANSFER_OBSRC_TRANSFORM  = 1 << 0,
1518         MOD_DATATRANSFER_MAP_MAXDIST      = 1 << 1,
1519         MOD_DATATRANSFER_INVERT_VGROUP    = 1 << 2,
1520
1521         /* Only for UI really. */
1522         MOD_DATATRANSFER_USE_VERT         = 1 << 28,
1523         MOD_DATATRANSFER_USE_EDGE         = 1 << 29,
1524         MOD_DATATRANSFER_USE_LOOP         = 1 << 30,
1525         MOD_DATATRANSFER_USE_POLY         = 1u << 31,
1526 };
1527
1528 /* Set Split Normals modifier */
1529 typedef struct NormalEditModifierData {
1530         ModifierData modifier;
1531         char defgrp_name[64];  /* MAX_VGROUP_NAME */
1532         struct Object *target;  /* Source of normals, or center of ellipsoid. */
1533         short mode;
1534         short flag;
1535         short mix_mode;
1536         char pad[2];
1537         float mix_factor;
1538         float mix_limit;
1539         float offset[3];
1540         float pad_f1;
1541 } NormalEditModifierData;
1542
1543 /* NormalEditModifierData.mode */
1544 enum {
1545         MOD_NORMALEDIT_MODE_RADIAL        = 0,
1546         MOD_NORMALEDIT_MODE_DIRECTIONAL   = 1,
1547 };
1548
1549 /* NormalEditModifierData.flags */
1550 enum {
1551         MOD_NORMALEDIT_INVERT_VGROUP            = (1 << 0),
1552         MOD_NORMALEDIT_USE_DIRECTION_PARALLEL   = (1 << 1),
1553 };
1554
1555 /* NormalEditModifierData.mix_mode */
1556 enum {
1557         MOD_NORMALEDIT_MIX_COPY = 0,
1558         MOD_NORMALEDIT_MIX_ADD  = 1,
1559         MOD_NORMALEDIT_MIX_SUB  = 2,
1560         MOD_NORMALEDIT_MIX_MUL  = 3,
1561 };
1562
1563 typedef struct MeshSeqCacheModifierData {
1564         ModifierData modifier;
1565
1566         struct CacheFile *cache_file;
1567         struct CacheReader *reader;
1568         char object_path[1024];  /* 1024 = FILE_MAX */
1569
1570         char read_flag;
1571         char pad[7];
1572 } MeshSeqCacheModifierData;
1573
1574 /* MeshSeqCacheModifierData.read_flag */
1575 enum {
1576         MOD_MESHSEQ_READ_VERT  = (1 << 0),
1577         MOD_MESHSEQ_READ_POLY  = (1 << 1),
1578         MOD_MESHSEQ_READ_UV    = (1 << 2),
1579         MOD_MESHSEQ_READ_COLOR = (1 << 3),
1580 };
1581
1582 typedef struct SDefBind {
1583         unsigned int *vert_inds;
1584         unsigned int numverts;
1585         int mode;
1586         float *vert_weights;
1587         float normal_dist;
1588         float influence;
1589 } SDefBind;
1590
1591 typedef struct SDefVert {
1592         SDefBind *binds;
1593         unsigned int numbinds;
1594         char pad[4];
1595 } SDefVert;
1596
1597 typedef struct SurfaceDeformModifierData {
1598         ModifierData modifier;
1599
1600         struct Object *target;  /* bind target object */
1601         SDefVert *verts;                /* vertex bind data */
1602         float falloff;
1603         unsigned int numverts, numpoly;
1604         int flags;
1605         float mat[4][4];
1606 } SurfaceDeformModifierData;
1607
1608 /* Surface Deform modifier flags */
1609 enum {
1610         MOD_SDEF_BIND = (1 << 0),
1611         MOD_SDEF_USES_LOOPTRI = (1 << 1),
1612         MOD_SDEF_HAS_CONCAVE = (1 << 2),
1613 };
1614
1615 /* Surface Deform vertex bind modes */
1616 enum {
1617         MOD_SDEF_MODE_LOOPTRI = 0,
1618         MOD_SDEF_MODE_NGON = 1,
1619         MOD_SDEF_MODE_CENTROID = 2,
1620 };
1621
1622 #define MOD_MESHSEQ_READ_ALL \
1623         (MOD_MESHSEQ_READ_VERT | MOD_MESHSEQ_READ_POLY | MOD_MESHSEQ_READ_UV | MOD_MESHSEQ_READ_COLOR)
1624
1625 #endif  /* __DNA_MODIFIER_TYPES_H__ */