BGE: GUI control over frame rate, logic rate, physics rate and physics subrate.
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #include "DNA_scriptlink_types.h"
36
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         
52         short colormodel, totex;
53         short texact, mistype;
54         
55         /* TODO - hork, zenk and ambk are not used, should remove at some point (Campbell) */
56         float horr, horg, horb, hork;
57         float zenr, zeng, zenb, zenk;
58         float ambr, ambg, ambb, ambk;
59
60         unsigned int fastcol;   
61         
62         /**
63          * Exposure= mult factor. unused now, but maybe back later. Kept in to be upward compat.
64          * New is exp/range control. linfac & logfac are constants... don't belong in
65          * file, but allocating 8 bytes for temp mem isnt useful either.
66          */
67         float exposure, exp, range;     
68         float linfac, logfac;
69
70         /**
71          * Gravitation constant for the game world
72          */
73         float gravity;
74
75         /**
76          * Radius of the activity bubble, in Manhattan length. Objects
77          * outside the box are activity-culled. */
78         float activityBoxRadius;
79         
80         short skytype;
81         /**
82          * Some world modes
83          * bit 0: Do mist
84          * bit 1: Do stars
85          * bit 2: (reserved) depth of field
86          * bit 3: (gameengine): Activity culling is enabled.
87          * bit 4: ambient occlusion
88          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustrum culling 
89          */
90         short mode;
91         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
92         short physicsEngine;    /* here it's aligned */
93         short ticrate, maxlogicstep, physubstep, maxphystep;
94         
95         float misi, miststa, mistdist, misthi;
96         
97         float starr, starg, starb, stark;
98         float starsize, starmindist;
99         float stardist, starcolnoise;
100         
101         /* unused now: DOF */
102         short dofsta, dofend, dofmin, dofmax;
103         
104         /* ambient occlusion */
105         float aodist, aodistfac, aoenergy, aobias;
106         short aomode, aosamp, aomix, aocolor;
107         float ao_adapt_thresh, ao_adapt_speed_fac;
108         float ao_approx_error, ao_approx_correction;
109         short ao_samp_method, ao_gather_method, ao_approx_passes, pad1;
110         
111         float *aosphere, *aotables;
112         
113         
114         struct Ipo *ipo;
115         struct MTex *mtex[18];          /* MAX_MTEX */
116
117         /* previews */
118         struct PreviewImage *preview;
119
120         ScriptLink scriptlink;
121
122 } World;
123
124 /* **************** WORLD ********************* */
125
126 /* skytype */
127 #define WO_SKYBLEND             1
128 #define WO_SKYREAL              2
129 #define WO_SKYPAPER             4
130 /* while render: */
131 #define WO_SKYTEX               8
132 #define WO_ZENUP                16
133
134 /* mode */
135 #define WO_MIST                1
136 #define WO_STARS               2
137 #define WO_DOF                 4
138 #define WO_ACTIVITY_CULLING        8
139 #define WO_AMB_OCC                        16
140 #define WO_DBVT_CULLING           32
141
142 /* aomix */
143 #define WO_AOADD        0
144 #define WO_AOSUB        1
145 #define WO_AOADDSUB     2
146
147 /* ao_samp_method - methods for sampling the AO hemi */
148 #define WO_AOSAMP_CONSTANT                      0
149 #define WO_AOSAMP_HALTON                        1
150 #define WO_AOSAMP_HAMMERSLEY            2
151
152 /* aomode (use distances & random sampling modes) */
153 #define WO_AODIST               1
154 #define WO_AORNDSMP             2
155 #define WO_AOCACHE              4
156
157 /* aocolor */
158 #define WO_AOPLAIN      0
159 #define WO_AOSKYCOL     1
160 #define WO_AOSKYTEX     2
161
162 /* ao_gather_method */
163 #define WO_AOGATHER_RAYTRACE    0
164 #define WO_AOGATHER_APPROX              1
165
166 /* texco (also in DNA_material_types.h) */
167 #define TEXCO_ANGMAP    64
168 #define TEXCO_H_SPHEREMAP       256
169 #define TEXCO_H_TUBEMAP 1024
170
171 /* mapto */
172 #define WOMAP_BLEND             1
173 #define WOMAP_HORIZ             2
174 #define WOMAP_ZENUP             4
175 #define WOMAP_ZENDOWN   8
176 #define WOMAP_MIST              16
177
178 /* physicsEngine */
179 #define WOPHY_NONE              0
180 #define WOPHY_ENJI              1
181 #define WOPHY_SUMO              2
182 #define WOPHY_DYNAMO    3
183 #define WOPHY_ODE               4
184 #define WOPHY_BULLET    5
185
186 #endif
187