Copying scripts from 2.4x without 2.5x changes
[blender-staging.git] / source / blender / makesdna / DNA_modifier_types.h
1 /**
2  * $Id$ 
3  */
4
5 #ifndef DNA_MODIFIER_TYPES_H
6 #define DNA_MODIFIER_TYPES_H
7
8 #define MODSTACK_DEBUG 1
9
10 /* WARNING ALERT! TYPEDEF VALUES ARE WRITTEN IN FILES! SO DO NOT CHANGE! */
11
12 typedef enum ModifierType {
13         eModifierType_None = 0,
14         eModifierType_Subsurf,
15         eModifierType_Lattice,
16         eModifierType_Curve,
17         eModifierType_Build,
18         eModifierType_Mirror,
19         eModifierType_Decimate,
20         eModifierType_Wave,
21         eModifierType_Armature,
22         eModifierType_Hook,
23         eModifierType_Softbody,
24         eModifierType_Boolean,
25         eModifierType_Array,
26         eModifierType_EdgeSplit,
27         eModifierType_Displace,
28         eModifierType_UVProject,
29         eModifierType_Smooth,
30         eModifierType_Cast,
31         eModifierType_MeshDeform,
32         eModifierType_ParticleSystem,
33         eModifierType_ParticleInstance,
34         eModifierType_Explode,
35         eModifierType_Cloth,
36         eModifierType_Collision,
37         eModifierType_Bevel,
38         eModifierType_Shrinkwrap,
39         eModifierType_Fluidsim,
40         eModifierType_Mask,
41         eModifierType_SimpleDeform,
42         eModifierType_Multires,
43         eModifierType_Surface,
44         eModifierType_Smoke,
45         NUM_MODIFIER_TYPES
46 } ModifierType;
47
48 typedef enum ModifierMode {
49         eModifierMode_Realtime = (1<<0),
50         eModifierMode_Render = (1<<1),
51         eModifierMode_Editmode = (1<<2),
52         eModifierMode_OnCage = (1<<3),
53         eModifierMode_Expanded = (1<<4),
54         eModifierMode_Virtual = (1<<5),
55         eModifierMode_DisableTemporary = (1 << 31)
56 } ModifierMode;
57
58 typedef struct ModifierData {
59         struct ModifierData *next, *prev;
60
61         int type, mode;
62         char name[32];
63         
64         /* XXX for timing info set by caller... solve later? (ton) */
65         struct Scene *scene;
66         
67         char *error;
68 } ModifierData;
69
70 typedef enum {
71         eSubsurfModifierFlag_Incremental = (1<<0),
72         eSubsurfModifierFlag_DebugIncr = (1<<1),
73         eSubsurfModifierFlag_ControlEdges = (1<<2),
74         eSubsurfModifierFlag_SubsurfUv = (1<<3)
75 } SubsurfModifierFlag;
76
77 typedef struct SubsurfModifierData {
78         ModifierData modifier;
79
80         short subdivType, levels, renderLevels, flags;
81
82         void *emCache, *mCache;
83 } SubsurfModifierData;
84
85 typedef struct LatticeModifierData {
86         ModifierData modifier;
87
88         struct Object *object;
89         char name[32];                  /* optional vertexgroup name */
90 } LatticeModifierData;
91
92 typedef struct CurveModifierData {
93         ModifierData modifier;
94
95         struct Object *object;
96         char name[32];                  /* optional vertexgroup name */
97         short defaxis;                  /* axis along which curve deforms */
98         char pad[6];
99 } CurveModifierData;
100
101 /* CurveModifierData->defaxis */
102 #define MOD_CURVE_POSX  1
103 #define MOD_CURVE_POSY  2
104 #define MOD_CURVE_POSZ  3
105 #define MOD_CURVE_NEGX  4
106 #define MOD_CURVE_NEGY  5
107 #define MOD_CURVE_NEGZ  6
108
109 typedef struct BuildModifierData {
110         ModifierData modifier;
111
112         float start, length;
113         int randomize, seed;
114 } BuildModifierData;
115
116 /* Mask Modifier */
117 typedef struct MaskModifierData {
118         ModifierData modifier;
119         
120         struct Object *ob_arm;  /* armature to use to in place of hardcoded vgroup */
121         char vgroup[32];                /* name of vertex group to use to mask */
122         
123         int mode;                               /* using armature or hardcoded vgroup */
124         int flag;                               /* flags for various things */
125 } MaskModifierData;
126
127 /* Mask Modifier -> mode */
128 #define MOD_MASK_MODE_VGROUP            0
129 #define MOD_MASK_MODE_ARM                       1
130
131 /* Mask Modifier -> flag */
132 #define MOD_MASK_INV                    (1<<0)
133
134 typedef struct ArrayModifierData {
135         ModifierData modifier;
136
137         /* the object with which to cap the start of the array  */
138         struct Object *start_cap;
139         /* the object with which to cap the end of the array  */
140         struct Object *end_cap;
141         /* the curve object to use for MOD_ARR_FITCURVE */
142         struct Object *curve_ob;
143         /* the object to use for object offset */
144         struct Object *offset_ob;
145         /* a constant duplicate offset;
146            1 means the duplicates are 1 unit apart
147     */
148         float offset[3];
149         /* a scaled factor for duplicate offsets;
150            1 means the duplicates are 1 object-width apart
151     */
152         float scale[3];
153         /* the length over which to distribute the duplicates */
154         float length;
155         /* the limit below which to merge vertices in adjacent duplicates */
156         float merge_dist;
157         /* determines how duplicate count is calculated; one of:
158               MOD_ARR_FIXEDCOUNT -> fixed
159               MOD_ARR_FITLENGTH  -> calculated to fit a set length
160               MOD_ARR_FITCURVE   -> calculated to fit the length of a Curve object
161     */
162         int fit_type;
163         /* flags specifying how total offset is calculated; binary OR of:
164              MOD_ARR_OFF_CONST    -> total offset += offset
165              MOD_ARR_OFF_RELATIVE -> total offset += relative * object width
166              MOD_ARR_OFF_OBJ      -> total offset += offset_ob's matrix
167            total offset is the sum of the individual enabled offsets
168         */
169         int offset_type;
170         /* general flags:
171               MOD_ARR_MERGE -> merge vertices in adjacent duplicates
172         */
173         int flags;
174         /* the number of duplicates to generate for MOD_ARR_FIXEDCOUNT */
175         int count;
176 } ArrayModifierData;
177
178 /* ArrayModifierData->fit_type */
179 #define MOD_ARR_FIXEDCOUNT 0
180 #define MOD_ARR_FITLENGTH  1
181 #define MOD_ARR_FITCURVE   2
182
183 /* ArrayModifierData->offset_type */
184 #define MOD_ARR_OFF_CONST    1<<0
185 #define MOD_ARR_OFF_RELATIVE 1<<1
186 #define MOD_ARR_OFF_OBJ      1<<2
187
188 /* ArrayModifierData->flags */
189 #define MOD_ARR_MERGE      1<<0
190 #define MOD_ARR_MERGEFINAL 1<<1
191
192 typedef struct MirrorModifierData {
193         ModifierData modifier;
194
195         short axis, flag;
196         float tolerance;
197         struct Object *mirror_ob;
198 } MirrorModifierData;
199
200 /* MirrorModifierData->flag */
201 #define MOD_MIR_CLIPPING        1<<0
202 #define MOD_MIR_MIRROR_U        1<<1
203 #define MOD_MIR_MIRROR_V        1<<2
204 #define MOD_MIR_AXIS_X          1<<3
205 #define MOD_MIR_AXIS_Y          1<<4
206 #define MOD_MIR_AXIS_Z          1<<5
207 #define MOD_MIR_VGROUP          1<<6
208
209 typedef struct EdgeSplitModifierData {
210         ModifierData modifier;
211
212         float split_angle;    /* angle above which edges should be split */
213         int flags;
214 } EdgeSplitModifierData;
215
216 /* EdgeSplitModifierData->flags */
217 #define MOD_EDGESPLIT_FROMANGLE   1<<1
218 #define MOD_EDGESPLIT_FROMFLAG    1<<2
219
220 typedef struct BevelModifierData {
221         ModifierData modifier;
222
223         float value;          /* the "raw" bevel value (distance/amount to bevel) */
224         int res;              /* the resolution (as originally coded, it is the number of recursive bevels) */
225         int pad;
226         short flags;          /* general option flags */
227         short val_flags;      /* flags used to interpret the bevel value */
228         short lim_flags;      /* flags to tell the tool how to limit the bevel */
229         short e_flags;        /* flags to direct how edge weights are applied to verts */
230         float bevel_angle;    /* if the BME_BEVEL_ANGLE is set, this will be how "sharp" an edge must be before it gets beveled */
231         char defgrp_name[32]; /* if the BME_BEVEL_VWEIGHT option is set, this will be the name of the vert group */
232 } BevelModifierData;
233
234 typedef struct BMeshModifierData {
235         ModifierData modifier;
236
237         float pad;
238         int type;
239 } BMeshModifierData;
240
241
242 /* Smoke modifier flags */
243 #define MOD_SMOKE_TYPE_DOMAIN (1 << 0)
244 #define MOD_SMOKE_TYPE_FLOW (1 << 1)
245 #define MOD_SMOKE_TYPE_COLL (1 << 2)
246
247 typedef struct SmokeModifierData {
248         ModifierData modifier;
249
250         struct SmokeDomainSettings *domain;
251         struct SmokeFlowSettings *flow; /* inflow, outflow, smoke objects */
252         struct SmokeCollSettings *coll; /* collision objects */
253         float time;
254         int type;  /* domain, inflow, outflow, ... */
255 } SmokeModifierData;
256
257 typedef struct DisplaceModifierData {
258         ModifierData modifier;
259
260         struct Tex *texture;
261         float strength;
262         int direction;
263         char defgrp_name[32];
264         float midlevel;
265         int texmapping;
266         struct Object *map_object;
267         char uvlayer_name[32];
268         int uvlayer_tmp, pad;
269 } DisplaceModifierData;
270
271 /* DisplaceModifierData->direction */
272 enum {
273         MOD_DISP_DIR_X,
274         MOD_DISP_DIR_Y,
275         MOD_DISP_DIR_Z,
276         MOD_DISP_DIR_NOR,
277         MOD_DISP_DIR_RGB_XYZ,
278 };
279
280 /* DisplaceModifierData->texmapping */
281 enum {
282         MOD_DISP_MAP_LOCAL,
283         MOD_DISP_MAP_GLOBAL,
284         MOD_DISP_MAP_OBJECT,
285         MOD_DISP_MAP_UV,
286 };
287
288 typedef struct UVProjectModifierData {
289         ModifierData modifier;
290
291         /* the objects which do the projecting */
292         struct Object *projectors[10]; /* MOD_UVPROJECT_MAX */
293         struct Image *image;      /* the image to project */
294         int flags;
295         int num_projectors;
296         float aspectx, aspecty;
297         char uvlayer_name[32];
298         int uvlayer_tmp, pad;
299 } UVProjectModifierData;
300
301 #define MOD_UVPROJECT_MAXPROJECTORS 10
302
303 /* UVProjectModifierData->flags */
304 #define MOD_UVPROJECT_OVERRIDEIMAGE 1<<0
305
306 typedef struct DecimateModifierData {
307         ModifierData modifier;
308
309         float percent;
310         int faceCount;
311 } DecimateModifierData;
312
313 /* Smooth modifier flags */
314 #define MOD_SMOOTH_X (1<<1)
315 #define MOD_SMOOTH_Y (1<<2)
316 #define MOD_SMOOTH_Z (1<<3)
317
318 typedef struct SmoothModifierData {
319         ModifierData modifier;
320         float fac;
321         char defgrp_name[32];
322         short flag, repeat;
323
324 } SmoothModifierData;
325
326 /* Cast modifier flags */
327 #define MOD_CAST_X (1<<1)
328 #define MOD_CAST_Y (1<<2)
329 #define MOD_CAST_Z (1<<3)
330 #define MOD_CAST_USE_OB_TRANSFORM (1<<4)
331 #define MOD_CAST_SIZE_FROM_RADIUS (1<<5)
332
333 /* Cast modifier projection types */
334 #define MOD_CAST_TYPE_SPHERE 0
335 #define MOD_CAST_TYPE_CYLINDER 1
336 #define MOD_CAST_TYPE_CUBOID 2
337
338 typedef struct CastModifierData {
339         ModifierData modifier;
340
341         struct Object *object;
342         float fac;
343         float radius;
344         float size;
345         char defgrp_name[32];
346         short flag, type;
347 } CastModifierData;
348
349 enum {
350         MOD_WAV_MAP_LOCAL,
351         MOD_WAV_MAP_GLOBAL,
352         MOD_WAV_MAP_OBJECT,
353         MOD_WAV_MAP_UV,
354 };
355
356 /* WaveModifierData.flag */
357 #define MOD_WAVE_X      1<<1
358 #define MOD_WAVE_Y      1<<2
359 #define MOD_WAVE_CYCL   1<<3
360 #define MOD_WAVE_NORM   1<<4
361 #define MOD_WAVE_NORM_X 1<<5
362 #define MOD_WAVE_NORM_Y 1<<6
363 #define MOD_WAVE_NORM_Z 1<<7
364
365 typedef struct WaveModifierData {
366         ModifierData modifier;
367
368         struct Object *objectcenter;
369         char defgrp_name[32];
370         struct Tex *texture;
371         struct Object *map_object;
372
373         short flag, pad;
374
375         float startx, starty, height, width;
376         float narrow, speed, damp, falloff;
377
378         int texmapping, uvlayer_tmp;
379
380         char uvlayer_name[32];
381
382         float timeoffs, lifetime;
383         float pad1;
384 } WaveModifierData;
385
386 typedef struct ArmatureModifierData {
387         ModifierData modifier;
388
389         short deformflag, multi;                /* deformflag replaces armature->deformflag */
390         int pad2;
391         struct Object *object;
392         float *prevCos;         /* stored input of previous modifier, for vertexgroup blending */
393         char defgrp_name[32];
394 } ArmatureModifierData;
395
396 typedef struct HookModifierData {
397         ModifierData modifier;
398
399         struct Object *object;
400         char subtarget[32];             /* optional name of bone target */
401         
402         float parentinv[4][4];  /* matrix making current transform unmodified */
403         float cent[3];                  /* visualization of hook */
404         float falloff;                  /* if not zero, falloff is distance where influence zero */
405         
406         int *indexar;                   /* if NULL, it's using vertexgroup */
407         int totindex;
408         float force;
409         char name[32];                  /* optional vertexgroup name */
410 } HookModifierData;
411
412 typedef struct SoftbodyModifierData {
413         ModifierData modifier;
414 } SoftbodyModifierData;
415
416 typedef struct ClothModifierData {
417         ModifierData            modifier;
418
419         struct Scene *scene;                    /* the context, time etc is here */
420         struct Cloth *clothObject;              /* The internal data structure for cloth. */
421         struct ClothSimSettings *sim_parms; /* definition is in DNA_cloth_types.h */
422         struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
423         struct PointCache *point_cache; /* definition is in DNA_object_force.h */
424         struct ListBase ptcaches;
425 } ClothModifierData;
426
427 typedef struct CollisionModifierData {
428         ModifierData    modifier;
429         
430         struct MVert *x; /* position at the beginning of the frame */
431         struct MVert *xnew; /* position at the end of the frame */
432         struct MVert *xold; /* unsued atm, but was discussed during sprint */
433         struct MVert *current_xnew; /* new position at the actual inter-frame step */
434         struct MVert *current_x; /* position at the actual inter-frame step */
435         struct MVert *current_v; /* (xnew - x) at the actual inter-frame step */
436         
437         struct MFace *mfaces; /* object face data */
438         
439         unsigned int numverts;
440         unsigned int numfaces;
441         float time, pad;                /* cfra time of modifier */
442         struct BVHTree *bvhtree; /* bounding volume hierarchy for this cloth object */
443 } CollisionModifierData;
444
445 typedef struct SurfaceModifierData {
446         ModifierData    modifier;
447
448         struct MVert *x; /* old position */
449         struct MVert *v; /* velocity */
450
451         struct DerivedMesh *dm;
452
453         struct BVHTreeFromMesh *bvhtree; /* bounding volume hierarchy of the mesh faces */
454
455         int cfra, numverts;
456 } SurfaceModifierData;
457
458 typedef enum {
459         eBooleanModifierOp_Intersect,
460         eBooleanModifierOp_Union,
461         eBooleanModifierOp_Difference,
462 } BooleanModifierOp;
463 typedef struct BooleanModifierData {
464         ModifierData modifier;
465
466         struct Object *object;
467         int operation, pad;
468 } BooleanModifierData;
469
470 #define MOD_MDEF_INVERT_VGROUP  (1<<0)
471 #define MOD_MDEF_DYNAMIC_BIND   (1<<1)
472
473 typedef struct MDefInfluence {
474         int vertex;
475         float weight;
476 } MDefInfluence;
477
478 typedef struct MDefCell {
479         int offset;
480         int totinfluence;
481 } MDefCell;
482
483 typedef struct MeshDeformModifierData {
484         ModifierData modifier;
485
486         struct Object *object;                  /* mesh object */
487         char defgrp_name[32];                   /* optional vertexgroup name */
488
489         short gridsize, needbind;
490         short flag, pad;
491
492         /* variables filled in when bound */
493         float *bindweights, *bindcos;   /* computed binding weights */
494         int totvert, totcagevert;               /* total vertices in mesh and cage */
495         MDefCell *dyngrid;                              /* grid with dynamic binding cell points */
496         MDefInfluence *dyninfluences;   /* dynamic binding vertex influences */
497         int *dynverts, *pad2;                   /* is this vertex bound or not? */
498         int dyngridsize;                                /* size of the dynamic bind grid */
499         int totinfluence;                               /* total number of vertex influences */
500         float dyncellmin[3];                    /* offset of the dynamic bind grid */
501         float dyncellwidth;                             /* width of dynamic bind cell */
502         float bindmat[4][4];                    /* matrix of cage at binding time */
503 } MeshDeformModifierData;
504
505 typedef enum {
506         eParticleSystemFlag_Loaded =            (1<<0),
507         eParticleSystemFlag_Pars =                      (1<<1),
508         eParticleSystemFlag_FromCurve =         (1<<2),
509         eParticleSystemFlag_DM_changed =        (1<<3),
510         eParticleSystemFlag_Disabled =          (1<<4),
511         eParticleSystemFlag_psys_updated =      (1<<5),
512 } ParticleSystemModifierFlag;
513
514 typedef struct ParticleSystemModifierData {
515         ModifierData modifier;
516         struct ParticleSystem *psys;
517         struct DerivedMesh *dm;
518         int totdmvert, totdmedge, totdmface;
519         short flag, rt;
520 } ParticleSystemModifierData;
521
522 typedef enum {
523         eParticleInstanceFlag_Parents =         (1<<0),
524         eParticleInstanceFlag_Children =        (1<<1),
525         eParticleInstanceFlag_Path =            (1<<2),
526         eParticleInstanceFlag_Unborn =          (1<<3),
527         eParticleInstanceFlag_Alive =           (1<<4),
528         eParticleInstanceFlag_Dead =            (1<<5),
529         eParticleInstanceFlag_KeepShape =       (1<<6),
530         eParticleInstanceFlag_UseSize =         (1<<7),
531 } ParticleInstanceModifierFlag;
532
533 typedef struct ParticleInstanceModifierData {
534         ModifierData modifier;
535         struct Object *ob;
536         short psys, flag, axis, rt;
537         float position, random_position;
538 } ParticleInstanceModifierData;
539
540 typedef enum {
541         eExplodeFlag_CalcFaces =        (1<<0),
542         //eExplodeFlag_PaSize =         (1<<1),
543         eExplodeFlag_EdgeSplit =        (1<<2),
544         eExplodeFlag_Unborn =           (1<<3),
545         eExplodeFlag_Alive =            (1<<4),
546         eExplodeFlag_Dead =                     (1<<5),
547 } ExplodeModifierFlag;
548
549 typedef struct ExplodeModifierData {
550         ModifierData modifier;
551         int *facepa;
552         short flag, vgroup;
553         float protect;
554 } ExplodeModifierData;
555
556 typedef struct MultiresModifierData {
557         ModifierData modifier;
558
559         struct MVert *undo_verts; /* Store DerivedMesh vertices for multires undo */
560         int undo_verts_tot; /* Length of undo_verts array */
561         char undo_signal; /* If true, signals to replace verts with undo verts */
562
563         char lvl, totlvl;
564         char simple;
565 } MultiresModifierData;
566
567 typedef struct FluidsimModifierData {
568         ModifierData modifier;
569         
570         struct FluidsimSettings *fss; /* definition is is DNA_object_fluidsim.h */
571         struct PointCache *point_cache; /* definition is in DNA_object_force.h */
572 } FluidsimModifierData;
573
574 typedef struct ShrinkwrapModifierData {
575         ModifierData modifier;
576
577         struct Object *target;  /* shrink target */
578         struct Object *auxTarget; /* additional shrink target */
579         char vgroup_name[32];   /* optional vertexgroup name */
580         float keepDist;                 /* distance offset to keep from mesh/projection point */
581         short shrinkType;               /* shrink type projection */
582         short shrinkOpts;               /* shrink options */
583         char projAxis;                  /* axis to project over */
584
585         /*
586          * if using projection over vertex normal this controls the
587          * the level of subsurface that must be done before getting the
588          * vertex coordinates and normal
589          */
590         char subsurfLevels;
591
592         char pad[6];
593
594 } ShrinkwrapModifierData;
595
596 /* Shrinkwrap->shrinkType */
597 #define MOD_SHRINKWRAP_NEAREST_SURFACE  0
598 #define MOD_SHRINKWRAP_PROJECT                  1
599 #define MOD_SHRINKWRAP_NEAREST_VERTEX   2
600
601 /* Shrinkwrap->shrinkOpts */
602 #define MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR    (1<<0)  /* allow shrinkwrap to move the vertex in the positive direction of axis */
603 #define MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR    (1<<1)  /* allow shrinkwrap to move the vertex in the negative direction of axis */
604
605 #define MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE    (1<<3)  /* ignore vertex moves if a vertex ends projected on a front face of the target */
606 #define MOD_SHRINKWRAP_CULL_TARGET_BACKFACE             (1<<4)  /* ignore vertex moves if a vertex ends projected on a back face of the target */
607
608 #define MOD_SHRINKWRAP_KEEP_ABOVE_SURFACE               (1<<5)  /* distance is measure to the front face of the target */
609
610 #define MOD_SHRINKWRAP_PROJECT_OVER_X_AXIS              (1<<0)
611 #define MOD_SHRINKWRAP_PROJECT_OVER_Y_AXIS              (1<<1)
612 #define MOD_SHRINKWRAP_PROJECT_OVER_Z_AXIS              (1<<2)
613 #define MOD_SHRINKWRAP_PROJECT_OVER_NORMAL                      0       /* projection over normal is used if no axis is selected */
614
615
616 typedef struct SimpleDeformModifierData {
617         ModifierData modifier;
618
619         struct Object *origin;  /* object to control the origin of modifier space coordinates */
620         char vgroup_name[32];   /* optional vertexgroup name */
621         float factor;                   /* factors to control simple deforms */
622         float limit[2];                 /* lower and upper limit */             
623
624         char mode;                              /* deform function */
625         char axis;                              /* lock axis (for taper and strech) */
626         char originOpts;                /* originOptions */
627         char pad;
628
629 } SimpleDeformModifierData;
630
631 #define MOD_SIMPLEDEFORM_MODE_TWIST             1
632 #define MOD_SIMPLEDEFORM_MODE_BEND              2
633 #define MOD_SIMPLEDEFORM_MODE_TAPER             3
634 #define MOD_SIMPLEDEFORM_MODE_STRETCH   4
635
636 #define MOD_SIMPLEDEFORM_LOCK_AXIS_X                    (1<<0)
637 #define MOD_SIMPLEDEFORM_LOCK_AXIS_Y                    (1<<1)
638
639 /* indicates whether simple deform should use the local
640    coordinates or global coordinates of origin */
641 #define MOD_SIMPLEDEFORM_ORIGIN_LOCAL                   (1<<0)
642
643 #define MOD_UVPROJECT_MAX                               10
644
645 #endif