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