Code comments add to collision interface
[blender.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 #include "DNA_cloth_types.h"
13
14 typedef enum ModifierType {
15         eModifierType_None = 0,
16         eModifierType_Subsurf,
17         eModifierType_Lattice,
18         eModifierType_Curve,
19         eModifierType_Build,
20         eModifierType_Mirror,
21         eModifierType_Decimate,
22         eModifierType_Wave,
23         eModifierType_Armature,
24         eModifierType_Hook,
25         eModifierType_Softbody,
26         eModifierType_Boolean,
27         eModifierType_Array,
28         eModifierType_EdgeSplit,
29         eModifierType_Displace,
30         eModifierType_UVProject,
31         eModifierType_Smooth,
32         eModifierType_Cast,
33         eModifierType_Cloth,
34         eModifierType_Collision,
35         NUM_MODIFIER_TYPES
36 } ModifierType;
37
38 typedef enum ModifierMode {
39         eModifierMode_Realtime = (1<<0),
40         eModifierMode_Render = (1<<1),
41         eModifierMode_Editmode = (1<<2),
42         eModifierMode_OnCage = (1<<3),
43         eModifierMode_Expanded = (1<<4),
44         eModifierMode_Virtual = (1<<5),
45         eModifierMode_DisableTemporary = (1 << 31)
46 } ModifierMode;
47
48 typedef struct ModifierData {
49         struct ModifierData *next, *prev;
50
51         int type, mode;
52         char name[32];
53
54         char *error;
55 } ModifierData;
56
57 typedef enum {
58         eSubsurfModifierFlag_Incremental = (1<<0),
59         eSubsurfModifierFlag_DebugIncr = (1<<1),
60         eSubsurfModifierFlag_ControlEdges = (1<<2),
61         eSubsurfModifierFlag_SubsurfUv = (1<<3)
62 } SubsurfModifierFlag;
63
64 typedef struct SubsurfModifierData {
65         ModifierData modifier;
66
67         short subdivType, levels, renderLevels, flags;
68
69         void *emCache, *mCache;
70 } SubsurfModifierData;
71
72 typedef struct LatticeModifierData {
73         ModifierData modifier;
74
75         struct Object *object;
76         char name[32];                  /* optional vertexgroup name */
77 } LatticeModifierData;
78
79 typedef struct CurveModifierData {
80         ModifierData modifier;
81
82         struct Object *object;
83         char name[32];                  /* optional vertexgroup name */
84         short defaxis;                  /* axis along which curve deforms */
85         char pad[6];
86 } CurveModifierData;
87
88 /* CurveModifierData->defaxis */
89 #define MOD_CURVE_POSX  1
90 #define MOD_CURVE_POSY  2
91 #define MOD_CURVE_POSZ  3
92 #define MOD_CURVE_NEGX  4
93 #define MOD_CURVE_NEGY  5
94 #define MOD_CURVE_NEGZ  6
95
96 typedef struct BuildModifierData {
97         ModifierData modifier;
98
99         float start, length;
100         int randomize, seed;
101 } BuildModifierData;
102
103 typedef struct ArrayModifierData {
104         ModifierData modifier;
105
106         /* the object with which to cap the start of the array  */
107         struct Object *start_cap;
108         /* the object with which to cap the end of the array  */
109         struct Object *end_cap;
110         /* the curve object to use for MOD_ARR_FITCURVE */
111         struct Object *curve_ob;
112         /* the object to use for object offset */
113         struct Object *offset_ob;
114         /* a constant duplicate offset;
115            1 means the duplicates are 1 unit apart
116     */
117         float offset[3];
118         /* a scaled factor for duplicate offsets;
119            1 means the duplicates are 1 object-width apart
120     */
121         float scale[3];
122         /* the length over which to distribute the duplicates */
123         float length;
124         /* the limit below which to merge vertices in adjacent duplicates */
125         float merge_dist;
126         /* determines how duplicate count is calculated; one of:
127               MOD_ARR_FIXEDCOUNT -> fixed
128               MOD_ARR_FITLENGTH  -> calculated to fit a set length
129               MOD_ARR_FITCURVE   -> calculated to fit the length of a Curve object
130     */
131         int fit_type;
132         /* flags specifying how total offset is calculated; binary OR of:
133              MOD_ARR_OFF_CONST    -> total offset += offset
134              MOD_ARR_OFF_RELATIVE -> total offset += relative * object width
135              MOD_ARR_OFF_OBJ      -> total offset += offset_ob's matrix
136            total offset is the sum of the individual enabled offsets
137         */
138         int offset_type;
139         /* general flags:
140               MOD_ARR_MERGE -> merge vertices in adjacent duplicates
141         */
142         int flags;
143         /* the number of duplicates to generate for MOD_ARR_FIXEDCOUNT */
144         int count;
145 } ArrayModifierData;
146
147 /* ArrayModifierData->fit_type */
148 #define MOD_ARR_FIXEDCOUNT 0
149 #define MOD_ARR_FITLENGTH  1
150 #define MOD_ARR_FITCURVE   2
151
152 /* ArrayModifierData->offset_type */
153 #define MOD_ARR_OFF_CONST    1<<0
154 #define MOD_ARR_OFF_RELATIVE 1<<1
155 #define MOD_ARR_OFF_OBJ      1<<2
156
157 /* ArrayModifierData->flags */
158 #define MOD_ARR_MERGE      1<<0
159 #define MOD_ARR_MERGEFINAL 1<<1
160
161 typedef struct MirrorModifierData {
162         ModifierData modifier;
163
164         short axis, flag;
165         float tolerance;
166 } MirrorModifierData;
167
168 /* MirrorModifierData->flag */
169 #define MOD_MIR_CLIPPING        1<<0
170 #define MOD_MIR_MIRROR_U        1<<1
171 #define MOD_MIR_MIRROR_V        1<<2
172 #define MOD_MIR_AXIS_X          1<<3
173 #define MOD_MIR_AXIS_Y          1<<4
174 #define MOD_MIR_AXIS_Z          1<<5
175
176 typedef struct EdgeSplitModifierData {
177         ModifierData modifier;
178
179         float split_angle;    /* angle above which edges should be split */
180         int flags;
181 } EdgeSplitModifierData;
182
183 /* EdgeSplitModifierData->flags */
184 #define MOD_EDGESPLIT_FROMANGLE   1<<1
185 #define MOD_EDGESPLIT_FROMFLAG    1<<2
186
187 typedef struct DisplaceModifierData {
188         ModifierData modifier;
189
190         struct Tex *texture;
191         float strength;
192         int direction;
193         char defgrp_name[32];
194         float midlevel;
195         int texmapping;
196         struct Object *map_object;
197         char uvlayer_name[32];
198         int uvlayer_tmp, pad;
199 } DisplaceModifierData;
200
201 /* DisplaceModifierData->direction */
202 enum {
203         MOD_DISP_DIR_X,
204         MOD_DISP_DIR_Y,
205         MOD_DISP_DIR_Z,
206         MOD_DISP_DIR_NOR,
207         MOD_DISP_DIR_RGB_XYZ,
208 };
209
210 /* DisplaceModifierData->texmapping */
211 enum {
212         MOD_DISP_MAP_LOCAL,
213         MOD_DISP_MAP_GLOBAL,
214         MOD_DISP_MAP_OBJECT,
215         MOD_DISP_MAP_UV,
216 };
217
218 typedef struct UVProjectModifierData {
219         ModifierData modifier;
220
221         /* the objects which do the projecting */
222         struct Object *projectors[10];
223         struct Image *image;      /* the image to project */
224         int flags;
225         int num_projectors;
226         float aspectx, aspecty;
227         char uvlayer_name[32];
228         int uvlayer_tmp, pad;
229 } UVProjectModifierData;
230
231 #define MOD_UVPROJECT_MAXPROJECTORS 10
232
233 /* UVProjectModifierData->flags */
234 #define MOD_UVPROJECT_OVERRIDEIMAGE 1<<0
235
236 typedef struct DecimateModifierData {
237         ModifierData modifier;
238
239         float percent;
240         int faceCount;
241 } DecimateModifierData;
242
243 /* Smooth modifier flags */
244 #define MOD_SMOOTH_X (1<<1)
245 #define MOD_SMOOTH_Y (1<<2)
246 #define MOD_SMOOTH_Z (1<<3)
247
248 typedef struct SmoothModifierData {
249         ModifierData modifier;
250         float fac;
251         char defgrp_name[32];
252         short flag, repeat;
253
254 } SmoothModifierData;
255
256 /* Cast modifier flags */
257 #define MOD_CAST_X (1<<1)
258 #define MOD_CAST_Y (1<<2)
259 #define MOD_CAST_Z (1<<3)
260 #define MOD_CAST_USE_OB_TRANSFORM (1<<4)
261 #define MOD_CAST_SIZE_FROM_RADIUS (1<<5)
262
263 /* Cast modifier projection types */
264 #define MOD_CAST_TYPE_SPHERE 0
265 #define MOD_CAST_TYPE_CYLINDER 1
266 #define MOD_CAST_TYPE_CUBOID 2
267
268 typedef struct CastModifierData {
269         ModifierData modifier;
270
271         struct Object *object;
272         float fac;
273         float radius;
274         float size;
275         char defgrp_name[32];
276         short flag, type;
277 } CastModifierData;
278
279 enum {
280         MOD_WAV_MAP_LOCAL,
281         MOD_WAV_MAP_GLOBAL,
282         MOD_WAV_MAP_OBJECT,
283         MOD_WAV_MAP_UV,
284 };
285
286 /* WaveModifierData.flag */
287 #define MOD_WAVE_X      1<<1
288 #define MOD_WAVE_Y      1<<2
289 #define MOD_WAVE_CYCL   1<<3
290 #define MOD_WAVE_NORM   1<<4
291 #define MOD_WAVE_NORM_X 1<<5
292 #define MOD_WAVE_NORM_Y 1<<6
293 #define MOD_WAVE_NORM_Z 1<<7
294
295 typedef struct WaveModifierData {
296         ModifierData modifier;
297
298         struct Object *objectcenter;
299         char defgrp_name[32];
300         struct Tex *texture;
301         struct Object *map_object;
302
303         short flag, pad;
304
305         float startx, starty, height, width;
306         float narrow, speed, damp;
307
308         int texmapping, uvlayer_tmp;
309
310         char uvlayer_name[32];
311         
312         float timeoffs, lifetime;
313 } WaveModifierData;
314
315 typedef struct ArmatureModifierData {
316         ModifierData modifier;
317
318         short deformflag, pad1;         /* deformflag replaces armature->deformflag */
319         int pad2;
320         struct Object *object;
321         char defgrp_name[32];
322 } ArmatureModifierData;
323
324 typedef struct HookModifierData {
325         ModifierData modifier;
326
327         struct Object *object;
328         float parentinv[4][4];  /* matrix making current transform unmodified */
329         float cent[3];                  /* visualization of hook */
330         float falloff;                  /* if not zero, falloff is distance where influence zero */
331         
332         int *indexar;                   /* if NULL, it's using vertexgroup */
333         int totindex;
334         float force;
335         char name[32];                  /* optional vertexgroup name */
336 } HookModifierData;
337
338 typedef struct SoftbodyModifierData {
339         ModifierData modifier;
340 } SoftbodyModifierData;
341
342 typedef struct ClothModifierData {
343    ModifierData         modifier;
344         
345    Cloth                *clothObject;   /* The internal data structure for cloth.               */
346    SimulationSettings   sim_parms;      /* definition is in DNA_cloth_types.h                   */
347    CollisionSettings    coll_parms;     /* definition is in DNA_cloth_types.h                   */
348 } ClothModifierData;
349
350 typedef struct CollisionModifierData {
351         ModifierData            modifier;
352         
353         struct MVert *x;
354         struct MVert *xnew;
355         
356         unsigned int numverts;
357         float time;
358         void *tree;     /* collision tree for this cloth object */
359 } CollisionModifierData;
360
361 typedef enum {
362         eBooleanModifierOp_Intersect,
363         eBooleanModifierOp_Union,
364         eBooleanModifierOp_Difference,
365 } BooleanModifierOp;
366 typedef struct BooleanModifierData {
367         ModifierData modifier;
368
369         struct Object *object;
370         int operation, pad;
371 } BooleanModifierData;
372
373 #endif