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