Merged changes in the trunk up to revision 42116.
[blender.git] / source / blender / blenkernel / BKE_global.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 #ifndef BKE_GLOBAL_H
28 #define BKE_GLOBAL_H
29
30 /** \file BKE_global.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  *  \section aboutglobal Global settings
35  *   Global settings, handles, pointers. This is the root for finding
36  *   any data in Blender. This block is not serialized, but built anew
37  *   for every fresh Blender run.
38  */
39 #include "DNA_listBase.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /* forwards */
46 struct Main;
47 struct Object;
48 struct BME_Glob;
49
50 typedef struct Global {
51
52         /* active pointers */
53         struct Main *main;
54         
55         /* strings: lastsaved */
56         char ima[256], lib[256];
57
58         /* flag: if != 0 G.main->name contains valid relative base path */
59         int relbase_valid;
60
61         /* strings of recent opened files */
62         struct ListBase recent_files;
63         
64         short afbreek, moving, file_loaded;
65         char background;
66         char factory_startup;
67         short winpos, displaymode;      /* used to be in Render */
68         short rendering;                        /* to indicate render is busy, prevent renderwindow events etc */
69
70         short rt;
71         int f;
72
73         /* Used for BMesh transformations */
74         struct BME_Glob *editBMesh;
75     
76         /* Frank's variables */
77         int     save_over;
78
79         /* Rob's variables (keep here for WM recode) */
80         int have_quicktime;
81         int ui_international;
82         int charstart;
83         int charmin;
84         int charmax;
85         struct VFont *selfont;
86         struct ListBase ttfdata;
87
88         /* this variable is written to / read from FileGlobal->fileflags */
89         int fileflags;
90     
91         /* save the allowed windowstate of blender when using -W or -w */
92         int windowstate;
93 } Global;
94
95 /* **************** GLOBAL ********************* */
96
97 /* G.f */
98 #define G_RENDER_OGL    (1 <<  0)
99 #define G_SWAP_EXCHANGE (1 <<  1)
100 /* also uses G_FILE_AUTOPLAY */
101 /* #define G_RENDER_SHADOW      (1 <<  3) */ /* temp flag, removed */
102 #define G_BACKBUFSEL    (1 <<  4)
103 #define G_PICKSEL               (1 <<  5)
104
105 /* #define G_FACESELECT (1 <<  8) use (mesh->editflag & ME_EDIT_PAINT_MASK) */
106
107 #define G_DEBUG                 (1 << 12)
108 #define G_SCRIPT_AUTOEXEC (1 << 13)
109 #define G_SCRIPT_OVERRIDE_PREF (1 << 14) /* when this flag is set ignore the userprefs */
110
111 /* #define G_NOFROZEN   (1 << 17) also removed */
112 /* #define G_GREASEPENCIL       (1 << 17)   also removed */
113
114 /* #define G_AUTOMATKEYS        (1 << 30)   also removed */
115
116 /* G.fileflags */
117
118 #define G_AUTOPACK               (1 << 0)
119 #define G_FILE_COMPRESS          (1 << 1)
120 #define G_FILE_AUTOPLAY          (1 << 2)
121 #define G_FILE_ENABLE_ALL_FRAMES (1 << 3)                               /* deprecated */
122 #define G_FILE_SHOW_DEBUG_PROPS  (1 << 4)                               /* deprecated */
123 #define G_FILE_SHOW_FRAMERATE    (1 << 5)                               /* deprecated */
124 /* #define G_FILE_SHOW_PROFILE   (1 << 6) */                    /* deprecated */
125 #define G_FILE_LOCK              (1 << 7)
126 #define G_FILE_SIGN              (1 << 8)
127 /* #define G_FILE_PUBLISH            (1 << 9) */                        /* deprecated */
128 #define G_FILE_NO_UI                     (1 << 10)
129 /* #define G_FILE_GAME_TO_IPO    (1 << 11) */                   /* deprecated */
130 #define G_FILE_GAME_MAT                  (1 << 12)                              /* deprecated */
131 /* #define G_FILE_DISPLAY_LISTS  (1 << 13) */                   /* deprecated */
132 #define G_FILE_SHOW_PHYSICS              (1 << 14)                              /* deprecated */
133 #define G_FILE_GAME_MAT_GLSL     (1 << 15)                              /* deprecated */
134 /* #define G_FILE_GLSL_NO_LIGHTS         (1 << 16) */           /* deprecated */
135 #define G_FILE_GLSL_NO_SHADERS   (1 << 17)                              /* deprecated */
136 #define G_FILE_GLSL_NO_SHADOWS   (1 << 18)                              /* deprecated */
137 #define G_FILE_GLSL_NO_RAMPS     (1 << 19)                              /* deprecated */
138 #define G_FILE_GLSL_NO_NODES     (1 << 20)                              /* deprecated */
139 #define G_FILE_GLSL_NO_EXTRA_TEX (1 << 21)                              /* deprecated */
140 #define G_FILE_IGNORE_DEPRECATION_WARNINGS      (1 << 22)       /* deprecated */
141 #define G_FILE_RECOVER                   (1 << 23)
142 #define G_FILE_RELATIVE_REMAP    (1 << 24)
143 #define G_FILE_HISTORY                   (1 << 25)
144
145 /* G.windowstate */
146 #define G_WINDOWSTATE_USERDEF           0
147 #define G_WINDOWSTATE_BORDER            1
148 #define G_WINDOWSTATE_FULLSCREEN        2
149
150 /* ENDIAN_ORDER: indicates what endianness the platform where the file was
151  * written had. */
152 #if !defined( __BIG_ENDIAN__ ) && !defined( __LITTLE_ENDIAN__ )
153 #  error Either __BIG_ENDIAN__ or __LITTLE_ENDIAN__ must be defined.
154 #endif
155
156 #define L_ENDIAN        1
157 #define B_ENDIAN        0
158
159 #ifdef __BIG_ENDIAN__
160 #  define ENDIAN_ORDER B_ENDIAN
161 #else
162 #  define ENDIAN_ORDER L_ENDIAN
163 #endif
164
165 /* G.moving, signals drawing in (3d) window to denote transform */
166 #define G_TRANSFORM_OBJ                 1
167 #define G_TRANSFORM_EDIT                2
168 #define G_TRANSFORM_MANIP               4
169 #define G_TRANSFORM_PARTICLE    8
170
171 /* G.special1 */
172
173 /* Memory is allocated where? blender.c */
174 extern Global G;
175
176 #ifdef __cplusplus
177 }
178 #endif
179         
180 #endif