42c80f4b8b5d2633874c0b753de8fa167f638a62
[blender.git] / source / blender / makesdna / DNA_world_types.h
1 /**
2  * blenlib/DNA_world_types.h (mar-2001 nzc)
3  *
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef DNA_WORLD_TYPES_H
32 #define DNA_WORLD_TYPES_H
33
34 #include "DNA_ID.h"
35
36 struct AnimData;
37 struct Ipo;
38 struct MTex;
39
40 #ifndef MAX_MTEX
41 #define MAX_MTEX        18
42 #endif
43
44
45 /**
46  * World defines general modeling data such as a background fill,
47  * gravity, color model, stars, etc. It mixes game-data, rendering
48  * data and modeling data. */
49 typedef struct World {
50         ID id;
51         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
52         
53         short colormodel, totex;
54         short texact, mistype;
55
56         float horr, horg, horb;
57         float zenr, zeng, zenb;
58         float ambr, ambg, ambb;
59         float pad2;
60
61         unsigned int fastcol;   
62         
63         /**
64          * Exposure= mult factor. unused now, but maybe back later. Kept in to be upward compat.
65          * New is exp/range control. linfac & logfac are constants... don't belong in
66          * file, but allocating 8 bytes for temp mem isnt useful either.
67          */
68         float exposure, exp, range;     
69         float linfac, logfac;
70
71         /**
72          * Gravitation constant for the game world
73          */
74         float gravity; // XXX moved to scene->gamedata in 2.5
75
76         /**
77          * Radius of the activity bubble, in Manhattan length. Objects
78          * outside the box are activity-culled. */
79         float activityBoxRadius; // XXX moved to scene->gamedata in 2.5
80         
81         short skytype;
82         /**
83          * Some world modes
84          * bit 0: Do mist
85          * bit 1: Do stars
86          * bit 2: (reserved) depth of field
87          * bit 3: (gameengine): Activity culling is enabled.
88          * bit 4: ambient occlusion
89          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustrum culling 
90          */
91         short mode;                                                                                             // partially moved to scene->gamedata in 2.5
92         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */ // XXX moved to scene->gamedata in 2.5
93         short physicsEngine;    /* here it's aligned */                                 // XXX moved to scene->gamedata in 2.5
94         short ticrate, maxlogicstep, physubstep, maxphystep;    // XXX moved to scene->gamedata in 2.5
95         
96         float misi, miststa, mistdist, misthi;
97         
98         float starr, starg, starb, stark;
99         float starsize, starmindist;
100         float stardist, starcolnoise;
101         
102         /* unused now: DOF */
103         short dofsta, dofend, dofmin, dofmax;
104         
105         /* ambient occlusion */
106         float aodist, aodistfac, aoenergy, aobias;
107         short aomode, aosamp, aomix, aocolor;
108         float ao_adapt_thresh, ao_adapt_speed_fac;
109         float ao_approx_error, ao_approx_correction;
110         float ao_indirect_energy, ao_env_energy, ao_pad2;
111         short ao_indirect_bounces, ao_pad;
112         short ao_samp_method, ao_gather_method, ao_approx_passes;
113         
114         /* assorted settings (in the middle of ambient occlusion settings for padding reasons) */
115         short flag;
116         
117         /* ambient occlusion (contd...) */
118         float *aosphere, *aotables;
119         
120         
121         struct Ipo *ipo;                        // XXX depreceated... old animation system
122         struct MTex *mtex[18];          /* MAX_MTEX */
123         short pr_texture, pad[3];
124
125         /* previews */
126         struct PreviewImage *preview;
127
128 } World;
129
130 /* **************** WORLD ********************* */
131
132 /* skytype */
133 #define WO_SKYBLEND             1
134 #define WO_SKYREAL              2
135 #define WO_SKYPAPER             4
136 /* while render: */
137 #define WO_SKYTEX               8
138 #define WO_ZENUP                16
139
140 /* mode */
141 #define WO_MIST                1
142 #define WO_STARS               2
143 #define WO_DOF                 4
144 #define WO_ACTIVITY_CULLING        8
145 #define WO_ENV_LIGHT              16
146 #define WO_DBVT_CULLING           32
147 #define WO_AMB_OCC                64
148 #define WO_INDIRECT_LIGHT         128
149
150 /* aomix */
151 #define WO_AOADD        0
152 #define WO_AOSUB        1 /* deprecated */
153 #define WO_AOADDSUB     2 /* deprecated */
154 #define WO_AOMUL        3
155
156 /* ao_samp_method - methods for sampling the AO hemi */
157 #define WO_AOSAMP_CONSTANT                      0
158 #define WO_AOSAMP_HALTON                        1
159 #define WO_AOSAMP_HAMMERSLEY            2
160
161 /* aomode (use distances & random sampling modes) */
162 #define WO_AODIST               1
163 #define WO_AORNDSMP             2
164 #define WO_AOCACHE              4
165
166 /* aocolor */
167 #define WO_AOPLAIN      0
168 #define WO_AOSKYCOL     1
169 #define WO_AOSKYTEX     2
170
171 /* ao_gather_method */
172 #define WO_AOGATHER_RAYTRACE    0
173 #define WO_AOGATHER_APPROX              1
174
175 /* texco (also in DNA_material_types.h) */
176 #define TEXCO_ANGMAP    64
177 #define TEXCO_H_SPHEREMAP       256
178 #define TEXCO_H_TUBEMAP 1024
179
180 /* mapto */
181 #define WOMAP_BLEND             1
182 #define WOMAP_HORIZ             2
183 #define WOMAP_ZENUP             4
184 #define WOMAP_ZENDOWN   8
185 #define WOMAP_MIST              16
186
187 /* flag */
188 #define WO_DS_EXPAND    (1<<0)
189         /* NOTE: this must have the same value as MA_DS_SHOW_TEXS, 
190          * otherwise anim-editors will not read correctly
191          */
192 #define WO_DS_SHOW_TEXS (1<<2)
193
194 #endif
195