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