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