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