a6478f2ae69b8372f2b754d4cf60fe3c10c2af34
[blender.git] / source / blender / makesdna / DNA_material_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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_material_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_MATERIAL_TYPES_H__
33 #define __DNA_MATERIAL_TYPES_H__
34
35 #include "DNA_defs.h"
36 #include "DNA_ID.h"
37 #include "DNA_listBase.h"
38
39 #ifndef MAX_MTEX
40 #define MAX_MTEX        18
41 #endif
42
43 struct MTex;
44 struct ColorBand;
45 struct Group;
46 struct bNodeTree;
47 struct AnimData;
48 struct Ipo;
49
50 /* WATCH IT: change type? also make changes in ipo.h  */
51
52 typedef struct VolumeSettings {
53         float density;
54         float emission;
55         float scattering;
56         float reflection;
57
58         float emission_col[3];
59         float transmission_col[3];
60         float reflection_col[3];
61
62         float density_scale;
63         float depth_cutoff;
64         float asymmetry;
65         
66         short stepsize_type;
67         short shadeflag;
68         short shade_type;
69         short precache_resolution;
70
71         float stepsize;
72         float ms_diff;
73         float ms_intensity;
74         float ms_spread;
75 } VolumeSettings;
76
77 /* Game Engine Options (old Texface mode, transp and flag) */
78 typedef struct GameSettings {
79         int flag;
80         int alpha_blend;
81         int face_orientation;
82         int pad1;
83 } GameSettings;
84
85 typedef struct Material {
86         ID id;
87         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
88         
89         short material_type, flag;
90         /* note, keep this below synced with render_types.h */
91         float r, g, b;
92         float specr, specg, specb;
93         float mirr, mirg, mirb;
94         float ambr, ambb, ambg;
95         float amb, emit, ang, spectra, ray_mirror;
96         float alpha, ref, spec, zoffs, add;
97         float translucency;
98         /* end synced with render_types.h */
99         
100         struct VolumeSettings vol;
101         struct GameSettings game;
102
103         float fresnel_mir, fresnel_mir_i;
104         float fresnel_tra, fresnel_tra_i;
105         float filter;           /* filter added, for raytrace transparency and transmissivity */
106         float tx_limit, tx_falloff;
107         short ray_depth, ray_depth_tra;
108         short har;
109         char seed1, seed2;
110         
111         float gloss_mir, gloss_tra;
112         short samp_gloss_mir, samp_gloss_tra;
113         float adapt_thresh_mir, adapt_thresh_tra;
114         float aniso_gloss_mir;
115         float dist_mir;
116         short fadeto_mir;
117         short shade_flag;               /* like Cubic interpolation */
118                 
119         int mode, mode_l;               /* mode_l is the or-ed result of all layer modes */
120         short flarec, starc, linec, ringc;
121         float hasize, flaresize, subsize, flareboost;
122         float strand_sta, strand_end, strand_ease, strand_surfnor;
123         float strand_min, strand_widthfade;
124         char strand_uvname[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
125         
126         float sbias;                    /* shadow bias to prevent terminator prob */
127         float lbias;                    /* factor to multiply lampbias with (0.0 = no mult) */
128         float shad_alpha;               /* in use for irregular shadowbuffer */
129         int     septex;
130         
131         /* for buttons and render*/
132         char rgbsel, texact, pr_type, use_nodes;
133         short pr_lamp, pr_texture, ml_flag;     /* ml_flag is for disable base material */
134         
135         /* mapping */
136         char mapflag, pad;
137
138         /* shaders */
139         short diff_shader, spec_shader;
140         float roughness, refrac;
141         /* XXX param[4] needs review and improvement (shader system as whole anyway)
142          * This is nasty reused variable for different goals and not easy to RNAify nicely. -jesterKing */
143         float param[4];         /* size, smooth, size, smooth, for toonshader, 0 (fac) and 1 (fresnel) also for fresnel shader */
144         float rms;
145         float darkness;
146
147         /* runtime - OR'd from 'mtex' */
148         short texco, mapto;
149         
150         /* ramp colors */
151         struct ColorBand *ramp_col;
152         struct ColorBand *ramp_spec;
153         char rampin_col, rampin_spec;
154         char rampblend_col, rampblend_spec;
155         short ramp_show, pad3;
156         float rampfac_col, rampfac_spec;
157
158         struct MTex *mtex[18];          /* MAX_MTEX */
159         struct bNodeTree *nodetree;
160         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
161         struct Group *group;    /* light group */
162         struct PreviewImage *preview;
163
164         /* dynamic properties */
165         float friction, fh, reflect;
166         float fhdist, xyfrict;
167         short dynamode, pad2;
168
169         /* subsurface scattering */
170         float sss_radius[3], sss_col[3];
171         float sss_error, sss_scale, sss_ior;
172         float sss_colfac, sss_texfac;
173         float sss_front, sss_back;
174         short sss_flag, sss_preset;
175
176         int mapto_textured;     /* render-time cache to optimize texture lookups */
177         short shadowonly_flag;  /* "shadowsonly" type */
178         short index;            /* custom index for render passes */
179
180         short vcol_alpha;
181         short pad4[3];
182
183         ListBase gpumaterial;           /* runtime */
184 } Material;
185
186
187 /* **************** GAME PROPERTIES ********************* */
188 // Blend Transparency Options - alpha_blend /* match GPU_material::GPUBlendMode */
189 #define GEMAT_SOLID             0 /* GPU_BLEND_SOLID */
190 #define GEMAT_ADD               1 /* GPU_BLEND_ADD */
191 #define GEMAT_ALPHA             2 /* GPU_BLEND_ALPHA */
192 #define GEMAT_CLIP              4 /* GPU_BLEND_CLIP */
193 #define GEMAT_ALPHA_SORT        8 /* GPU_BLEND_ALPHA_SORT */
194
195 // Game Options - flag
196 #define GEMAT_BACKCULL          16 /* KX_BACKCULL */
197 #define GEMAT_SHADED            32 /* KX_LIGHT */
198 #define GEMAT_TEXT              64 /* RAS_RENDER_3DPOLYGON_TEXT */
199 #define GEMAT_NOPHYSICS         128
200 #define GEMAT_INVISIBLE         256
201
202 // Face Orientation Options - face_orientation
203 #define GEMAT_NORMAL            0
204 #define GEMAT_HALO              512  /* BILLBOARD_SCREENALIGNED  */
205 #define GEMAT_BILLBOARD         1024 /* BILLBOARD_AXISALIGNED */
206 #define GEMAT_SHADOW            2048 /* SHADOW */
207
208 // Use Textures - not defined directly in the UI
209 #define GEMAT_TEX               4096 /* KX_TEX */
210
211
212 /* **************** MATERIAL ********************* */
213
214 /* maximum number of materials per material array.
215  * (on object, mesh, lamp, etc.). limited by
216  * short mat_nr in verts, faces.
217  * -1 because for active material we store the index + 1 */
218 #define MAXMAT                  (32767-1)
219
220 /* material_type */
221 #define MA_TYPE_SURFACE 0
222 #define MA_TYPE_HALO    1
223 #define MA_TYPE_VOLUME  2
224 #define MA_TYPE_WIRE    3
225
226 /* flag */
227                 /* for render */
228 #define MA_IS_USED              1
229                 /* for dopesheet */
230 #define MA_DS_EXPAND    2
231                 /* for dopesheet (texture stack expander)
232                  * NOTE: this must have the same value as other texture stacks, 
233                  * otherwise anim-editors will not read correctly
234                  */
235 #define MA_DS_SHOW_TEXS 4
236
237 /* mode (is int) */
238 #define MA_TRACEBLE             1
239 #define MA_SHADOW               2
240 #define MA_SHLESS               4
241 #define MA_WIRE                 8                       /* deprecated */
242 #define MA_VERTEXCOL    16
243 #define MA_HALO_SOFT    16
244 #define MA_HALO                 32                      /* deprecated */
245 #define MA_ZTRANSP              64
246 #define MA_VERTEXCOLP   128
247 #define MA_ZINV                 256
248 #define MA_HALO_RINGS   256
249 #define MA_ENV                  512
250 #define MA_HALO_LINES   512
251 #define MA_ONLYSHADOW   1024
252 #define MA_HALO_XALPHA  1024
253 #define MA_STAR                 0x800
254 #define MA_FACETEXTURE  0x800
255 #define MA_HALOTEX              0x1000
256 #define MA_HALOPUNO             0x2000
257 #define MA_ONLYCAST             0x2000
258 #define MA_NOMIST               0x4000
259 #define MA_HALO_SHADE   0x4000
260 #define MA_HALO_FLARE   0x8000
261 #define MA_TRANSP               0x10000
262 #define MA_RAYTRANSP    0x20000
263 #define MA_RAYMIRROR    0x40000
264 #define MA_SHADOW_TRA   0x80000
265 #define MA_RAMP_COL             0x100000
266 #define MA_RAMP_SPEC    0x200000
267 #define MA_RAYBIAS              0x400000
268 #define MA_FULL_OSA             0x800000
269 #define MA_TANGENT_STR  0x1000000
270 #define MA_SHADBUF              0x2000000
271                 /* note; we drop MA_TANGENT_STR later to become tangent_u */
272 #define MA_TANGENT_V    0x4000000
273 /* qdn: a bit clumsy this, tangents needed for normal maps separated from shading */
274 #define MA_NORMAP_TANG  0x8000000
275 #define MA_GROUP_NOLAY  0x10000000
276 #define MA_FACETEXTURE_ALPHA    0x20000000
277 #define MA_STR_B_UNITS  0x40000000
278 #define MA_STR_SURFDIFF 0x80000000
279
280 #define MA_MODE_MASK    0x6fffffff      /* all valid mode bits */
281
282 /* mapflag */
283 #define MA_MAPFLAG_UVPROJECT (1 << 0)
284
285 /* ray mirror fadeout */
286 #define MA_RAYMIR_FADETOSKY     0
287 #define MA_RAYMIR_FADETOMAT     1
288
289 /* shadowonly_flag */
290 #define MA_SO_OLD                       0
291 #define MA_SO_SHADOW            1
292 #define MA_SO_SHADED            2
293
294 /* shade_flag */
295 #define MA_CUBIC                        1
296 #define MA_OBCOLOR                      2
297 #define MA_APPROX_OCCLUSION     4
298 #define MA_GROUP_LOCAL      8
299
300 /* diff_shader */
301 #define MA_DIFF_LAMBERT         0
302 #define MA_DIFF_ORENNAYAR       1
303 #define MA_DIFF_TOON            2
304 #define MA_DIFF_MINNAERT    3
305 #define MA_DIFF_FRESNEL     4
306
307 /* spec_shader */
308 #define MA_SPEC_COOKTORR        0
309 #define MA_SPEC_PHONG           1
310 #define MA_SPEC_BLINN           2
311 #define MA_SPEC_TOON            3
312 #define MA_SPEC_WARDISO         4
313
314 /* dynamode */
315 // #define MA_DRAW_DYNABUTS    1                /* deprecated */
316 #define MA_FH_NOR               2
317
318 /* ramps */
319 #define MA_RAMP_IN_SHADER       0
320 #define MA_RAMP_IN_ENERGY       1
321 #define MA_RAMP_IN_NOR          2
322 #define MA_RAMP_IN_RESULT       3
323
324 #define MA_RAMP_BLEND           0
325 #define MA_RAMP_ADD                     1
326 #define MA_RAMP_MULT            2
327 #define MA_RAMP_SUB                     3
328 #define MA_RAMP_SCREEN          4
329 #define MA_RAMP_DIV                     5
330 #define MA_RAMP_DIFF            6
331 #define MA_RAMP_DARK            7
332 #define MA_RAMP_LIGHT           8
333 #define MA_RAMP_OVERLAY         9
334 #define MA_RAMP_DODGE           10
335 #define MA_RAMP_BURN            11
336 #define MA_RAMP_HUE                     12
337 #define MA_RAMP_SAT                     13
338 #define MA_RAMP_VAL                     14
339 #define MA_RAMP_COLOR           15
340 #define MA_RAMP_SOFT        16 
341 #define MA_RAMP_LINEAR      17 
342
343 /* texco */
344 #define TEXCO_ORCO              1
345 #define TEXCO_REFL              2
346 #define TEXCO_NORM              4
347 #define TEXCO_GLOB              8
348 #define TEXCO_UV                16
349 #define TEXCO_OBJECT    32
350 #define TEXCO_LAVECTOR  64
351 #define TEXCO_VIEW              128
352 #define TEXCO_STICKY_   256  // DEPRECATED
353 #define TEXCO_OSA               512
354 #define TEXCO_WINDOW    1024
355 #define NEED_UV                 2048
356 #define TEXCO_TANGENT   4096
357         /* still stored in vertex->accum, 1 D */
358 #define TEXCO_STRAND    8192
359 #define TEXCO_PARTICLE  8192 /* strand is used for normal materials, particle for halo materials */
360 #define TEXCO_STRESS    16384
361 #define TEXCO_SPEED             32768
362
363 /* mapto */
364 #define MAP_COL                 1
365 #define MAP_NORM                2
366 #define MAP_COLSPEC             4
367 #define MAP_COLMIR              8
368 #define MAP_VARS                (0xFFF0)
369 #define MAP_REF                 16
370 #define MAP_SPEC                32
371 #define MAP_EMIT                64
372 #define MAP_ALPHA               128
373 #define MAP_HAR                 256
374 #define MAP_RAYMIRR             512
375 #define MAP_TRANSLU             1024
376 #define MAP_AMB                 2048
377 #define MAP_DISPLACE    4096
378 #define MAP_WARP                8192
379 // #define MAP_LAYER            16384           /* unused */
380
381 /* volume mapto - reuse definitions for now - a bit naughty! */
382 #define MAP_DENSITY                             128
383 #define MAP_EMISSION                    64
384 #define MAP_EMISSION_COL                1
385 #define MAP_SCATTERING                  16
386 #define MAP_TRANSMISSION_COL    8
387 #define MAP_REFLECTION_COL              4
388 #define MAP_REFLECTION                  32
389
390
391 /* mapto for halo */
392 //#define MAP_HA_COL            1
393 //#define MAP_HA_ALPHA  128
394 //#define MAP_HA_HAR            256
395 //#define MAP_HA_SIZE           2
396 //#define MAP_HA_ADD            64
397
398 /* pmapto */
399 /* init */
400 #define MAP_PA_INIT             31
401 #define MAP_PA_TIME             1
402 #define MAP_PA_LIFE             2
403 #define MAP_PA_DENS             4
404 #define MAP_PA_SIZE             8
405 #define MAP_PA_LENGTH   16
406 /* reset */
407 #define MAP_PA_IVEL             32
408 /* physics */
409 #define MAP_PA_PVEL             64
410 /* path cache */
411 #define MAP_PA_CACHE    912
412 #define MAP_PA_CLUMP    128
413 #define MAP_PA_KINK             256
414 #define MAP_PA_ROUGH    512
415
416 /* pr_type */
417 #define MA_FLAT                 0
418 #define MA_SPHERE               1
419 #define MA_CUBE                 2
420 #define MA_MONKEY               3
421 #define MA_SPHERE_A             4
422 #define MA_TEXTURE              5
423 #define MA_LAMP                 6
424 #define MA_SKY                  7
425 #define MA_HAIR                 10
426 #define MA_ATMOS                11
427
428 /* sss_flag */
429 #define MA_DIFF_SSS             1
430
431 /* vol_stepsize_type */
432 #define MA_VOL_STEP_RANDOMIZED  0
433 #define MA_VOL_STEP_CONSTANT    1
434 #define MA_VOL_STEP_ADAPTIVE    2
435
436 /* vol_shadeflag */
437 #define MA_VOL_RECV_EXT_SHADOW  1
438 #define MA_VOL_PRECACHESHADING  8
439
440 /* vol_shading_type */
441 #define MA_VOL_SHADE_SHADELESS                                  0
442 #define MA_VOL_SHADE_SHADOWED                                   2
443 #define MA_VOL_SHADE_SHADED                                             1
444 #define MA_VOL_SHADE_MULTIPLE                                   3
445 #define MA_VOL_SHADE_SHADEDPLUSMULTIPLE                 4
446
447 #endif
448