Filling in branch from trunk
[blender.git] / source / blender / makesdna / DNA_texture_types.h
1 /**
2  * blenlib/DNA_texture_types.h (mar-2001 nzc)
3  *
4  * $Id$ 
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef DNA_TEXTURE_TYPES_H
35 #define DNA_TEXTURE_TYPES_H
36
37 #include "DNA_ID.h"
38 #include "DNA_image_types.h"
39
40 struct Ipo;
41 struct PluginTex;
42 struct ColorBand;
43 struct EnvMap;
44 struct Object;
45 struct Tex;
46 struct Image;
47 struct PreviewImage;
48 struct ImBuf;
49
50 typedef struct MTex {
51
52         short texco, mapto, maptoneg, blendtype;
53         struct Object *object;
54         struct Tex *tex;
55         char uvname[32];
56         
57         char projx, projy, projz, mapping;
58         float ofs[3], size[3];
59         
60         short texflag, colormodel;
61         float r, g, b, k;
62         float def_var;
63         
64         float colfac, norfac, varfac;
65         float dispfac; 
66         float warpfac; 
67         
68 } MTex;
69
70 #ifndef DNA_USHORT_FIX
71 #define DNA_USHORT_FIX
72 /**
73  * @deprecated This typedef serves to avoid badly typed functions when
74  * @deprecated compiling while delivering a proper dna.c. Do not use
75  * @deprecated it in any case.
76  */
77 typedef unsigned short dna_ushort_fix;
78 #endif
79
80 typedef struct PluginTex {
81         char name[160];
82         void *handle;
83         
84         char *pname;
85         char *stnames;
86
87         int stypes;
88         int vars;
89         void *varstr;
90         float *result;
91         float *cfra;
92         
93         float data[32];
94
95         int (*doit)(void);
96         void (*instance_init)(void *);
97
98         /* should be void (*)(unsigned short)... patched */     
99         void (*callback)(dna_ushort_fix);
100         
101         int version, pad;
102 } PluginTex;
103
104 typedef struct CBData {
105         float r, g, b, a, pos;
106         int cur;
107 } CBData;
108
109 /* 32 = MAXCOLORBAND */
110 /* note that this has to remain a single struct, for UserDef */
111 typedef struct ColorBand {
112         short flag, tot, cur, ipotype;
113         CBData data[32];
114         
115 } ColorBand;
116
117 typedef struct EnvMap {
118         struct Object *object;
119         struct Image *ima;              /* type ENV_LOAD */
120         struct ImBuf *cube[6];          /* these images are dynamic, not part of the main struct */
121         float imat[4][4];
122         float obimat[3][3];
123         short type, stype;
124         float clipsta, clipend;
125         float viewscale;        /* viewscale is for planar envmaps to zoom in or out */
126         unsigned int notlay;
127         short cuberes, depth;
128         int ok, lastframe;
129         short recalc, lastsize;
130 } EnvMap;
131
132 typedef struct Tex {
133         ID id;
134         
135         float noisesize, turbul;
136         float bright, contrast, rfac, gfac, bfac;
137         float filtersize;
138
139         /* newnoise: musgrave parameters */
140         float mg_H, mg_lacunarity, mg_octaves, mg_offset, mg_gain;
141
142         /* newnoise: distorted noise amount, musgrave & voronoi ouput scale */
143         float dist_amount, ns_outscale;
144
145         /* newnoise: voronoi nearest neighbour weights, minkovsky exponent, distance metric & color type */
146         float vn_w1, vn_w2, vn_w3, vn_w4, vn_mexp;
147         short vn_distm, vn_coltype;
148
149         short noisedepth, noisetype;
150
151         /* newnoise: noisebasis type for clouds/marble/etc, noisebasis2 only used for distorted noise */
152         short noisebasis, noisebasis2;
153         
154         short imaflag, flag;
155         short type, stype;
156         
157         float cropxmin, cropymin, cropxmax, cropymax;
158         short xrepeat, yrepeat;
159         short extend;
160         
161         /* variables disabled, moved to struct iuser */
162         short fie_ima;
163         int len;
164         int frames, offset, sfra;
165         
166         float checkerdist, nabla;
167         float norfac;
168         
169         struct ImageUser iuser;
170         
171         struct Ipo *ipo;
172         struct Image *ima;
173         struct PluginTex *plugin;
174         struct ColorBand *coba;
175         struct EnvMap *env;
176         struct PreviewImage * preview;
177         
178 } Tex;
179
180 /* used for mapping node. note: rot is in degrees */
181
182 typedef struct TexMapping {
183         float loc[3], rot[3], size[3];
184         int flag;
185         
186         float mat[4][4];
187         float min[3], max[3];
188         struct Object *ob;
189
190 } TexMapping;
191
192 /* texmap->flag */
193 #define TEXMAP_CLIP_MIN 1
194 #define TEXMAP_CLIP_MAX 2
195
196
197 /* **************** TEX ********************* */
198
199 /* type */
200 #define TEX_CLOUDS              1
201 #define TEX_WOOD                2
202 #define TEX_MARBLE              3
203 #define TEX_MAGIC               4
204 #define TEX_BLEND               5
205 #define TEX_STUCCI              6
206 #define TEX_NOISE               7
207 #define TEX_IMAGE               8
208 #define TEX_PLUGIN              9
209 #define TEX_ENVMAP              10
210 #define TEX_MUSGRAVE    11
211 #define TEX_VORONOI             12
212 #define TEX_DISTNOISE   13
213
214 /* musgrave stype */
215 #define TEX_MFRACTAL            0
216 #define TEX_RIDGEDMF            1
217 #define TEX_HYBRIDMF            2
218 #define TEX_FBM                         3
219 #define TEX_HTERRAIN            4
220
221 /* newnoise: noisebasis 1 & 2 */
222 #define TEX_BLENDER                     0
223 #define TEX_STDPERLIN           1
224 #define TEX_NEWPERLIN           2
225 #define TEX_VORONOI_F1          3
226 #define TEX_VORONOI_F2          4
227 #define TEX_VORONOI_F3          5
228 #define TEX_VORONOI_F4          6
229 #define TEX_VORONOI_F2F1        7
230 #define TEX_VORONOI_CRACKLE             8
231 #define TEX_CELLNOISE           14
232
233 /* newnoise: Voronoi distance metrics, vn_distm */
234 #define TEX_DISTANCE            0
235 #define TEX_DISTANCE_SQUARED            1
236 #define TEX_MANHATTAN           2
237 #define TEX_CHEBYCHEV           3
238 #define TEX_MINKOVSKY_HALF              4
239 #define TEX_MINKOVSKY_FOUR              5
240 #define TEX_MINKOVSKY           6
241
242 /* imaflag */
243 #define TEX_INTERPOL    1
244 #define TEX_USEALPHA    2
245 #define TEX_MIPMAP              4
246 #define TEX_IMAROT              16
247 #define TEX_CALCALPHA   32
248 #define TEX_NORMALMAP   2048
249 #define TEX_GAUSS_MIP   4096
250
251 /* imaflag unused, only for version check */
252 #define TEX_FIELDS_             8
253 #define TEX_ANIMCYCLIC_ 64
254 #define TEX_ANIM5_              128
255 #define TEX_ANTIALI_    256
256 #define TEX_ANTISCALE_  512
257 #define TEX_STD_FIELD_  1024
258
259 /* flag */
260 #define TEX_COLORBAND           1
261 #define TEX_FLIPBLEND           2
262 #define TEX_NEGALPHA            4
263 #define TEX_CHECKER_ODD         8
264 #define TEX_CHECKER_EVEN        16
265 #define TEX_PRV_ALPHA           32
266 #define TEX_PRV_NOR                     64
267 #define TEX_REPEAT_XMIR         128
268 #define TEX_REPEAT_YMIR         256
269 #define TEX_FLAG_MASK           ( TEX_COLORBAND | TEX_FLIPBLEND | TEX_NEGALPHA | TEX_CHECKER_ODD | TEX_CHECKER_EVEN | TEX_PRV_ALPHA | TEX_PRV_NOR | TEX_REPEAT_XMIR | TEX_REPEAT_YMIR ) 
270
271 /* extend (starts with 1 because of backward comp.) */
272 #define TEX_EXTEND              1
273 #define TEX_CLIP                2
274 #define TEX_REPEAT              3
275 #define TEX_CLIPCUBE    4
276 #define TEX_CHECKER             5
277
278 /* noisetype */
279 #define TEX_NOISESOFT   0
280 #define TEX_NOISEPERL   1
281
282 /* tex->noisebasis2 in texture.c - wood waveforms */
283 #define TEX_SIN                 0
284 #define TEX_SAW                 1
285 #define TEX_TRI                 2
286
287 /* tex->stype in texture.c - wood types */
288 #define TEX_BAND                0
289 #define TEX_RING                1
290 #define TEX_BANDNOISE   2
291 #define TEX_RINGNOISE   3
292
293 /* tex->stype in texture.c - cloud types */
294 #define TEX_DEFAULT             0
295 #define TEX_COLOR               1
296
297 /* tex->stype in texture.c - marble types */
298 #define TEX_SOFT                0
299 #define TEX_SHARP               1
300 #define TEX_SHARPER             2
301
302 /* tex->stype in texture.c - blend types */
303 #define TEX_LIN                 0
304 #define TEX_QUAD                1
305 #define TEX_EASE                2
306 #define TEX_DIAG                3
307 #define TEX_SPHERE              4
308 #define TEX_HALO                5
309 #define TEX_RAD                 6
310
311 /* tex->stype in texture.c - stucci types */
312 #define TEX_PLASTIC             0
313 #define TEX_WALLIN              1
314 #define TEX_WALLOUT             2
315
316 /* tex->stype in texture.c - voronoi types */
317 #define TEX_INTENSITY   0
318 #define TEX_COL1                1
319 #define TEX_COL2                2
320 #define TEX_COL3                3
321
322 /* wrap */
323 #define MTEX_FLAT               0
324 #define MTEX_CUBE               1
325 #define MTEX_TUBE               2
326 #define MTEX_SPHERE             3
327
328 /* return value */
329 #define TEX_INT         0
330 #define TEX_RGB         1
331 #define TEX_NOR         2
332
333 /* **************** MTEX ********************* */
334
335 /* proj */
336 #define PROJ_N                  0
337 #define PROJ_X                  1
338 #define PROJ_Y                  2
339 #define PROJ_Z                  3
340
341 /* texflag */
342 #define MTEX_RGBTOINT   1
343 #define MTEX_STENCIL    2
344 #define MTEX_NEGATIVE   4
345 #define MTEX_ALPHAMIX   8
346 #define MTEX_VIEWSPACE  16
347
348 /* blendtype */
349 #define MTEX_BLEND              0
350 #define MTEX_MUL                1
351 #define MTEX_ADD                2
352 #define MTEX_SUB                3
353 #define MTEX_DIV                4
354 #define MTEX_DARK               5
355 #define MTEX_DIFF               6
356 #define MTEX_LIGHT              7
357 #define MTEX_SCREEN             8
358 #define MTEX_OVERLAY    9
359
360 /* **************** EnvMap ********************* */
361
362 /* type */
363 #define ENV_CUBE        0
364 #define ENV_PLANE       1
365 #define ENV_SPHERE      2
366
367 /* stype */
368 #define ENV_STATIC      0
369 #define ENV_ANIM        1
370 #define ENV_LOAD        2
371
372 /* ok */
373 #define ENV_NORMAL      1
374 #define ENV_OSA         2
375
376 #endif
377