2.5
[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          */
88         short mode;
89         int physicsEngine;      /* here it's aligned */
90         
91         float misi, miststa, mistdist, misthi;
92         
93         float starr, starg, starb, stark;
94         float starsize, starmindist;
95         float stardist, starcolnoise;
96         
97         /* unused now: DOF */
98         short dofsta, dofend, dofmin, dofmax;
99         
100         /* ambient occlusion */
101         float aodist, aodistfac, aoenergy, aobias;
102         short aomode, aosamp, aomix, aocolor;
103         float ao_adapt_thresh, ao_adapt_speed_fac;
104         float ao_approx_error, ao_approx_correction;
105         short ao_samp_method, ao_gather_method, ao_approx_passes, pad1;
106         
107         float *aosphere, *aotables;
108         
109         
110         struct Ipo *ipo;
111         struct MTex *mtex[18];          /* MAX_MTEX */
112
113         /* previews */
114         struct PreviewImage *preview;
115
116         ScriptLink scriptlink;
117
118 } World;
119
120 /* **************** WORLD ********************* */
121
122 /* skytype */
123 #define WO_SKYBLEND             1
124 #define WO_SKYREAL              2
125 #define WO_SKYPAPER             4
126 /* while render: */
127 #define WO_SKYTEX               8
128 #define WO_ZENUP                16
129
130 /* mode */
131 #define WO_MIST                1
132 #define WO_STARS               2
133 #define WO_DOF                 4
134 #define WO_ACTIVITY_CULLING        8
135 #define WO_AMB_OCC                        16
136
137 /* aomix */
138 #define WO_AOADD        0
139 #define WO_AOSUB        1
140 #define WO_AOADDSUB     2
141
142 /* ao_samp_method - methods for sampling the AO hemi */
143 #define WO_AOSAMP_CONSTANT                      0
144 #define WO_AOSAMP_HALTON                        1
145 #define WO_AOSAMP_HAMMERSLEY            2
146
147 /* aomode (use distances & random sampling modes) */
148 #define WO_AODIST               1
149 #define WO_AORNDSMP             2
150 #define WO_AOCACHE              4
151
152 /* aocolor */
153 #define WO_AOPLAIN      0
154 #define WO_AOSKYCOL     1
155 #define WO_AOSKYTEX     2
156
157 /* ao_gather_method */
158 #define WO_AOGATHER_RAYTRACE    0
159 #define WO_AOGATHER_APPROX              1
160
161 /* texco (also in DNA_material_types.h) */
162 #define TEXCO_ANGMAP    64
163 #define TEXCO_H_SPHEREMAP       256
164 #define TEXCO_H_TUBEMAP 1024
165
166 /* mapto */
167 #define WOMAP_BLEND             1
168 #define WOMAP_HORIZ             2
169 #define WOMAP_ZENUP             4
170 #define WOMAP_ZENDOWN   8
171 #define WOMAP_MIST              16
172
173 /* physicsEngine */
174 #define WOPHY_NONE              0
175 #define WOPHY_ENJI              1
176 #define WOPHY_SUMO              2
177 #define WOPHY_DYNAMO    3
178 #define WOPHY_ODE               4
179 #define WOPHY_BULLET    5
180
181 #endif
182