Cleanup: sort forward declarations of enum & struct
[blender.git] / source / blender / makesdna / DNA_world_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_world_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_WORLD_TYPES_H__
33 #define __DNA_WORLD_TYPES_H__
34
35 #include "DNA_defs.h"
36 #include "DNA_ID.h"
37
38 struct AnimData;
39 struct Ipo;
40 struct MTex;
41 struct bNodeTree;
42
43 #ifndef MAX_MTEX
44 #define MAX_MTEX        18
45 #endif
46
47
48 /**
49  * World defines general modeling data such as a background fill,
50  * gravity, color model etc. It mixes game-data, rendering
51  * data and modeling data. */
52 typedef struct World {
53         ID id;
54         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
55
56         short colormodel, totex;
57         short texact, mistype;
58
59         float horr, horg, horb;
60         float zenr, zeng, zenb;
61         float ambr, ambg, ambb;
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 isn't 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 frustum 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  DNA_DEPRECATED, starg  DNA_DEPRECATED, starb  DNA_DEPRECATED, stark  DNA_DEPRECATED; /* Deprecated */
99         float starsize DNA_DEPRECATED, starmindist DNA_DEPRECATED;
100         float stardist DNA_DEPRECATED, starcolnoise DNA_DEPRECATED;
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  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
122         struct MTex *mtex[18];          /* MAX_MTEX */
123         short pr_texture, use_nodes, pad[2];
124
125         /* previews */
126         struct PreviewImage *preview;
127
128         /* nodes */
129         struct bNodeTree *nodetree;
130
131         ListBase gpumaterial;           /* runtime */
132 } World;
133
134 /* **************** WORLD ********************* */
135
136 /* skytype */
137 #define WO_SKYBLEND     (1 << 0)
138 #define WO_SKYREAL      (1 << 1)
139 #define WO_SKYPAPER     (1 << 2)
140 /* while render: */
141 #define WO_SKYTEX       (1 << 3)
142 #define WO_ZENUP        (1 << 4)
143
144 /* mode */
145 #define WO_MIST                (1 << 0)
146 //#define WO_STARS               (1 << 1) /* deprecated */
147 /*#define WO_DOF                 (1 << 2) */
148 #define WO_ACTIVITY_CULLING    (1 << 3)
149 #define WO_ENV_LIGHT          (1 << 4)
150 #define WO_DBVT_CULLING       (1 << 5)
151 #define WO_AMB_OCC            (1 << 6)
152 #define WO_INDIRECT_LIGHT     (1 << 7)
153
154 /* aomix */
155 enum {
156         WO_AOADD    = 0,
157 #ifdef DNA_DEPRECATED
158         WO_AOSUB    = 1,  /* deprecated */
159         WO_AOADDSUB = 2,  /* deprecated */
160 #endif
161         WO_AOMUL    = 3,
162 };
163
164 /* ao_samp_method - methods for sampling the AO hemi */
165 #define WO_AOSAMP_CONSTANT                      0
166 #define WO_AOSAMP_HALTON                        1
167 #define WO_AOSAMP_HAMMERSLEY            2
168
169 /* aomode (use distances & random sampling modes) */
170 #define WO_AODIST       (1 << 0)
171 #define WO_AORNDSMP     (1 << 1)
172 #define WO_AOCACHE      (1 << 2)
173
174 /* aocolor */
175 #define WO_AOPLAIN      0
176 #define WO_AOSKYCOL     1
177 #define WO_AOSKYTEX     2
178
179 /* ao_gather_method */
180 #define WO_AOGATHER_RAYTRACE    0
181 #define WO_AOGATHER_APPROX              1
182
183 /* texco (also in DNA_material_types.h) */
184 #define TEXCO_ANGMAP      (1 << 6)
185 #define TEXCO_H_SPHEREMAP (1 << 8)
186 #define TEXCO_H_TUBEMAP   (1 << 10)
187 #define TEXCO_EQUIRECTMAP (1 << 11)
188
189 /* mapto */
190 #define WOMAP_BLEND     (1 << 0)
191 #define WOMAP_HORIZ     (1 << 1)
192 #define WOMAP_ZENUP     (1 << 2)
193 #define WOMAP_ZENDOWN   (1 << 3)
194 // #define WOMAP_MIST   (1 << 4) /* Deprecated */
195
196 /* flag */
197 #define WO_DS_EXPAND    (1<<0)
198         /* NOTE: this must have the same value as MA_DS_SHOW_TEXS,
199          * otherwise anim-editors will not read correctly
200          */
201 #define WO_DS_SHOW_TEXS (1<<2)
202
203 #endif