add option for decimate-collapse to keep triangulated geometry (normally quads stay...
[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;  /* (mode == MOD_DECIM_MODE_COLLAPSE) */
365         short   iter;   /* (mode == MOD_DECIM_MODE_UNSUBDIV) */
366         short   pad;
367         float   angle;  /* (mode == MOD_DECIM_MODE_DISSOLVE) */
368
369         char defgrp_name[64];   /* MAX_VGROUP_NAME */
370         short flag, mode;
371
372         /* runtime only */
373         int face_count;
374 } DecimateModifierData;
375
376 enum {
377         MOD_DECIM_FLAG_INVERT_VGROUP = (1 << 0),
378         MOD_DECIM_FLAG_TRIANGULATE   = (1 << 1)   /* for collapse only. dont convert tri pairs back to quads */
379 };
380
381 enum {
382         MOD_DECIM_MODE_COLLAPSE,
383         MOD_DECIM_MODE_UNSUBDIV,
384         MOD_DECIM_MODE_DISSOLVE   /* called planar in the UI */
385 };
386
387 /* Smooth modifier flags */
388 #define MOD_SMOOTH_X (1<<1)
389 #define MOD_SMOOTH_Y (1<<2)
390 #define MOD_SMOOTH_Z (1<<3)
391
392 typedef struct SmoothModifierData {
393         ModifierData modifier;
394         float fac;
395         char defgrp_name[64];   /* MAX_VGROUP_NAME */
396         short flag, repeat;
397
398 } SmoothModifierData;
399
400 /* Cast modifier flags */
401 #define MOD_CAST_X (1<<1)
402 #define MOD_CAST_Y (1<<2)
403 #define MOD_CAST_Z (1<<3)
404 #define MOD_CAST_USE_OB_TRANSFORM (1<<4)
405 #define MOD_CAST_SIZE_FROM_RADIUS (1<<5)
406
407 /* Cast modifier projection types */
408 #define MOD_CAST_TYPE_SPHERE 0
409 #define MOD_CAST_TYPE_CYLINDER 1
410 #define MOD_CAST_TYPE_CUBOID 2
411
412 typedef struct CastModifierData {
413         ModifierData modifier;
414
415         struct Object *object;
416         float fac;
417         float radius;
418         float size;
419         char defgrp_name[64];   /* MAX_VGROUP_NAME */
420         short flag, type;
421 } CastModifierData;
422
423 /* WaveModifierData.flag */
424 #define MOD_WAVE_X      (1<<1)
425 #define MOD_WAVE_Y      (1<<2)
426 #define MOD_WAVE_CYCL   (1<<3)
427 #define MOD_WAVE_NORM   (1<<4)
428 #define MOD_WAVE_NORM_X (1<<5)
429 #define MOD_WAVE_NORM_Y (1<<6)
430 #define MOD_WAVE_NORM_Z (1<<7)
431
432 typedef struct WaveModifierData {
433         ModifierData modifier;
434
435         /* keep in sync with MappingInfoModifierData */
436         struct Tex *texture;
437         struct Object *map_object;
438         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
439         int uvlayer_tmp;
440         int texmapping;
441         /* end MappingInfoModifierData */
442
443         struct Object *objectcenter;
444         char defgrp_name[64];   /* MAX_VGROUP_NAME */
445
446         short flag, pad;
447
448         float startx, starty, height, width;
449         float narrow, speed, damp, falloff;
450
451         float timeoffs, lifetime;
452         float pad1;
453 } WaveModifierData;
454
455 typedef struct ArmatureModifierData {
456         ModifierData modifier;
457
458         short deformflag, multi;                /* deformflag replaces armature->deformflag */
459         int pad2;
460         struct Object *object;
461         float *prevCos;         /* stored input of previous modifier, for vertexgroup blending */
462         char defgrp_name[64];   /* MAX_VGROUP_NAME */
463 } ArmatureModifierData;
464
465 typedef struct HookModifierData {
466         ModifierData modifier;
467
468         struct Object *object;
469         char subtarget[64];             /* optional name of bone target, MAX_ID_NAME-2 */
470         
471         float parentinv[4][4];  /* matrix making current transform unmodified */
472         float cent[3];                  /* visualization of hook */
473         float falloff;                  /* if not zero, falloff is distance where influence zero */
474         
475         int *indexar;                   /* if NULL, it's using vertexgroup */
476         int totindex;
477         float force;
478         char name[64];                  /* optional vertexgroup name, MAX_VGROUP_NAME */
479 } HookModifierData;
480
481 typedef struct SoftbodyModifierData {
482         ModifierData modifier;
483 } SoftbodyModifierData;
484
485 typedef struct ClothModifierData {
486         ModifierData            modifier;
487
488         struct Scene *scene;                    /* the context, time etc is here */
489         struct Cloth *clothObject;              /* The internal data structure for cloth. */
490         struct ClothSimSettings *sim_parms; /* definition is in DNA_cloth_types.h */
491         struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
492         struct PointCache *point_cache; /* definition is in DNA_object_force.h */
493         struct ListBase ptcaches;
494 } ClothModifierData;
495
496 typedef struct CollisionModifierData {
497         ModifierData    modifier;
498         
499         struct MVert *x; /* position at the beginning of the frame */
500         struct MVert *xnew; /* position at the end of the frame */
501         struct MVert *xold; /* unsued atm, but was discussed during sprint */
502         struct MVert *current_xnew; /* new position at the actual inter-frame step */
503         struct MVert *current_x; /* position at the actual inter-frame step */
504         struct MVert *current_v; /* (xnew - x) at the actual inter-frame step */
505         
506         struct MFace *mfaces; /* object face data */
507         
508         unsigned int numverts;
509         unsigned int numfaces;
510         float time_x, time_xnew;                /* cfra time of modifier */
511         struct BVHTree *bvhtree; /* bounding volume hierarchy for this cloth object */
512 } CollisionModifierData;
513
514 typedef struct SurfaceModifierData {
515         ModifierData    modifier;
516
517         struct MVert *x; /* old position */
518         struct MVert *v; /* velocity */
519
520         struct DerivedMesh *dm;
521
522         struct BVHTreeFromMesh *bvhtree; /* bounding volume hierarchy of the mesh faces */
523
524         int cfra, numverts;
525 } SurfaceModifierData;
526
527 typedef enum {
528         eBooleanModifierOp_Intersect = 0,
529         eBooleanModifierOp_Union = 1,
530         eBooleanModifierOp_Difference = 2,
531 } BooleanModifierOp;
532 typedef struct BooleanModifierData {
533         ModifierData modifier;
534
535         struct Object *object;
536         int operation, pad;
537 } BooleanModifierData;
538
539 #define MOD_MDEF_INVERT_VGROUP  (1<<0)
540 #define MOD_MDEF_DYNAMIC_BIND   (1<<1)
541
542 #define MOD_MDEF_VOLUME                 0
543 #define MOD_MDEF_SURFACE                1
544
545 typedef struct MDefInfluence {
546         int vertex;
547         float weight;
548 } MDefInfluence;
549
550 typedef struct MDefCell {
551         int offset;
552         int totinfluence;
553 } MDefCell;
554
555 typedef struct MeshDeformModifierData {
556         ModifierData modifier;
557
558         struct Object *object;                  /* mesh object */
559         char defgrp_name[64];                   /* optional vertexgroup name, MAX_VGROUP_NAME */
560
561         short gridsize, flag, mode, pad;
562
563         /* result of static binding */
564         MDefInfluence *bindinfluences;  /* influences */
565         int *bindoffsets;                               /* offsets into influences array */
566         float *bindcagecos;                             /* coordinates that cage was bound with */
567         int totvert, totcagevert;               /* total vertices in mesh and cage */
568
569         /* result of dynamic binding */
570         MDefCell *dyngrid;                              /* grid with dynamic binding cell points */
571         MDefInfluence *dyninfluences;   /* dynamic binding vertex influences */
572         int *dynverts, *pad2;                   /* is this vertex bound or not? */
573         int dyngridsize;                                /* size of the dynamic bind grid */
574         int totinfluence;                               /* total number of vertex influences */
575         float dyncellmin[3];                    /* offset of the dynamic bind grid */
576         float dyncellwidth;                             /* width of dynamic bind cell */
577         float bindmat[4][4];                    /* matrix of cage at binding time */
578
579         /* deprecated storage */
580         float *bindweights;                             /* deprecated inefficient storage */
581         float *bindcos;                                 /* deprecated storage of cage coords */
582
583         /* runtime */
584         void (*bindfunc)(struct Scene *scene,
585                 struct MeshDeformModifierData *mmd,
586                 float *vertexcos, int totvert, float cagemat[][4]);
587 } MeshDeformModifierData;
588
589 typedef enum {
590         eParticleSystemFlag_Pars =                      (1<<0),
591         eParticleSystemFlag_psys_updated =      (1<<1),
592         eParticleSystemFlag_file_loaded =       (1<<2),
593 } ParticleSystemModifierFlag;
594
595 typedef struct ParticleSystemModifierData {
596         ModifierData modifier;
597         struct ParticleSystem *psys;
598         struct DerivedMesh *dm;
599         int totdmvert, totdmedge, totdmface;
600         short flag, rt;
601 } ParticleSystemModifierData;
602
603 typedef enum {
604         eParticleInstanceFlag_Parents =         (1<<0),
605         eParticleInstanceFlag_Children =        (1<<1),
606         eParticleInstanceFlag_Path =            (1<<2),
607         eParticleInstanceFlag_Unborn =          (1<<3),
608         eParticleInstanceFlag_Alive =           (1<<4),
609         eParticleInstanceFlag_Dead =            (1<<5),
610         eParticleInstanceFlag_KeepShape =       (1<<6),
611         eParticleInstanceFlag_UseSize =         (1<<7),
612 } ParticleInstanceModifierFlag;
613
614 typedef struct ParticleInstanceModifierData {
615         ModifierData modifier;
616         struct Object *ob;
617         short psys, flag, axis, rt;
618         float position, random_position;
619 } ParticleInstanceModifierData;
620
621 typedef enum {
622         eExplodeFlag_CalcFaces =        (1<<0),
623         eExplodeFlag_PaSize =           (1<<1),
624         eExplodeFlag_EdgeCut =          (1<<2),
625         eExplodeFlag_Unborn =           (1<<3),
626         eExplodeFlag_Alive =            (1<<4),
627         eExplodeFlag_Dead =                     (1<<5),
628 } ExplodeModifierFlag;
629
630 typedef struct ExplodeModifierData {
631         ModifierData modifier;
632         int *facepa;
633         short flag, vgroup;
634         float protect;
635         char uvname[64];        /* MAX_CUSTOMDATA_LAYER_NAME */
636 } ExplodeModifierData;
637
638 typedef struct MultiresModifierData {
639         ModifierData modifier;
640
641         char lvl, sculptlvl, renderlvl, totlvl;
642         char simple, flags, pad[2];
643 } MultiresModifierData;
644
645 typedef enum {
646         eMultiresModifierFlag_ControlEdges = (1<<0),
647         eMultiresModifierFlag_PlainUv = (1<<1),
648 } MultiresModifierFlag;
649
650 typedef struct FluidsimModifierData {
651         ModifierData modifier;
652         
653         struct FluidsimSettings *fss; /* definition is in DNA_object_fluidsim.h */
654         struct PointCache *point_cache; /* definition is in DNA_object_force.h */
655 } FluidsimModifierData;
656
657 typedef struct ShrinkwrapModifierData {
658         ModifierData modifier;
659
660         struct Object *target;  /* shrink target */
661         struct Object *auxTarget; /* additional shrink target */
662         char vgroup_name[64];   /* optional vertexgroup name, MAX_VGROUP_NAME */
663         float keepDist;                 /* distance offset to keep from mesh/projection point */
664         short shrinkType;               /* shrink type projection */
665         short shrinkOpts;               /* shrink options */
666         char projAxis;                  /* axis to project over */
667
668         /*
669          * if using projection over vertex normal this controls the
670          * the level of subsurface that must be done before getting the
671          * vertex coordinates and normal
672          */
673         char subsurfLevels;
674
675         char pad[6];
676
677 } ShrinkwrapModifierData;
678
679 /* Shrinkwrap->shrinkType */
680 #define MOD_SHRINKWRAP_NEAREST_SURFACE  0
681 #define MOD_SHRINKWRAP_PROJECT                  1
682 #define MOD_SHRINKWRAP_NEAREST_VERTEX   2
683
684 /* Shrinkwrap->shrinkOpts */
685 #define MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR    (1<<0)  /* allow shrinkwrap to move the vertex in the positive direction of axis */
686 #define MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR    (1<<1)  /* allow shrinkwrap to move the vertex in the negative direction of axis */
687
688 #define MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE    (1<<3)  /* ignore vertex moves if a vertex ends projected on a front face of the target */
689 #define MOD_SHRINKWRAP_CULL_TARGET_BACKFACE             (1<<4)  /* ignore vertex moves if a vertex ends projected on a back face of the target */
690
691 #define MOD_SHRINKWRAP_KEEP_ABOVE_SURFACE               (1<<5)  /* distance is measure to the front face of the target */
692
693 #define MOD_SHRINKWRAP_PROJECT_OVER_X_AXIS              (1<<0)
694 #define MOD_SHRINKWRAP_PROJECT_OVER_Y_AXIS              (1<<1)
695 #define MOD_SHRINKWRAP_PROJECT_OVER_Z_AXIS              (1<<2)
696 #define MOD_SHRINKWRAP_PROJECT_OVER_NORMAL                      0       /* projection over normal is used if no axis is selected */
697
698
699 typedef struct SimpleDeformModifierData {
700         ModifierData modifier;
701
702         struct Object *origin;  /* object to control the origin of modifier space coordinates */
703         char vgroup_name[64];   /* optional vertexgroup name, MAX_VGROUP_NAME */
704         float factor;                   /* factors to control simple deforms */
705         float limit[2];                 /* lower and upper limit */
706
707         char mode;                              /* deform function */
708         char axis;                              /* lock axis (for taper and strech) */
709         char originOpts;                /* originOptions */
710         char pad;
711
712 } SimpleDeformModifierData;
713
714 #define MOD_SIMPLEDEFORM_MODE_TWIST             1
715 #define MOD_SIMPLEDEFORM_MODE_BEND              2
716 #define MOD_SIMPLEDEFORM_MODE_TAPER             3
717 #define MOD_SIMPLEDEFORM_MODE_STRETCH   4
718
719 #define MOD_SIMPLEDEFORM_LOCK_AXIS_X                    (1<<0)
720 #define MOD_SIMPLEDEFORM_LOCK_AXIS_Y                    (1<<1)
721
722 /* indicates whether simple deform should use the local
723  * coordinates or global coordinates of origin */
724 /* XXX, this should have never been an option, all other modifiers work relatively
725  * (so moving both objects makes no change!) - Campbell */
726 #define MOD_SIMPLEDEFORM_ORIGIN_LOCAL                   (1<<0)
727
728 #define MOD_UVPROJECT_MAX                               10
729
730 typedef struct ShapeKeyModifierData {
731         ModifierData modifier;
732 } ShapeKeyModifierData;
733
734 typedef struct SolidifyModifierData {
735         ModifierData modifier;
736
737         char defgrp_name[64];   /* name of vertex group to use, MAX_VGROUP_NAME */
738         float offset;                   /* new surface offset level*/
739         float offset_fac;               /* midpoint of the offset  */
740         float offset_fac_vg;    /* factor for the minimum weight to use when vgroups are used, avoids 0.0 weights giving duplicate geometry */
741         float crease_inner;
742         float crease_outer;
743         float crease_rim;
744         int flag;
745         short mat_ofs;
746         short mat_ofs_rim;
747 } SolidifyModifierData;
748
749 #define MOD_SOLIDIFY_RIM            (1 << 0)
750 #define MOD_SOLIDIFY_EVEN           (1 << 1)
751 #define MOD_SOLIDIFY_NORMAL_CALC    (1 << 2)
752 #define MOD_SOLIDIFY_VGROUP_INV     (1 << 3)
753 #define MOD_SOLIDIFY_RIM_MATERIAL   (1 << 4) /* deprecated, used in do_versions */
754 #define MOD_SOLIDIFY_FLIP           (1 << 5)
755
756 typedef struct ScrewModifierData {
757         ModifierData modifier;
758         struct Object *ob_axis;
759         int             steps;
760         int             render_steps;
761         int             iter;
762         float   screw_ofs;
763         float   angle;
764         short   axis;
765         short   flag;
766 } ScrewModifierData;
767
768 #define MOD_SCREW_NORMAL_FLIP    (1 << 0)
769 #define MOD_SCREW_NORMAL_CALC    (1 << 1)
770 #define MOD_SCREW_OBJECT_OFFSET  (1 << 2)
771 // #define MOD_SCREW_OBJECT_ANGLE       (1 << 4)
772 #define MOD_SCREW_SMOOTH_SHADING (1 << 5)
773
774 typedef struct OceanModifierData {
775         ModifierData modifier;
776         
777         struct Ocean *ocean;
778         struct OceanCache *oceancache;
779         
780         int             resolution;
781         int             spatial_size;
782         
783         float   wind_velocity;
784         
785         float   damp;
786         float   smallest_wave;
787         float   depth;
788         
789         float   wave_alignment;
790         float   wave_direction;
791         float   wave_scale;
792         
793         float   chop_amount;
794         float   foam_coverage;
795         float   time;
796         
797         int             bakestart;
798         int             bakeend;
799         
800         char    cachepath[1024];        // FILE_MAX
801         char    foamlayername[64];      /* MAX_CUSTOMDATA_LAYER_NAME */
802         char    cached;
803         char    geometry_mode;
804
805         char    flag;
806         char    refresh;
807
808         short   repeat_x;
809         short   repeat_y;
810
811         int             seed;
812
813         float   size;
814         
815         float   foam_fade;
816
817         int pad;
818
819 } OceanModifierData;
820
821 #define MOD_OCEAN_GEOM_GENERATE 0
822 #define MOD_OCEAN_GEOM_DISPLACE 1
823 #define MOD_OCEAN_GEOM_SIM_ONLY 2
824
825 #define MOD_OCEAN_REFRESH_RESET                 1
826 #define MOD_OCEAN_REFRESH_SIM                   2
827 #define MOD_OCEAN_REFRESH_ADD                   4
828 #define MOD_OCEAN_REFRESH_CLEAR_CACHE   8
829 #define MOD_OCEAN_REFRESH_TOPOLOGY              16
830
831 #define MOD_OCEAN_GENERATE_FOAM 1
832 #define MOD_OCEAN_GENERATE_NORMALS      2
833
834
835 typedef struct WarpModifierData {
836         ModifierData modifier;
837         /* keep in sync with MappingInfoModifierData */
838         struct Tex *texture;
839         struct Object *map_object;
840         char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
841         int uvlayer_tmp;
842         int texmapping;
843         /* end MappingInfoModifierData */
844
845         struct Object *object_from;
846         struct Object *object_to;
847         struct CurveMapping *curfalloff;
848         char defgrp_name[64];                   /* optional vertexgroup name, MAX_VGROUP_NAME */
849         float strength;
850         float falloff_radius;
851         char flag; /* not used yet */
852         char falloff_type;
853         char pad[6];
854 } WarpModifierData;
855
856 #define MOD_WARP_VOLUME_PRESERVE 1
857
858 typedef enum {
859         eWarp_Falloff_None =            0,
860         eWarp_Falloff_Curve =           1,
861         eWarp_Falloff_Sharp =           2, /* PROP_SHARP */
862         eWarp_Falloff_Smooth =          3, /* PROP_SMOOTH */
863         eWarp_Falloff_Root =            4, /* PROP_ROOT */
864         eWarp_Falloff_Linear =          5, /* PROP_LIN */
865         eWarp_Falloff_Const =           6, /* PROP_CONST */
866         eWarp_Falloff_Sphere =          7, /* PROP_SPHERE */
867         /* PROP_RANDOM not used */
868 } WarpModifierFalloff;
869
870 typedef struct WeightVGEditModifierData {
871         ModifierData modifier;
872
873         /* Note: I tried to keep everything logically ordered - provided the
874          * alignment constraints... */
875
876         char    defgrp_name[64];      /* Name of vertex group to edit. MAX_VGROUP_NAME. */
877
878         short   edit_flags;     /* Using MOD_WVG_EDIT_* flags. */
879         short   falloff_type;   /* Using MOD_WVG_MAPPING_* defines. */
880         float   default_weight; /* Weight for vertices not in vgroup. */
881
882         /* Mapping stuff. */
883         struct CurveMapping *cmap_curve;  /* The custom mapping curve! */
884
885         /* The add/remove vertices weight thresholds. */
886         float   add_threshold, rem_threshold;
887
888         /* Masking options. */
889         float   mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
890         /* Name of mask vertex group from which to get weight factors. */
891         char    mask_defgrp_name[64];   /* MAX_VGROUP_NAME */
892
893         /* Texture masking. */
894         int             mask_tex_use_channel;      /* Which channel to use as weightf. */
895         struct Tex *mask_texture;          /* The texture. */
896         struct Object *mask_tex_map_obj;   /* Name of the map object. */
897         /* How to map the texture (using MOD_DISP_MAP_* constants). */
898         int             mask_tex_mapping;
899         char    mask_tex_uvlayer_name[64]; /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME */
900
901         /* Padding... */
902         int pad_i1;
903 } WeightVGEditModifierData;
904
905 /* WeightVGEdit flags. */
906 /* Use parametric mapping. */
907 //#define MOD_WVG_EDIT_MAP                                      (1 << 0)
908 /* Use curve mapping. */
909 //#define MOD_WVG_EDIT_CMAP                                     (1 << 1)
910 /* Reverse weights (in the [0.0, 1.0] standard range). */
911 //#define MOD_WVG_EDIT_REVERSE_WEIGHTS          (1 << 2)
912 /* Add vertices with higher weight than threshold to vgroup. */
913 #define MOD_WVG_EDIT_ADD2VG                                     (1 << 3)
914 /* Remove vertices with lower weight than threshold from vgroup. */
915 #define MOD_WVG_EDIT_REMFVG                                     (1 << 4)
916 /* Clamp weights. */
917 //#define MOD_WVG_EDIT_CLAMP                                    (1 << 5)
918
919 typedef struct WeightVGMixModifierData {
920         ModifierData modifier;
921
922         /* XXX Note: I tried to keep everything logically ordered - provided the
923          *           alignment constraints... */
924
925         char    defgrp_name_a[64];      /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
926         char    defgrp_name_b[64];     /* Name of other vertex group to mix in. MAX_VGROUP_NAME. */
927         float   default_weight_a;       /* Default weight value for first vgroup. */
928         float   default_weight_b;      /* Default weight value to mix in. */
929         char    mix_mode;             /* How second vgroups weights affect first ones */
930         char    mix_set;              /* What vertices to affect. */
931
932         char    pad_c1[6];
933
934         /* Masking options. */
935         float   mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
936         /* Name of mask vertex group from which to get weight factors. */
937         char    mask_defgrp_name[64];   /* MAX_VGROUP_NAME */
938
939         /* Texture masking. */
940         int             mask_tex_use_channel;      /* Which channel to use as weightf. */
941         struct Tex *mask_texture;          /* The texture. */
942         struct Object *mask_tex_map_obj;   /* Name of the map object. */
943         int             mask_tex_mapping;          /* How to map the texture! */
944         char    mask_tex_uvlayer_name[64]; /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
945
946         /* Padding... */
947         int pad_i1;
948 } WeightVGMixModifierData;
949
950 /* How second vgroup's weights affect first ones. */
951 #define MOD_WVG_MIX_SET                 1 /* Second weights replace weights. */
952 #define MOD_WVG_MIX_ADD                 2 /* Second weights are added to weights. */
953 #define MOD_WVG_MIX_SUB                 3 /* Second weights are subtracted from weights. */
954 #define MOD_WVG_MIX_MUL                 4 /* Second weights are multiplied with weights. */
955 #define MOD_WVG_MIX_DIV                 5 /* Second weights divide weights. */
956 #define MOD_WVG_MIX_DIF                 6 /* Difference between second weights and weights. */
957 #define MOD_WVG_MIX_AVG                 7 /* Average of both weights. */
958
959 /* What vertices to affect. */
960 #define MOD_WVG_SET_ALL                 1 /* Affect all vertices. */
961 #define MOD_WVG_SET_A                   2 /* Affect only vertices in first vgroup. */
962 #define MOD_WVG_SET_B                   3 /* Affect only vertices in second vgroup. */
963 #define MOD_WVG_SET_OR                  4 /* Affect only vertices in one vgroup or the other. */
964 #define MOD_WVG_SET_AND                 5 /* Affect only vertices in both vgroups. */
965
966 typedef struct WeightVGProximityModifierData {
967         ModifierData modifier;
968
969         /* Note: I tried to keep everything logically ordered - provided the
970          * alignment constraints... */
971
972         char    defgrp_name[64];      /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
973
974         /* Proximity modes. */
975         int             proximity_mode;
976         int             proximity_flags;
977
978         /* Target object from which to calculate vertices distances. */
979         struct Object *proximity_ob_target;
980
981         /* Masking options. */
982         float   mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
983         /* Name of mask vertex group from which to get weight factors. */
984         char    mask_defgrp_name[64];   /* MAX_VGROUP_NAME */
985
986         /* Texture masking. */
987         int             mask_tex_use_channel;      /* Which channel to use as weightf. */
988         struct Tex *mask_texture;          /* The texture. */
989         struct Object *mask_tex_map_obj;   /* Name of the map object. */
990         int             mask_tex_mapping;          /* How to map the texture! */
991         char    mask_tex_uvlayer_name[64]; /* Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
992
993         float   min_dist, max_dist;        /* Distances mapping to 0.0/1.0 weights. */
994
995         /* Put here to avoid breaking existing struct... */
996         short   falloff_type;              /* Using MOD_WVG_MAPPING_* defines. */
997
998         /* Padding... */
999         short pad_s1;
1000 } WeightVGProximityModifierData;
1001
1002 /* Modes of proximity weighting. */
1003 /* Dist from target object to affected object. */
1004 #define MOD_WVG_PROXIMITY_OBJECT                        1 /* source vertex to other location */
1005 /* Dist from target object to vertex. */
1006 #define MOD_WVG_PROXIMITY_GEOMETRY                      2 /* source vertex to other geometry */
1007
1008 /* Flags options for proximity weighting. */
1009 /* Use nearest vertices of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
1010 #define MOD_WVG_PROXIMITY_GEOM_VERTS            (1 << 0)
1011 /* Use nearest edges of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
1012 #define MOD_WVG_PROXIMITY_GEOM_EDGES            (1 << 1)
1013 /* Use nearest faces of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */
1014 #define MOD_WVG_PROXIMITY_GEOM_FACES            (1 << 2)
1015
1016 /* Defines common to all WeightVG modifiers. */
1017 /* Mapping modes. */
1018 #define MOD_WVG_MAPPING_NONE                            0
1019 #define MOD_WVG_MAPPING_CURVE                           1
1020 #define MOD_WVG_MAPPING_SHARP                           2 /* PROP_SHARP */
1021 #define MOD_WVG_MAPPING_SMOOTH                          3 /* PROP_SMOOTH */
1022 #define MOD_WVG_MAPPING_ROOT                            4 /* PROP_ROOT */
1023 /* PROP_LIN not used (same as NONE, here...). */
1024 /* PROP_CONST not used. */
1025 #define MOD_WVG_MAPPING_SPHERE                          7 /* PROP_SPHERE */
1026 #define MOD_WVG_MAPPING_RANDOM                          8 /* PROP_RANDOM */
1027 #define MOD_WVG_MAPPING_STEP                            9 /* Median Step. */
1028
1029 /* Tex channel to be used as mask. */
1030 #define MOD_WVG_MASK_TEX_USE_INT                        1
1031 #define MOD_WVG_MASK_TEX_USE_RED                        2
1032 #define MOD_WVG_MASK_TEX_USE_GREEN                      3
1033 #define MOD_WVG_MASK_TEX_USE_BLUE                       4
1034 #define MOD_WVG_MASK_TEX_USE_HUE                        5
1035 #define MOD_WVG_MASK_TEX_USE_SAT                        6
1036 #define MOD_WVG_MASK_TEX_USE_VAL                        7
1037 #define MOD_WVG_MASK_TEX_USE_ALPHA                      8
1038
1039 /* Dynamic paint modifier flags */
1040 #define MOD_DYNAMICPAINT_TYPE_CANVAS (1 << 0)
1041 #define MOD_DYNAMICPAINT_TYPE_BRUSH (1 << 1)
1042
1043 typedef struct DynamicPaintModifierData {
1044         ModifierData modifier;
1045
1046         struct DynamicPaintCanvasSettings *canvas;
1047         struct DynamicPaintBrushSettings *brush;
1048         int type;  /* ui display: canvas / brush */
1049         int pad;
1050 } DynamicPaintModifierData;
1051
1052 /* Remesh modifier */
1053
1054 typedef enum RemeshModifierFlags {
1055         MOD_REMESH_FLOOD_FILL = 1,
1056         MOD_REMESH_SMOOTH_SHADING = 2,
1057 } RemeshModifierFlags;
1058
1059 typedef enum RemeshModifierMode {
1060         /* blocky */
1061         MOD_REMESH_CENTROID = 0,
1062         /* smooth */
1063         MOD_REMESH_MASS_POINT = 1,
1064         /* keeps sharp edges */
1065         MOD_REMESH_SHARP_FEATURES = 2,
1066 } RemeshModifierMode;
1067
1068 typedef struct RemeshModifierData {
1069         ModifierData modifier;
1070
1071         /* floodfill option, controls how small components can be
1072          * before they are removed */
1073         float threshold;
1074
1075         /* ratio between size of model and grid */
1076         float scale;
1077
1078         float hermite_num;
1079
1080         /* octree depth */
1081         char depth;
1082
1083         char flag;
1084         char mode;
1085         char pad;
1086 } RemeshModifierData;
1087
1088 /* Skin modifier */
1089
1090 typedef struct SkinModifierData {
1091         ModifierData modifier;
1092
1093         float branch_smoothing;
1094
1095         char flag;
1096         
1097         char symmetry_axes;
1098
1099         char pad[2];
1100 } SkinModifierData;
1101
1102 /* SkinModifierData.symmetry_axes */
1103 enum {
1104         MOD_SKIN_SYMM_X = 1,
1105         MOD_SKIN_SYMM_Y = 2,
1106         MOD_SKIN_SYMM_Z = 4,
1107 };
1108
1109 /* SkinModifierData.flag */
1110 enum {
1111         MOD_SKIN_SMOOTH_SHADING = 1
1112 };
1113
1114 #endif