doxygen: add newline after \file
[blender.git] / source / blender / makesdna / DNA_world_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  */
23
24 #ifndef __DNA_WORLD_TYPES_H__
25 #define __DNA_WORLD_TYPES_H__
26
27 #include "DNA_defs.h"
28 #include "DNA_ID.h"
29
30 struct AnimData;
31 struct Ipo;
32 struct MTex;
33 struct bNodeTree;
34
35 #ifndef MAX_MTEX
36 #define MAX_MTEX        18
37 #endif
38
39
40 /**
41  * World defines general modeling data such as a background fill,
42  * gravity, color model etc. It mixes rendering data and modeling data. */
43 typedef struct World {
44         ID id;
45         /** Animation data (must be immediately after id for utilities to use it). */
46         struct AnimData *adt;
47         /* runtime (must be immediately after id for utilities to use it). */
48         DrawDataList drawdata;
49
50         char _pad0[4];
51         short texact, mistype;
52
53         float horr, horg, horb;
54
55         /**
56          * Exposure= mult factor. unused now, but maybe back later. Kept in to be upward compat.
57          * New is exp/range control. linfac & logfac are constants... don't belong in
58          * file, but allocating 8 bytes for temp mem isn't useful either.
59          */
60         float exposure, exp, range;
61         float linfac, logfac;
62
63         /**
64          * Some world modes
65          * bit 0: Do mist
66          */
67         short mode;
68         short pad2[3];
69
70         float misi, miststa, mistdist, misthi;
71
72         /** Ambient occlusion. */
73         float aodist, aoenergy;
74
75         /** Assorted settings. */
76         short flag, pad3[3];
77
78         /** Old animation system, deprecated for 2.5. */
79         struct Ipo *ipo  DNA_DEPRECATED;
80         short pr_texture, use_nodes, pad[2];
81
82         /* previews */
83         struct PreviewImage *preview;
84
85         /* nodes */
86         struct bNodeTree *nodetree;
87
88         /** Runtime : miststa + mistdist, used for drawing camera. */
89         float mistend, pad1;
90         /** Runtime. */
91         ListBase gpumaterial;
92 } World;
93
94 /* **************** WORLD ********************* */
95
96 /* mode */
97 #define WO_MIST                   (1 << 0)
98 #define WO_MODE_DEPRECATED_1      (1 << 1)  /* cleared */
99 #define WO_MODE_DEPRECATED_2      (1 << 2)  /* cleared */
100 #define WO_MODE_DEPRECATED_3      (1 << 3)  /* cleared */
101 #define WO_MODE_DEPRECATED_4      (1 << 4)  /* cleared */
102 #define WO_MODE_DEPRECATED_5      (1 << 5)  /* cleared */
103 #define WO_AMB_OCC                (1 << 6)
104 #define WO_MODE_DEPRECATED_7      (1 << 7)  /* cleared */
105
106 enum {
107         WO_MIST_QUADRATIC          = 0,
108         WO_MIST_LINEAR             = 1,
109         WO_MIST_INVERSE_QUADRATIC  = 2,
110 };
111
112 /* flag */
113 #define WO_DS_EXPAND    (1<<0)
114         /* NOTE: this must have the same value as MA_DS_SHOW_TEXS,
115          * otherwise anim-editors will not read correctly
116          */
117 #define WO_DS_SHOW_TEXS (1<<2)
118
119 #endif