Merged changes in the trunk up to revision 43038.
[blender-staging.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[32];
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_back, pr_lamp, pr_texture, ml_flag;    /* ml_flag is for disable base material */
134         
135         /* shaders */
136         short diff_shader, spec_shader;
137         float roughness, refrac;
138         /* XXX param[4] needs review and improvement (shader system as whole anyway)
139            This is nasty reused variable for different goals and not easy to RNAify nicely. -jesterKing */
140         float param[4];         /* size, smooth, size, smooth, for toonshader, 0 (fac) and 1 (fresnel) also for fresnel shader */
141         float rms;
142         float darkness;
143         short texco, mapto;
144         
145         /* ramp colors */
146         struct ColorBand *ramp_col;
147         struct ColorBand *ramp_spec;
148         char rampin_col, rampin_spec;
149         char rampblend_col, rampblend_spec;
150         short ramp_show, pad3;
151         float rampfac_col, rampfac_spec;
152
153         struct MTex *mtex[18];          /* MAX_MTEX */
154         struct bNodeTree *nodetree;     
155         struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
156         struct Group *group;    /* light group */
157         struct PreviewImage * preview;
158
159         /* dynamic properties */
160         float friction, fh, reflect;
161         float fhdist, xyfrict;
162         short dynamode, pad2;
163
164         /* subsurface scattering */
165         float sss_radius[3], sss_col[3];
166         float sss_error, sss_scale, sss_ior;
167         float sss_colfac, sss_texfac;
168         float sss_front, sss_back;
169         short sss_flag, sss_preset;
170
171         int mapto_textured;     /* render-time cache to optimise texture lookups */
172         short shadowonly_flag;  /* "shadowsonly" type */
173         short index;            /* custom index for render passes */
174
175         short vcol_alpha;
176         short pad[3];
177
178         ListBase gpumaterial;           /* runtime */
179 } Material;
180
181
182 /* **************** GAME PROPERTIES ********************* */
183 // Blend Transparency Options - alpha_blend /* match GPU_material::GPUBlendMode */
184 #define GEMAT_SOLID             0 /* GPU_BLEND_SOLID */
185 #define GEMAT_ADD               1 /* GPU_BLEND_ADD */
186 #define GEMAT_ALPHA             2 /* GPU_BLEND_ALPHA */
187 #define GEMAT_CLIP              4 /* GPU_BLEND_CLIP */
188 #define GEMAT_ALPHA_SORT        8 /* GPU_BLEND_ALPHA_SORT */
189
190 // Game Options - flag
191 #define GEMAT_BACKCULL          16 /* KX_BACKCULL */
192 #define GEMAT_SHADED            32 /* KX_LIGHT */
193 #define GEMAT_TEXT              64 /* RAS_RENDER_3DPOLYGON_TEXT */
194 #define GEMAT_NOPHYSICS         128
195 #define GEMAT_INVISIBLE         256
196
197 // Face Orientation Options - face_orientation
198 #define GEMAT_NORMAL            0
199 #define GEMAT_HALO              512  /* BILLBOARD_SCREENALIGNED  */
200 #define GEMAT_BILLBOARD         1024 /* BILLBOARD_AXISALIGNED */
201 #define GEMAT_SHADOW            2048 /* SHADOW */
202
203 // Use Textures - not defined directly in the UI
204 #define GEMAT_TEX               4096 /* KX_TEX */
205
206
207 /* **************** MATERIAL ********************* */
208
209 /* maximum number of materials per material array.
210  * (on object, mesh, lamp, etc.). limited by
211  * short mat_nr in verts, faces.
212  * -1 becayse for active material we store the index + 1 */
213 #define MAXMAT                  (32767-1)
214
215 /* material_type */
216 #define MA_TYPE_SURFACE 0
217 #define MA_TYPE_HALO    1
218 #define MA_TYPE_VOLUME  2
219 #define MA_TYPE_WIRE    3
220
221 /* flag */
222                 /* for render */
223 #define MA_IS_USED              1
224                 /* for dopesheet */
225 #define MA_DS_EXPAND    2
226                 /* for dopesheet (texture stack expander)
227                  * NOTE: this must have the same value as other texture stacks, 
228                  * otherwise anim-editors will not read correctly
229                  */
230 #define MA_DS_SHOW_TEXS 4
231
232 /* mode (is int) */
233 #define MA_TRACEBLE             1
234 #define MA_SHADOW               2
235 #define MA_SHLESS               4
236 #define MA_WIRE                 8                       /* deprecated */
237 #define MA_VERTEXCOL    16
238 #define MA_HALO_SOFT    16
239 #define MA_HALO                 32                      /* deprecated */
240 #define MA_ZTRANSP              64
241 #define MA_VERTEXCOLP   128
242 #define MA_ZINV                 256
243 #define MA_HALO_RINGS   256
244 #define MA_ENV                  512
245 #define MA_HALO_LINES   512
246 #define MA_ONLYSHADOW   1024
247 #define MA_HALO_XALPHA  1024
248 #define MA_STAR                 0x800
249 #define MA_FACETEXTURE  0x800
250 #define MA_HALOTEX              0x1000
251 #define MA_HALOPUNO             0x2000
252 #define MA_ONLYCAST             0x2000
253 #define MA_NOMIST               0x4000
254 #define MA_HALO_SHADE   0x4000
255 #define MA_HALO_FLARE   0x8000
256 #define MA_TRANSP               0x10000
257 #define MA_RAYTRANSP    0x20000
258 #define MA_RAYMIRROR    0x40000
259 #define MA_SHADOW_TRA   0x80000
260 #define MA_RAMP_COL             0x100000
261 #define MA_RAMP_SPEC    0x200000
262 #define MA_RAYBIAS              0x400000
263 #define MA_FULL_OSA             0x800000
264 #define MA_TANGENT_STR  0x1000000
265 #define MA_SHADBUF              0x2000000
266                 /* note; we drop MA_TANGENT_STR later to become tangent_u */
267 #define MA_TANGENT_V    0x4000000
268 /* qdn: a bit clumsy this, tangents needed for normal maps separated from shading */
269 #define MA_NORMAP_TANG  0x8000000
270 #define MA_GROUP_NOLAY  0x10000000
271 #define MA_FACETEXTURE_ALPHA    0x20000000
272 #define MA_STR_B_UNITS  0x40000000
273 #define MA_STR_SURFDIFF 0x80000000
274
275 #define MA_MODE_MASK    0x6fffffff      /* all valid mode bits */
276
277 /* ray mirror fadeout */
278 #define MA_RAYMIR_FADETOSKY     0
279 #define MA_RAYMIR_FADETOMAT     1
280
281 /* shadowonly_flag */
282 #define MA_SO_OLD                       0
283 #define MA_SO_SHADOW            1
284 #define MA_SO_SHADED            2
285
286 /* shade_flag */
287 #define MA_CUBIC                        1
288 #define MA_OBCOLOR                      2
289 #define MA_APPROX_OCCLUSION     4
290
291 /* diff_shader */
292 #define MA_DIFF_LAMBERT         0
293 #define MA_DIFF_ORENNAYAR       1
294 #define MA_DIFF_TOON            2
295 #define MA_DIFF_MINNAERT    3
296 #define MA_DIFF_FRESNEL     4
297
298 /* spec_shader */
299 #define MA_SPEC_COOKTORR        0
300 #define MA_SPEC_PHONG           1
301 #define MA_SPEC_BLINN           2
302 #define MA_SPEC_TOON            3
303 #define MA_SPEC_WARDISO         4
304
305 /* dynamode */
306 #define MA_DRAW_DYNABUTS    1           /* deprecated */
307 #define MA_FH_NOR               2
308
309 /* ramps */
310 #define MA_RAMP_IN_SHADER       0
311 #define MA_RAMP_IN_ENERGY       1
312 #define MA_RAMP_IN_NOR          2
313 #define MA_RAMP_IN_RESULT       3
314
315 #define MA_RAMP_BLEND           0
316 #define MA_RAMP_ADD                     1
317 #define MA_RAMP_MULT            2
318 #define MA_RAMP_SUB                     3
319 #define MA_RAMP_SCREEN          4
320 #define MA_RAMP_DIV                     5
321 #define MA_RAMP_DIFF            6
322 #define MA_RAMP_DARK            7
323 #define MA_RAMP_LIGHT           8
324 #define MA_RAMP_OVERLAY         9
325 #define MA_RAMP_DODGE           10
326 #define MA_RAMP_BURN            11
327 #define MA_RAMP_HUE                     12
328 #define MA_RAMP_SAT                     13
329 #define MA_RAMP_VAL                     14
330 #define MA_RAMP_COLOR           15
331 #define MA_RAMP_SOFT        16 
332 #define MA_RAMP_LINEAR      17 
333
334 /* texco */
335 #define TEXCO_ORCO              1
336 #define TEXCO_REFL              2
337 #define TEXCO_NORM              4
338 #define TEXCO_GLOB              8
339 #define TEXCO_UV                16
340 #define TEXCO_OBJECT    32
341 #define TEXCO_LAVECTOR  64
342 #define TEXCO_VIEW              128
343 #define TEXCO_STICKY    256
344 #define TEXCO_OSA               512
345 #define TEXCO_WINDOW    1024
346 #define NEED_UV                 2048
347 #define TEXCO_TANGENT   4096
348         /* still stored in vertex->accum, 1 D */
349 #define TEXCO_STRAND    8192
350 #define TEXCO_PARTICLE  8192 /* strand is used for normal materials, particle for halo materials */
351 #define TEXCO_STRESS    16384
352 #define TEXCO_SPEED             32768
353
354 /* mapto */
355 #define MAP_COL                 1
356 #define MAP_NORM                2
357 #define MAP_COLSPEC             4
358 #define MAP_COLMIR              8
359 #define MAP_VARS                (0xFFF0)
360 #define MAP_REF                 16
361 #define MAP_SPEC                32
362 #define MAP_EMIT                64
363 #define MAP_ALPHA               128
364 #define MAP_HAR                 256
365 #define MAP_RAYMIRR             512
366 #define MAP_TRANSLU             1024
367 #define MAP_AMB                 2048
368 #define MAP_DISPLACE    4096
369 #define MAP_WARP                8192
370 #define MAP_LAYER               16384           /* unused */
371
372 /* volume mapto - reuse definitions for now - a bit naughty! */
373 #define MAP_DENSITY                             128
374 #define MAP_EMISSION                    64
375 #define MAP_EMISSION_COL                1
376 #define MAP_SCATTERING                  16
377 #define MAP_TRANSMISSION_COL    8
378 #define MAP_REFLECTION_COL              4
379 #define MAP_REFLECTION                  32
380
381
382 /* mapto for halo */
383 //#define MAP_HA_COL            1
384 //#define MAP_HA_ALPHA  128
385 //#define MAP_HA_HAR            256
386 //#define MAP_HA_SIZE           2
387 //#define MAP_HA_ADD            64
388
389 /* pmapto */
390 /* init */
391 #define MAP_PA_INIT             31
392 #define MAP_PA_TIME             1
393 #define MAP_PA_LIFE             2
394 #define MAP_PA_DENS             4
395 #define MAP_PA_SIZE             8
396 #define MAP_PA_LENGTH   16
397 /* reset */
398 #define MAP_PA_IVEL             32
399 /* physics */
400 #define MAP_PA_PVEL             64
401 /* path cache */
402 #define MAP_PA_CACHE    912
403 #define MAP_PA_CLUMP    128
404 #define MAP_PA_KINK             256
405 #define MAP_PA_ROUGH    512
406
407 /* pr_type */
408 #define MA_FLAT                 0
409 #define MA_SPHERE               1
410 #define MA_CUBE                 2
411 #define MA_MONKEY               3
412 #define MA_SPHERE_A             4
413 #define MA_TEXTURE              5
414 #define MA_LAMP                 6
415 #define MA_SKY                  7
416 #define MA_HAIR                 10
417 #define MA_ATMOS                11
418
419 /* pr_back */
420 #define MA_DARK                 1
421
422 /* sss_flag */
423 #define MA_DIFF_SSS             1
424
425 /* vol_stepsize_type */
426 #define MA_VOL_STEP_RANDOMIZED  0
427 #define MA_VOL_STEP_CONSTANT    1
428 #define MA_VOL_STEP_ADAPTIVE    2
429
430 /* vol_shadeflag */
431 #define MA_VOL_RECV_EXT_SHADOW  1
432 #define MA_VOL_PRECACHESHADING  8
433
434 /* vol_shading_type */
435 #define MA_VOL_SHADE_SHADELESS                                  0
436 #define MA_VOL_SHADE_SHADOWED                                   2
437 #define MA_VOL_SHADE_SHADED                                             1
438 #define MA_VOL_SHADE_MULTIPLE                                   3
439 #define MA_VOL_SHADE_SHADEDPLUSMULTIPLE                 4
440
441 #endif
442